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

Spacing +6 added lines, -6 removed lines

@@ -26,7 +26,7 @@ 
 		$expected = array('first');
 		$this->assertEquals($expected, array_keys($terms['Title.standard']['terms']));
 
-		$expected = array('fi','fir','firs','first','ir','irs','irst','rs','rst','st');
+		$expected = array('fi', 'fir', 'firs', 'first', 'ir', 'irs', 'irst', 'rs', 'rst', 'st');
 		$this->assertEquals($expected, array_keys($terms['Title.autocomplete']['terms']));
 
 		// ---- now a parental class page ----
@@ -60,20 +60,20 @@ 
 		$terms = $page->getTermVectors();
 
 		//Check the expected fields are indexed
-		$expected = array('Content','Content.shingles','Content.standard','FatherText','FatherText.shingles','FatherText.standard',
-			'GrandFatherText','GrandFatherText.shingles','GrandFatherText.standard','Link','Title','Title.autocomplete',
-			'Title.shingles','Title.standard');
+		$expected = array('Content', 'Content.shingles', 'Content.standard', 'FatherText', 'FatherText.shingles', 'FatherText.standard',
+			'GrandFatherText', 'GrandFatherText.shingles', 'GrandFatherText.standard', 'Link', 'Title', 'Title.autocomplete',
+			'Title.shingles', 'Title.standard');
 		$indexedFields = array_keys($terms);
 		sort($indexedFields);
 		foreach ($indexedFields as $field) {
-			echo "'".$field."',";
+			echo "'" . $field . "',";
 		}
 		$this->assertEquals($expected, $indexedFields);
 
 		$fatherTerms = $terms['FatherText.standard']['terms'];
 		$grandFatherTerms = $terms['GrandFatherText.standard']['terms'];
 
-		$expected = array('father', 'field', 'grandfather', 'page', 'trace3');;
+		$expected = array('father', 'field', 'grandfather', 'page', 'trace3'); ;
 		$this->assertEquals($expected, array_keys($fatherTerms));
 
 		$expected = array('grandfather', 'page', 'trace4');

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

@@ -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(

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

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 	 * Execute the task to delete the currently configured index
 	 */
 	public function run($request) {
-		$message = function ($content) {
+		$message = function($content) {
 			print(\Director::is_cli() ? "$content\n" : "<p>$content</p>");
 		};
 

src/SilverStripe/Elastica/ReindexTask.php

Spacing +6 added lines, -6 removed lines

@@ -27,12 +27,12 @@ 
 	*/
 
 	public function run($request) {
-		$message = function ($content) {
+		$message = function($content) {
 			print(\Director::is_cli() ? "$content\n" : "<p>$content</p>");
 		};
 
 		$locales = array();
-		if(class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
+		if (class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
 			foreach (\Translatable::get_existing_content_languages('SiteTree') as $code => $val) {
 				array_push($locales, $code);
 			}
@@ -43,7 +43,7 @@ 
 		// now iterate all the locales indexing each locale in turn using it's owner index settings
 		foreach ($locales as $locale) {
 			Searchable::$index_ctr = 0;
-			$message('Indexing locale '.$locale);
+			$message('Indexing locale ' . $locale);
 
 			if (class_exists('Translatable')) {
 				\Translatable::set_current_locale($locale);
@@ -62,10 +62,10 @@ 
 			$this->service->refresh();
 			// display indexing speed stats
 			$endTime = microtime(true);
-			$elapsed = $endTime-$startTime;
+			$elapsed = $endTime - $startTime;
 			$perSecond = Searchable::$index_ctr / $elapsed;
-			$info = "\nReindexing $locale completed \n ".Searchable::$index_ctr." docs in ".round($elapsed,2)." seconds ";
-			$info .= "at ".round($perSecond,2)." documents per second\n\n";
+			$info = "\nReindexing $locale completed \n " . Searchable::$index_ctr . " docs in " . round($elapsed, 2) . " seconds ";
+			$info .= "at " . round($perSecond, 2) . " documents per second\n\n";
 			$message($info);
 		}