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 +33 added lines, -33 removed lines

@@ -34,9 +34,9 @@ 
 		$this->aggregationByName($aggregations);
 
 		error_log('AGGS');
-		foreach ($aggregations as $agg) {
+		foreach($aggregations as $agg) {
 			error_log($agg->Name);
-			foreach ($agg->Buckets as $bucket) {
+			foreach($agg->Buckets as $bucket) {
 				error_log("\t$bucket->Key -> $bucket->DocumentCount");
 			}
 		}
@@ -432,7 +432,7 @@ 
 		$resultList = $this->search('');
 
 		//assert there are actually some results
-		$this->assertGreaterThan(0,$resultList->getTotalItems());
+		$this->assertGreaterThan(0, $resultList->getTotalItems());
 		$aggregations = $resultList->getAggregations()->toArray();
 		$this->aggregationByName($aggregations);
 
@@ -452,49 +452,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);
 
@@ -507,43 +507,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);
 
@@ -830,7 +830,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);
@@ -842,8 +842,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);
@@ -858,8 +858,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);
@@ -899,7 +899,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();
@@ -908,17 +908,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]
 				);
@@ -954,8 +954,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();
@@ -974,7 +974,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);
@@ -983,9 +983,9 @@ 
 		$es->setQueryResultManipulator('FlickrPhotoTOElasticaSearchHelper');
 
 		//Add filters
-		foreach ($filters as $key => $value) {
+		foreach($filters as $key => $value) {
 			error_log("ADDING FILTER RESULT $key, $value");
-			$es->addFilter($key,$value);
+			$es->addFilter($key, $value);
 		}
 
 		$es->showResultsForEmptySearch();
@@ -1003,7 +1003,7 @@ 
 	 */
 	private function aggregationByName(&$aggregations) {
 		$ctr = 0;
-		foreach ($aggregations as $agg) {
+		foreach($aggregations as $agg) {
 			$aggregations[$agg->Name] = $agg;
 			unset($aggregations[$ctr]);
 			$ctr++;

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 +17 added lines, -17 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'
 	);
 
 
@@ -24,7 +24,7 @@ 
 
 	public function setUp() {
 
-		echo "*************** TEST: ".$this->getName();
+		echo "*************** TEST: " . $this->getName();
 
 		$cache = SS_Cache::factory('elasticsearch');
 		$cache->clean(Zend_Cache::CLEANING_MODE_ALL);
@@ -32,7 +32,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;
 
@@ -48,7 +48,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,9 +59,9 @@ 
 
 		$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;
 			}
 		}
@@ -83,11 +83,11 @@ 
 
 
 	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;
 
-			$page->publish('Stage','Live');
+			$page->publish('Stage', 'Live');
 		}
 	}
 
@@ -108,7 +108,7 @@ 
 		$items = $this->cssParser()->getBySelector($selector);
 
 		$ctr = 0;
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$text = strip_tags($item);
 			$escaped = str_replace("'", "\'", $text);
 			$ctr++;
@@ -130,7 +130,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']);
 		}
 	}
@@ -139,9 +139,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);
@@ -151,7 +151,7 @@ 
 
 	public function assertNumberOfNodes($selector, $expectedAmount) {
 		$items = $this->cssParser()->getBySelector($selector);
-		foreach ($items as $item) {
+		foreach($items as $item) {
 			$text = strip_tags($item);
 		}
 
@@ -164,9 +164,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 +2 added lines, -2 removed lines

@@ -131,8 +131,8 @@
 		$errors = Session::get("FormInfo.{$form->FormName()}.errors");
 		$found = false;
 
-		foreach ($errors as $error) {
-			if ($error['message'] == $message && $error['fieldName'] == $fieldName) {
+		foreach($errors as $error) {
+			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 +27 added lines, -27 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,9 +60,9 @@ 
 
 		$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;
 			}
 		}
@@ -91,55 +91,55 @@ 
 
 
 	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;
-			$page->publish('Stage','Live');
+			$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";
@@ -163,7 +163,7 @@ 
 		$size = sizeof($splits);
 		$nameToCheck = end($splits);
 		$this->assertEquals($actualTabName, $nameToCheck);
-		if ($size == 1) {
+		if($size == 1) {
 			$this->assertEquals("Root_${tabName}", $tab->id());
 		} else {
 			$expected = "Root_{$splits[0]}_set_{$splits[1]}";
@@ -174,7 +174,7 @@ 
 	}
 
 
-	public function checkFieldExists($tab,$fieldName) {
+	public function checkFieldExists($tab, $fieldName) {
 		$fields = $tab->Fields();
 		$field = $tab->fieldByName($fieldName);
 		$this->assertTrue($field != null);
@@ -207,11 +207,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);
 	}
 
 	/*
@@ -222,7 +222,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/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);

Spacing +2 added lines, -2 removed lines

@@ -319,10 +319,10 @@
 
 		foreach($toarr as $item) {
 			$hl = $item->SearchHighlights;
-			foreach ($hl as $shl) {
+			foreach($hl as $shl) {
 				$html = $shl->Snippet;
 				$splits = explode('<strong class="hl">', $html);
-				if (sizeof($splits) > 1) {
+				if(sizeof($splits) > 1) {
 					$splits = explode('</strong>', $splits[1]);
 					$term = $splits[0];
 					$term = strtolower($term);

tests/TranslatableUnitTest.php

Doc Comments +3 added lines

@@ -233,6 +233,9 @@
 
 
 
+	/**
+	 * @param PaginatedList $paginated
+	 */
 	private function makeCode($paginated) {
 		$results = $paginated->getList()->toArray();
 		$ctr = 0;

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 		$es->setLocale($locale);
 		$es->setClasses('FlickrPhotoTO');
 
-		$fields = array('Description.standard' => 1,'Title.standard' => 1);
+		$fields = array('Description.standard' => 1, 'Title.standard' => 1);
 		$results = $es->moreLikeThis($fp, $fields, true);
 
 		$terms = $results->getList()->MoreLikeThisTerms;