diff --git a/code/DocumentationHelper.php b/code/DocumentationHelper.php
index 768ea00..60d28c2 100644
--- a/code/DocumentationHelper.php
+++ b/code/DocumentationHelper.php
@@ -8,7 +8,7 @@
class DocumentationHelper
{
/**
- * String helper for cleaning a file name to a readable version.
+ * String helper for cleaning a file name to a readable version.
*
* @param string $name to convert
*
@@ -95,9 +95,9 @@ class DocumentationHelper
/**
* Helper function to normalize paths to unix style directory separators
- *
+ *
* @param string
- *
+ *
* @return string
*/
public static function normalizePath($path)
@@ -111,9 +111,9 @@ class DocumentationHelper
/**
* Helper function to make normalized paths relative
- *
+ *
* @param string
- *
+ *
* @return string
*/
public static function relativePath($path)
diff --git a/code/DocumentationManifest.php b/code/DocumentationManifest.php
index 9e044b9..bd7463d 100644
--- a/code/DocumentationManifest.php
+++ b/code/DocumentationManifest.php
@@ -90,7 +90,9 @@ class DocumentationManifest
$this->registeredEntities = new ArrayList();
$this->cache = SS_Cache::factory(
- 'DocumentationManifest', 'Core', array(
+ 'DocumentationManifest',
+ 'Core',
+ array(
'automatic_serialization' => true,
'lifetime' => null
)
@@ -159,7 +161,8 @@ class DocumentationManifest
* @var DocumentationEntity $entity
*/
$entity = Injector::inst()->create(
- 'DocumentationEntity', $key
+ 'DocumentationEntity',
+ $key
);
$entity->setPath(DocumentationHelper::normalizePath(Controller::join_links($path, $lang, '/')));
@@ -242,7 +245,9 @@ class DocumentationManifest
}
Config::inst()->update(
- 'DocumentationManifest', 'register_entities', $entities
+ 'DocumentationManifest',
+ 'register_entities',
+ $entities
);
$this->automaticallyPopulated = true;
@@ -371,7 +376,8 @@ class DocumentationManifest
foreach ($grouped as $entity) {
uasort(
- $entity, function ($a, $b) {
+ $entity,
+ function ($a, $b) {
// ensure parent directories are first
$a['filepath'] = str_replace('index.md', '', $a['filepath']);
$b['filepath'] = str_replace('index.md', '', $b['filepath']);
@@ -417,7 +423,8 @@ class DocumentationManifest
Config::inst()->get('DocumentationViewer', 'link_base'),
'',
$link
- ), '/'
+ ),
+ '/'
);
}
@@ -461,7 +468,10 @@ class DocumentationManifest
public function handleFolder($basename, $path, $depth)
{
$folder = Injector::inst()->create(
- 'DocumentationFolder', $this->entity, $basename, $path
+ 'DocumentationFolder',
+ $this->entity,
+ $basename,
+ $path
);
// Add main folder link
@@ -491,7 +501,9 @@ class DocumentationManifest
{
$page = Injector::inst()->create(
'DocumentationPage',
- $this->entity, $basename, $path
+ $this->entity,
+ $basename,
+ $path
);
// populate any meta data
diff --git a/code/DocumentationManifestFileFinder.php b/code/DocumentationManifestFileFinder.php
index f907346..9a7fc3a 100644
--- a/code/DocumentationManifestFileFinder.php
+++ b/code/DocumentationManifestFileFinder.php
@@ -21,7 +21,7 @@ class DocumentationManifestFileFinder extends SS_FileFinder
);
/**
- *
+ *
*/
public function acceptDir($basename, $pathname, $depth)
{
diff --git a/code/DocumentationParser.php b/code/DocumentationParser.php
index 628cef9..4083b12 100755
--- a/code/DocumentationParser.php
+++ b/code/DocumentationParser.php
@@ -125,7 +125,6 @@ class DocumentationParser
$inner = true;
}
} elseif (preg_match('/^[\ ]{0,3}?[\t](.*)/', $line, $matches)) {
-
// inner line of block, or first line of standard markdown code block
// regex removes first tab (any following tabs are part of the code).
if (!$started) {
@@ -248,7 +247,9 @@ class DocumentationParser
if (substr($url, 0, 1) == '/') {
$relativeUrl = DocumentationHelper::normalizePath(
str_replace(
- BASE_PATH, '', Controller::join_links(
+ BASE_PATH,
+ '',
+ Controller::join_links(
$page->getEntity()->getPath(),
$url
)
@@ -326,11 +327,11 @@ class DocumentationParser
$html_format = '%s';
// parse api links without backticks into html
- foreach($regexs as $type => $regex) {
+ foreach ($regexs as $type => $regex) {
preg_match_all($regex, $markdown, $links);
- if($links) {
- foreach($links[0] as $i => $match) {
- if($type === 'no_title') {
+ if ($links) {
+ foreach ($links[0] as $i => $match) {
+ if ($type === 'no_title') {
$title = $links[1][$i];
$link = $links[1][$i];
// change backticked links to avoid being parsed in the same way as non-backticked links
@@ -349,8 +350,8 @@ class DocumentationParser
// recover backticked links with no titles
preg_match_all('#XYZ(.*)?XYZ#', $markdown, $links);
- if($links) {
- foreach($links[0] as $i => $match) {
+ if ($links) {
+ foreach ($links[0] as $i => $match) {
$link = $links[1][$i];
$markdown = str_replace($match, '`[api:'.$link.']`', $markdown);
}
@@ -358,8 +359,8 @@ class DocumentationParser
// recover backticked links with titles
preg_match_all('#XX(.*)?YY(.*)?ZZ#', $markdown, $links);
- if($links) {
- foreach($links[0] as $i => $match) {
+ if ($links) {
+ foreach ($links[0] as $i => $match) {
$title = $links[1][$i];
$link = $links[2][$i];
$markdown = str_replace($match, '`['.$title.'](api:'.$link.')`', $markdown);
@@ -367,7 +368,6 @@ class DocumentationParser
}
return $markdown;
-
}
/**
@@ -488,7 +488,7 @@ class DocumentationParser
$fileBaseLink,
$url
);
- } else if (preg_match('/^#/', $url)) {
+ } elseif (preg_match('/^#/', $url)) {
// for relative links begining with a hash use the current page link
$relativeUrl = Controller::join_links($baselink, $page->getRelativeLink(), $url);
} else {
@@ -521,5 +521,4 @@ class DocumentationParser
return $md;
}
-
}
diff --git a/code/DocumentationPermalinks.php b/code/DocumentationPermalinks.php
index ca04c2f..63f2316 100755
--- a/code/DocumentationPermalinks.php
+++ b/code/DocumentationPermalinks.php
@@ -1,7 +1,7 @@
*
- * Do not need to include the language or the version current as it
+ * Do not need to include the language or the version current as it
* will add it based off the language or version in the session
*
* @param array
diff --git a/code/DocumentationSearch.php b/code/DocumentationSearch.php
index 8ce67b1..8e7a921 100755
--- a/code/DocumentationSearch.php
+++ b/code/DocumentationSearch.php
@@ -8,20 +8,20 @@ set_include_path(
require_once 'Zend/Search/Lucene.php';
/**
- * Documentation Search powered by Lucene. You will need Zend_Lucene installed
+ * Documentation Search powered by Lucene. You will need Zend_Lucene installed
* on your path.
*
- * To rebuild the indexes run the {@link RebuildLuceneDocsIndex} task. You may
+ * To rebuild the indexes run the {@link RebuildLuceneDocsIndex} task. You may
* wish to setup a cron job to remake the indexes on a regular basis.
*
- * This class has the ability to generate an OpenSearch RSS formatted feeds
+ * This class has the ability to generate an OpenSearch RSS formatted feeds
* simply by using the URL:
*
*
* yoursite.com/search/?q=Foo&format=rss. // Format can either be specified as rss or left off.
*
*
- * To get a specific amount of results you can also use the modifiers start and
+ * To get a specific amount of results you can also use the modifiers start and
* limit:
*
*
@@ -127,7 +127,7 @@ class DocumentationSearch
* Folder name for indexes (in the temp folder).
*
* @config
- * @var string
+ * @var string
*/
private static $index_location;
@@ -363,7 +363,7 @@ class DocumentationSearch
}
/**
- * OpenSearch MetaData fields. For a list of fields consult
+ * OpenSearch MetaData fields. For a list of fields consult
* {@link self::get_meta_data()}
*
* @param array
@@ -406,7 +406,7 @@ class DocumentationSearch
}
/**
- * Renders the search results into a template. Either the search results
+ * Renders the search results into a template. Either the search results
* template or the Atom feed.
*/
public function renderResults()
@@ -428,7 +428,8 @@ class DocumentationSearch
$title = ($title = $this->getTitle()) ? ' - '. $title : "";
$link = Controller::join_links(
- $this->outputController->Link(), 'DocumentationOpenSearchController/description/'
+ $this->outputController->Link(),
+ 'DocumentationOpenSearchController/description/'
);
$data->setField('Title', $data->Title . $title);
diff --git a/code/controllers/DocumentationViewer.php b/code/controllers/DocumentationViewer.php
index 78d481e..807214e 100755
--- a/code/controllers/DocumentationViewer.php
+++ b/code/controllers/DocumentationViewer.php
@@ -110,7 +110,7 @@ class DocumentationViewer extends Controller implements PermissionProvider
)
);
Requirements::combine_files(
- 'docs.css',
+ 'docs.css',
array(
DOCSVIEWER_DIR .'/css/highlight.css',
DOCSVIEWER_DIR .'/css/normalize.css',
@@ -204,7 +204,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
// Strip off the base url
//
$base = ltrim(
- Config::inst()->get('DocumentationViewer', 'link_base'), '/'
+ Config::inst()->get('DocumentationViewer', 'link_base'),
+ '/'
);
if ($base && strpos($url, $base) !== false) {
@@ -393,7 +394,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
// add children
$children = $this->getManifest()->getChildrenFor(
- $entity->getPath(), ($record) ? $record->getPath() : $entity->getPath()
+ $entity->getPath(),
+ ($record) ? $record->getPath() : $entity->getPath()
);
} else {
if ($current && $current->getKey() == $entity->getKey()) {
@@ -438,7 +440,7 @@ class DocumentationViewer extends Controller implements PermissionProvider
public function replaceChildrenCalls($html)
{
$codes = new ShortcodeParser();
- $codes->register('CHILDREN', array($this, 'includeChildren'));
+ $codes->register('CHILDREN', array($this, 'includeChildren'));
return $codes->parse($html);
}
@@ -694,7 +696,6 @@ class DocumentationViewer extends Controller implements PermissionProvider
$entity = $page->getEntity();
if ($entity && isset(self::$edit_links[strtolower($entity->title)])) {
-
// build the edit link, using the version defined
$url = self::$edit_links[strtolower($entity->title)];
$version = $entity->getVersion();
@@ -738,7 +739,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
{
return ($this->record)
? $this->getManifest()->getNextPage(
- $this->record->getPath(), $this->getEntity()->getPath()
+ $this->record->getPath(),
+ $this->getEntity()->getPath()
)
: null;
}
@@ -753,7 +755,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
{
return ($this->record)
? $this->getManifest()->getPreviousPage(
- $this->record->getPath(), $this->getEntity()->getPath()
+ $this->record->getPath(),
+ $this->getEntity()->getPath()
)
: null;
}
diff --git a/code/forms/DocumentationAdvancedSearchForm.php b/code/forms/DocumentationAdvancedSearchForm.php
index 51beaed..04f19a3 100644
--- a/code/forms/DocumentationAdvancedSearchForm.php
+++ b/code/forms/DocumentationAdvancedSearchForm.php
@@ -34,7 +34,8 @@ class DocumentationAdvancedSearchForm extends Form
CheckboxSetField::create(
'Versions',
_t('DocumentationViewer.VERSIONS', 'Versions'),
- $versions, $searchedVersions
+ $versions,
+ $searchedVersions
)
);
diff --git a/code/models/DocumentationFolder.php b/code/models/DocumentationFolder.php
index 61ff5b6..9bc1be3 100644
--- a/code/models/DocumentationFolder.php
+++ b/code/models/DocumentationFolder.php
@@ -1,9 +1,9 @@
";
}
}
- public function end()
+ public function end()
{
- if(Director::is_cli()) {
+ if (Director::is_cli()) {
echo "\nTotal errors: {$this->errors}\n";
} else {
echo "";
@@ -27,10 +27,10 @@ class CheckDocsSourcesTask extends BuildTask
}
}
- public function showError($error)
+ public function showError($error)
{
$this->errors++;
- if(Director::is_cli()) {
+ if (Director::is_cli()) {
echo "\n$error";
} else {
echo "" . Convert::raw2xml($error) . "";
diff --git a/code/tasks/RebuildLuceneDocsIndex.php b/code/tasks/RebuildLuceneDocsIndex.php
index b0f63b3..546a37a 100755
--- a/code/tasks/RebuildLuceneDocsIndex.php
+++ b/code/tasks/RebuildLuceneDocsIndex.php
@@ -1,9 +1,9 @@
addField(
Zend_Search_Lucene_Field::Keyword(
- 'Version', $page->getEntity()->getVersion()
+ 'Version',
+ $page->getEntity()->getVersion()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
- 'Language', $page->getEntity()->getLanguage()
+ 'Language',
+ $page->getEntity()->getLanguage()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
- 'Entity', $page->getEntity()
+ 'Entity',
+ $page->getEntity()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
- 'Link', $page->Link()
+ 'Link',
+ $page->Link()
)
);
diff --git a/tests/DocumentationEntityTest.php b/tests/DocumentationEntityTest.php
index 577c93c..35d7172 100644
--- a/tests/DocumentationEntityTest.php
+++ b/tests/DocumentationEntityTest.php
@@ -2,7 +2,7 @@
class DocumentationEntityTest extends SapphireTest
{
- public function dataCompare()
+ public function dataCompare()
{
return array(
array('3', '3.0', 1),
@@ -20,7 +20,7 @@ class DocumentationEntityTest extends SapphireTest
* @param string $right
* @param int $result
*/
- public function testCompare($left, $right, $result)
+ public function testCompare($left, $right, $result)
{
$leftVersion = new DocumentationEntity('Framework');
$leftVersion->setVersion($left);
diff --git a/tests/DocumentationManifestTests.php b/tests/DocumentationManifestTests.php
index 717e7d3..46bd150 100644
--- a/tests/DocumentationManifestTests.php
+++ b/tests/DocumentationManifestTests.php
@@ -16,18 +16,24 @@ class DocumentationManifestTests extends SapphireTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
- 'DocumentationViewer', 'link_base', 'dev/docs'
+ 'DocumentationViewer',
+ 'link_base',
+ 'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
- 'DocumentationManifest', 'automatic_registration', false
+ 'DocumentationManifest',
+ 'automatic_registration',
+ false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
- 'DocumentationManifest', 'register_entities', array(
+ 'DocumentationManifest',
+ 'register_entities',
+ array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',
@@ -189,7 +195,8 @@ class DocumentationManifestTests extends SapphireTest
);
$this->assertDOSContains(
- $expected, $this->manifest->getChildrenFor(
+ $expected,
+ $this->manifest->getChildrenFor(
DOCSVIEWER_PATH . '/tests/docs/en/'
)
);
diff --git a/tests/DocumentationPageTest.php b/tests/DocumentationPageTest.php
index 7f9349d..8e72bca 100755
--- a/tests/DocumentationPageTest.php
+++ b/tests/DocumentationPageTest.php
@@ -42,7 +42,8 @@ class DocumentationPageTest extends SapphireTest
// single layer
$this->assertEquals(
- 'dev/docs/en/doctest/2.4/test/', $page->Link(),
+ 'dev/docs/en/doctest/2.4/test/',
+ $page->Link(),
'The page link should have no extension and have a language'
);
diff --git a/tests/DocumentationParserTest.php b/tests/DocumentationParserTest.php
index 2f12033..906d509 100755
--- a/tests/DocumentationParserTest.php
+++ b/tests/DocumentationParserTest.php
@@ -23,7 +23,9 @@ class DocumentationParserTest extends SapphireTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
- 'DocumentationViewer', 'link_base', 'dev/docs/'
+ 'DocumentationViewer',
+ 'link_base',
+ 'dev/docs/'
);
$this->entity = new DocumentationEntity('DocumentationParserTest');
@@ -294,7 +296,9 @@ HTML;
);
$expected = Controller::join_links(
- Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/subfolder/_images/image.png'
+ Director::absoluteBaseURL(),
+ DOCSVIEWER_DIR,
+ '/tests/docs/en/subfolder/_images/image.png'
);
$this->assertContains(
@@ -304,15 +308,20 @@ HTML;
$this->assertContains(
sprintf(
- '[parent image link](%s)', Controller::join_links(
- Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/_images/image.png'
+ '[parent image link](%s)',
+ Controller::join_links(
+ Director::absoluteBaseURL(),
+ DOCSVIEWER_DIR,
+ '/tests/docs/en/_images/image.png'
)
),
$result
);
$expected = Controller::join_links(
- Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/_images/image.png'
+ Director::absoluteBaseURL(),
+ DOCSVIEWER_DIR,
+ '/tests/docs/en/_images/image.png'
);
$this->assertContains(
@@ -350,11 +359,10 @@ HTML;
array('[Title](api:DataObject::populateDefaults())',sprintf($html_format, 'DataObject::populateDefaults()', 'Title'))
);
- foreach($test_cases as $test_case) {
+ foreach ($test_cases as $test_case) {
$expected_html = $test_case[1];
$this->assertContains($expected_html, $parsed_page);
}
-
}
public function testHeadlineAnchors()
diff --git a/tests/DocumentationSearchTest.php b/tests/DocumentationSearchTest.php
index 0e9766c..fe27bd1 100755
--- a/tests/DocumentationSearchTest.php
+++ b/tests/DocumentationSearchTest.php
@@ -13,20 +13,26 @@ class DocumentationSearchTest extends FunctionalTest
Config::nest();
- // explicitly use dev/docs. Custom paths should be tested separately
+ // explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
- 'DocumentationViewer', 'link_base', 'dev/docs'
+ 'DocumentationViewer',
+ 'link_base',
+ 'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
- 'DocumentationManifest', 'automatic_registration', false
+ 'DocumentationManifest',
+ 'automatic_registration',
+ false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update('DocumentationSearch', 'enabled', true);
Config::inst()->update(
- 'DocumentationManifest', 'register_entities', array(
+ 'DocumentationManifest',
+ 'register_entities',
+ array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs-search/",
'Title' => 'Docs Search Test', )
@@ -54,8 +60,8 @@ class DocumentationSearchTest extends FunctionalTest
$response = $c->handleRequest(new SS_HTTPRequest('GET', 'description/'), DataModel::inst());
// $this->assertEquals(404, $response->getStatusCode());
- // test we get a response to the description. The meta data test will
- // check that the individual fields are valid but we should check urls
+ // test we get a response to the description. The meta data test will
+ // check that the individual fields are valid but we should check urls
// are there
Config::inst()->update('DocumentationSearch', 'enabled', true);
diff --git a/tests/DocumentationViewerTest.php b/tests/DocumentationViewerTest.php
index bc18fad..ef6b8bb 100755
--- a/tests/DocumentationViewerTest.php
+++ b/tests/DocumentationViewerTest.php
@@ -22,18 +22,24 @@ class DocumentationViewerTest extends FunctionalTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
- 'DocumentationViewer', 'link_base', 'dev/docs/'
+ 'DocumentationViewer',
+ 'link_base',
+ 'dev/docs/'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
- 'DocumentationManifest', 'automatic_registration', false
+ 'DocumentationManifest',
+ 'automatic_registration',
+ false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
- 'DocumentationManifest', 'register_entities', array(
+ 'DocumentationManifest',
+ 'register_entities',
+ array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',
diff --git a/tests/DocumentationViewerVersionWarningTest.php b/tests/DocumentationViewerVersionWarningTest.php
index 1ffc23d..f5b90cf 100644
--- a/tests/DocumentationViewerVersionWarningTest.php
+++ b/tests/DocumentationViewerVersionWarningTest.php
@@ -16,20 +16,26 @@ class DocumentationViewerVersionWarningTest extends SapphireTest
Config::nest();
- // explicitly use dev/docs. Custom paths should be tested separately
+ // explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
- 'DocumentationViewer', 'link_base', 'dev/docs'
+ 'DocumentationViewer',
+ 'link_base',
+ 'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
- 'DocumentationManifest', 'automatic_registration', false
+ 'DocumentationManifest',
+ 'automatic_registration',
+ false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
- 'DocumentationManifest', 'register_entities', array(
+ 'DocumentationManifest',
+ 'register_entities',
+ array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',