gordonbanderson / silverstripe-elastica

tests/ElasticaServiceTest.php

Spacing +11 added lines, -11 removed lines

@@ -27,7 +27,7 @@ 
 			$this->invokeMethod($this->service, 'createIndex', array());
 			$this->assertFalse(true, "Creation of index with unknown locale should have failed");
 		} catch (Exception $e) {
-			$this->assertTrue(true,"Creation of index with unknown locale failed as expected");
+			$this->assertTrue(true, "Creation of index with unknown locale failed as expected");
 		}
 
 
@@ -116,7 +116,7 @@ 
 		$fp->write();
 		$this->service->getIndex()->refresh();
 
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart - 1);
 
 		$fp->ShowInSearch = true;
 		$fp->write();
@@ -134,7 +134,7 @@ 
 		$fp->doUnpublish();
 
 		$this->service->getIndex()->refresh();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart - 1);
 	}
 
 
@@ -146,7 +146,7 @@ 
 		$fp->delete();
 
 		$this->service->getIndex()->refresh();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart - 1);
 	}
 
 
@@ -158,7 +158,7 @@ 
 		$fp->delete();
 
 		$this->service->getIndex()->refresh();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart - 1);
 	}
 
 
@@ -177,7 +177,7 @@ 
 		//Check that the number of indexing requests has increased by 2
 		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
 		//One call is made for each of Page and FlickrPhotoTO
-		$this->assertEquals(2,$deltaReqs);
+		$this->assertEquals(2, $deltaReqs);
 
 		// default installed pages plus 100 FlickrPhotoTOs
 		$this->checkNumberOfIndexedDocuments(103);
@@ -195,21 +195,21 @@ 
 		$fp = new FlickrPhotoTO();
 		$fp->Title = 'The cat sits on the mat';
 		$fp->write();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart+1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart + 1);
 
 		$fp2 = new FlickrPhotoTO();
 		$fp2->Title = 'The cat sat on the hat';
 		$fp2->write();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart+2);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart + 2);
 
 		$fp3 = new FlickrPhotoTO();
 		$fp3->Title = 'The bat flew around the cat';
 		$fp3->write();
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart+3);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart + 3);
 
 		//Check that the number of indexing requests has increased by 3
 		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
-		$this->assertEquals(3,$deltaReqs);
+		$this->assertEquals(3, $deltaReqs);
 	}
 
 
@@ -283,6 +283,6 @@ 
 	public function testListIndexes() {
 		$message = 'This is a test trace';
 		$trace = $this->service->listIndexes($message);
-		$this->assertContains('elastica_ss_module_test_en_us', print_r($trace,1));
+		$this->assertContains('elastica_ss_module_test_en_us', print_r($trace, 1));
 	}
 }

tests/FindElasticaSearchPageExtensionTest.php

Spacing +5 added lines, -5 removed lines

@@ -25,11 +25,11 @@ 
 		// don't check the server name as this will differ, just check the path is /search/
 		$uri = $searchPage->SearchPageURI('testsearchpage');
 		$splits = explode('/', $uri);
-		$this->assertEquals($splits[3],'search');
+		$this->assertEquals($splits[3], 'search');
 
 		// check the form
 		$form = $searchPage->SearchPageForm('testsearchpage');
-		$this->assertInstanceOf('ElasticSearchForm',$form);
+		$this->assertInstanceOf('ElasticSearchForm', $form);
 
 		$fields = $form->Fields();
 		$actions = $form->Actions();
@@ -45,7 +45,7 @@ 
 	public function testButtonOverride() {
 		$searchPage = $this->objFromFixture('ElasticSearchPage', 'search');
 		$buttonText = 'Search Me!';
-		$form = $searchPage->SearchPageForm('testsearchpage',$buttonText);
+		$form = $searchPage->SearchPageForm('testsearchpage', $buttonText);
 		$actions = $form->Actions();
 		$this->assertEquals($buttonText, $actions->FieldByName('action_submit')->Title());
 	}
@@ -86,12 +86,12 @@ 
 		$esp = new ElasticSearchPage();
 		// ensure default identifier
 		$esp->Identifier = $searchPage->Identifier;
-		$esp->Title='This should not be saved';
+		$esp->Title = 'This should not be saved';
 		try {
 			$esp->write();
 			$this->assertFalse(true, 'Duplicate identifier was incorrectly saved');
 		} catch (Exception $e) {
-			$this->assertTrue(true,'The page could not be saved as expected, due to duplicate '.
+			$this->assertTrue(true, 'The page could not be saved as expected, due to duplicate ' .
 								'identifier');
 		}
 	}

src/SilverStripe/Elastica/ElasticaSearcher.php

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

Doc Comments +2 added lines, -1 removed lines

@@ -127,7 +127,7 @@ 
 
 	/**
 	 * Set the manipulator, mainly used for aggregation
-	 * @param ElasticaSearchHelper $newManipulator manipulator used for aggregation
+	 * @param string $newManipulator manipulator used for aggregation
 	 */
 	public function setQueryResultManipulator($newManipulator) {
 		$this->manipulator = $newManipulator;
@@ -199,6 +199,7 @@ 
 	/**
 	 * Set the maximum number of documents a term can reside in for consideration as
 	 * part of the input query
+	 * @param integer $newMaxDocFreq
 	 */
 	public function setMaxDocFreq($newMaxDocFreq) {
 		$this->maxDocFreq = $newMaxDocFreq;

Spacing +21 added lines, -21 removed lines

@@ -251,9 +251,9 @@ 
 	 *                              e.g. array('Title' => array('Weight' => 2, 'Type' => 'string'))
 	 * @return \PaginatedList    SilverStripe DataObjects returned from the search against ElasticSearch
 	 */
-	public function search($queryText, $fieldsToSearch = null,  $testMode = false) {
-		if ($this->locale == null) {
-			if (class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
+	public function search($queryText, $fieldsToSearch = null, $testMode = false) {
+		if($this->locale == null) {
+			if(class_exists('Translatable') && \SiteTree::has_extension('Translatable')) {
 				$this->locale = \Translatable::get_current_locale();
 			} else {
 				// if no translatable we only have the default locale
@@ -280,7 +280,7 @@ 
 		$elasticService = \Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
 		$elasticService->setLocale($this->locale);
 		$elasticService->setHighlightedFields($this->highlightedFields);
-		if ($testMode) {
+		if($testMode) {
 			$elasticService->setTestMode(true);
 		}
 		$resultList = new ResultList($elasticService, $query, $queryText, $this->filters);
@@ -305,7 +305,7 @@ 
 
 		$this->aggregations = $resultList->getAggregations();
 
-		if ($resultList->SuggestedQuery) {
+		if($resultList->SuggestedQuery) {
 			$this->SuggestedQuery = $resultList->SuggestedQuery;
 			$this->SuggestedQueryHighlighted = $resultList->SuggestedQueryHighlighted;
 		}
@@ -319,8 +319,8 @@ 
 	 * @param string $queryText
 	 */
 	public function autocomplete_search($queryText, $field) {
-		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 {
 				// if no translatable we only have the default locale
@@ -333,11 +333,11 @@ 
 
 		//only one field but must be array
 		$qg->setFields(array($field => 1));
-		if ($this->classes) {
+		if($this->classes) {
 			$qg->setClasses($this->classes);
 		}
 
-		if (!empty($this->filters)) {
+		if(!empty($this->filters)) {
 			$qg->setSelectedFilters($this->filters);
 		}
 
@@ -370,20 +370,20 @@ 
 	 * @return \PaginatedList  List of results
 	 */
 	public function moreLikeThis($indexedItem, $fieldsToSearch, $testMode = false) {
-		if ($indexedItem == null) {
+		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');
+		if(!$indexedItem->hasExtension('SilverStripe\Elastica\Searchable')) {
+			throw new \InvalidArgumentException('Objects of class ' . $indexedItem->ClassName . ' are not searchable');
 		}
 
-		if ($fieldsToSearch == null) {
+		if($fieldsToSearch == null) {
 			throw new \InvalidArgumentException('Fields cannot be null');
 		}
 
-		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 {
 				// if no translatable we only have the default locale
@@ -392,14 +392,14 @@ 
 		}
 
 		$weightedFieldsArray = array();
-		foreach ($fieldsToSearch as $field => $weighting) {
-			if (!is_string($field)) {
+		foreach($fieldsToSearch as $field => $weighting) {
+			if(!is_string($field)) {
 				throw new \InvalidArgumentException('Fields must be of the form fieldname => weight');
 			}
-			if (!is_numeric($weighting)) {
+			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);
 		}
@@ -430,7 +430,7 @@ 
 			'stop_words' => explode(',', $this->similarityStopWords)
 		);
 
-		if ($this->maxDocFreq > 0) {
+		if($this->maxDocFreq > 0) {
 			$mlt['max_doc_freq'] = $this->maxDocFreq;
 		}
 
@@ -442,7 +442,7 @@ 
 
         $elasticService = \Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
 		$elasticService->setLocale($this->locale);
-		if ($testMode) {
+		if($testMode) {
 			$elasticService->setTestMode(true);
 		}
 

src/SilverStripe/Elastica/RangedAggregation.php

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

src/SilverStripe/Elastica/indexing/GermanIndexSettings.php

Spacing +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 		$germanWithURLs = array(
 			'tokenizer' => 'uax_url_email',
 			//'filter' => array('english_possessive_stemmer', 'lowercase', 'english_stop', /*'english_keywords',*/ 'english_stemmer' ),
-			'filter' => array('no_single_chars', 'german_snowball', 'lowercase', 'german_stop' ),
+			'filter' => array('no_single_chars', 'german_snowball', 'lowercase', 'german_stop'),
 			'type' => 'custom'
 		);
 

src/SilverStripe/Elastica/indexing/BaseIndexSettings.php

Indentation +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
 			$analyzers['folded'] = $analyzerFolded;
 		}
 
-        //Store bigrams in the index, namely pairs of words
+		//Store bigrams in the index, namely pairs of words
 		$this->addFilter('filter_shingle', array(
 			'type' => 'shingle',
 			'min_shingle_size' => 2,

Spacing +6 added lines, -6 removed lines

@@ -86,9 +86,9 @@ 
 	 * @param array or string $newStopWords An array of stopwords or a CSV string of stopwords
 	 */
 	public function setStopwords($newStopWords) {
-		if (is_array($newStopWords)) {
+		if(is_array($newStopWords)) {
 			$this->stopWords = $newStopWords;
-		} else if (is_string($newStopWords)) {
+		} else if(is_string($newStopWords)) {
 			$this->stopWords = explode(',', $newStopWords);
 		} else {
 			throw new Exception("ERROR: Stopwords must be a string or an array");
@@ -177,10 +177,10 @@ 
 			'type' => 'nGram',
 			'min_gram' => 2,
 			'max_gram' => 20,
-			'token_chars' => array('letter', 'digit','punctuation', 'symbol')
+			'token_chars' => array('letter', 'digit', 'punctuation', 'symbol')
 		));
 
-		$this->addAnalyzer('autocomplete_index_analyzer',array(
+		$this->addAnalyzer('autocomplete_index_analyzer', array(
 			'type' => 'custom',
 			'tokenizer' => 'whitespace',
 			'filter' => array(
@@ -190,7 +190,7 @@ 
 			)
 		));
 
-		$this->addAnalyzer('autocomplete_search_analyzer',array(
+		$this->addAnalyzer('autocomplete_search_analyzer', array(
 			'type' => 'custom',
 			'tokenizer' => 'whitespace',
 			'filter' => array(
@@ -210,7 +210,7 @@ 
 		$this->analyzers['unstemmed'] = $analyzerNotStemmed;
 
 
-		if ($this->foldedAscii) {
+		if($this->foldedAscii) {
 			$analyzers['folded'] = $analyzerFolded;
 		}
 

src/SilverStripe/Elastica/indexing/EnglishIndexSettings.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 		$englishWithURLs = array(
 			'tokenizer' => 'uax_url_email',
 			//'filter' => array('english_possessive_stemmer', 'lowercase', 'english_stop', /*'english_keywords',*/ 'english_stemmer' ),
-			'filter' => array('no_single_chars', 'english_snowball', 'lowercase', $this->stopWordFilter ),
+			'filter' => array('no_single_chars', 'english_snowball', 'lowercase', $this->stopWordFilter),
 			'type' => 'custom'
 		);
 

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

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

@@ -202,16 +202,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;
 					}
 				}
@@ -231,17 +231,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;
 					}
 				}
@@ -258,7 +258,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);
 		}
 	}
@@ -268,7 +268,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++;
 		}