gordonbanderson / silverstripe-elastica

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

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'

src/SilverStripe/Elastica/FindElasticaSearchPageExtension.php

Spacing +5 added lines, -5 removed lines

@@ -12,7 +12,7 @@ 
 
 		$searchPage = $this->getSearchPage($identifier);
 
-		if ($searchPage) {
+		if($searchPage) {
 			$result = $searchPage->AbsoluteLink();
 		}
 		return $result;
@@ -24,7 +24,7 @@ 
 
 		$searchPage = $this->getSearchPage($identifier);
 
-		if ($searchPage) {
+		if($searchPage) {
 			$result = $searchPage->SearchForm($buttonTextOverride);
 		}
 		return $result;
@@ -32,7 +32,7 @@ 
 
 
 	public function getSearchPage($identifier) {
-		if (!isset($this->_CachedLastEdited)) {
+		if(!isset($this->_CachedLastEdited)) {
 			$this->_CachedLastEdited = ElasticSearchPage::get()->max('LastEdited');
 		}
 		$ck = $this->_CachedLastEdited;
@@ -42,10 +42,10 @@ 
 
 		$cache = SS_Cache::factory('searchpagecache');
 		$searchPage = null;
-		$cachekeyname = 'searchpageuri'.$identifier.$this->owner->Locale.$ck;
+		$cachekeyname = 'searchpageuri' . $identifier . $this->owner->Locale . $ck;
 
 		if(!($searchPage = unserialize($cache->load($cachekeyname)))) {
-			$searchPage = ElasticSearchPage::get()->filter('Identifier',$identifier)->first();
+			$searchPage = ElasticSearchPage::get()->filter('Identifier', $identifier)->first();
 			$cache->save(serialize($searchPage), $cachekeyname);
 		}
 		return $searchPage;

tests/SearchableFieldTest.php

Spacing +7 added lines, -7 removed lines

@@ -15,7 +15,7 @@ 
 
 		$fields = $sf->getCMSFields();
 
-		$tab = $this->checkTabExists($fields,'Main');
+		$tab = $this->checkTabExists($fields, 'Main');
 
 		//Check fields
 		$nf = $this->checkFieldExists($tab, 'Name');
@@ -33,8 +33,8 @@ 
 		$extraFields = array('Searchable' => 1, 'SimilarSearchable' => 1, 'Active' => 1,
 			'Weight' => 0);
 		$esfs = $searchPage->ElasticaSearchableFields();
-		foreach ($esfs as $sf) {
-			if ($sf->Name == 'Title' || $sf->Name == 'Description') {
+		foreach($esfs as $sf) {
+			if($sf->Name == 'Title' || $sf->Name == 'Description') {
 				$esfs->remove($sf);
 				$esfs->add($sf, $extraFields);
 			}
@@ -45,7 +45,7 @@ 
 			$this->fail('Searchable fail should have failed to write');
 		} catch (ValidationException $e) {
 			$this->assertInstanceOf('ValidationException', $e);
-			$expected = 'The field SearchableTestPage.Title has a zero weight. ; The field '.
+			$expected = 'The field SearchableTestPage.Title has a zero weight. ; The field ' .
 			'SiteTree.Title has a zero weight. ; The field Page.Title has a zero weight. ';
 			$this->assertEquals($expected, $e->getMessage());
 		}
@@ -64,8 +64,8 @@ 
 		$extraFields = array('Searchable' => 1, 'SimilarSearchable' => 1, 'Active' => 1,
 			'Weight' => -1);
 		$esfs = $searchPage->ElasticaSearchableFields();
-		foreach ($esfs as $sf) {
-			if ($sf->Name == 'Title' || $sf->Name == 'Description') {
+		foreach($esfs as $sf) {
+			if($sf->Name == 'Title' || $sf->Name == 'Description') {
 				$esfs->remove($sf);
 				$esfs->add($sf, $extraFields);
 			}
@@ -76,7 +76,7 @@ 
 			$this->fail('Searchable fail should have failed to write');
 		} catch (ValidationException $e) {
 			$this->assertInstanceOf('ValidationException', $e);
-			$expected = 'The field SearchableTestPage.Title has a negative weight. ; The field '.
+			$expected = 'The field SearchableTestPage.Title has a negative weight. ; The field ' .
 			'SiteTree.Title has a negative weight. ; The field Page.Title has a negative weight. ';
 			$this->assertEquals($expected, $e->getMessage());
 		}

searchpage/ElasticSearchPage_Controller.php

Spacing +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 			$this->checkForSimulatedServerDown();
 
 			// now actually perform the search using the original query
-			$paginated = $es->search($this->QueryText, $this->FieldsToSearch,$this->TestMode);
+			$paginated = $es->search($this->QueryText, $this->FieldsToSearch, $this->TestMode);
 
 			// This is the case of the original query having a better one suggested.  Do a
 			// second search for the suggested query, throwing away the original
@@ -319,7 +319,7 @@ 
 
 		// For a 'more like this' search, use the original unstemmed words
 		// This means using the .standard named field of text
-		if ($this->action == 'similar') {
+		if($this->action == 'similar') {
 			// Use the standard field for more like this, ie not stemmed
 			foreach($fieldsToSearch as $field => $value) {
 				$fieldsToSearch[$field . '.standard'] = $value;

src/SilverStripe/Elastica/SearchableHelper.php

Spacing +1 added lines, -1 removed lines

@@ -255,7 +255,7 @@
 
 	private function getFormatForDate($class) {
 		$format = 'y-M-d'; // default
-		switch ($class) {
+		switch($class) {
 			case 'Date':
 				$format = 'y-M-d';
 				break;

Doc Comments +7 added lines

@@ -45,6 +45,7 @@ 
 	 * @param string &$name
 	 * @param boolean $storeMethodName
 	 * @param boolean $recurse
+	 * @param string $name
 	 */
 	public static function assignSpecForRelationship(&$name, $resultType, &$spec, $storeMethodName, $recurse) {
 		$resultTypeInstance = \Injector::inst()->create($resultType);
@@ -161,6 +162,9 @@ 
 	}
 
 
+	/**
+	 * @param boolean $recurse
+	 */
 	public static function storeRelationshipValue($instance, $field, &$fields, $config, $recurse) {
 		if(isset($config['properties']['__method'])) {
 			$methodName = $config['properties']['__method'];
@@ -206,6 +210,9 @@ 
 	}
 
 
+	/**
+	 * @param \DataObject $searchableClass
+	 */
 	public static function findOrCreateSearchableField($className, $fieldName, $searchableField, $searchableClass) {
 		$filter = array('ClazzName' => $className, 'Name' => $fieldName);
 		$doSF = \SearchableField::get()->filter($filter)->first();

src/SilverStripe/Elastica/ElasticaService.php

Doc Comments +5 added lines, -1 removed lines

@@ -140,7 +140,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
@@ -244,6 +244,10 @@ 
 	}
 
 
+	/**
+	 * @param Query $elasticaQuery
+	 * @param Search $search
+	 */
 	private function checkForTermsMoreLikeThis($elasticaQuery, $search) {
 		if($elasticaQuery->MoreLikeThis) {