gordonbanderson / silverstripe-elastica

src/SilverStripe/Elastica/QueryGenerator.php

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);

Spacing +49 added lines, -49 removed lines

@@ -126,12 +126,12 @@ 
 		$queryTextExists = ($this->queryText != '');
 		$isMultiMatch = ($this->fields != null);
 
-		if ($this->selectedFilters == null) {
+		if($this->selectedFilters == null) {
 			$this->selectedFilters = array();
 		}
 
 		$this->manipulatorInstance = null;
-		if ($this->manipulator) {
+		if($this->manipulator) {
 			$this->manipulatorInstance = \Injector::inst()->create($this->manipulator);
 			$this->manipulatorInstance->queryGenerator = $this;
 			$this->manipulatorInstance->originalQueryString = $this->queryText;
@@ -140,7 +140,7 @@ 
 		//This is a query_string object
 		$textQuery = null;
 
-		if (!$isMultiMatch) {
+		if(!$isMultiMatch) {
 			$textQuery = $this->simpleTextQuery();
 		} else {
 			$textQuery = $this->multiMatchQuery();
@@ -159,7 +159,7 @@ 
 		$query->setLimit($this->pageLength);
 		$query->setFrom($this->start);
 
-		if ($this->manipulatorInstance && !$queryTextExists) {
+		if($this->manipulatorInstance && !$queryTextExists) {
 			$sort = $this->manipulatorInstance->getDefaultSort();
 			$query->setSort($sort);
 		}
@@ -190,7 +190,7 @@ 
 			'size' => 10,
 			'query' => array(
 				'match' => array(
-					$field.'.autocomplete' => array(
+					$field . '.autocomplete' => array(
 						'query' => $this->queryText,
 						'operator' => 'and'
 					)
@@ -199,7 +199,7 @@ 
 		);
 
 		// The query clause can only have one entry, so a bit of mangling
-		if (!empty($this->selectedFilters)) {
+		if(!empty($this->selectedFilters)) {
 			$filtered = array();
 			$filtered['query'] = $data['query'];
 			unset($data['query']);
@@ -228,17 +228,17 @@ 
 	 * @param Elastica\Query\QueryString $textQuery A query_string representing the current query
 	 */
 	private function addFilters($textQuery) {
-		if ($this->manipulator) {
+		if($this->manipulator) {
 			$this->manipulatorInstance->updateFilters($this->selectedFilters);
 		}
 
 		$elFilters = array();
 		$rangeFilterKeys = RangedAggregation::getTitles();
 
-		foreach ($this->selectedFilters as $key => $value) {
-			if (!in_array($key, $rangeFilterKeys)) {
+		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
@@ -251,7 +251,7 @@ 
 
 		// if not facets selected, pass through null
 		$queryFilter = null;
-		switch (count($this->selectedFilters)) {
+		switch(count($this->selectedFilters)) {
 			case 0:
 				// filter already null
 				break;
@@ -261,18 +261,18 @@ 
 			default:
 				$queryFilter = new BoolAnd();
 
-				foreach ($elFilters as $filter) {
+				foreach($elFilters as $filter) {
 					$queryFilter->addFilter($filter);
 				}
 				break;
 		}
 
 		// the Elastica query object
-		if ($queryFilter == null) {
+		if($queryFilter == null) {
 			$query = new Query($textQuery);
 		} else {
 			//MatchAll appears not be allowed inside a filtered query which is a bit of a pain.
-			if ($textQuery instanceof MatchAll) {
+			if($textQuery instanceof MatchAll) {
 				$textQuery = null;
 			}
 
@@ -289,7 +289,7 @@ 
 
 	private function addAggregation(&$query) {
 		// aggregation (optional)
-		if ($this->manipulatorInstance) {
+		if($this->manipulatorInstance) {
 			$this->manipulatorInstance->augmentQuery($query);
 		}
 	}
@@ -316,7 +316,7 @@ 
 		//Setting the lenient flag means that numeric fields can be searched for text values
 		$textQuery->setParam('lenient', true);
 
-		if ($this->showResultsForEmptyQuery && $this->queryText == '') {
+		if($this->showResultsForEmptyQuery && $this->queryText == '') {
 			$textQuery = new MatchAll();
 		}
 
@@ -329,8 +329,8 @@ 
 		$textQuery = new MultiMatch();
 
 		// Differing cases for showing and not showing empty string
-		if ($this->queryText == '') {
-			if (!$this->showResultsForEmptyQuery) {
+		if($this->queryText == '') {
+			if(!$this->showResultsForEmptyQuery) {
 				$textQuery->setQuery('');
 			} else {
 				//WIP
@@ -343,7 +343,7 @@ 
 			$textQuery->setQuery($this->queryText);
 		}
 
-		if ($textQuery instanceof MultiMatch) {
+		if($textQuery instanceof MultiMatch) {
 			$elasticaFields = $this->convertWeightedFieldsForElastica($this->fields);
 			$textQuery->setFields($elasticaFields);
 			$textQuery->setType('most_fields');
@@ -366,20 +366,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) {
+		if(sizeof($fields) != 0) {
+			foreach($fields as $fieldName => $weight) {
 				$fieldCfg = "$fieldName";
-				if ($weight != 1) {
-					$fieldCfg .= '^'.$weight;
+				if($weight != 1) {
+					$fieldCfg .= '^' . $weight;
 				}
 				array_push($result, $fieldCfg);
-				if (isset($nameToType[$fieldName])) {
-					if ($nameToType[$fieldName] == 'string') {
+				if(isset($nameToType[$fieldName])) {
+					if($nameToType[$fieldName] == 'string') {
 						$fieldCfg = "{$fieldName}.*";
-						if ($weight != 1) {
-							$fieldCfg .= '^'.$weight;
+						if($weight != 1) {
+							$fieldCfg .= '^' . $weight;
 						}
 						array_push($result, $fieldCfg);
 					}
@@ -405,29 +405,29 @@ 
 		// Get a array of relevant classes to search
 		$cache = QueryGenerator::getCache();
 		$csvClasses = $classes;
-		if (is_array($classes)) {
-			$csvClasses = implode(',',$classes);
+		if(is_array($classes)) {
+			$csvClasses = implode(',', $classes);
 		}
 
 		error_log("CSV CLASSES: $csvClasses");
 
-		$key ='SEARCHABLE_FIELDS_'.str_replace(',', '_', $csvClasses);
+		$key = 'SEARCHABLE_FIELDS_' . str_replace(',', '_', $csvClasses);
 
-		if ($fieldsAllowed) {
+		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);
 		}
 
 		$result = $cache->load($key);
 		error_log("RESULT:$result for key $key \n");
-		if (!$result) {
+		if(!$result) {
 			$relevantClasses = array();
-			if (empty($csvClasses)) {
+			if(empty($csvClasses)) {
 				$sql = "SELECT DISTINCT Name from SearchableClass where InSiteTree = 1 order by Name";
 				$records = \DB::query($sql);
-				foreach ($records as $record) {
+				foreach($records as $record) {
 					array_push($relevantClasses, $record['Name']);
 				}
 			} else {
@@ -435,21 +435,21 @@ 
 			}
 
 			$result = array();
-			if (sizeof($relevantClasses) > 0) {
+			if(sizeof($relevantClasses) > 0) {
 				$relevantClassesCSV = self::convertToQuotedCSV($relevantClasses);
 
 				//Perform a database query to get get a list of searchable fieldnames to Elasticsearch mapping
 				$sql = "SELECT  sf.Name,sf.Type FROM SearchableClass sc  INNER JOIN SearchableField sf ON "
 					 . "sc.id = sf.SearchableClassID WHERE sc.name IN ($relevantClassesCSV)";
-				if ($fieldsAllowed) {
+				if($fieldsAllowed) {
 					$fieldsAllowedCSV = self::convertToQuotedCSV(array_keys($fieldsAllowed));
-					if (strlen($fieldsAllowedCSV) > 0) {
+					if(strlen($fieldsAllowedCSV) > 0) {
 						$sql .= " AND sf.Name IN ($fieldsAllowedCSV)";
 					}
 				}
 
 				$records = \DB::query($sql);
-				foreach ($records as $record) {
+				foreach($records as $record) {
 					$name = $record['Name'];
 					$type = $record['Type'];
 
@@ -463,11 +463,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;
@@ -488,21 +488,21 @@ 
 	 */
 	public static function convertToQuotedCSV($csvOrArray) {
 		$asArray = $csvOrArray;
-		if (!is_array($csvOrArray)) {
-			if ($csvOrArray == null) {
+		if(!is_array($csvOrArray)) {
+			if($csvOrArray == null) {
 				$asArray = array();
 			} else {
 				$asArray = explode(',', $csvOrArray);
 			}
 		}
 		$quoted = array();
-		foreach ($asArray as $value) {
-			if (strlen($value) > 0) {
-				$item = "'".$value."'";
+		foreach($asArray as $value) {
+			if(strlen($value) > 0) {
+				$item = "'" . $value . "'";
 				array_push($quoted, $item);
 			}
 
 		}
-		return implode(',', $quoted);;
+		return implode(',', $quoted); ;
 	}
 }

Doc Comments +15 added lines

@@ -47,6 +47,9 @@ 
 	private $classes = '';
 
 
+	/**
+	 * @param string $newQueryText
+	 */
 	public function setQueryText($newQueryText) {
 		$this->queryText = $newQueryText;
 	}
@@ -62,6 +65,9 @@ 
 	}
 
 
+	/**
+	 * @param boolean $newShowResultsForEmptyQuery
+	 */
 	public function setShowResultsForEmptyQuery($newShowResultsForEmptyQuery) {
 		$this->showResultsForEmptyQuery = $newShowResultsForEmptyQuery;
 	}
@@ -72,11 +78,17 @@ 
 	}
 
 
+	/**
+	 * @param integer $newPageLength
+	 */
 	public function setPageLength($newPageLength) {
 		$this->pageLength = $newPageLength;
 	}
 
 
+	/**
+	 * @param integer $newStart
+	 */
 	public function setStart($newStart) {
 		$this->start = $newStart;
 	}
@@ -287,6 +299,9 @@ 
 	}
 
 
+	/**
+	 * @param Query $query
+	 */
 	private function addAggregation(&$query) {
 		// aggregation (optional)
 		if ($this->manipulatorInstance) {

searchpage/ElasticSearchForm.php

Indentation +10 added lines, -10 removed lines

@@ -27,17 +27,17 @@ 
 	 */
 	public function __construct($controller, $name, $fields = null, $actions = null) {
 		$searchText = isset($this->Query) ? $this->Query : '';
-        $fields = new FieldList(
-           $tf = new TextField("q", "", $searchText)
-        );
+		$fields = new FieldList(
+		   $tf = new TextField("q", "", $searchText)
+		);
 
 
-        $buttonText = _t('SearchPage.SEARCH', 'Search');
-        $actions = new FieldList(
-            $fa = new FormAction('submit', $buttonText)
-        );
+		$buttonText = _t('SearchPage.SEARCH', 'Search');
+		$actions = new FieldList(
+			$fa = new FormAction('submit', $buttonText)
+		);
 
-        $this->SubmitButton = $fa;
+		$this->SubmitButton = $fa;
 
 		if(class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
 			$fields->push(new HiddenField('searchlocale', 'searchlocale', Translatable::get_current_locale()));
@@ -64,7 +64,7 @@ 
 	 */
 	public function setButtonText($newButtonText) {
 		$this->actions = new FieldList(
-            $fa = new FormAction('submit', $newButtonText)
-        );
+			$fa = new FormAction('submit', $newButtonText)
+		);
 	}
 }

tests/ElasticSearcherUnitTest.php

Doc Comments +3 added lines

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

Spacing +13 added lines, -13 removed lines

@@ -49,7 +49,7 @@ 
 		$results = $es->moreLikeThis($fp, $fields, true);
 
 		echo "RESULTS:\n";
-		foreach ($results as $result) {
+		foreach($results as $result) {
 			echo "-\t{$result->Title}\n";
 		}
 
@@ -129,7 +129,7 @@ 
 		$es->setClasses('FlickrPhotoTO');
 		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
 		$paginated = $es->moreLikeThis($fp, $fields, true);
-		foreach ($paginated->getList() as $result) {
+		foreach($paginated->getList() as $result) {
 			echo $result->ID . ' : ' . $result->Title . "\n";
 		}
 		$this->assertEquals(32, $paginated->getTotalItems());
@@ -155,7 +155,7 @@ 
 		$es->setClasses('FlickrPhotoTO');
 		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
 		$paginated = $es->moreLikeThis($fp, $fields, true);
-		foreach ($paginated->getList() as $result) {
+		foreach($paginated->getList() as $result) {
 			echo $result->ID . ' : ' . $result->Title . "\n";
 		}
 		$this->assertEquals(14, $paginated->getTotalItems());
@@ -211,16 +211,16 @@ 
 		$paginated = $es->search($query, $fields);
 		$ctr = 0;
 
-		foreach ($paginated->getList()->toArray() as $result) {
+		foreach($paginated->getList()->toArray() as $result) {
 			$ctr++;
-			foreach ($result->SearchHighlightsByField->Description_standard->getIterator() as $highlight) {
+			foreach($result->SearchHighlightsByField->Description_standard->getIterator() as $highlight) {
 				$snippet = $highlight->Snippet;
 				$snippet = strtolower($snippet);
 				$wordFound = false;
 				$lcquery = explode(' ', strtolower($query));
-				foreach ($lcquery as $part) {
+				foreach($lcquery as $part) {
 					$bracketed = '<strong class="hl">' . $part . '</strong>';
-					if (strpos($snippet, $bracketed) > 0) {
+					if(strpos($snippet, $bracketed) > 0) {
 						$wordFound = true;
 					}
 				}
@@ -240,17 +240,17 @@ 
 		$paginated = $es->search($query, $fields);
 		$ctr = 0;
 
-		foreach ($paginated->getList()->toArray() as $result) {
+		foreach($paginated->getList()->toArray() as $result) {
 			$ctr++;
 
-			foreach ($result->SearchHighlightsByField->Description->getIterator() as $highlight) {
+			foreach($result->SearchHighlightsByField->Description->getIterator() as $highlight) {
 				$snippet = $highlight->Snippet;
 				$snippet = strtolower($snippet);
 				$wordFound = false;
 				$lcquery = explode(' ', strtolower($query));
-				foreach ($lcquery as $part) {
+				foreach($lcquery as $part) {
 					$bracketed = '<strong class="hl">' . $part . '</strong>';
-					if (strpos($snippet, $bracketed) > 0) {
+					if(strpos($snippet, $bracketed) > 0) {
 						$wordFound = true;
 					}
 				}
@@ -267,7 +267,7 @@ 
 		$query = 'Lond';
 		$results = $es->autocomplete_search($query, 'Title');
 		$this->assertEquals(7, $results->getTotalItems());
-		foreach ($results->toArray() as $result) {
+		foreach($results->toArray() as $result) {
 			$this->assertTrue(strpos($result->Title, $query) > 0);
 		}
 	}
@@ -277,7 +277,7 @@ 
 		$results = $paginated->getList()->toArray();
 		$ctr = 0;
 		echo '$result = $paginated->getList()->toArray();' . "\n";
-		foreach ($results as $result) {
+		foreach($results as $result) {
 			echo '$this->assertEquals("' . $result->Title . '", $results[' . $ctr . ']->Title);' . "\n";
 			$ctr++;
 		}

tests/SearchableTest.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);

tests/TranslatableSearchableTest.php

Spacing +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 	public function setUp() {
 		// 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', 'FlickrSetTO');
 		$this->requireDefaultRecordsFrom = $classes;
 

src/SilverStripe/Elastica/ElasticaService.php

Doc Comments +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
 	 *
 	 * @param \Elastica\Query|string|array $query
 	 * @param string|array $types List of comma separated SilverStripe classes to search, or blank for all
-	 * @return \Elastica\ResultList
+	 * @return \Elastica\ResultSet
 	 */
 	public function search($query, $types = '') {
 		$query = Query::create($query); // may be a string

code/AutoCompleteOption.php

Spacing +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
 		parent::requireDefaultRecords();
 
 		$similar = AutoCompleteOption::get()->filter('Name', 'Similar')->first();
-		if (!$similar) {
+		if(!$similar) {
 			$similar = new AutoCompleteOption();
 			$similar->Name = 'Similar';
 			$similar->Slug = 'SIMILAR';
@@ -37,7 +37,7 @@ 
 		}
 
 		$search = AutoCompleteOption::get()->filter('Name', 'Search')->first();
-		if (!$search) {
+		if(!$search) {
 			$search = new AutoCompleteOption();
 			$search->Name = 'Search';
 			$search->Description = 'Find records similar to the selected item';
@@ -47,7 +47,7 @@ 
 		}
 
 		$goto = AutoCompleteOption::get()->filter('Name', 'GoToRecord')->first();
-		if (!$goto) {
+		if(!$goto) {
 			$goto = new AutoCompleteOption();
 			$goto->Name = 'GoToRecord';
 			$goto->Description = 'Go to the page of the selected item, found by the Link() method';

code/ElasticaAutoCompleteController.php

Spacing +5 added lines, -5 removed lines

@@ -20,24 +20,24 @@
 		// Makes most sense to only provide one field here, e.g. Title, Name
 		$field = $this->request->getVar('field');
 
-		error_log('QUERY:'.$query);
+		error_log('QUERY:' . $query);
 
 		// start, and page length, i.e. pagination
 		$es->setPageLength(10);
-		if ($classes) {
+		if($classes) {
 			$es->setClasses($classes);
 		}
 
-		if ($filter) {
+		if($filter) {
 			$es->addFilter('InSiteTree', true);
 		}
 
-		$resultList = $es->autocomplete_search($query,$field);
+		$resultList = $es->autocomplete_search($query, $field);
 		$result = array();
 		$result['Query'] = $query;
 		$suggestions = array();
 
-		foreach ($resultList->getResults() as $singleResult) {
+		foreach($resultList->getResults() as $singleResult) {
 			$suggestion = array('value' => $singleResult->Title);
 			$suggestion['data'] = array(
 				'ID' => $singleResult->getParam('_id'),

searchpage/ElasticSearchPage_Validator.php

Spacing +13 added lines, -13 removed lines

@@ -22,7 +22,7 @@ 
 		//return false;
 		//
 
-		if ($data['ClassesToSearch'] == array()) {
+		if($data['ClassesToSearch'] == array()) {
 			$data['ClassesToSearch'] = '';
 		}
 
@@ -30,8 +30,8 @@ 
 		echo "STDATA:$debug\n";
 
 		// Check if any classes to search if site tree only is not ticked
-		if (!$data['SiteTreeOnly']) {
-			if (!$data['ClassesToSearch']) {
+		if(!$data['SiteTreeOnly']) {
+			if(!$data['ClassesToSearch']) {
 				$valid = false;
 				$this->validationError("ClassesToSearch",
 					"Please provide at least one class to search, or select 'Site Tree Only'",
@@ -39,15 +39,15 @@ 
 				);
 			} else {
 				$toSearch = $data['ClassesToSearch'];
-				foreach ($toSearch as $clazz) {
+				foreach($toSearch as $clazz) {
 					try {
 						$instance = Injector::inst()->create($clazz);
-						if (!$instance->hasExtension('SilverStripe\Elastica\Searchable')) {
-							$this->validationError('ClassesToSearch', 'The class '.$clazz.' must have the Searchable extension');
+						if(!$instance->hasExtension('SilverStripe\Elastica\Searchable')) {
+							$this->validationError('ClassesToSearch', 'The class ' . $clazz . ' must have the Searchable extension');
 						}
 					} catch (ReflectionException $e) {
 						$this->validationError("ClassesToSearch",
-							'The class '.$clazz.' does not exist',
+							'The class ' . $clazz . ' does not exist',
 							'error'
 						);
 					}
@@ -58,23 +58,23 @@ 
 
 		// Check the identifier is unique
 		$mode = Versioned::get_reading_mode();
-		$suffix =  '';
-		if ($mode == 'Stage.Live') {
+		$suffix = '';
+		if($mode == 'Stage.Live') {
 			$suffix = '_Live';
 		}
-		$where = 'ElasticSearchPage'.$suffix.'.ID != '.$data['ID']." AND `Identifier` = '".$data['Identifier']."'";
+		$where = 'ElasticSearchPage' . $suffix . '.ID != ' . $data['ID'] . " AND `Identifier` = '" . $data['Identifier'] . "'";
 		$existing = ElasticSearchPage::get()->where($where)->count();
-		if ($existing > 0) {
+		if($existing > 0) {
 			$valid = false;
 			$this->validationError('Identifier',
-					'The identifier '.$data['Identifier'].' already exists',
+					'The identifier ' . $data['Identifier'] . ' already exists',
 					'error'
 			);
 		}
 
 
 		// Check number of results per page >= 1
-		if ($data['ResultsPerPage'] <= 0) {
+		if($data['ResultsPerPage'] <= 0) {
 			$valid = false;
 			$this->validationError('ResultsPerPage',
 				'Results per page must be >=1'