gordonbanderson / silverstripe-elastica

src/SilverStripe/Elastica/ElasticaSearchHelperInterface.php

Doc Comments +3 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 	/**
 	 * Alter the query or add to it, perhaps for example adding aggregation
 	 * @param  Elastic\Query &$query query object from Elastica
-	 * @return [type]         [description]
+	 * @return void         [description]
 	 */
 	public function augmentQuery(&$query);
 
@@ -12,6 +12,7 @@ 
 	 * Update filters, perhaps remaps them, prior to performing a search.
 	 * This allows for aggregation values to be updated prior to rendering.
 	 * @param  array &$filters array of key/value pairs for query filtering
+	 * @return void
 	 */
 	public function updateFilters(&$filters);
 
@@ -19,7 +20,7 @@ 
 	 * Manipulate the array of aggregations post search butprior to rendering
 	 * them in a template.
 	 * @param  [type] &$aggs [description]
-	 * @return [type]        [description]
+	 * @return void        [description]
 	 */
 	public function updateAggregation(&$aggs);
 

src/SilverStripe/Elastica/ResultList.php

Doc Comments +3 added lines

@@ -250,6 +250,9 @@
 	}
 
 
+	/**
+	 * @return integer
+	 */
 	public function getTotalItems() {
 		$this->getResults();
 		return $this->TotalItems;

tests/AggregationUnitTest.php

Doc Comments +1 added lines

@@ -1036,6 +1036,7 @@
 	/**
 	 * Test searching
 	 * http://stackoverflow.com/questions/28305250/elasticsearch-customize-score-for-synonyms-stemming
+	 * @param string $queryText
 	 */
 	private function search($queryText,$fields = array('Title' => 1, 'Description' => 1),
 		$filters = array()) {

Spacing +36 added lines, -36 removed lines

@@ -421,7 +421,7 @@ 
 		$resultList = $this->search('');
 
 		//assert there are actually some results
-		$this->assertGreaterThan(0,$resultList->getTotalItems());
+		$this->assertGreaterThan(0, $resultList->getTotalItems());
 		$aggregations = $resultList->getAggregations()->toArray();
 
 		/*
@@ -440,49 +440,49 @@ 
 		//Asserting aggregate of ISO, 64 has count 5
 		$this->assertEquals("64", $buckets[0]->Key);
 		$this->assertEquals(5, $buckets[0]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',64)->count(),5);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 64)->count(), 5);
 		$bucketSum += $buckets[0]->DocumentCount;
 
 		//Asserting aggregate of ISO, 100 has count 11
 		$this->assertEquals("100", $buckets[1]->Key);
 		$this->assertEquals(11, $buckets[1]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',100)->count(),11);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 100)->count(), 11);
 		$bucketSum += $buckets[1]->DocumentCount;
 
 		//Asserting aggregate of ISO, 200 has count 12
 		$this->assertEquals("200", $buckets[2]->Key);
 		$this->assertEquals(12, $buckets[2]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',200)->count(),12);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 200)->count(), 12);
 		$bucketSum += $buckets[2]->DocumentCount;
 
 		//Asserting aggregate of ISO, 400 has count 13
 		$this->assertEquals("400", $buckets[3]->Key);
 		$this->assertEquals(13, $buckets[3]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',400)->count(),13);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 400)->count(), 13);
 		$bucketSum += $buckets[3]->DocumentCount;
 
 		//Asserting aggregate of ISO, 800 has count 16
 		$this->assertEquals("800", $buckets[4]->Key);
 		$this->assertEquals(16, $buckets[4]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',800)->count(),16);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 800)->count(), 16);
 		$bucketSum += $buckets[4]->DocumentCount;
 
 		//Asserting aggregate of ISO, 1600 has count 13
 		$this->assertEquals("1600", $buckets[5]->Key);
 		$this->assertEquals(13, $buckets[5]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',1600)->count(),13);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 1600)->count(), 13);
 		$bucketSum += $buckets[5]->DocumentCount;
 
 		//Asserting aggregate of ISO, 2000 has count 11
 		$this->assertEquals("2000", $buckets[6]->Key);
 		$this->assertEquals(11, $buckets[6]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',2000)->count(),11);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 2000)->count(), 11);
 		$bucketSum += $buckets[6]->DocumentCount;
 
 		//Asserting aggregate of ISO, 3200 has count 19
 		$this->assertEquals("3200", $buckets[7]->Key);
 		$this->assertEquals(19, $buckets[7]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO',3200)->count(),19);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('ISO', 3200)->count(), 19);
 		$bucketSum += $buckets[7]->DocumentCount;
 		$this->assertEquals(100, $bucketSum);
 
@@ -495,43 +495,43 @@ 
 		//Asserting aggregate of Focal Length, 24 has count 12
 		$this->assertEquals("24", $buckets[0]->Key);
 		$this->assertEquals(12, $buckets[0]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',24)->count(),12);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 24)->count(), 12);
 		$bucketSum += $buckets[0]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 50 has count 11
 		$this->assertEquals("50", $buckets[1]->Key);
 		$this->assertEquals(11, $buckets[1]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',50)->count(),11);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 50)->count(), 11);
 		$bucketSum += $buckets[1]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 80 has count 11
 		$this->assertEquals("80", $buckets[2]->Key);
 		$this->assertEquals(11, $buckets[2]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',80)->count(),11);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 80)->count(), 11);
 		$bucketSum += $buckets[2]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 90 has count 20
 		$this->assertEquals("90", $buckets[3]->Key);
 		$this->assertEquals(20, $buckets[3]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',90)->count(),20);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 90)->count(), 20);
 		$bucketSum += $buckets[3]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 120 has count 12
 		$this->assertEquals("120", $buckets[4]->Key);
 		$this->assertEquals(12, $buckets[4]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',120)->count(),12);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 120)->count(), 12);
 		$bucketSum += $buckets[4]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 150 has count 17
 		$this->assertEquals("150", $buckets[5]->Key);
 		$this->assertEquals(17, $buckets[5]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',150)->count(),17);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 150)->count(), 17);
 		$bucketSum += $buckets[5]->DocumentCount;
 
 		//Asserting aggregate of Focal Length, 200 has count 17
 		$this->assertEquals("200", $buckets[6]->Key);
 		$this->assertEquals(17, $buckets[6]->DocumentCount);
-		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm',200)->count(),17);
+		$this->assertEquals(FlickrPhotoTO::get()->filter('FocalLength35mm', 200)->count(), 17);
 		$bucketSum += $buckets[6]->DocumentCount;
 		$this->assertEquals(100, $bucketSum);
 
@@ -731,7 +731,7 @@ 
 		$buckets = $agg->Buckets->toArray();
 
 
-		foreach ($buckets as $bucket) {
+		foreach($buckets as $bucket) {
 			echo "{$bucket->Key} => {$bucket->DocumentCount}\n";
 		}
 
@@ -825,7 +825,7 @@ 
 		$originalAggregations = $resultList->getAggregations()->toArray();
 
 		$filters = array('ISO' => 3200);
-		$resultListFiltered = $this->search('New Zealand', $fields,$filters);
+		$resultListFiltered = $this->search('New Zealand', $fields, $filters);
 		$filteredAggregations = $resultListFiltered->getAggregations()->toArray();
 
 		$this->checkDrillingDownHasHappened($filteredAggregations, $originalAggregations);
@@ -837,8 +837,8 @@ 
 		$resultList = $this->search('New Zealand', $fields, array('ISO' => 400));
 		$originalAggregations = $resultList->getAggregations()->toArray();
 
-		$filters = array('ISO' => 400, 'Aspect' => 'Vertical' );
-		$resultListFiltered = $this->search('New Zealand', $fields,$filters);
+		$filters = array('ISO' => 400, 'Aspect' => 'Vertical');
+		$resultListFiltered = $this->search('New Zealand', $fields, $filters);
 		$filteredAggregations = $resultListFiltered->getAggregations()->toArray();
 
 		$this->checkDrillingDownHasHappened($filteredAggregations, $originalAggregations);
@@ -854,8 +854,8 @@ 
 										'Aspect' => 'Vertical'));
 		$originalAggregations = $resultList->getAggregations()->toArray();
 
-		$filters = array('ISO' => 400, 'Aspect' => 'Vertical', 'Aperture' => 5 );
-		$resultListFiltered = $this->search('New Zealand', $fields,$filters);
+		$filters = array('ISO' => 400, 'Aspect' => 'Vertical', 'Aperture' => 5);
+		$resultListFiltered = $this->search('New Zealand', $fields, $filters);
 		$filteredAggregations = $resultListFiltered->getAggregations()->toArray();
 
 		$this->checkDrillingDownHasHappened($filteredAggregations, $originalAggregations);
@@ -895,7 +895,7 @@ 
 	private function checkDrillingDownHasHappened($filteredAggregations, $originalAggregations) {
 		$aggCtr = 0;
 
-		foreach ($filteredAggregations as $filteredAgg) {
+		foreach($filteredAggregations as $filteredAgg) {
 			$origAgg = $originalAggregations[$aggCtr];
 			$bucketCtr = 0;
 			$origBuckets = $origAgg->Buckets->toArray();
@@ -904,17 +904,17 @@ 
 			$origCounts = array();
 			$filteredCounts = array();
 
-			foreach ($origBuckets as $bucket) {
+			foreach($origBuckets as $bucket) {
 				$origCounts[$bucket->Key] = $bucket->DocumentCount;
 			}
 
-			foreach ($filteredBuckets as $bucket) {
+			foreach($filteredBuckets as $bucket) {
 				$filteredCounts[$bucket->Key] = $bucket->DocumentCount;
 			}
 
 			$akf = array_keys($filteredCounts);
 
-			foreach ($akf as $aggregateKey) {
+			foreach($akf as $aggregateKey) {
 				$this->assertGreaterThanOrEqual(
 					$filteredCounts[$aggregateKey], $origCounts[$aggregateKey]
 				);
@@ -950,8 +950,8 @@ 
 		$es->setQueryResultManipulator('FlickrPhotoTOElasticaSearchHelper');
 
 		//Add filters
-		foreach ($filters as $key => $value) {
-			$es->addFilter($key,$value);
+		foreach($filters as $key => $value) {
+			$es->addFilter($key, $value);
 		}
 
 		$es->showResultsForEmptySearch();
@@ -970,7 +970,7 @@ 
 	 * Test searching
 	 * http://stackoverflow.com/questions/28305250/elasticsearch-customize-score-for-synonyms-stemming
 	 */
-	private function search($queryText,$fields = array('Title' => 1, 'Description' => 1),
+	private function search($queryText, $fields = array('Title' => 1, 'Description' => 1),
 		$filters = array()) {
 		$es = new ElasticSearcher();
 		$es->setStart(0);
@@ -980,9 +980,9 @@ 
 		$es->setQueryResultManipulator('FlickrPhotoTOElasticaSearchHelper');
 
 		//Add filters
-		foreach ($filters as $key => $value) {
+		foreach($filters as $key => $value) {
 			echo "ADDING FILTER:$key => $value\n";
-			$es->addFilter($key,$value);
+			$es->addFilter($key, $value);
 		}
 
 		$es->showResultsForEmptySearch();
@@ -991,12 +991,12 @@ 
 		$ctr = 0;
 
 		echo "{$resultList->count()} items found searching for '$queryText'\n\n";
-		foreach ($resultList as $result) {
+		foreach($resultList as $result) {
 			$ctr++;
-			echo("($ctr) ".$result->Title."\n");
-			if ($result->SearchHighlightsByField->Content) {
-				foreach ($result->SearchHighlightsByField->Content as $highlight) {
-					echo("- ".$highlight->Snippet);
+			echo("($ctr) " . $result->Title . "\n");
+			if($result->SearchHighlightsByField->Content) {
+				foreach($result->SearchHighlightsByField->Content as $highlight) {
+					echo("- " . $highlight->Snippet);
 				}
 			}
 		}

tests/ElasticaUtilTest.php

Doc Comments +3 added lines

@@ -153,6 +153,9 @@
 
 	/**
 	 * Simulate a call to Elastica to get suggestions for a given phrase
+	 * @param string $phrase
+	 * @param string $suggestion
+	 * @param string $highlightedSuggestion
 	 * @return [type] [description]
 	 */
 	private function getSuggestionArray($phrase, $suggestion, $highlightedSuggestion) {

tests/ElasticsearchFunctionalTestBase.php

Doc Comments +14 added lines, -1 removed lines

@@ -102,7 +102,7 @@ 
 	 * Note:   characters are stripped from the content; make sure that your assertions take this into account.
 	 *
 	 * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
-	 * @param array|string $expectedMatches The content of at least one of the matched tags
+	 * @param integer $index
 	 * @throws PHPUnit_Framework_AssertionFailedError
 	 * @return boolean
 	 */
@@ -133,6 +133,12 @@ 
 	/*
 	Check all the nodes matching the selector for attribute name = expected value
 	 */
+
+	/**
+	 * @param string $selector
+	 * @param string $attributeName
+	 * @param string $expectedValue
+	 */
 	public function assertAttributeHasExactValue($selector, $attributeName, $expectedValue) {
 		$items = $this->cssParser()->getBySelector($selector);
 		foreach ($items as $item) {
@@ -141,6 +147,9 @@ 
 	}
 
 
+	/**
+	 * @param string $selector
+	 */
 	public function assertAttributesHaveExactValues($selector, $expectedValues) {
 		$attributeNames = array_keys($expectedValues);
 		$items = $this->cssParser()->getBySelector($selector);
@@ -154,6 +163,10 @@ 
 	}
 
 
+	/**
+	 * @param string $selector
+	 * @param integer $expectedAmount
+	 */
 	public function assertNumberOfNodes($selector, $expectedAmount) {
 		$items = $this->cssParser()->getBySelector($selector);
 		foreach ($items as $item) {

Spacing +19 added lines, -19 removed lines

@@ -8,8 +8,8 @@ 
 	public static $ignoreFixtureFileFor = array();
 
 	protected $extraDataObjects = array(
-		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
-		'SearchableTestFatherPage','SearchableTestGrandFatherPage'
+		'SearchableTestPage', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO', 'FlickrTagTO',
+		'SearchableTestFatherPage', 'SearchableTestGrandFatherPage'
 	);
 
 
@@ -29,7 +29,7 @@ 
 
 		// this needs to be called in order to create the list of searchable
 		// classes and fields that are available.  Simulates part of a build
-		$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
+		$classes = array('SearchableTestPage', 'SiteTree', 'Page', 'FlickrPhotoTO', 'FlickrSetTO',
 			'FlickrTagTO', 'FlickrAuthorTO');
 		$this->requireDefaultRecordsFrom = $classes;
 
@@ -45,7 +45,7 @@ 
 		$this->service->setTestMode(true);
 
 		// A previous test may have deleted the index and then failed, so check for this
-		if (!$this->service->getIndex()->exists()) {
+		if(!$this->service->getIndex()->exists()) {
 			$this->service->getIndex()->create();
 		}
 		$this->service->reset();
@@ -59,10 +59,10 @@ 
 		echo "TESTS TO IGNORE:\n";
 		print_r(static::$ignoreFixtureFileFor);
 
-		foreach (static::$ignoreFixtureFileFor as $testPattern) {
-			$pattern = '/'.$testPattern.'/';
-			echo "GREP: $pattern against ".$this->getName()."\n";
-			if (preg_match($pattern, $this->getName())) {
+		foreach(static::$ignoreFixtureFileFor as $testPattern) {
+			$pattern = '/' . $testPattern . '/';
+			echo "GREP: $pattern against " . $this->getName() . "\n";
+			if(preg_match($pattern, $this->getName())) {
 				static::$fixture_file = null;
 			}
 		}
@@ -84,12 +84,12 @@ 
 
 
 	private function publishSiteTree() {
-		foreach (SiteTree::get()->getIterator() as $page) {
+		foreach(SiteTree::get()->getIterator() as $page) {
 			// temporarily disable Elasticsearch indexing, it will be done in a batch
 			$page->IndexingOff = true;
 
-			echo "Publishing ".$page->Title."\n";
-			$page->publish('Stage','Live');
+			echo "Publishing " . $page->Title . "\n";
+			$page->publish('Stage', 'Live');
 		}
 	}
 
@@ -111,11 +111,11 @@ 
 		$items = $this->cssParser()->getBySelector($selector);
 
 		$ctr = 0;
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$text = strip_tags($item);
 			$escaped = str_replace("'", "\'", $text);
 			echo "SELECTED:\$this->assertSelectorStartsWithOrEquals('{$selector}', $ctr, '$escaped');\n";
-			echo "ITEM:".$item."\n";
+			echo "ITEM:" . $item . "\n";
 			$ctr++;
 		}
 
@@ -135,7 +135,7 @@ 
 	 */
 	public function assertAttributeHasExactValue($selector, $attributeName, $expectedValue) {
 		$items = $this->cssParser()->getBySelector($selector);
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$this->assertEquals($expectedValue, $item['value']);
 		}
 	}
@@ -144,9 +144,9 @@ 
 	public function assertAttributesHaveExactValues($selector, $expectedValues) {
 		$attributeNames = array_keys($expectedValues);
 		$items = $this->cssParser()->getBySelector($selector);
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$actualValues = array();
-			foreach ($attributeNames as $attributeName) {
+			foreach($attributeNames as $attributeName) {
 				$actualValues[$attributeName] = (string)$item[$attributeName];
 			}
 			$this->assertEquals($expectedValues, $actualValues);
@@ -156,7 +156,7 @@ 
 
 	public function assertNumberOfNodes($selector, $expectedAmount) {
 		$items = $this->cssParser()->getBySelector($selector);
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$text = strip_tags($item);
 		}
 
@@ -169,9 +169,9 @@ 
 	public function collateSearchResults() {
 		$items = $this->cssParser()->getBySelector('div.searchResults .searchResult');
 		$result = array();
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$attr = $item->attributes()->id;
-			array_push($result, $attr."");
+			array_push($result, $attr . "");
 		}
 
 		return $result;

tests/ElasticSearchPage_Validator_Test.php

Doc Comments +4 added lines

@@ -106,6 +106,10 @@
 	}
 
 
+	/**
+	 * @param string $fieldName
+	 * @param string $message
+	 */
 	private function checkForError($fieldName, $badValue, $message) {
 		$this->ElasticSearchPage->$fieldName = $badValue;
 

Spacing +9 added lines, -9 removed lines

@@ -8,7 +8,7 @@ 
 		parent::setup();
 		$this->ElasticSearchPage = $this->objFromFixture('ElasticSearchPage', 'search');
 
-		$this->ElasticSearchPage->SimilarityStopWords =  'a,the,which';
+		$this->ElasticSearchPage->SimilarityStopWords = 'a,the,which';
 		$this->ElasticSearchPage->write();
 
 		$this->Validator = $this->ElasticSearchPage->getCMSValidator();
@@ -34,7 +34,7 @@ 
 			'AutoCompleteFieldID' => null,
 			'AutoCompleteFunctionID' => null,
 			'SearchHelper' => null,
-			'SimilarityStopWords' => array('a', 'an', 'the', ),
+			'SimilarityStopWords' => array('a', 'an', 'the',),
 			'MinTermFreq' => 2,
 			'MaxTermFreq' => 25,
 			'MinDocFreq' => 2,
@@ -102,7 +102,7 @@ 
 		$esp->Identifier = 'THISWILLBECOPIED';
 		$esp->write();
 		$this->checkForError('Identifier', 'THISWILLBECOPIED',
-			'The identifier THISWILLBECOPIED already exists' );
+			'The identifier THISWILLBECOPIED already exists');
 	}
 
 
@@ -114,7 +114,7 @@ 
 		$form = new Form($this, 'Form', $fields, new FieldList());
 		$form->loadDataFrom($this->ElasticSearchPage);
 
-		foreach ($form->Fields() as $field) {
+		foreach($form->Fields() as $field) {
 			echo "************** {$field->getName()} -> {$field->Value()}\n";
 		}
 		$form->setValidator($this->ElasticSearchPage->getCMSValidator());
@@ -124,13 +124,13 @@ 
 		$found = false;
 		print_r($errors);
 
-		foreach ($errors as $error) {
+		foreach($errors as $error) {
 			echo "Checking error\n";
-			echo " - " . $error['fieldName'].' => '.$error['message']."\n";
-			echo "\tT1:".($error['message'] == $message);
-			echo "\n\tT2:".($error['fieldName'] == $fieldName);
+			echo " - " . $error['fieldName'] . ' => ' . $error['message'] . "\n";
+			echo "\tT1:" . ($error['message'] == $message);
+			echo "\n\tT2:" . ($error['fieldName'] == $fieldName);
 
-			if ($error['message'] == $message && $error['fieldName'] == $fieldName) {
+			if($error['message'] == $message && $error['fieldName'] == $fieldName) {
 				$found = true;
 				break;
 			}

tests/ElasticsearchTestBase.php

Doc Comments +11 added lines

@@ -132,6 +132,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $depth
+	 * @param string $parentKey
+	 */
 	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
 		$prefix = str_repeat("\t",$depth);
 		echo "\t{$prefix}'$parentKey' => array(\n";
@@ -160,6 +164,10 @@ 
 	/*
 	Helper methods for testing CMS fields
 	 */
+
+	/**
+	 * @param string $tabName
+	 */
 	public function checkTabExists($fields, $tabName) {
 		echo "Searching for tab $tabName\n";
 		$tab = $fields->findOrMakeTab("Root.{$tabName}");
@@ -184,6 +192,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fieldName
+	 */
 	public function checkFieldExists($tab,$fieldName) {
 		$fields = $tab->Fields();
 		echo "TAB:{$tab->Name}\n";

Indentation +4 added lines, -4 removed lines

@@ -208,11 +208,11 @@
 	 */
 	public function invokeMethod(&$object, $methodName, array $parameters = array())
 	{
-	    $reflection = new \ReflectionClass(get_class($object));
-	    $method = $reflection->getMethod($methodName);
-	    $method->setAccessible(true);
+		$reflection = new \ReflectionClass(get_class($object));
+		$method = $reflection->getMethod($methodName);
+		$method->setAccessible(true);
 
-	    return $method->invokeArgs($object, $parameters);
+		return $method->invokeArgs($object, $parameters);
 	}
 
 

Spacing +31 added lines, -31 removed lines

@@ -9,8 +9,8 @@ 
 	public static $ignoreFixtureFileFor = array();
 
 	protected $extraDataObjects = array(
-		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
-		'SearchableTestFatherPage','SearchableTestGrandFatherPage','AutoCompleteOption'
+		'SearchableTestPage', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO', 'FlickrTagTO',
+		'SearchableTestFatherPage', 'SearchableTestGrandFatherPage', 'AutoCompleteOption'
 	);
 
 
@@ -39,7 +39,7 @@ 
 
 		// this needs to be called in order to create the list of searchable
 		// classes and fields that are available.  Simulates part of a build
-		$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
+		$classes = array('SearchableTestPage', 'SiteTree', 'Page', 'FlickrPhotoTO', 'FlickrSetTO',
 			'FlickrTagTO', 'FlickrAuthorTO');
 		$this->requireDefaultRecordsFrom = $classes;
 
@@ -49,7 +49,7 @@ 
 		$this->service->setTestMode(true);
 
 		// A previous test may have deleted the index and then failed, so check for this
-		if (!$this->service->getIndex()->exists()) {
+		if(!$this->service->getIndex()->exists()) {
 			$this->service->getIndex()->create();
 		}
 		$this->service->reset();
@@ -60,14 +60,14 @@ 
 
 		$orig_fixture_file = static::$fixture_file;
 
-		foreach (static::$ignoreFixtureFileFor as $testPattern) {
-			$pattern = '/'.$testPattern.'/';
-			if (preg_match($pattern, $this->getName())) {
+		foreach(static::$ignoreFixtureFileFor as $testPattern) {
+			$pattern = '/' . $testPattern . '/';
+			if(preg_match($pattern, $this->getName())) {
 				static::$fixture_file = null;
 			}
 		}
 
-		echo "\n\n\n\nEXECUTING TEST {$this->getName()}, FIXTURES=".static::$fixture_file."\n";
+		echo "\n\n\n\nEXECUTING TEST {$this->getName()}, FIXTURES=" . static::$fixture_file . "\n";
 
 		parent::setUp();
 		static::$fixture_file = $orig_fixture_file;
@@ -93,57 +93,57 @@ 
 
 
 	private function publishSiteTree() {
-		foreach (SiteTree::get()->getIterator() as $page) {
+		foreach(SiteTree::get()->getIterator() as $page) {
 			// temporarily disable Elasticsearch indexing, it will be done in a batch
 			$page->IndexingOff = true;
 
-			echo "Publishing ".$page->Title."\n";
-			$page->publish('Stage','Live');
+			echo "Publishing " . $page->Title . "\n";
+			$page->publish('Stage', 'Live');
 		}
 	}
 
 
 	public function generateAssertionsFromArray($toAssert) {
-		echo '$expected = array('."\n";
-		foreach ($toAssert as $key => $value) {
+		echo '$expected = array(' . "\n";
+		foreach($toAssert as $key => $value) {
 			$escValue = str_replace("'", '\\\'', $value);
 			echo "'$key' => '$escValue',\n";
 		}
 		echo ");\n";
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	public function generateAssertionsFromArray1D($toAssert) {
-		echo '$expected = array('."\n";
-		foreach ($toAssert as $key => $value) {
+		echo '$expected = array(' . "\n";
+		foreach($toAssert as $key => $value) {
 			$escValue = str_replace("'", '\\\'', $value);
 			echo "'$escValue',";
 		}
 		echo ");\n";
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	public function generateAssertionsFromArrayRecurse($toAssert) {
 		echo '$expected = ';
-			$this->recurseArrayAssertion($toAssert,1, 'FIXME');
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+			$this->recurseArrayAssertion($toAssert, 1, 'FIXME');
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
-		$prefix = str_repeat("\t",$depth);
+		$prefix = str_repeat("\t", $depth);
 		echo "\t{$prefix}'$parentKey' => array(\n";
 		$ctr = 0;
 		$len = sizeof(array_keys($toAssert));
-		foreach ($toAssert as $key => $value) {
-			if (is_array($value)) {
-				$this->recurseArrayAssertion($value, $depth+1, $key);
+		foreach($toAssert as $key => $value) {
+			if(is_array($value)) {
+				$this->recurseArrayAssertion($value, $depth + 1, $key);
 			} else {
 				$escValue = str_replace("'", '\\\'', $value);
 				$comma = ',';
-				if ($ctr == $len-1) {
+				if($ctr == $len - 1) {
 					$comma = '';
 				}
 				echo "\t\t$prefix'$key' => '$escValue'$comma\n";
@@ -173,7 +173,7 @@ 
 		$nameToCheck = end($splits);
 		echo "NAME TO CHECK:$nameToCheck\n";
 		$this->assertEquals($actualTabName, $nameToCheck);
-		if ($size == 1) {
+		if($size == 1) {
 			$this->assertEquals("Root_${tabName}", $tab->id());
 		} else {
 			$expected = "Root_{$splits[0]}_set_{$splits[1]}";
@@ -184,11 +184,11 @@ 
 	}
 
 
-	public function checkFieldExists($tab,$fieldName) {
+	public function checkFieldExists($tab, $fieldName) {
 		$fields = $tab->Fields();
 		echo "TAB:{$tab->Name}\n";
-		foreach ($fields as $fi) {
-			echo "NAME:".$fi->Name."\n";
+		foreach($fields as $fi) {
+			echo "NAME:" . $fi->Name . "\n";
 		}
 		$field = $tab->fieldByName($fieldName);
 		$this->assertTrue($field != null);
@@ -221,11 +221,11 @@ 
 		$status = $index->getStatus()->getData();
 
 		$numberDocsInIndex = -1; // flag value for not yet indexed
-		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
+		if(isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
 			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
 		}
 
-		$this->assertEquals($expectedAmount,$numberDocsInIndex);
+		$this->assertEquals($expectedAmount, $numberDocsInIndex);
 	}
 
 	/*
@@ -236,7 +236,7 @@ 
 		$status = $index->getStatus()->getData();
 
 		$numberDocsInIndex = -1; // flag value for not yet indexed
-		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
+		if(isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
 			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
 		}
 

tests/mock/Translatable.php

Doc Comments +2 added lines, -3 removed lines

@@ -282,7 +282,6 @@ 
 	 * to "auto-filter" all SELECT queries by this language.
 	 * See {@link disable_locale_filter()} on how to override this behaviour temporarily.
 	 *
-	 * @param string $lang New reading language.
 	 */
 	static function set_current_locale($locale) {
 		self::$current_locale = $locale;
@@ -373,7 +372,7 @@ 
 	 * Check if a given SQLQuery filters on the Locale field
 	 *
 	 * @param SQLQuery $query
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	protected function filtersOnLocale($query) {
 		foreach($query->getWhere() as $condition) {
@@ -536,7 +535,7 @@ 
 	 * This ID might equal the record ID, but doesn't have to -
 	 * it just points to one "original" record in the list.
 	 *
-	 * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
+	 * @return false|string Numeric ID of the translationgroup in the <classname>_translationgroup table
 	 */
 	public function getTranslationGroup() {
 		if(!$this->owner->exists()) return false;

Braces +45 added lines, -15 removed lines

@@ -377,7 +377,9 @@ 
 	 */
 	protected function filtersOnLocale($query) {
 		foreach($query->getWhere() as $condition) {
-			if(preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) return true;
+			if(preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) {
+				return true;
+			}
 		}
 	}
 
@@ -429,7 +431,9 @@ 
 	 // FIXME - NO TEST COVERAGE BUT REQUIRED
 	function augmentDatabase() {
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
-		if($this->owner->class != $baseDataClass) return;
+		if($this->owner->class != $baseDataClass) {
+			return;
+		}
 
 		$fields = array(
 			'OriginalID' => 'Int',
@@ -456,7 +460,9 @@ 
 	 */
 	public function requireDefaultRecords() {
 		// @todo This relies on the Locale attribute being on the base data class, and not any subclasses
-		if($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) return false;
+		if($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) {
+			return false;
+		}
 
 		// Permissions: If a group doesn't have any specific TRANSLATE_<locale> edit rights,
 		// but has CMS_ACCESS_CMSMain (general CMS access), then assign TRANSLATE_ALL permissions as a default.
@@ -468,14 +474,20 @@ 
 			'CMS_ACCESS_LeftAndMain',
 			'ADMIN'
 		));
-		if($groups) foreach($groups as $group) {
+		if($groups) {
+			foreach($groups as $group) {
 			$codes = $group->Permissions()->column('Code');
+		}
 			$hasTranslationCode = false;
 			foreach($codes as $code) {
-				if(preg_match('/^TRANSLATE_/', $code)) $hasTranslationCode = true;
+				if(preg_match('/^TRANSLATE_/', $code)) {
+					$hasTranslationCode = true;
+				}
 			}
 			// Only add the code if no more restrictive code exists
-			if(!$hasTranslationCode) Permission::grant($group->ID, 'TRANSLATE_ALL');
+			if(!$hasTranslationCode) {
+				Permission::grant($group->ID, 'TRANSLATE_ALL');
+			}
 		}
 
 		// If the Translatable extension was added after the first records were already
@@ -485,7 +497,9 @@ 
 			'SELECT "ID" FROM "%s" WHERE "Locale" IS NULL OR "Locale" = \'\'',
 			ClassInfo::baseDataClass($this->owner->class)
 		))->column();
-		if(!$idsWithoutLocale) return;
+		if(!$idsWithoutLocale) {
+			return;
+		}
 
 
 
@@ -502,7 +516,9 @@ 
 	 * @param boolean $overwrite
 	 */
 	public function addTranslationGroup($originalID, $overwrite = false) {
-		if(!$this->owner->exists()) return false;
+		if(!$this->owner->exists()) {
+			return false;
+		}
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		$existingGroupID = $this->getTranslationGroup($originalID);
@@ -539,7 +555,9 @@ 
 	 * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
 	 */
 	public function getTranslationGroup() {
-		if(!$this->owner->exists()) return false;
+		if(!$this->owner->exists()) {
+			return false;
+		}
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		return DB::query(
@@ -646,8 +664,10 @@ 
 				$this->owner->ClassName = $changedFields['ClassName']['before'];
 				$translations = $this->owner->getTranslations();
 				$this->owner->ClassName = $changedFields['ClassName']['after'];
-				if($translations) foreach($translations as $translation) {
+				if($translations) {
+					foreach($translations as $translation) {
 					$translation->setClassName($this->owner->ClassName);
+				}
 					$translation = $translation->newClassInstance($translation->ClassName);
 					$translation->populateDefaults();
 					$translation->forceChange();
@@ -745,7 +765,9 @@ 
 	 * @return DataObjectSet
 	 */
 	function getTranslations($locale = null, $stage = null) {
-		if(!$this->owner->exists()) return new ArrayList();
+		if(!$this->owner->exists()) {
+			return new ArrayList();
+		}
 
 		// HACK need to disable language filtering in augmentSQL(),
 		// as we purposely want to get different language
@@ -770,14 +792,18 @@ 
 		$currentStage = Versioned::current_stage();
 		$joinOnClause = sprintf('"%s_translationgroups"."OriginalID" = "%s"."ID"', $baseDataClass, $baseDataClass);
 		if($this->owner->hasExtension("Versioned")) {
-			if($stage) Versioned::reading_stage($stage);
+			if($stage) {
+				Versioned::reading_stage($stage);
+			}
 			$translations = Versioned::get_by_stage(
 				$baseDataClass,
 				Versioned::current_stage(),
 				$filter,
 				null
 			)->leftJoin("{$baseDataClass}_translationgroups", $joinOnClause);
-			if($stage) Versioned::reading_stage($currentStage);
+			if($stage) {
+				Versioned::reading_stage($currentStage);
+			}
 		} else {
 			$class = $this->owner->class;
 			$translations = $baseDataClass::get()
@@ -861,7 +887,9 @@ 
 		self::set_current_locale($originalLocale);
 
 		if($original) {
-			if($translation = $original->getTranslation($locale)) return trim($translation->RelativeLink(true), '/');
+			if($translation = $original->getTranslation($locale)) {
+				return trim($translation->RelativeLink(true), '/');
+			}
 		}
 	}
 
@@ -916,7 +944,9 @@ 
 		$existingPage = SiteTree::get()
 			// disable get_one cache, as this otherwise may pick up results from when locale_filter was on
 			->where("\"URLSegment\" = '{$this->owner->URLSegment}' $IDFilter $parentFilter")->First();
-		if($reEnableFilter) self::enable_locale_filter();
+		if($reEnableFilter) {
+			self::enable_locale_filter();
+		}
 
 		// By returning TRUE or FALSE, we overrule the base SiteTree->validateURLSegment() logic
 		return !$existingPage;

Indentation +152 added lines, -152 removed lines

@@ -1,156 +1,156 @@ 
 <?php
 /**
- * The Translatable decorator allows your DataObjects to have versions in different languages,
- * defining which fields are can be translated. Translatable can be applied
- * to any {@link DataObject} subclass, but is mostly used with {@link SiteTree}.
- * Translatable is compatible with the {@link Versioned} extension.
- * To avoid cluttering up the database-schema of the 99% of sites without multiple languages,
- * the translation-feature is disabled by default.
- *
- * Locales (e.g. 'en_US') are used in Translatable for identifying a record by language,
- * see section "Locales and Language Tags".
- *
- * <h2>Configuration</h2>
- *
- * The extension is automatically enabled for SiteTree and SiteConfig records,
- * if they can be found. Add the following to your config.yml in order to
- * register a custom class:
- *
- * <code>
- * MyClass:
- *   extensions:
- *     Translatable
- * </code>
- *
- * Make sure to rebuild the database through /dev/build after enabling translatable.
- * Use the correct {@link set_default_locale()} before building the database
- * for the first time, as this locale will be written on all new records.
- *
- * <h3>"Default" locales</h3>
- *
- * Important: If the "default language" of your site is not US-English (en_US),
- * please ensure to set the appropriate default language for
- * your content before building the database with Translatable enabled:
- * <code>
- * Translatable::set_default_locale(<locale>); // e.g. 'de_DE' or 'fr_FR'
- * </code>
- *
- * For the Translatable class, a "locale" consists of a language code plus a region
- * code separated by an underscore,
- * for example "de_AT" for German language ("de") in the region Austria ("AT").
- * See http://www.w3.org/International/articles/language-tags/ for a detailed description.
- *
- * <h2>Usage</h2>
- *
- * Getting a translation for an existing instance:
- * <code>
- * $translatedObj = Translatable::get_one_by_locale('MyObject', 'de_DE');
- * </code>
- *
- * Getting a translation for an existing instance:
- * <code>
- * $obj = DataObject::get_by_id('MyObject', 99); // original language
- * $translatedObj = $obj->getTranslation('de_DE');
- * </code>
- *
- * Getting translations through {@link Translatable::set_current_locale()}.
- * This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
- * <code>
- * $origLocale = Translatable::get_current_locale();
- * Translatable::set_current_locale('de_DE');
- * $obj = Versioned::get_one_by_stage('MyObject', "ID = 99");
- * Translatable::set_current_locale($origLocale);
- * </code>
- *
- * Creating a translation:
- * <code>
- * $obj = new MyObject();
- * $translatedObj = $obj->createTranslation('de_DE');
- * </code>
- *
- * <h2>Usage for SiteTree</h2>
- *
- * Translatable can be used for subclasses of {@link SiteTree},
- * it is automatically configured if this class is foun.
- *
- * If a child page translation is requested without the parent
- * page already having a translation in this language, the extension
- * will recursively create translations up the tree.
- * Caution: The "URLSegment" property is enforced to be unique across
- * languages by auto-appending the language code at the end.
- * You'll need to ensure that the appropriate "reading language" is set
- * before showing links to other pages on a website through $_GET['locale'].
- * Pages in different languages can have different publication states
- * through the {@link Versioned} extension.
- *
- * Note: You can't get Children() for a parent page in a different language
- * through set_current_locale(). Get the translated parent first.
- *
- * <code>
- * // wrong
- * Translatable::set_current_locale('de_DE');
- * $englishParent->Children();
- * // right
- * $germanParent = $englishParent->getTranslation('de_DE');
- * $germanParent->Children();
- * </code>
- *
- * <h2>Translation groups</h2>
- *
- * Each translation can have one or more related pages in other languages.
- * This relation is optional, meaning you can
- * create translations which have no representation in the "default language".
- * This means you can have a french translation with a german original,
- * without either of them having a representation
- * in the default english language tree.
- * Caution: There is no versioning for translation groups,
- * meaning associating an object with a group will affect both stage and live records.
- *
- * SiteTree database table (abbreviated)
- * ^ ID ^ URLSegment ^ Title ^ Locale ^
- * | 1 | about-us | About us | en_US |
- * | 2 | ueber-uns | Über uns | de_DE |
- * | 3 | contact | Contact | en_US |
- *
- * SiteTree_translationgroups database table
- * ^ TranslationGroupID ^ OriginalID ^
- * | 99 | 1 |
- * | 99 | 2 |
- * | 199 | 3 |
- *
- * <h2>Character Sets</h2>
- *
- * Caution: Does not apply any character-set conversion, it is assumed that all content
- * is stored and represented in UTF-8 (Unicode). Please make sure your database and
- * HTML-templates adjust to this.
- *
- * <h2>Permissions</h2>
- *
- * Authors without administrative access need special permissions to edit locales other than
- * the default locale.
- *
- * - TRANSLATE_ALL: Translate into all locales
- * - Translate_<locale>: Translate a specific locale. Only available for all locales set in
- *   `Translatable::set_allowed_locales()`.
- *
- * Note: If user-specific view permissions are required, please overload `SiteTree->canView()`.
- *
- * <h2>Uninstalling/Disabling</h2>
- *
- * Disabling Translatable after creating translations will lead to all
- * pages being shown in the default sitetree regardless of their language.
- * It is advised to start with a new database after uninstalling Translatable,
- * or manually filter out translated objects through their "Locale" property
- * in the database.
- *
- * @see http://doc.silverstripe.org/doku.php?id=multilingualcontent
- *
- * @author Ingo Schommer <ingo (at) silverstripe (dot) com>
- * @author Michael Gall <michael (at) wakeless (dot) net>
- * @author Bernat Foj Capell <bernat@silverstripe.com>
- *
- * @package translatable
- */
+	 * The Translatable decorator allows your DataObjects to have versions in different languages,
+	 * defining which fields are can be translated. Translatable can be applied
+	 * to any {@link DataObject} subclass, but is mostly used with {@link SiteTree}.
+	 * Translatable is compatible with the {@link Versioned} extension.
+	 * To avoid cluttering up the database-schema of the 99% of sites without multiple languages,
+	 * the translation-feature is disabled by default.
+	 *
+	 * Locales (e.g. 'en_US') are used in Translatable for identifying a record by language,
+	 * see section "Locales and Language Tags".
+	 *
+	 * <h2>Configuration</h2>
+	 *
+	 * The extension is automatically enabled for SiteTree and SiteConfig records,
+	 * if they can be found. Add the following to your config.yml in order to
+	 * register a custom class:
+	 *
+	 * <code>
+	 * MyClass:
+	 *   extensions:
+	 *     Translatable
+	 * </code>
+	 *
+	 * Make sure to rebuild the database through /dev/build after enabling translatable.
+	 * Use the correct {@link set_default_locale()} before building the database
+	 * for the first time, as this locale will be written on all new records.
+	 *
+	 * <h3>"Default" locales</h3>
+	 *
+	 * Important: If the "default language" of your site is not US-English (en_US),
+	 * please ensure to set the appropriate default language for
+	 * your content before building the database with Translatable enabled:
+	 * <code>
+	 * Translatable::set_default_locale(<locale>); // e.g. 'de_DE' or 'fr_FR'
+	 * </code>
+	 *
+	 * For the Translatable class, a "locale" consists of a language code plus a region
+	 * code separated by an underscore,
+	 * for example "de_AT" for German language ("de") in the region Austria ("AT").
+	 * See http://www.w3.org/International/articles/language-tags/ for a detailed description.
+	 *
+	 * <h2>Usage</h2>
+	 *
+	 * Getting a translation for an existing instance:
+	 * <code>
+	 * $translatedObj = Translatable::get_one_by_locale('MyObject', 'de_DE');
+	 * </code>
+	 *
+	 * Getting a translation for an existing instance:
+	 * <code>
+	 * $obj = DataObject::get_by_id('MyObject', 99); // original language
+	 * $translatedObj = $obj->getTranslation('de_DE');
+	 * </code>
+	 *
+	 * Getting translations through {@link Translatable::set_current_locale()}.
+	 * This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
+	 * <code>
+	 * $origLocale = Translatable::get_current_locale();
+	 * Translatable::set_current_locale('de_DE');
+	 * $obj = Versioned::get_one_by_stage('MyObject', "ID = 99");
+	 * Translatable::set_current_locale($origLocale);
+	 * </code>
+	 *
+	 * Creating a translation:
+	 * <code>
+	 * $obj = new MyObject();
+	 * $translatedObj = $obj->createTranslation('de_DE');
+	 * </code>
+	 *
+	 * <h2>Usage for SiteTree</h2>
+	 *
+	 * Translatable can be used for subclasses of {@link SiteTree},
+	 * it is automatically configured if this class is foun.
+	 *
+	 * If a child page translation is requested without the parent
+	 * page already having a translation in this language, the extension
+	 * will recursively create translations up the tree.
+	 * Caution: The "URLSegment" property is enforced to be unique across
+	 * languages by auto-appending the language code at the end.
+	 * You'll need to ensure that the appropriate "reading language" is set
+	 * before showing links to other pages on a website through $_GET['locale'].
+	 * Pages in different languages can have different publication states
+	 * through the {@link Versioned} extension.
+	 *
+	 * Note: You can't get Children() for a parent page in a different language
+	 * through set_current_locale(). Get the translated parent first.
+	 *
+	 * <code>
+	 * // wrong
+	 * Translatable::set_current_locale('de_DE');
+	 * $englishParent->Children();
+	 * // right
+	 * $germanParent = $englishParent->getTranslation('de_DE');
+	 * $germanParent->Children();
+	 * </code>
+	 *
+	 * <h2>Translation groups</h2>
+	 *
+	 * Each translation can have one or more related pages in other languages.
+	 * This relation is optional, meaning you can
+	 * create translations which have no representation in the "default language".
+	 * This means you can have a french translation with a german original,
+	 * without either of them having a representation
+	 * in the default english language tree.
+	 * Caution: There is no versioning for translation groups,
+	 * meaning associating an object with a group will affect both stage and live records.
+	 *
+	 * SiteTree database table (abbreviated)
+	 * ^ ID ^ URLSegment ^ Title ^ Locale ^
+	 * | 1 | about-us | About us | en_US |
+	 * | 2 | ueber-uns | Über uns | de_DE |
+	 * | 3 | contact | Contact | en_US |
+	 *
+	 * SiteTree_translationgroups database table
+	 * ^ TranslationGroupID ^ OriginalID ^
+	 * | 99 | 1 |
+	 * | 99 | 2 |
+	 * | 199 | 3 |
+	 *
+	 * <h2>Character Sets</h2>
+	 *
+	 * Caution: Does not apply any character-set conversion, it is assumed that all content
+	 * is stored and represented in UTF-8 (Unicode). Please make sure your database and
+	 * HTML-templates adjust to this.
+	 *
+	 * <h2>Permissions</h2>
+	 *
+	 * Authors without administrative access need special permissions to edit locales other than
+	 * the default locale.
+	 *
+	 * - TRANSLATE_ALL: Translate into all locales
+	 * - Translate_<locale>: Translate a specific locale. Only available for all locales set in
+	 *   `Translatable::set_allowed_locales()`.
+	 *
+	 * Note: If user-specific view permissions are required, please overload `SiteTree->canView()`.
+	 *
+	 * <h2>Uninstalling/Disabling</h2>
+	 *
+	 * Disabling Translatable after creating translations will lead to all
+	 * pages being shown in the default sitetree regardless of their language.
+	 * It is advised to start with a new database after uninstalling Translatable,
+	 * or manually filter out translated objects through their "Locale" property
+	 * in the database.
+	 *
+	 * @see http://doc.silverstripe.org/doku.php?id=multilingualcontent
+	 *
+	 * @author Ingo Schommer <ingo (at) silverstripe (dot) com>
+	 * @author Michael Gall <michael (at) wakeless (dot) net>
+	 * @author Bernat Foj Capell <bernat@silverstripe.com>
+	 *
+	 * @package translatable
+	 */
 class Translatable extends DataExtension implements TestOnly {
 
 	const QUERY_LOCALE_FILTER_ENABLED = 'Translatable.LocaleFilterEnabled';
@@ -892,7 +892,7 @@ 
 	 * to Translatable
 	 *
 	 * @return bool
-     */
+	 */
 	public function augmentValidURLSegment() {
 		$reEnableFilter = false;
 		if(!Config::inst()->get('Translatable', 'enforce_global_unique_urls')) {

Spacing +17 added lines, -17 removed lines

@@ -304,7 +304,7 @@ 
 	 * @param $enabled (default true), if false this call is a no-op - see {@link disable_locale_filter()}
 	 */
 	public static function enable_locale_filter($enabled = true) {
-		if ($enabled) {
+		if($enabled) {
 			self::$locale_filter_enabled = true;
 		}
 	}
@@ -350,8 +350,8 @@ 
 				array_keys($this->owner->has_many()),
 				array_keys($this->owner->many_many())
 			);
-			foreach (array_keys($this->owner->has_one()) as $fieldname) {
-				$this->translatableFields[] = $fieldname.'ID';
+			foreach(array_keys($this->owner->has_one()) as $fieldname) {
+				$this->translatableFields[] = $fieldname . 'ID';
 			}
 		}
 	}
@@ -389,7 +389,7 @@ 
 	 *
 	 * Use {@link disable_locale_filter()} to temporarily disable this "auto-filtering".
 	 */
-	public function augmentSQL(SQLQuery &$query, DataQuery $dataQuery = null) {
+	public function augmentSQL(SQLQuery & $query, DataQuery $dataQuery = null) {
 		// If the record is saved (and not a singleton), and has a locale,
 		// limit the current call to its locale. This fixes a lot of problems
 		// with other extensions like Versioned
@@ -415,13 +415,13 @@ 
 			// call or through custom SQL filters)
 			&& !$this->filtersOnLocale($query)
 			//&& !$query->filtersOnFK()
-		)  {
+		) {
 			$qry = sprintf('"%s"."Locale" = \'%s\'', $baseTable, Convert::raw2sql($locale));
 			$query->addWhere($qry);
 		}
 	}
 
-	function augmentDataQueryCreation(SQLQuery &$sqlQuery, DataQuery &$dataQuery) {
+	function augmentDataQueryCreation(SQLQuery & $sqlQuery, DataQuery & $dataQuery) {
 		$enabled = self::locale_filter_enabled();
 		$dataQuery->setQueryParam(self::QUERY_LOCALE_FILTER_ENABLED, $enabled);
 	}
@@ -618,7 +618,7 @@ 
 			$changedFields = $this->owner->getChangedFields();
 			$changed = isset($changedFields['ClassName']);
 
-			if ($changed && $this->owner->hasExtension('Versioned')) {
+			if($changed && $this->owner->hasExtension('Versioned')) {
 				// this is required because when publishing a node the before/after
 				// values of $changedFields['ClassName'] will be the same because
 				// the record was already written to the stage/draft table and thus
@@ -637,7 +637,7 @@ 
 					'"ID" = ' . $this->owner->ID,
 					null
 				);
-				if ($fresh) {
+				if($fresh) {
 					$changed = $changedFields['ClassName']['after'] != $fresh->ClassName;
 				}
 			}
@@ -694,7 +694,7 @@ 
 		// If the parentID value has come from a translated page,
 		// then we need to find the corresponding parentID value
 		// in the default Locale.
-		if (
+		if(
 			is_int($parentID)
 			&& $parentID > 0
 			&& ($parent = DataObject::get_by_id('SiteTree', $parentID))
@@ -705,7 +705,7 @@ 
 
 		// Find the locale language-independent of the page
 		self::disable_locale_filter();
-		$default = SiteTree::get()->where(sprintf (
+		$default = SiteTree::get()->where(sprintf(
 			'"URLSegment" = \'%s\'%s',
 			Convert::raw2sql($URLSegment),
 			(is_int($parentID) ? " AND \"ParentID\" = $parentID" : null)
@@ -721,7 +721,7 @@ 
 	public function updateRelativeLink(&$base, &$action) {
 		// Prevent home pages for non-default locales having their urlsegments
 		// reduced to the site root.
-		if($base === null && $this->owner->Locale != self::default_locale()){
+		if($base === null && $this->owner->Locale != self::default_locale()) {
 			$base = $this->owner->URLSegment;
 		}
 	}
@@ -827,7 +827,7 @@ 
 	 */
 	static function get_existing_content_languages($className = 'SiteTree', $where = '') {
 		$baseTable = ClassInfo::baseDataClass($className);
-		$query = new SQLQuery("Distinct \"Locale\"","\"$baseTable\"",$where, '', "\"Locale\"");
+		$query = new SQLQuery("Distinct \"Locale\"", "\"$baseTable\"", $where, '', "\"Locale\"");
 		$dbLangs = $query->execute()->column();
 		$langlist = array_merge((array)Translatable::default_locale(), (array)$dbLangs);
 		$returnMap = array();
@@ -835,7 +835,7 @@ 
 			Config::inst()->get('i18n', 'all_locales'),
 			Config::inst()->get('i18n', 'common_locales')
 		);
-		foreach ($langlist as $langCode) {
+		foreach($langlist as $langCode) {
 			if($langCode && isset($allCodes[$langCode])) {
 				if(is_array($allCodes[$langCode])) {
 					$returnMap[$langCode] = $allCodes[$langCode]['name'];
@@ -870,7 +870,7 @@ 
 	 * @deprecated 2.4 Use {@link Translatable::get_homepage_link_by_locale()}
 	 */
 	static function get_homepage_urlsegment_by_locale($locale) {
-		user_error (
+		user_error(
 			'Translatable::get_homepage_urlsegment_by_locale() is deprecated, please use get_homepage_link_by_locale()',
 			E_USER_NOTICE
 		);
@@ -884,7 +884,7 @@ 
 	 * Return a piece of text to keep DataObject cache keys appropriately specific
 	 */
 	function cacheKeyComponent() {
-		return 'locale-'.self::get_current_locale();
+		return 'locale-' . self::get_current_locale();
 	}
 
 	/**
@@ -902,10 +902,10 @@ 
 			$reEnableFilter = true;
 		}
 
-		$IDFilter = ($this->owner->ID) ? "AND \"SiteTree\".\"ID\" <> {$this->owner->ID}" :  null;
+		$IDFilter = ($this->owner->ID) ? "AND \"SiteTree\".\"ID\" <> {$this->owner->ID}" : null;
 		$parentFilter = null;
 
-		if (Config::inst()->get('SiteTree', 'nested_urls')) {
+		if(Config::inst()->get('SiteTree', 'nested_urls')) {
 			if($this->owner->ParentID) {
 				$parentFilter = " AND \"SiteTree\".\"ParentID\" = {$this->owner->ParentID}";
 			} else {

tests/SearchAndIndexingTest.php

Doc Comments +3 added lines

@@ -479,6 +479,9 @@
 	}
 
 
+	/**
+	 * @param string $query
+	 */
 	private function getResultsFor($query, $pageLength = 10, $fields = array('Title' => 1, 'Description' => 1)) {
 		$es = new ElasticSearcher();
 		$es->setStart(0);

Indentation +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 
 	public function testEach() {
 		$callback = function($fp) {
-		    $this->assertTrue(true, 'Callback reached');
+			$this->assertTrue(true, 'Callback reached');
 		};
 		$resultList = $this->getResultsFor('New Zealand',10);
 		$resultList->each($callback);