gordonbanderson / silverstripe-elastica

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

src/SilverStripe/Elastica/Searchable.php

Spacing +1 added lines, -1 removed lines

@@ -483,7 +483,7 @@
 	public function updateCMSFields(\FieldList $fields) {
 		$isIndexed = false;
 		// SIteTree object must have a live record, ShowInSearch = true
-		if (\DB::getConn()->hasTable($this->owner->ClassName)) {
+		if(\DB::getConn()->hasTable($this->owner->ClassName)) {
 			if(SearchableHelper::isInSiteTree($this->owner->ClassName)) {
 				$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
 					byID($this->owner->ID);

tests/AutocompleteControllerTest.php

Spacing +4 added lines, -4 removed lines

@@ -18,13 +18,13 @@ 
 
 
 		// Delete and assert that it does not exist
-		$sql =  "SELECT ID,Name,ClazzName from SearchableField";
+		$sql = "SELECT ID,Name,ClazzName from SearchableField";
 		$records = DB::query($sql);
 
 		$filter = array('Name' => 'Title', 'ClazzName' => 'FlickrPhotoTO');
 		$sf = SearchableField::get()->filter($filter)->first();
-		$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;
 
 		DB::query($sql);
 
@@ -45,7 +45,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/AutocompleteFilteredControllerTest.php

Spacing +4 added lines, -4 removed lines

@@ -18,13 +18,13 @@ 
 
 
 		// Delete and assert that it does not exist
-		$sql =  "SELECT ID,Name,ClazzName from SearchableField";
+		$sql = "SELECT ID,Name,ClazzName from SearchableField";
 		$records = DB::query($sql);
 
 		$filter = array('Name' => 'Title', 'ClazzName' => 'FlickrPhotoTO');
 		$sf = SearchableField::get()->filter($filter)->first();
-		$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;
 
 		DB::query($sql);
 
@@ -43,7 +43,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/ElasticSearchPageControllerTest.php

Indentation +19 added lines, -19 removed lines

@@ -74,10 +74,10 @@ 
 		$this->assertEquals(200, $searchPage->getStatusCode());
 		$url = rtrim($url, '/');
 
-        $response = $this->get($url);
-        $this->assertEquals(200, $response->getStatusCode());
+		$response = $this->get($url);
+		$this->assertEquals(200, $response->getStatusCode());
 
-        $this->assertSelectorStartsWithOrEquals('span.count', 0, '(5)');
+		$this->assertSelectorStartsWithOrEquals('span.count', 0, '(5)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 1, '(11)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 2, '(12)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 3, '(13)');
@@ -127,10 +127,10 @@ 
 		$url = rtrim($url, '/');
 		$url .= '?ISO=400';
 
-        $response = $this->get($url);
-        $this->assertEquals(200, $response->getStatusCode());
+		$response = $this->get($url);
+		$this->assertEquals(200, $response->getStatusCode());
 
-        // These are less than in the no facets selected case, as expected
+		// These are less than in the no facets selected case, as expected
 		$this->assertSelectorStartsWithOrEquals('span.count', 0, '(2)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 1, '(1)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 2, '(2)');
@@ -174,11 +174,11 @@ 
 		$url = rtrim($url, '/');
 		$url .= '?ISO=400&ShutterSpeed=2%2F250';
 
-        $response = $this->get($url);
-        $this->assertEquals(200, $response->getStatusCode());
+		$response = $this->get($url);
+		$this->assertEquals(200, $response->getStatusCode());
 
-        // These are less than in the one facet selected case, as expected
-        $this->assertSelectorStartsWithOrEquals('span.count', 0, '(1)');
+		// These are less than in the one facet selected case, as expected
+		$this->assertSelectorStartsWithOrEquals('span.count', 0, '(1)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 1, '(2)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 2, '(1)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 3, '(1)');
@@ -207,11 +207,11 @@ 
 		$url = rtrim($url, '/');
 		$url .= '?ISO=400&ShutterSpeed=2%2F250&Aspect=Vertical';
 
-        $response = $this->get($url);
-        $this->assertEquals(200, $response->getStatusCode());
+		$response = $this->get($url);
+		$this->assertEquals(200, $response->getStatusCode());
 
-        // These are less than in the one facet selected case, as expected
-        $this->assertSelectorStartsWithOrEquals('span.count', 0, '(2)');
+		// These are less than in the one facet selected case, as expected
+		$this->assertSelectorStartsWithOrEquals('span.count', 0, '(2)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 1, '(1)');
 		$this->assertSelectorStartsWithOrEquals('span.count', 2, '(1)');
 	}
@@ -545,13 +545,13 @@ 
 		$searchPage = $this->get($searchPageObj->URLSegment);
 		$this->assertEquals(200, $searchPage->getStatusCode());
 
-        $response = $this->submitForm("ElasticSearchForm_SearchForm", null, array(
-            'q' => 'New Zealand'
-        ));
+		$response = $this->submitForm("ElasticSearchForm_SearchForm", null, array(
+			'q' => 'New Zealand'
+		));
 
 		$url = rtrim($url, '/');
-        $this->assertEquals(302, $response->getStatusCode());
-        $this->assertEquals($url . '?q=New Zealand&sfid=testwithagg', $response->getHeader('Location'));
+		$this->assertEquals(302, $response->getStatusCode());
+		$this->assertEquals($url . '?q=New Zealand&sfid=testwithagg', $response->getHeader('Location'));
 	}
 
 

Spacing +6 added lines, -6 removed lines

@@ -246,7 +246,7 @@ 
 	public function testQueryInSearchBoxForOneFormOnly() {
 		$searchPageObj = $this->ElasticSearchPage2;
 		$url = rtrim($searchPageObj->Link(), '/');
-		$url .= "?q=Auckland&sfid=".$searchPageObj->Identifier;
+		$url .= "?q=Auckland&sfid=" . $searchPageObj->Identifier;
 		$response = $this->get($url);
 		$this->assertEquals(200, $response->getStatusCode());
 		$this->assertAttributeHasExactValue('#ElasticSearchForm_SearchForm_q', 'q',
@@ -504,7 +504,7 @@ 
 		//Note pages need to be published, by default fixtures only reside in Stage
 		$searchPageObj = $this->ElasticSearchPage2;
 		$url = rtrim($searchPageObj->Link(), '/');
-		$url = $url.'?q='.$searchTerm;
+		$url = $url . '?q=' . $searchTerm;
 		$response = $this->get($url);
 		$this->assertEquals(200, $response->getStatusCode());
 
@@ -571,7 +571,7 @@ 
 		//Note pages need to be published, by default fixtures only reside in Stage
 		$searchPageObj = $this->ElasticSearchPage;
 		$url = rtrim($searchPageObj->Link(), '/');
-		$url = $url.'?q='.$searchTerm;
+		$url = $url . '?q=' . $searchTerm;
 		$response = $this->get($url);
 		$this->assertEquals(200, $response->getStatusCode());
 
@@ -702,18 +702,18 @@ 
 		//increase the number of results and assert that they are the same as per pages 1,2 joined
 		$searchPageObj->ResultsPerPage = 20;
 		$searchPageObj->write();
-		$searchPageObj->publish('Stage','Live');
+		$searchPageObj->publish('Stage', 'Live');
 		$response3 = $this->get($firstPageURL);
 	}
 
 
 	private function enableHighlights() {
-		foreach (SearchableField::get()->filter('Name', 'Title') as $sf) {
+		foreach(SearchableField::get()->filter('Name', 'Title') as $sf) {
 			$sf->ShowHighlights = true;
 			$sf->write();
 		}
 
-		foreach (SearchableField::get()->filter('Name', 'Content') as $sf) {
+		foreach(SearchableField::get()->filter('Name', 'Content') as $sf) {
 			$sf->ShowHighlights = true;
 			$sf->write();
 		}

tests/ElasticSearchPageTest.php

Spacing +26 added lines, -26 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');
@@ -176,7 +176,7 @@ 
 		$pageLength = 10; // the default
 		$searchPageObj->ResultsPerPage = $pageLength;
 		$searchPageObj->write();
-		$searchPageObj->publish('Stage','Live');
+		$searchPageObj->publish('Stage', 'Live');
 
 		$form = $searchPageObj->SearchForm();
 		$fields = $form->Fields();
@@ -306,11 +306,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);
 
@@ -320,7 +320,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');
@@ -340,15 +340,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
@@ -369,21 +369,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 +5 added lines, -5 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 ----
@@ -50,9 +50,9 @@ 
 		$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);
 
@@ -61,7 +61,7 @@ 
 		$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/TranslatableSearchableTest.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	public function setUpOnce() {
 		//Add translatable if it exists
-		if (class_exists('Translatable')) {
+		if(class_exists('Translatable')) {
 			SiteTree::add_extension('Translatable');
 		}
 		parent::setUpOnce();