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 $queryText 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($queryText, $fieldsToSearch = null,  $testMode = false) {
 		if ($this->locale == null) {
@@ -307,6 +311,10 @@ 
 
 
 	/* Perform an autocomplete search */
+
+	/**
+	 * @param string $queryText
+	 */
 	public function autocomplete_search($queryText, $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;
 	}

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($queryText, $fieldsToSearch = null,  $testMode = false) {
+	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();
@@ -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/ElasticaService.php

Indentation +41 added lines, -41 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,21 +164,21 @@ 
 		if ($query->MoreLikeThis) {
 			$path = $search->getPath();
 
-	        $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
@@ -194,14 +194,14 @@ 
 			}
 		}
 
-        if (!$empty($types)) {
-        	foreach($types as $type) {
-        		$search->addType($type);
-        	}
-        }
+		if (!$empty($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'];
@@ -269,14 +269,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;
 	}
 
 
@@ -350,11 +350,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;
 	}
 
 
@@ -525,11 +525,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;
 			}
@@ -683,15 +683,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'];
 	}
 
 }