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

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

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

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

src/SilverStripe/Elastica/ResultList.php

Doc Comments +3 added lines

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

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

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