tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 09:05:56 +00:00
Code Issues Projects Releases Wiki Activity

ENHANCEMENT: hide index pages from menus. BUGFIX: fixed incorrect name strings coming through on nested pages

Browse Source
This commit is contained in:
Will Rossiter 2010-10-29 02:12:20 +00:00
parent 8a02cee714
commit 9335c789af
3 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
code/DocumentationParser.php
View File

@ -331,11 +331,10 @@ class DocumentationParser {
// if the name has a . then take the substr // if the name has a . then take the substr
$formatted = ($pos = strrpos($formatted, '.')) ? substr($formatted, 0, $pos) : $formatted; $formatted = ($pos = strrpos($formatted, '.')) ? substr($formatted, 0, $pos) : $formatted;
$name = ($dot = strrpos($formatted, '.')) ? substr($name, 0, $dot) : $name; $name = ($dot = strrpos($name, '.')) ? substr($name, 0, $dot) : $name;
// the folder is the one that we are looking for. // the folder is the one that we are looking for.
if($name == $formatted) { if(strtolower($name) == strtolower($formatted)) {
if(is_dir($base . $file)) { if(is_dir($base . $file)) {
// if this is a directory check that there is any more states to get // if this is a directory check that there is any more states to get
// to in the goal. If none then what we want is the 'index.md' file // to in the goal. If none then what we want is the 'index.md' file

13
code/DocumentationViewer.php
View File

@ -354,6 +354,7 @@ class DocumentationViewer extends Controller {
if(!$module) return false; if(!$module) return false;
$absFilepath = DocumentationParser::find_page($module->getPath(), $this->Remaining); $absFilepath = DocumentationParser::find_page($module->getPath(), $this->Remaining);
if($absFilepath) { if($absFilepath) {
$relativeFilePath = str_replace($module->getPath(), '', $absFilepath); $relativeFilePath = str_replace($module->getPath(), '', $absFilepath);
@ -382,6 +383,12 @@ class DocumentationViewer extends Controller {
if($pages) { if($pages) {
foreach($pages as $page) { foreach($pages as $page) {
if(strtolower($page->Title) == "index") {
$pages->remove($page);
continue;
}
$linkParts = array(); $linkParts = array();
// don't include the 'index in the url // don't include the 'index in the url
@ -426,6 +433,12 @@ class DocumentationViewer extends Controller {
} }
foreach($children as $child) { foreach($children as $child) {
if(strtolower($child->Title) == "index") {
$children->remove($child);
continue;
}
$child->Link = $this->Link(array_merge($segments, array($child->Filename))); $child->Link = $this->Link(array_merge($segments, array($child->Filename)));
$child->LinkingMode = 'link'; $child->LinkingMode = 'link';
$child->Children = $this->_getModulePagesNested($child, $level + 1); $child->Children = $this->_getModulePagesNested($child, $level + 1);

15
tests/DocumentationViewerTests.php
View File

@ -127,22 +127,23 @@ class DocumentationViewerTests extends FunctionalTest {
$response = $v->handleRequest(new SS_HTTPRequest('GET', '2.4/en/DocumentationViewerTests/subfolder/')); $response = $v->handleRequest(new SS_HTTPRequest('GET', '2.4/en/DocumentationViewerTests/subfolder/'));
$pages = $v->getModulePages(); $pages = $v->getModulePages();
$this->assertEquals( $this->assertEquals(
array('index', 'sort', 'subfolder', 'test'), array('sort', 'subfolder', 'test'),
$pages->column('Filename') $pages->column('Filename')
); );
$this->assertEquals( $this->assertEquals(
array('link', 'link','current', 'link'), array('link','current', 'link'),
$pages->column('LinkingMode') $pages->column('LinkingMode')
); );
$links = $pages->column('Link'); $links = $pages->column('Link');
$this->assertStringEndsWith('2.4/en/DocumentationViewerTests/', $links[0]);
$this->assertStringEndsWith('2.4/en/DocumentationViewerTests/sort/', $links[1]); $this->assertStringEndsWith('2.4/en/DocumentationViewerTests/sort/', $links[0]);
$this->assertStringEndsWith('2.4/en/DocumentationViewerTests/subfolder/', $links[2]); $this->assertStringEndsWith('2.4/en/DocumentationViewerTests/subfolder/', $links[1]);
$this->assertStringEndsWith('2.4/en/DocumentationViewerTests/test/', $links[3]); $this->assertStringEndsWith('2.4/en/DocumentationViewerTests/test/', $links[2]);
// Children // Children
$pagesArr = $pages->toArray(); $pagesArr = $pages->toArray();
$child1 = $pagesArr[0];
$child1 = $pagesArr[1];
$this->assertFalse($child1->Children); $this->assertFalse($child1->Children);