gordonbanderson / silverstripe-elastica

tests/AutocompleteControllerTest.php

Spacing +6 added lines, -6 removed lines

@@ -21,17 +21,17 @@ 
 
 		// Delete and assert that it does not exist
 		echo "Displaying searchable fields\n";
-		$sql =  "SELECT ID,Name,ClazzName from SearchableField";
+		$sql = "SELECT ID,Name,ClazzName from SearchableField";
 		$records = DB::query($sql);
-		foreach ($records as $record) {
+		foreach($records as $record) {
 			print_r($record);
 		}
 
 		$filter = array('Name' => 'Title', 'ClazzName' => 'FlickrPhotoTO');
 		$sf = SearchableField::get()->filter($filter)->first();
 		print_r($sf);
-		$sql = "UPDATE ElasticSearchPage_ElasticaSearchableFields SET Searchable=1,".
-				"EnableAutocomplete=1 where SearchableFieldID=".$sf->ID;
+		$sql = "UPDATE ElasticSearchPage_ElasticaSearchableFields SET Searchable=1," .
+				"EnableAutocomplete=1 where SearchableFieldID=" . $sf->ID;
 		echo $sql;
 
 		DB::query($sql);
@@ -56,7 +56,7 @@ 
 
 		$this->assertEquals('the', $result->Query);
 		$lquery = strtolower($result->Query);
-		foreach ($result->suggestions as $suggestion) {
+		foreach($result->suggestions as $suggestion) {
 			$value = $suggestion->value;
 			$value = strtolower($value);
 			$this->assertContains($lquery, $value);
@@ -110,7 +110,7 @@ 
 
 		$this->assertEquals('the', $result->Query);
 		$lquery = strtolower($result->Query);
-		foreach ($result->suggestions as $suggestion) {
+		foreach($result->suggestions as $suggestion) {
 			$value = $suggestion->value;
 			$value = strtolower($value);
 			$this->assertContains($lquery, $value);

tests/ElasticSearchPageTest.php

Spacing +28 added lines, -28 removed lines

@@ -13,15 +13,15 @@ 
 
 		$fields = $searchPage->getCMSFields();
 
-		$mainTab = $this->checkTabExists($fields,'Main');
+		$mainTab = $this->checkTabExists($fields, 'Main');
 		$this->checkFieldExists($mainTab, 'Identifier');
 		$this->checkFieldExists($mainTab, 'ContentForEmptySearch');
 
-		$searchTab = $this->checkTabExists($fields,'Search.SearchFor');
-		$fieldsTab = $this->checkTabExists($fields,'Search.Fields');
-		$autoCompleteTab = $this->checkTabExists($fields,'Search.AutoComplete');
-		$aggTab = $this->checkTabExists($fields,'Search.Aggregations');
-		$simTab = $this->checkTabExists($fields,'Search.Similarity');
+		$searchTab = $this->checkTabExists($fields, 'Search.SearchFor');
+		$fieldsTab = $this->checkTabExists($fields, 'Search.Fields');
+		$autoCompleteTab = $this->checkTabExists($fields, 'Search.AutoComplete');
+		$aggTab = $this->checkTabExists($fields, 'Search.Aggregations');
+		$simTab = $this->checkTabExists($fields, 'Search.Similarity');
 
 		$this->checkFieldExists($searchTab, 'InfoField');
 		$this->checkFieldExists($searchTab, 'SiteTreeOnly');
@@ -49,7 +49,7 @@ 
 		$tab = $fields->findOrMakeTab("Root.Search.Fields");
 		$fieldsTab = $tab->Fields();
 
-		foreach ($fieldsTab as $field) {
+		foreach($fieldsTab as $field) {
 			echo "FIELD:{$field->getName()}\n";
 		}
 
@@ -58,7 +58,7 @@ 
 		$gridDetailForm = $pickerConfig->getComponentByType('GridFieldDetailForm');
 
 		echo "SEARCHABLE FIELDS\n";
-		foreach ($searchPage->ElasticaSearchableFields()->getIterator() as $sf) {
+		foreach($searchPage->ElasticaSearchableFields()->getIterator() as $sf) {
 			echo "SEARCHABLE FIELD {$sf->ClazzName},{$sf->Name}!\n";
 
 		}
@@ -185,7 +185,7 @@ 
 		$pageLength = 10; // the default
 		$searchPageObj->ResultsPerPage = $pageLength;
 		$searchPageObj->write();
-		$searchPageObj->publish('Stage','Live');
+		$searchPageObj->publish('Stage', 'Live');
 
 		$form = $searchPageObj->SearchForm();
 		$fields = $form->Fields();
@@ -317,11 +317,11 @@ 
 		$filter = array('ClazzName' => 'FlickrPhotoTO', 'Name' => 'Title');
 
 		//Check fieldnames as expected
-		$searchableFields = $searchPage->ElasticaSearchableFields()->filter('Active',1);
+		$searchableFields = $searchPage->ElasticaSearchableFields()->filter('Active', 1);
 		$sfs = $searchableFields->map('Name')->toArray();
 		sort($sfs);
-		$expected = array('Aperture','AspectRatio','Description','FirstViewed','FlickrID',
-			'FlickrSetTOs','FlickrTagTOs','FocalLength35mm','ISO','Photographer','ShutterSpeed',
+		$expected = array('Aperture', 'AspectRatio', 'Description', 'FirstViewed', 'FlickrID',
+			'FlickrSetTOs', 'FlickrTagTOs', 'FocalLength35mm', 'ISO', 'Photographer', 'ShutterSpeed',
 			'TakenAt', 'TakenAtDT', 'TestMethod', 'TestMethodHTML', 'Title');
 		$this->assertEquals($expected, $sfs);
 
@@ -331,7 +331,7 @@ 
 		$searchPage->Title = '**** SiteTree Search ****';
 		$searchPage->write();
 
-		$searchableFields = $searchPage->ElasticaSearchableFields()->filter('Active',1);
+		$searchableFields = $searchPage->ElasticaSearchableFields()->filter('Active', 1);
 		$sfs = $searchableFields->map('Name')->toArray();
 		sort($sfs);
 		$expected = array('Content', 'Country', 'PageDate', 'Title');
@@ -351,15 +351,15 @@ 
 		// expected mapping of searchable classes to searchable fields that will be
 		// stored in the database as SearchableClass and SearchableField
 		$expected = array(
-			'Page' => array('Title','Content'),
-			'SiteTree' => array('Title','Content'),
-			'SearchableTestPage' => array('Title','Content','Country','PageDate'),
+			'Page' => array('Title', 'Content'),
+			'SiteTree' => array('Title', 'Content'),
+			'SearchableTestPage' => array('Title', 'Content', 'Country', 'PageDate'),
 			'FlickrTagTO' => array('RawValue'),
-			'FlickrAuthorTO' => array('PathAlias','DisplayName','FlickrPhotoTOs'),
-			'FlickrPhotoTO' => array('Title','FlickrID','Description','TakenAt', 'TakenAtDT', 'Aperture',
-				'ShutterSpeed','FocalLength35mm','ISO','Photographer','FlickrTagTOs','FlickrSetTOs',
-				'FirstViewed','AspectRatio', 'TestMethod', 'TestMethodHTML'),
-			'FlickrSetTO' => array('Title','FlickrID','Description')
+			'FlickrAuthorTO' => array('PathAlias', 'DisplayName', 'FlickrPhotoTOs'),
+			'FlickrPhotoTO' => array('Title', 'FlickrID', 'Description', 'TakenAt', 'TakenAtDT', 'Aperture',
+				'ShutterSpeed', 'FocalLength35mm', 'ISO', 'Photographer', 'FlickrTagTOs', 'FlickrSetTOs',
+				'FirstViewed', 'AspectRatio', 'TestMethod', 'TestMethodHTML'),
+			'FlickrSetTO' => array('Title', 'FlickrID', 'Description')
 		);
 
 		// check the expected classes
@@ -380,21 +380,21 @@ 
 		// check the names expected to appear
 
 		$fieldCtr = 0;
-		foreach ($expectedClasses as $expectedClass) {
+		foreach($expectedClasses as $expectedClass) {
 			$expectedFields = array();
 			$sc = SearchableClass::get()->filter('Name', $expectedClass)->first();
-			$this->assertEquals($expectedClass,$sc->Name);
+			$this->assertEquals($expectedClass, $sc->Name);
 
 			$inSiteTree = 1;
-			$start = substr($expectedClass, 0,6);
-			if ($start == 'Flickr') {
+			$start = substr($expectedClass, 0, 6);
+			if($start == 'Flickr') {
 				$inSiteTree = 0;
 			};
-			$this->assertEquals($inSiteTree,$sc->InSiteTree);
+			$this->assertEquals($inSiteTree, $sc->InSiteTree);
 
 			$expectedNames = $expected[$expectedClass];
-			foreach ($expectedNames as $expectedName) {
-				$filter = array('Name' => $expectedName, 'SearchableClassID' => $sc->ID );
+			foreach($expectedNames as $expectedName) {
+				$filter = array('Name' => $expectedName, 'SearchableClassID' => $sc->ID);
 				$sf = SearchableField::get()->filter($filter)->first();
 				$this->assertEquals($expectedName, $sf->Name);
 				$fieldCtr++;

tests/InheritanceTest.php

Spacing +7 added lines, -7 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."',";
+		foreach($indexedFields as $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/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) {