gordonbanderson / silverstripe-elastica

src/SilverStripe/Elastica/ElasticaSearcher.php

Doc Comments +14 added lines, -3 removed lines

@@ -230,6 +230,10 @@ 
 	/*
 	Set the highlight fields for subsequent searches
 	 */
+
+	/**
+	 * @param string[] $newHighlightedFields
+	 */
 	public function setHighlightedFields($newHighlightedFields) {
 		$this->highlightedFields = $newHighlightedFields;
 	}
@@ -242,7 +246,7 @@ 
 	 * @param  string $q query string, e.g. 'New Zealand'
 	 * @param array $fieldsToSearch Mapping of name to an array of mapping Weight and Elastic mapping,
 	 *                              e.g. array('Title' => array('Weight' => 2, 'Type' => 'string'))
-	 * @return ArrayList    SilverStripe DataObjects returned from the search against ElasticSearch
+	 * @return \PaginatedList    SilverStripe DataObjects returned from the search against ElasticSearch
 	 */
 	public function search($q, $fieldsToSearch = null,  $testMode = false) {
 		if ($this->locale == null) {
@@ -307,6 +311,10 @@ 
 
 
 	/* Perform an autocomplete search */
+
+	/**
+	 * @param string $q
+	 */
 	public function autocomplete_search($q, $field) {
 		if ($this->locale == null) {
 			if (class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
@@ -358,11 +366,11 @@ 
 
 	/**
 	 * Perform a 'More Like This' search, aka relevance feedback, using the provided indexed DataObject
-	 * @param  DataObject $indexedItem A DataObject that has been indexed in Elasticsearch
+	 * @param  \DataObject|null $indexedItem A DataObject that has been indexed in Elasticsearch
 	 * @param  array $fieldsToSearch  array of fieldnames to search, mapped to weighting
 	 * @param  $$testMode Use all shards, not just one, for consistent results during unit testing. See
 	 *         https://www.elastic.co/guide/en/elasticsearch/guide/current/relevance-is-broken.html#relevance-is-broken
-	 * @return resultList  List of results
+	 * @return \PaginatedList  List of results
 	 */
 	public function moreLikeThis($indexedItem, $fieldsToSearch, $testMode = false) {
 		echo "INDEXED ITEM:".$indexedItem;
@@ -469,6 +477,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getSuggestedQuery() {
 		return $this->SuggestedQuery;
 	}

Indentation +4 added lines, -4 removed lines

@@ -434,11 +434,11 @@ 
 
 
 
-        $query = new Query();
-        $query->setParams(array('query' => array('more_like_this' => $mlt)));
+		$query = new Query();
+		$query->setParams(array('query' => array('more_like_this' => $mlt)));
 
 
-        $elasticService = \Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
+		$elasticService = \Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
 		$elasticService->setLocale($this->locale);
 		if ($testMode) {
 			$elasticService->setTestMode(true);
@@ -450,7 +450,7 @@ 
 		$query->setFrom($this->start);
 
 		$resultList = new ResultList($elasticService, $query, null);
-        // at this point ResultList object, not yet executed search query
+		// at this point ResultList object, not yet executed search query
 		$paginated = new \PaginatedList(
 			$resultList
 		);

Spacing +4 added lines, -4 removed lines

@@ -244,7 +244,7 @@ 
 	 *                              e.g. array('Title' => array('Weight' => 2, 'Type' => 'string'))
 	 * @return ArrayList    SilverStripe DataObjects returned from the search against ElasticSearch
 	 */
-	public function search($q, $fieldsToSearch = null,  $testMode = false) {
+	public function search($q, $fieldsToSearch = null, $testMode = false) {
 		if ($this->locale == null) {
 			if (class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
 				$this->locale = \Translatable::get_current_locale();
@@ -365,14 +365,14 @@ 
 	 * @return resultList  List of results
 	 */
 	public function moreLikeThis($indexedItem, $fieldsToSearch, $testMode = false) {
-		echo "INDEXED ITEM:".$indexedItem;
+		echo "INDEXED ITEM:" . $indexedItem;
 
 		if ($indexedItem == null) {
 			throw new \InvalidArgumentException('A searchable item cannot be null');
 		}
 
 		if (!$indexedItem->hasExtension('SilverStripe\Elastica\Searchable')) {
-			throw new \InvalidArgumentException('Objects of class '.$indexedItem->ClassName.' are not searchable');
+			throw new \InvalidArgumentException('Objects of class ' . $indexedItem->ClassName . ' are not searchable');
 		}
 
 		if ($fieldsToSearch == null) {
@@ -396,7 +396,7 @@ 
 			if (!is_numeric($weighting)) {
 				throw new \InvalidArgumentException('Fields must be of the form fieldname => weight');
 			}
-			$weightedField = $field.'^'.$weighting;
+			$weightedField = $field . '^' . $weighting;
 			$weightedField = str_replace('^1', '', $weightedField);
 			array_push($weightedFieldsArray, $weightedField);
 		}

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/ElasticaService.php

Doc Comments +1 added lines, -2 removed lines

@@ -81,7 +81,6 @@ 
 
 	/**
 	 * @param \Elastica\Client $client
-	 * @param string $index
 	 */
 	public function __construct(Client $client, $newIndexName) {
 		$this->client = $client;
@@ -133,7 +132,7 @@ 
 	 *
 	 * @param \Elastica\Query|string|array $query
 	 * @param array $types List of comma separated SilverStripe classes to search, or blank for all
-	 * @return ResultList
+	 * @return \Elastica\ResultSet
 	 */
 	public function search($query, $types = '', $debugTerms = false) {
 		$query = Query::create($query); // may be a string

Indentation +42 added lines, -42 removed lines

@@ -141,7 +141,7 @@ 
 			$types = explode(',', $types);
 		}
 
-        $data = $query->toArray();
+		$data = $query->toArray();
 		if (isset($data['query']['more_like_this'])) {
 			$query->MoreLikeThis = true;
 		} else {
@@ -164,23 +164,23 @@ 
 		if ($query->MoreLikeThis) {
 			$termsQuery = clone $query;
 			$path = $search->getPath();
-	        $params = $search->getOptions();
+			$params = $search->getOptions();
 
-	        $termData = array();
-	        $termData['query'] = $data['query'];
+			$termData = array();
+			$termData['query'] = $data['query'];
 
-	        $path = str_replace('_search', '_validate/query', $path);
-	        $params = array('explain' => true, 'rewrite' => true);
-	        if ($this->test_mode) {
-	        	$params['search_type'] = Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH;
-	        }
+			$path = str_replace('_search', '_validate/query', $path);
+			$params = array('explain' => true, 'rewrite' => true);
+			if ($this->test_mode) {
+				$params['search_type'] = Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH;
+			}
 
-	        $response = $this->getClient()->request(
-	            $path,
-	            \Elastica\Request::GET,
-	            $termData,
-	            $params
-	        );
+			$response = $this->getClient()->request(
+				$path,
+				\Elastica\Request::GET,
+				$termData,
+				$params
+			);
 
 			$r = $response->getData();
 			$terms = null; // keep in scope
@@ -196,14 +196,14 @@ 
 			}
 		}
 
-        if ($types) {
-        	foreach($types as $type) {
-        		$search->addType($type);
-        	}
-        }
+		if ($types) {
+			foreach($types as $type) {
+				$search->addType($type);
+			}
+		}
 
-        $path = $search->getPath();
-        $params = $search->getOptions();
+		$path = $search->getPath();
+		$params = $search->getOptions();
 
 		$highlightsCfg = \Config::inst()->get('Elastica', 'Highlights');
 		$preTags = $highlightsCfg['PreTags'];
@@ -271,14 +271,14 @@ 
 		}
 
 
-        $path = $search->getPath();
-        $params = $search->getOptions();
+		$path = $search->getPath();
+		$params = $search->getOptions();
 		$searchResults = $search->search($query, $params);
 		if (isset($this->MoreLikeThisTerms)) {
 			$searchResults->MoreLikeThisTerms = $this->MoreLikeThisTerms;
 		}
 
-        return $searchResults;
+		return $searchResults;
 	}
 
 
@@ -352,11 +352,11 @@ 
 
 	public function listIndexes($trace) {
 		$command = "curl 'localhost:9200/_cat/indices?v'";
-        exec($command,$op);
-        ElasticaUtil::message("\n++++ $trace ++++\n");
-        ElasticaUtil::message(print_r($op,1));
-        ElasticaUtil::message("++++ /{$trace} ++++\n\n");
-        return $op;
+		exec($command,$op);
+		ElasticaUtil::message("\n++++ $trace ++++\n");
+		ElasticaUtil::message(print_r($op,1));
+		ElasticaUtil::message("++++ /{$trace} ++++\n\n");
+		return $op;
 	}
 
 
@@ -527,11 +527,11 @@ 
 			} else {
 				$class = new \ReflectionClass($classname);
 				while ($class = $class->getParentClass()) {
-				    $parentClass = $class->getName();
-				    if ($parentClass == 'SiteTree') {
-				    	$inSiteTree = true;
-				    	break;
-				    }
+					$parentClass = $class->getName();
+					if ($parentClass == 'SiteTree') {
+						$inSiteTree = true;
+						break;
+					}
 				}
 				self::$site_tree_classes[$classname] = $inSiteTree;
 			}
@@ -685,15 +685,15 @@ 
 		//FlickrPhoto/3829/_termvector
 		$path = $this->getIndex()->getName().'/'.$searchable->ClassName.'/'.$searchable->ID.'/_termvector';
 		$response = $this->getClient()->request(
-	            $path,
-	            \Elastica\Request::GET,
-	            $data,
-	            $params
-	    );
+				$path,
+				\Elastica\Request::GET,
+				$data,
+				$params
+		);
 
 
-	    $data = $response->getData();
-	    return $data['term_vectors'];
+		$data = $response->getData();
+		return $data['term_vectors'];
 	}
 
 }

Spacing +23 added lines, -23 removed lines

@@ -121,7 +121,7 @@ 
 	}
 
 	private function getLocaleIndexName() {
-		$name = $this->indexName.'-'.$this->locale;
+		$name = $this->indexName . '-' . $this->locale;
 		$name = strtolower($name);
 		$name = str_replace('-', '_', $name);
 		return $name;
@@ -152,7 +152,7 @@ 
 		$search = new Search(new Client());
 
 		if ($this->test_mode) {
-			$search->setOption('search_type',Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH);
+			$search->setOption('search_type', Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH);
 		}
 
 
@@ -197,7 +197,7 @@ 
 		}
 
         if ($types) {
-        	foreach($types as $type) {
+        	foreach ($types as $type) {
         		$search->addType($type);
         	}
         }
@@ -265,7 +265,7 @@ 
 		//$search = new Search(new Client());
 		$search->addIndex($this->getLocaleIndexName());
 		if ($types) {
-			foreach($types as $type) {
+			foreach ($types as $type) {
 				$search->addType($type);
 			}
 		}
@@ -352,9 +352,9 @@ 
 
 	public function listIndexes($trace) {
 		$command = "curl 'localhost:9200/_cat/indices?v'";
-        exec($command,$op);
+        exec($command, $op);
         ElasticaUtil::message("\n++++ $trace ++++\n");
-        ElasticaUtil::message(print_r($op,1));
+        ElasticaUtil::message(print_r($op, 1));
         ElasticaUtil::message("++++ /{$trace} ++++\n\n");
         return $op;
 	}
@@ -377,12 +377,12 @@ 
 			ElasticaUtil::message("\tAdding $amount documents to the index\n");
 			if (isset($this->StartTime)) {
 				$elapsed = microtime(true) - $this->StartTime;
-				$timePerDoc = ($elapsed)/($this->nDocumentsIndexed);
+				$timePerDoc = ($elapsed) / ($this->nDocumentsIndexed);
 				$documentsRemaining = $this->nDocumentsToIndexForLocale - $this->nDocumentsIndexed;
-				$eta = ($documentsRemaining)*$timePerDoc;
-				$hours = (int)($eta/3600);
-				$minutes = (int)(($eta-$hours*3600)/60);
-				$seconds = (int)(0.5+$eta-$minutes*60-$hours*3600);
+				$eta = ($documentsRemaining) * $timePerDoc;
+				$hours = (int)($eta / 3600);
+				$minutes = (int)(($eta - $hours * 3600) / 60);
+				$seconds = (int)(0.5 + $eta - $minutes * 60 - $hours * 3600);
 				$etaHR = "{$hours}h {$minutes}m {$seconds}s";
 				ElasticaUtil::message("ETA to completion of indexing $this->locale ($documentsRemaining documents): $etaHR");
 			}
@@ -453,17 +453,17 @@ 
 	 * @return \DataObject[] $records
 	 */
 	protected function recordsByClassConsiderVersioned($class, $pageSize = 0, $page = 0) {
-		$offset = $page*$pageSize;
+		$offset = $page * $pageSize;
 
 		if ($class::has_extension("Versioned")) {
-			if ($pageSize >0) {
+			if ($pageSize > 0) {
 				$records = \Versioned::get_by_stage($class, 'Live')->limit($pageSize, $offset);
 			} else {
 				$records = \Versioned::get_by_stage($class, 'Live');
 			}
 		} else {
-			if ($pageSize >0) {
-				$records = $class::get()->limit($pageSize,$offset);
+			if ($pageSize > 0) {
+				$records = $class::get()->limit($pageSize, $offset);
 			} else {
 				$records = $class::get();
 			}
@@ -481,12 +481,12 @@ 
 	protected function refreshClass($class) {
 		$nRecords = $this->recordsByClassConsiderVersioned($class)->count();
 		$batchSize = 500;
-		$pages = $nRecords/$batchSize + 1;
+		$pages = $nRecords / $batchSize + 1;
 		$processing = true;
 
-		for ($i=0; $i < $pages; $i++) {
+		for ($i = 0; $i < $pages; $i++) {
 			$this->startBulkIndex();
-			$pagedRecords = $this->recordsByClassConsiderVersioned($class,$batchSize, $i);
+			$pagedRecords = $this->recordsByClassConsiderVersioned($class, $batchSize, $i);
 			$this->nDocumentsIndexed += $pagedRecords->count();
 			$batch = $pagedRecords->toArray();
 			$this->refreshRecords($batch);
@@ -508,7 +508,7 @@ 
 
 		//Count the number of documents for this locale
 		$amount = 0;
-		echo "CURRENT LOCALE:".$this->locale;
+		echo "CURRENT LOCALE:" . $this->locale;
 		foreach ($classes as $class) {
 			$amount += $this->recordsByClassConsiderVersioned($class)->count();
 		}
@@ -584,7 +584,7 @@ 
 			$settingsClassName = $indexSettings[$this->locale];
 			$result = \Injector::inst()->create($settingsClassName);
 		} else {
-			throw new \Exception('ERROR: No index settings are provided for locale '.$this->locale."\n");
+			throw new \Exception('ERROR: No index settings are provided for locale ' . $this->locale . "\n");
 
 		}
 		return $result;
@@ -600,7 +600,7 @@ 
 		$classes = array();
 
 		$whitelist = array('SearchableTestPage', 'SearchableTestFatherPage', 'SearchableTestGrandFatherPage',
-			'FlickrPhotoTO','FlickrTagTO','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO');
+			'FlickrPhotoTO', 'FlickrTagTO', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO');
 
 		foreach (\ClassInfo::subclassesFor('DataObject') as $candidate) {
 			$instance = singleton($candidate);
@@ -663,7 +663,7 @@ 
 			if (isset($mapping['fields'])) {
 				$subFields = array_keys($mapping['fields']);
 				foreach ($subFields as $subField) {
-					$name = $field.'.'.$subField;
+					$name = $field . '.' . $subField;
 					array_push($allFields, $name);
 				}
 			}
@@ -683,7 +683,7 @@ 
 		);
 
 		//FlickrPhoto/3829/_termvector
-		$path = $this->getIndex()->getName().'/'.$searchable->ClassName.'/'.$searchable->ID.'/_termvector';
+		$path = $this->getIndex()->getName() . '/' . $searchable->ClassName . '/' . $searchable->ID . '/_termvector';
 		$response = $this->getClient()->request(
 	            $path,
 	            \Elastica\Request::GET,

src/SilverStripe/Elastica/QueryGenerator.php

Doc Comments +12 added lines

@@ -62,6 +62,9 @@ 
 	}
 
 
+	/**
+	 * @param boolean $newShowResultsForEmptyQuery
+	 */
 	public function setShowResultsForEmptyQuery($newShowResultsForEmptyQuery) {
 		$this->showResultsForEmptyQuery = $newShowResultsForEmptyQuery;
 	}
@@ -72,11 +75,17 @@ 
 	}
 
 
+	/**
+	 * @param integer $newPageLength
+	 */
 	public function setPageLength($newPageLength) {
 		$this->pageLength = $newPageLength;
 	}
 
 
+	/**
+	 * @param integer $newStart
+	 */
 	public function setStart($newStart) {
 		$this->start = $newStart;
 	}
@@ -317,6 +326,9 @@ 
 	}
 
 
+	/**
+	 * @param Query $query
+	 */
 	private function addAggregation(&$query) {
 		// aggregation (optional)
 		if ($this->manipulatorInstance) {

Indentation +7 added lines, -7 removed lines

@@ -384,16 +384,16 @@
 
 		if ($textQuery instanceof MultiMatch) {
 			$elasticaFields = $this->convertWeightedFieldsForElastica($this->fields);
-	        //$textQuery->setFields(array('Title^4','Content','Content.*'));
-	        //$fieldsCSV = implode(',', $fieldsToSearch);
-	        $textQuery->setFields($elasticaFields);
-	        $textQuery->setType('most_fields');
+			//$textQuery->setFields(array('Title^4','Content','Content.*'));
+			//$fieldsCSV = implode(',', $fieldsToSearch);
+			$textQuery->setFields($elasticaFields);
+			$textQuery->setType('most_fields');
 
-	        //Setting the lenient flag means that numeric fields can be searched for text values
-	        $textQuery->setParam('lenient', true);
+			//Setting the lenient flag means that numeric fields can be searched for text values
+			$textQuery->setParam('lenient', true);
 		}
 
-        return $textQuery;
+		return $textQuery;
 	}
 
 

Spacing +15 added lines, -15 removed lines

@@ -209,7 +209,7 @@ 
 			'size' => 10,
 			'query' => array(
 				'match' => array(
-					$field.'.autocomplete' => array(
+					$field . '.autocomplete' => array(
 						'query' => $this->queryText,
 						'operator' => 'and'
 					)
@@ -268,7 +268,7 @@ 
 		foreach ($this->selectedFilters as $key => $value) {
 			if (!in_array($key, $rangeFilterKeys)) {
 				$filter = new Term();
-				$filter->setTerm($key,$value);
+				$filter->setTerm($key, $value);
 				$elFilters[] = $filter;
 			} else {
 				// get the selected range filter
@@ -407,20 +407,20 @@ 
 	 */
 	public function convertWeightedFieldsForElastica($fields) {
 		$result = array();
-		$nameToType = self::getSearchFieldsMappingForClasses($this->classes,$fields);
+		$nameToType = self::getSearchFieldsMappingForClasses($this->classes, $fields);
 
 		if (sizeof($fields) != 0) {
 			foreach ($fields as $fieldName => $weight) {
 				$fieldCfg = "$fieldName";
 				if ($weight != 1) {
-					$fieldCfg .= '^'.$weight;
+					$fieldCfg .= '^' . $weight;
 				}
 				array_push($result, $fieldCfg);
 				if (isset($nameToType[$fieldName])) {
 					if ($nameToType[$fieldName] == 'string') {
 						$fieldCfg = "{$fieldName}.*";
 						if ($weight != 1) {
-							$fieldCfg .= '^'.$weight;
+							$fieldCfg .= '^' . $weight;
 						}
 						array_push($result, $fieldCfg);
 					}
@@ -447,16 +447,16 @@ 
 		$cache = QueryGenerator::getCache();
 		$csvClasses = $classes;
 		if (is_array($classes)) {
-			$csvClasses = implode(',',$classes);
+			$csvClasses = implode(',', $classes);
 		}
 
 		error_log("CSV CLASSES: $csvClasses");
 
-		$key ='SEARCHABLE_FIELDS_'.str_replace(',', '_', $csvClasses);
+		$key = 'SEARCHABLE_FIELDS_' . str_replace(',', '_', $csvClasses);
 
 		if ($fieldsAllowed) {
 			$fieldsAllowedCSV = self::convertToQuotedCSV(array_keys($fieldsAllowed));
-			$key .= '_' . str_replace(',', '_', str_replace("'", '_',$fieldsAllowedCSV));
+			$key .= '_' . str_replace(',', '_', str_replace("'", '_', $fieldsAllowedCSV));
 			$key = str_replace('.', '_', $key);
 			$key = str_replace(' ', '_', $key);
 		}
@@ -468,7 +468,7 @@ 
 			if (!$csvClasses) {
 
 				$sql = "SELECT DISTINCT Name from SearchableClass where InSiteTree = 1 order by Name";
-								error_log('T1 - sql = '.$sql);
+								error_log('T1 - sql = ' . $sql);
 
 				$records = \DB::query($sql);
 				foreach ($records as $record) {
@@ -492,7 +492,7 @@ 
 					}
 				}
 
-				error_log('T2 - sql = '.$sql);
+				error_log('T2 - sql = ' . $sql);
 
 
 				$records = \DB::query($sql);
@@ -510,11 +510,11 @@ 
 					$result[$name] = $type;
 				}
 			}
-			$cache->save(json_encode($result),$key);
-		}  else {
+			$cache->save(json_encode($result), $key);
+		} else {
 			// true is necessary here to decode the array hash back to an array and not a struct
 			self::$cacheHitCtr++;
-			$result = json_decode($result,true);
+			$result = json_decode($result, true);
 		}
 
 		return $result;
@@ -546,11 +546,11 @@ 
 		$quoted = array();
 		foreach ($asArray as $value) {
 			if (strlen($value) > 0) {
-				$item = "'".$value."'";
+				$item = "'" . $value . "'";
 				array_push($quoted, $item);
 			}
 
 		}
-		return implode(',', $quoted);;
+		return implode(',', $quoted); ;
 	}
 }

Braces +1 added lines, -1 removed lines

@@ -511,7 +511,7 @@
 				}
 			}
 			$cache->save(json_encode($result),$key);
-		}  else {
+		} else {
 			// true is necessary here to decode the array hash back to an array and not a struct
 			self::$cacheHitCtr++;
 			$result = json_decode($result,true);

src/SilverStripe/Elastica/RangedAggregation.php

Doc Comments +9 added lines

@@ -6,6 +6,10 @@ 
 	private static $ranged_aggregations = array();
 
 
+	/**
+	 * @param string $title
+	 * @param string $field
+	 */
 	public function __construct($title, $field) {
 		$this->Title = $title;
 		$this->Range = new \Elastica\Aggregation\Range($title);
@@ -14,6 +18,11 @@ 
 	}
 
 
+	/**
+	 * @param double $from
+	 * @param double $to
+	 * @param string $name
+	 */
 	public function addRange($from, $to, $name) {
 		$this->Range->addRange($from,$to,$name);
 	}

Indentation +2 added lines, -2 removed lines

@@ -38,8 +38,8 @@
 					$to = $range['to'];
 				}
 				$rangeFilter = array('gte' => (string)$from, 'lt' => (string)$to);
-		        $filter = new \Elastica\Filter\Range('AspectRatio', $rangeFilter);
-		        $result = $filter;
+				$filter = new \Elastica\Filter\Range('AspectRatio', $rangeFilter);
+				$result = $filter;
 			}
 		}
 

Spacing +2 added lines, -2 removed lines

@@ -10,12 +10,12 @@
 		$this->Title = $title;
 		$this->Range = new \Elastica\Aggregation\Range($title);
 		$this->Range->setField($field);
-		self::$ranged_aggregations[$title] = $this;;
+		self::$ranged_aggregations[$title] = $this; ;
 	}
 
 
 	public function addRange($from, $to, $name) {
-		$this->Range->addRange($from,$to,$name);
+		$this->Range->addRange($from, $to, $name);
 	}
 
 

src/SilverStripe/Elastica/ResultList.php

Doc Comments +3 added lines

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

Indentation +42 added lines, -42 removed lines

@@ -12,14 +12,14 @@ 
  */
 class ResultList extends \ViewableData implements \SS_Limitable, \SS_List {
 
-    /**
-     * @var \Elastica\Index
-     */
-    private $service;
-
-    /**
-     * @var \Elastica\Query
-     */
+	/**
+	 * @var \Elastica\Index
+	 */
+	private $service;
+
+	/**
+	 * @var \Elastica\Query
+	 */
 	private $query;
 
 	/**
@@ -312,51 +312,51 @@ 
 			// Safeguards against indexed items which might no longer be in the DB
 			if(array_key_exists($item->getId(), $retrieved[$item->getType()])) {
 
-                $data_object = $retrieved[$item->getType()][$item->getId()];
-                $data_object->setElasticaResult($item);
-                $highlights = $item->getHighlights();
+				$data_object = $retrieved[$item->getType()][$item->getId()];
+				$data_object->setElasticaResult($item);
+				$highlights = $item->getHighlights();
 
-                //$snippets will contain the highlights shown in the body of the search result
-                //$namedSnippets will be used to add highlights to the Link and Title
-                $snippets = new \ArrayList();
-                $namedSnippets = new \ArrayList();
+				//$snippets will contain the highlights shown in the body of the search result
+				//$namedSnippets will be used to add highlights to the Link and Title
+				$snippets = new \ArrayList();
+				$namedSnippets = new \ArrayList();
 
-                foreach (array_keys($highlights) as $fieldName) {
-                	$fieldSnippets = new \ArrayList();
+				foreach (array_keys($highlights) as $fieldName) {
+					$fieldSnippets = new \ArrayList();
 
-                	foreach ($highlights[$fieldName] as $snippet) {
-                		$do = new \DataObject();
-                		$do->Snippet = $snippet;
+					foreach ($highlights[$fieldName] as $snippet) {
+						$do = new \DataObject();
+						$do->Snippet = $snippet;
 
-                		// skip title and link in the summary of highlights
-                		if (!in_array($fieldName, $ignore)) {
-                			$snippets->push($do);
-                		}
+						// skip title and link in the summary of highlights
+						if (!in_array($fieldName, $ignore)) {
+							$snippets->push($do);
+						}
 
-                		$fieldSnippets->push($do);
-                	}
+						$fieldSnippets->push($do);
+					}
 
-                	if ($fieldSnippets->count() > 0) {
-                		//Fields may have a dot in their name, e.g. Title.standard - take this into account
-                		//As dots are an issue with template syntax, store as Title_standard
-                		$splits = explode('.', $fieldName);
-                		if (sizeof($splits) == 1) {
-                			$namedSnippets->$fieldName = $fieldSnippets;
-                		} else {
-                			// The Title.standard case, for example
-                			$splits = explode('.', $fieldName);
-                			$compositeFielddName = $splits[0].'_'.$splits[1];
-                			$namedSnippets->$compositeFielddName = $fieldSnippets;
-                		}
+					if ($fieldSnippets->count() > 0) {
+						//Fields may have a dot in their name, e.g. Title.standard - take this into account
+						//As dots are an issue with template syntax, store as Title_standard
+						$splits = explode('.', $fieldName);
+						if (sizeof($splits) == 1) {
+							$namedSnippets->$fieldName = $fieldSnippets;
+						} else {
+							// The Title.standard case, for example
+							$splits = explode('.', $fieldName);
+							$compositeFielddName = $splits[0].'_'.$splits[1];
+							$namedSnippets->$compositeFielddName = $fieldSnippets;
+						}
 
-                	}
+					}
 
 
-                }
+				}
 
 
-                $data_object->SearchHighlights = $snippets;
-                $data_object->SearchHighlightsByField = $namedSnippets;
+				$data_object->SearchHighlights = $snippets;
+				$data_object->SearchHighlightsByField = $namedSnippets;
 
 				$result[] = $data_object;
 

Spacing +13 added lines, -13 removed lines

@@ -102,7 +102,7 @@ 
 	 */
 	public function getResults() {
 		if (!isset($this->_cachedResults)) {
-			$ers = $this->service->search($this->query,$this->types);
+			$ers = $this->service->search($this->query, $this->types);
 
 			if (isset($ers->MoreLikeThisTerms)) {
 				$this->MoreLikeThisTerms = $ers->MoreLikeThisTerms;
@@ -150,10 +150,10 @@ 
 			}
 
 			// get the base URL for the current facets selected
-			$baseURL = \Controller::curr()->Link().'?';
+			$baseURL = \Controller::curr()->Link() . '?';
 			$prefixAmp = false;
 			if ($q !== '') {
-				$baseURL .= 'q='.urlencode($q);
+				$baseURL .= 'q=' . urlencode($q);
 				$prefixAmp = true;
 			}
 
@@ -164,7 +164,7 @@ 
 				} else {
 					$prefixAmp = true;
 				}
-				$baseURL .= $key.'='.urlencode($value);
+				$baseURL .= $key . '=' . urlencode($value);
 			}
 
 			foreach (array_keys($aggs) as $key) {
@@ -187,7 +187,7 @@ 
 						$ct->DocumentCount = $value['doc_count'];
 						$query[$key] = $value;
 						if ($prefixAmp) {
-							$url = $baseURL.'&';
+							$url = $baseURL . '&';
 						} else {
 							$url = $baseURL;
 							$prefixAmp = true;
@@ -203,24 +203,24 @@ 
 								// of the display of the facet can be done via the template.
 								$aggDO->IsSelected = true;
 
-								$urlParam = $key.'='.urlencode($this->filters[$key]);
+								$urlParam = $key . '=' . urlencode($this->filters[$key]);
 
 								//echo "    - URL PARAM : $urlParam \n";
 
 								// possible ampersand combos to remove
-								$v2 = '&'.$urlParam;
-								$v3 = $urlParam.'&';
+								$v2 = '&' . $urlParam;
+								$v3 = $urlParam . '&';
 								$url = str_replace($v2, '', $url);
 								$url = str_replace($v3, '', $url);
 								$url = str_replace($urlParam, '', $url);
 								$ct->URL = $url;
 							}
 						} else {
-							$url .= $key .'='.urlencode($value['key']);
+							$url .= $key . '=' . urlencode($value['key']);
 							$prefixAmp = true;
 						}
 
-						$url = rtrim($url,'&');
+						$url = rtrim($url, '&');
 
 						$ct->URL = $url;
 						$bucketsAL->push($ct);
@@ -310,7 +310,7 @@ 
 
 		foreach ($found as $item) {
 			// Safeguards against indexed items which might no longer be in the DB
-			if(array_key_exists($item->getId(), $retrieved[$item->getType()])) {
+			if (array_key_exists($item->getId(), $retrieved[$item->getType()])) {
 
                 $data_object = $retrieved[$item->getType()][$item->getId()];
                 $data_object->setElasticaResult($item);
@@ -345,7 +345,7 @@ 
                 		} else {
                 			// The Title.standard case, for example
                 			$splits = explode('.', $fieldName);
-                			$compositeFielddName = $splits[0].'_'.$splits[1];
+                			$compositeFielddName = $splits[0] . '_' . $splits[1];
                 			$namedSnippets->$compositeFielddName = $fieldSnippets;
                 		}
 
@@ -396,7 +396,7 @@ 
 	}
 
 	public function column($col = 'ID') {
-		if($col == 'ID') {
+		if ($col == 'ID') {
 			$ids = array();
 
 			foreach ($this->getResults() as $result) {

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

@@ -483,7 +483,7 @@ 
 		$resultList = $this->search('');
 
 		//assert there are actually some results
-		$this->assertGreaterThan(0,$resultList->getTotalItems());
+		$this->assertGreaterThan(0, $resultList->getTotalItems());
 		$aggregations = $resultList->getAggregations()->toArray();
 
 		/*
@@ -502,49 +502,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);
 
@@ -557,43 +557,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);
 
@@ -887,7 +887,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);
@@ -899,8 +899,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);
@@ -916,8 +916,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);
@@ -1018,7 +1018,7 @@ 
 
 		//Add filters
 		foreach ($filters as $key => $value) {
-			$es->addFilter($key,$value);
+			$es->addFilter($key, $value);
 		}
 
 		$es->showResultsForEmptySearch();
@@ -1037,7 +1037,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);
@@ -1049,7 +1049,7 @@ 
 		//Add filters
 		foreach ($filters as $key => $value) {
 			echo "ADDING FILTER:$key => $value\n";
-			$es->addFilter($key,$value);
+			$es->addFilter($key, $value);
 		}
 
 		$es->showResultsForEmptySearch();
@@ -1060,10 +1060,10 @@ 
 		echo "{$resultList->count()} items found searching for '$queryText'\n\n";
 		foreach ($resultList as $result) {
 			$ctr++;
-			echo("($ctr) ".$result->Title."\n");
+			echo("($ctr) " . $result->Title . "\n");
 			if ($result->SearchHighlightsByField->Content) {
 				foreach ($result->SearchHighlightsByField->Content as $highlight) {
-					echo("- ".$highlight->Snippet);
+					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 +9 added lines, -9 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;
 
@@ -60,8 +60,8 @@ 
 		print_r(static::$ignoreFixtureFileFor);
 
 		foreach (static::$ignoreFixtureFileFor as $testPattern) {
-			$pattern = '/'.$testPattern.'/';
-			echo "GREP: $pattern against ".$this->getName()."\n";
+			$pattern = '/' . $testPattern . '/';
+			echo "GREP: $pattern against " . $this->getName() . "\n";
 			if (preg_match($pattern, $this->getName())) {
 				static::$fixture_file = null;
 			}
@@ -88,8 +88,8 @@ 
 			// 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');
 		}
 	}
 
@@ -115,7 +115,7 @@ 
 			$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++;
 		}
 
@@ -171,7 +171,7 @@ 
 		$result = array();
 		foreach ($items as $item) {
 			$attr = $item->attributes()->id;
-			array_push($result, $attr."");
+			array_push($result, $attr . "");
 		}
 
 		return $result;