gordonbanderson / silverstripe-elastica

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/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/ElasticSearchPage_Validator_Test.php

Doc Comments +4 added lines

@@ -106,6 +106,10 @@
 	}
 
 
+	/**
+	 * @param string $fieldName
+	 * @param string $message
+	 */
 	private function checkForError($fieldName, $badValue, $message) {
 		$this->ElasticSearchPage->$fieldName = $badValue;
 

tests/ElasticsearchTestBase.php

Doc Comments +11 added lines

@@ -132,6 +132,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $depth
+	 * @param string $parentKey
+	 */
 	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
 		$prefix = str_repeat("\t",$depth);
 		echo "\t{$prefix}'$parentKey' => array(\n";
@@ -160,6 +164,10 @@ 
 	/*
 	Helper methods for testing CMS fields
 	 */
+
+	/**
+	 * @param string $tabName
+	 */
 	public function checkTabExists($fields, $tabName) {
 		echo "Searching for tab $tabName\n";
 		$tab = $fields->findOrMakeTab("Root.{$tabName}");
@@ -184,6 +192,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fieldName
+	 */
 	public function checkFieldExists($tab,$fieldName) {
 		$fields = $tab->Fields();
 		echo "TAB:{$tab->Name}\n";

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

src/SilverStripe/Elastica/QueryGenerator.php

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