gordonbanderson / silverstripe-elastica

code/ElasticaUtil.php

Doc Comments +2 added lines, -1 removed lines

@@ -196,7 +196,7 @@ 
 	}
 
 	/**
-	 * @return function print content to either web browser or command line.  Can be optionally supressed
+	 * @return \Closure print content to either web browser or command line.  Can be optionally supressed
 	 */
 	public static function getPrinter() {
 		return function ($content) {
@@ -211,6 +211,7 @@ 
 	 * Set to true to show output on the command line or browser, false to not
 	 *
 	 * @param   $newcli_printer_output true to show output, false to hide it
+	 * @param boolean $new_cli_printer_output
 	 */
 	public static function setPrinterOutput($new_cli_printer_output) {
 		self::$cli_printer_output = $new_cli_printer_output;

Spacing +22 added lines, -22 removed lines

@@ -28,7 +28,7 @@ 
 	 * @var string $content Text to display when in command line mode
 	 */
 	public static function message($content) {
-		if (\Director::is_cli() && self::$cli_printer_output == true) {
+		if(\Director::is_cli() && self::$cli_printer_output == true) {
 			echo "$content\n";
 		}
 	}
@@ -53,7 +53,7 @@ 
 		$options = $alternativeQuerySuggestions[0]['options'];
 
 		$resultArray = null;
-		if (sizeof($options) > 0) {
+		if(sizeof($options) > 0) {
 			//take the first suggestion
 			$suggestedPhrase = $options[0]['text'];
 			$suggestedPhraseHighlighted = $options[0]['highlighted'];
@@ -62,10 +62,10 @@ 
 			$originalParts = explode(' ', $originalQuery);
 			$suggestedParts = explode(' ', $suggestedPhrase);
 
-			$markedHighlightedParts = ' '.$suggestedPhraseHighlighted.' ';
-			$markedHighlightedParts = str_replace(' '.$preTags, ' '.self::$pre_marker, $markedHighlightedParts);
+			$markedHighlightedParts = ' ' . $suggestedPhraseHighlighted . ' ';
+			$markedHighlightedParts = str_replace(' ' . $preTags, ' ' . self::$pre_marker, $markedHighlightedParts);
 
-			$markedHighlightedParts = str_replace($postTags.' ', self::$post_marker, $markedHighlightedParts);
+			$markedHighlightedParts = str_replace($postTags . ' ', self::$post_marker, $markedHighlightedParts);
 
 			$markedHighlightedParts = trim($markedHighlightedParts);
 			$markedHighlightedParts = trim($markedHighlightedParts);
@@ -76,7 +76,7 @@ 
 			$lowerToUpper = array();
 			$lowerToHighlighted = array();
 			$ctr = 0;
-			foreach ($suggestedParts as $lowercaseWord) {
+			foreach($suggestedParts as $lowercaseWord) {
 				$lowerToUpper[$lowercaseWord] = $originalParts[$ctr];
 				$lowerToHighlighted[$lowercaseWord] = $highlightedParts[$ctr];
 				$ctr++;
@@ -84,19 +84,19 @@ 
 
 			$plain = array();
 			$highlighted = array();
-			foreach ($suggestedParts as $lowercaseWord) {
+			foreach($suggestedParts as $lowercaseWord) {
 				$possiblyUppercase = $lowerToUpper[$lowercaseWord];
 				$possiblyUppercaseHighlighted = $lowerToHighlighted[$lowercaseWord];
 
 				//If the terms are identical other than case, e.g. new => New, then simply swap
-				if (strtolower($possiblyUppercase) == $lowercaseWord) {
+				if(strtolower($possiblyUppercase) == $lowercaseWord) {
 					array_push($plain, $possiblyUppercase);
 					array_push($highlighted, $possiblyUppercase);
 				} else {
 					//Need to check capitalisation of terms suggested that are different
 
-					$chr = mb_substr ($possiblyUppercase, 0, 1, "UTF-8");
-    				if (mb_strtolower($chr, "UTF-8") != $chr) {
+					$chr = mb_substr($possiblyUppercase, 0, 1, "UTF-8");
+    				if(mb_strtolower($chr, "UTF-8") != $chr) {
     					$upperLowercaseWord = $lowercaseWord;
     					$upperLowercaseWord[0] = $chr;
 
@@ -119,9 +119,9 @@ 
 				}
 			}
 
-			$highlighted = ' '.implode(' ', $highlighted).' ';
-			$highlighted = str_replace(self::$pre_marker, ' '.$preTags, $highlighted);
-			$highlighted = str_replace(self::$post_marker, $postTags.' ', $highlighted);
+			$highlighted = ' ' . implode(' ', $highlighted) . ' ';
+			$highlighted = str_replace(self::$pre_marker, ' ' . $preTags, $highlighted);
+			$highlighted = str_replace(self::$post_marker, $postTags . ' ', $highlighted);
 
 			$resultArray['suggestedQuery'] = implode(' ', $plain);
 			$resultArray['suggestedQueryHighlighted'] = trim($highlighted);
@@ -150,10 +150,10 @@ 
 
         $bracketPos = strpos($explanation, ')~');
 
-        if (substr($explanation, 0,2) == '((') {
-        	$explanation = substr($explanation, 2, $bracketPos-2);
-        } elseif (substr($explanation, 0,1) == '(') {
-        	$explanation = substr($explanation, 1, $bracketPos-2);
+        if(substr($explanation, 0, 2) == '((') {
+        	$explanation = substr($explanation, 2, $bracketPos - 2);
+        } elseif(substr($explanation, 0, 1) == '(') {
+        	$explanation = substr($explanation, 1, $bracketPos - 2);
         }
 
        	$terms = array();
@@ -161,18 +161,18 @@ 
         //Field name(s) => terms
         $splits = explode(' ', $explanation);
 
-        foreach ($splits as $fieldAndTerm) {
+        foreach($splits as $fieldAndTerm) {
         	$splits = explode(':', $fieldAndTerm);
 
         	// This is the no terms case
-        	if (sizeof($splits) < 2) {
+        	if(sizeof($splits) < 2) {
         		break;
         	}
 
         	$fieldname = $splits[0];
         	$term = $splits[1];
 
-        	if (!isset($terms[$fieldname])) {
+        	if(!isset($terms[$fieldname])) {
         		$terms[$fieldname] = array();
         	}
 
@@ -199,8 +199,8 @@ 
 	 * @return function print content to either web browser or command line.  Can be optionally supressed
 	 */
 	public static function getPrinter() {
-		return function ($content) {
-			if (self::$cli_printer_output == true) {
+		return function($content) {
+			if(self::$cli_printer_output == true) {
 				print(\Director::is_cli() ? "T1 $content\n" : "T2 <p>$content</p>");
 			}
 

tests/AggregationUnitTest.php

Spacing +32 added lines, -32 removed lines

@@ -35,9 +35,9 @@ 
 		sort($aggregations);
 
 		error_log('AGGS');
-		foreach ($aggregations as $agg) {
+		foreach($aggregations as $agg) {
 			error_log($agg->Name);
-			foreach ($agg->Buckets() as $value => $count) {
+			foreach($agg->Buckets() as $value => $count) {
 				error_log("\t$value -> $count");
 			}
 		}
@@ -431,7 +431,7 @@ 
 		$resultList = $this->search('');
 
 		//assert there are actually some results
-		$this->assertGreaterThan(0,$resultList->getTotalItems());
+		$this->assertGreaterThan(0, $resultList->getTotalItems());
 		$aggregations = $resultList->getAggregations()->toArray();
 
 		/*
@@ -450,49 +450,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);
 
@@ -505,43 +505,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);
 
@@ -829,7 +829,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);
@@ -841,8 +841,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);
@@ -857,8 +857,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);
@@ -898,7 +898,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();
@@ -907,17 +907,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]
 				);
@@ -953,8 +953,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();
@@ -973,7 +973,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);
@@ -982,8 +982,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();

src/SilverStripe/Elastica/ReindexTask.php

Spacing +7 added lines, -7 removed lines

@@ -31,7 +31,7 @@ 
 
 		$locales = array();
 		if(class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
-			foreach (\Translatable::get_existing_content_languages('SiteTree') as $code => $val) {
+			foreach(\Translatable::get_existing_content_languages('SiteTree') as $code => $val) {
 				array_push($locales, $code);
 			}
 		} else {
@@ -39,11 +39,11 @@ 
 		}
 
 		// now iterate all the locales indexing each locale in turn using it's owner index settings
-		foreach ($locales as $locale) {
+		foreach($locales as $locale) {
 			Searchable::$index_ctr = 0;
-			$message('Indexing locale '.$locale);
+			$message('Indexing locale ' . $locale);
 
-			if (class_exists('Translatable')) {
+			if(class_exists('Translatable')) {
 				\Translatable::set_current_locale($locale);
 			}
 
@@ -60,10 +60,10 @@ 
 			$this->service->refresh();
 			// display indexing speed stats
 			$endTime = microtime(true);
-			$elapsed = $endTime-$startTime;
+			$elapsed = $endTime - $startTime;
 			$perSecond = Searchable::$index_ctr / $elapsed;
-			$info = "\nReindexing $locale completed \n ".Searchable::$index_ctr." docs in ".round($elapsed,2)." seconds ";
-			$info .= "at ".round($perSecond,2)." documents per second\n\n";
+			$info = "\nReindexing $locale completed \n " . Searchable::$index_ctr . " docs in " . round($elapsed, 2) . " seconds ";
+			$info .= "at " . round($perSecond, 2) . " documents per second\n\n";
 			$message($info);
 		}
 

src/SilverStripe/Elastica/SearchIndexTask.php

Spacing +8 added lines, -8 removed lines

@@ -25,11 +25,11 @@ 
 
 		$locales = array();
 
-		if ($this->locale == null) {
-			if (class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
+		if($this->locale == null) {
+			if(class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
 				$this->locale = \Translatable::get_current_locale();
 			} else {
-				foreach (\Translatable::get_existing_content_languages('SiteTree') as $code => $val) {
+				foreach(\Translatable::get_existing_content_languages('SiteTree') as $code => $val) {
 					array_push($locales, $code);
 				}
 			}
@@ -42,13 +42,13 @@ 
 		$es->setPageLength(20);
 		$es->addFilter('IsInSiteTree', true);
 		$results = $es->search($query);
-		foreach ($results as $result) {
-			$title = '['.$result->ClassName.', '.$result->ID.']  ';
+		foreach($results as $result) {
+			$title = '[' . $result->ClassName . ', ' . $result->ID . ']  ';
 			$title .= $result->Title;
 			$message($title);
-			if ($result->SearchHighlightsByField->Content) {
-				foreach ($result->SearchHighlightsByField->Content as $highlight) {
-					$message("- ".$highlight->Snippet);
+			if($result->SearchHighlightsByField->Content) {
+				foreach($result->SearchHighlightsByField->Content as $highlight) {
+					$message("- " . $highlight->Snippet);
 				}
 			}