gordonbanderson / silverstripe-elastica

src/SilverStripe/Elastica/Searchable.php

Indentation +41 added lines, -41 removed lines

@@ -340,10 +340,10 @@ 
 
 
 	/**
-	* Get an elasticsearch document
-	*
-	* @return \Elastica\Document
-	*/
+	 * Get an elasticsearch document
+	 *
+	 * @return \Elastica\Document
+	 */
 	public function getElasticaDocument() {
 		self::$index_ctr++;
 		$fields = $this->getFieldValuesAsArray();
@@ -754,7 +754,7 @@ 
 	}
 
 
-    public function updateCMSFields(\FieldList $fields) {
+	public function updateCMSFields(\FieldList $fields) {
 		$isIndexed = false;
 		// SIteTree object must have a live record, ShowInSearch = true
 		if ($this->isInSiteTree($this->owner->ClassName)) {
@@ -781,47 +781,47 @@ 
 				$terms = new \ArrayList();
 
 				foreach (array_keys($termVectors[$field]['terms']) as $term) {
-		        	$do = new \DataObject();
-			        $do->Term = $term;
-			        $stats = $termVectors[$field]['terms'][$term];
-			        if (isset($stats['ttf'])) {
-			        	$do->TTF = $stats['ttf'];
-			        }
-
-			        if (isset($stats['doc_freq'])) {
-			        	$do->DocFreq = $stats['doc_freq'];
-			        }
-
-			        if (isset($stats['term_freq'])) {
-			        	$do->TermFreq = $stats['term_freq'];
-			        }
-			        $terms->push($do);
-		        }
-
-		        $config = \GridFieldConfig_RecordViewer::create(100);
+					$do = new \DataObject();
+					$do->Term = $term;
+					$stats = $termVectors[$field]['terms'][$term];
+					if (isset($stats['ttf'])) {
+						$do->TTF = $stats['ttf'];
+					}
+
+					if (isset($stats['doc_freq'])) {
+						$do->DocFreq = $stats['doc_freq'];
+					}
+
+					if (isset($stats['term_freq'])) {
+						$do->TermFreq = $stats['term_freq'];
+					}
+					$terms->push($do);
+				}
+
+				$config = \GridFieldConfig_RecordViewer::create(100);
 				$config->getComponentByType('GridFieldDataColumns')->setDisplayFields(array(
-		            'Term' => 'Term',
-		            'TTF' => 'Total term frequency (how often a term occurs in all documents)',
-		            'DocFreq' => 'n documents with this term',
-		            'TermFreq'=> 'n times this term appears in this field'
-		        ));
-
-		       $underscored = str_replace('.', '_', $field);
-
-		        $gridField = new \GridField(
-		            'TermsFor'.$underscored, // Field name
-		            $field.'TITLE'.$field, // Field title
-		            $terms,
-		            $config
-		        );
-
-		      // $tab = new \Tab($field, new \TextField('Test'.$field, 'Testing'));
-		       $fields->addFieldToTab('Root.ElasticaTerms.'.$underscored, $gridField);
+					'Term' => 'Term',
+					'TTF' => 'Total term frequency (how often a term occurs in all documents)',
+					'DocFreq' => 'n documents with this term',
+					'TermFreq'=> 'n times this term appears in this field'
+				));
+
+			   $underscored = str_replace('.', '_', $field);
+
+				$gridField = new \GridField(
+					'TermsFor'.$underscored, // Field name
+					$field.'TITLE'.$field, // Field title
+					$terms,
+					$config
+				);
+
+			  // $tab = new \Tab($field, new \TextField('Test'.$field, 'Testing'));
+			   $fields->addFieldToTab('Root.ElasticaTerms.'.$underscored, $gridField);
 			}
 
 		}
 
-	    return $fields;
+		return $fields;
 	}
 
 

Braces +11 added lines, -6 removed lines

@@ -555,8 +555,7 @@ 
 				// this goes to elastica service
 				$this->service->remove($this->owner);
 			}
-		}
-		catch(\Elastica\Exception\NotFoundException $e) {
+		} catch(\Elastica\Exception\NotFoundException $e) {
 			trigger_error("Deleted document ".$this->owner->ClassName." (".$this->owner->ID.
 				") not found in search index.", E_USER_NOTICE);
 		}
@@ -574,7 +573,9 @@ 
 		$fields = \Config::inst()->get(get_class($this->owner), 'searchable_fields');
 
 		// fallback to default method
-		if(!$fields) user_error('The field $searchable_fields must be set for the class '.$this->owner->ClassName);
+		if(!$fields) {
+			user_error('The field $searchable_fields must be set for the class '.$this->owner->ClassName);
+		}
 
 		// get the values of these fields
 		$elasticaMapping = $this->fieldsToElasticaConfig($this->owner, $fields);
@@ -595,7 +596,9 @@ 
 
 						$relClass = $has_lists[$methodName];
 						$fields = \Config::inst()->get($relClass, 'searchable_fields');
-						if(!$fields) user_error('The field $searchable_fields must be set for the class '.$relClass);
+						if(!$fields) {
+							user_error('The field $searchable_fields must be set for the class '.$relClass);
+						}
 						$rewrite = $this->fieldsToElasticaConfig($relClass, $fields);
 
 						// mark as a method, the resultant fields are correct
@@ -605,7 +608,9 @@ 
 					} else if (isset($has_ones[$methodName])) {
 						$relClass = $has_ones[$methodName];
 						$fields = \Config::inst()->get($relClass, 'searchable_fields');
-						if(!$fields) user_error('The field $searchable_fields must be set for the class '.$relClass);
+						if(!$fields) {
+							user_error('The field $searchable_fields must be set for the class '.$relClass);
+						}
 						$rewrite = $this->fieldsToElasticaConfig($relClass, $fields);
 						$classname = $has_ones[$methodName];
 
@@ -687,7 +692,7 @@ 
 
 				if (isset($searchableField['type'])) {
 					$doSF->Type = $searchableField['type'];
-				}  else {
+				} else {
 					$doSF->Name = $searchableField['properties']['__method'];
 					$doSF->Type = 'relationship';
 				}

Spacing +21 added lines, -21 removed lines

@@ -312,12 +312,12 @@ 
 
 		if (isset($_GET['progress'])) {
 			$progress = $_GET['progress'];
-			self::$progressInterval = (int) $progress;
+			self::$progressInterval = (int)$progress;
 		}
 
 		if (self::$progressInterval > 0) {
 			if (self::$index_ctr % self::$progressInterval === 0) {
-				ElasticaUtil::message("\t".$this->owner->ClassName." - Prepared ".self::$index_ctr." for indexing...");
+				ElasticaUtil::message("\t" . $this->owner->ClassName . " - Prepared " . self::$index_ctr . " for indexing...");
 			}
 		}
 
@@ -508,14 +508,14 @@ 
 	 * Removes the record from the search index.
 	 */
 	protected function doDeleteDocument() {
-		try{
+		try {
 			if (!$this->owner->IndexingOff) {
 				// this goes to elastica service
 				$this->service->remove($this->owner);
 			}
 		}
-		catch(\Elastica\Exception\NotFoundException $e) {
-			trigger_error("Deleted document ".$this->owner->ClassName." (".$this->owner->ID.
+		catch (\Elastica\Exception\NotFoundException $e) {
+			trigger_error("Deleted document " . $this->owner->ClassName . " (" . $this->owner->ID .
 				") not found in search index.", E_USER_NOTICE);
 		}
 
@@ -532,7 +532,7 @@ 
 		$fields = \Config::inst()->get(get_class($this->owner), 'searchable_fields');
 
 		// fallback to default method
-		if(!$fields) user_error('The field $searchable_fields must be set for the class '.$this->owner->ClassName);
+		if (!$fields) user_error('The field $searchable_fields must be set for the class ' . $this->owner->ClassName);
 
 		// get the values of these fields
 		$elasticaMapping = $this->fieldsToElasticaConfig($this->owner, $fields);
@@ -553,24 +553,24 @@ 
 
 						$relClass = $has_lists[$methodName];
 						$fields = \Config::inst()->get($relClass, 'searchable_fields');
-						if(!$fields) user_error('The field $searchable_fields must be set for the class '.$relClass);
+						if (!$fields) user_error('The field $searchable_fields must be set for the class ' . $relClass);
 						$rewrite = $this->fieldsToElasticaConfig($relClass, $fields);
 
 						// mark as a method, the resultant fields are correct
-						$elasticaMapping[$methodName.'()'] = $rewrite;
+						$elasticaMapping[$methodName . '()'] = $rewrite;
 
 
 					} else if (isset($has_ones[$methodName])) {
 						$relClass = $has_ones[$methodName];
 						$fields = \Config::inst()->get($relClass, 'searchable_fields');
-						if(!$fields) user_error('The field $searchable_fields must be set for the class '.$relClass);
+						if (!$fields) user_error('The field $searchable_fields must be set for the class ' . $relClass);
 						$rewrite = $this->fieldsToElasticaConfig($relClass, $fields);
 						$classname = $has_ones[$methodName];
 
 						// mark as a method, the resultant fields are correct
-						$elasticaMapping[$methodName.'()'] = $rewrite;
+						$elasticaMapping[$methodName . '()'] = $rewrite;
 					} else {
-						user_error('The method '.$methodName.' not found in class '.$this->owner->ClassName.
+						user_error('The method ' . $methodName . ' not found in class ' . $this->owner->ClassName .
 								', please check configuration');
 					}
 				}
@@ -587,14 +587,14 @@ 
 	private function fieldsToElasticaConfig($objectInContext, $fields) {
 		// Copied from DataObject::searchableFields() as there is no separate accessible method
 		$rewrite = array();
-		foreach($fields as $name => $specOrName) {
+		foreach ($fields as $name => $specOrName) {
 			$identifer = (is_int($name)) ? $specOrName : $name;
 			$rewrite[$identifer] = array();
-			if(!isset($rewrite[$identifer]['title'])) {
+			if (!isset($rewrite[$identifer]['title'])) {
 				$rewrite[$identifer]['title'] = (isset($labels[$identifer]))
 					? $labels[$identifer] : \FormField::name_to_label($identifer);
 			}
-			if(!isset($rewrite[$identifer]['filter'])) {
+			if (!isset($rewrite[$identifer]['filter'])) {
 				$rewrite[$identifer]['filter'] = 'PartialMatchFilter';
 			}
 		}
@@ -606,7 +606,7 @@ 
 	public function requireDefaultRecords() {
 		parent::requireDefaultRecords();
 
-		$searchableFields = $this->getElasticaFields(true,true);
+		$searchableFields = $this->getElasticaFields(true, true);
 
 
 		$doSC = \SearchableClass::get()->filter(array('Name' => $this->owner->ClassName))->first();
@@ -639,7 +639,7 @@ 
 
 				if (isset($searchableField['type'])) {
 					$doSF->Type = $searchableField['type'];
-				}  else {
+				} else {
 					$doSF->Name = $searchableField['properties']['__method'];
 					$doSF->Type = 'relationship';
 				}
@@ -650,7 +650,7 @@ 
 				}
 
 				$doSF->write();
-				\DB::alteration_message("Created new searchable editable field ".$name,"changed");
+				\DB::alteration_message("Created new searchable editable field " . $name, "changed");
 			}
 
 			// FIXME deal with deletions
@@ -695,7 +695,7 @@ 
 	 */
 	public function RenderResult($linkToContainer = '') {
 		$vars = new \ArrayData(array('SearchResult' => $this->owner, 'ContainerLink' => $linkToContainer));
-		$possibleTemplates = array($this->owner->ClassName.'ElasticSearchResult', 'ElasticSearchResult');
+		$possibleTemplates = array($this->owner->ClassName . 'ElasticSearchResult', 'ElasticSearchResult');
 		return $this->owner->customise($vars)->renderWith($possibleTemplates);
 	}
 
@@ -761,14 +761,14 @@ 
 		       $underscored = str_replace('.', '_', $field);
 
 		        $gridField = new \GridField(
-		            'TermsFor'.$underscored, // Field name
-		            $field.'TITLE'.$field, // Field title
+		            'TermsFor' . $underscored, // Field name
+		            $field . 'TITLE' . $field, // Field title
 		            $terms,
 		            $config
 		        );
 
 		      // $tab = new \Tab($field, new \TextField('Test'.$field, 'Testing'));
-		       $fields->addFieldToTab('Root.ElasticaTerms.'.$underscored, $gridField);
+		       $fields->addFieldToTab('Root.ElasticaTerms.' . $underscored, $gridField);
 			}
 
 		}

src/SilverStripe/Elastica/ElasticaService.php

Spacing +23 added lines, -23 removed lines

@@ -121,7 +121,7 @@ 
 	}
 
 	private function getLocaleIndexName() {
-		$name = $this->indexName.'-'.$this->locale;
+		$name = $this->indexName . '-' . $this->locale;
 		$name = strtolower($name);
 		$name = str_replace('-', '_', $name);
 		return $name;
@@ -152,7 +152,7 @@ 
 		$search = new Search(new Client());
 
 		if ($this->test_mode) {
-			$search->setOption('search_type',Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH);
+			$search->setOption('search_type', Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH);
 		}
 
 
@@ -197,7 +197,7 @@ 
 		}
 
         if ($types) {
-        	foreach($types as $type) {
+        	foreach ($types as $type) {
         		$search->addType($type);
         	}
         }
@@ -265,7 +265,7 @@ 
 		//$search = new Search(new Client());
 		$search->addIndex($this->getLocaleIndexName());
 		if ($types) {
-			foreach($types as $type) {
+			foreach ($types as $type) {
 				$search->addType($type);
 			}
 		}
@@ -352,9 +352,9 @@ 
 
 	public function listIndexes($trace) {
 		$command = "curl 'localhost:9200/_cat/indices?v'";
-        exec($command,$op);
+        exec($command, $op);
         ElasticaUtil::message("\n++++ $trace ++++\n");
-        ElasticaUtil::message(print_r($op,1));
+        ElasticaUtil::message(print_r($op, 1));
         ElasticaUtil::message("++++ /{$trace} ++++\n\n");
         return $op;
 	}
@@ -377,12 +377,12 @@ 
 			ElasticaUtil::message("\tAdding $amount documents to the index\n");
 			if (isset($this->StartTime)) {
 				$elapsed = microtime(true) - $this->StartTime;
-				$timePerDoc = ($elapsed)/($this->nDocumentsIndexed);
+				$timePerDoc = ($elapsed) / ($this->nDocumentsIndexed);
 				$documentsRemaining = $this->nDocumentsToIndexForLocale - $this->nDocumentsIndexed;
-				$eta = ($documentsRemaining)*$timePerDoc;
-				$hours = (int)($eta/3600);
-				$minutes = (int)(($eta-$hours*3600)/60);
-				$seconds = (int)(0.5+$eta-$minutes*60-$hours*3600);
+				$eta = ($documentsRemaining) * $timePerDoc;
+				$hours = (int)($eta / 3600);
+				$minutes = (int)(($eta - $hours * 3600) / 60);
+				$seconds = (int)(0.5 + $eta - $minutes * 60 - $hours * 3600);
 				$etaHR = "{$hours}h {$minutes}m {$seconds}s";
 				ElasticaUtil::message("ETA to completion of indexing $this->locale ($documentsRemaining documents): $etaHR");
 			}
@@ -453,17 +453,17 @@ 
 	 * @return \DataObject[] $records
 	 */
 	protected function recordsByClassConsiderVersioned($class, $pageSize = 0, $page = 0) {
-		$offset = $page*$pageSize;
+		$offset = $page * $pageSize;
 
 		if ($class::has_extension("Versioned")) {
-			if ($pageSize >0) {
+			if ($pageSize > 0) {
 				$records = \Versioned::get_by_stage($class, 'Live')->limit($pageSize, $offset);
 			} else {
 				$records = \Versioned::get_by_stage($class, 'Live');
 			}
 		} else {
-			if ($pageSize >0) {
-				$records = $class::get()->limit($pageSize,$offset);
+			if ($pageSize > 0) {
+				$records = $class::get()->limit($pageSize, $offset);
 			} else {
 				$records = $class::get();
 			}
@@ -481,12 +481,12 @@ 
 	protected function refreshClass($class) {
 		$nRecords = $this->recordsByClassConsiderVersioned($class)->count();
 		$batchSize = 500;
-		$pages = $nRecords/$batchSize + 1;
+		$pages = $nRecords / $batchSize + 1;
 		$processing = true;
 
-		for ($i=0; $i < $pages; $i++) {
+		for ($i = 0; $i < $pages; $i++) {
 			$this->startBulkIndex();
-			$pagedRecords = $this->recordsByClassConsiderVersioned($class,$batchSize, $i);
+			$pagedRecords = $this->recordsByClassConsiderVersioned($class, $batchSize, $i);
 			$this->nDocumentsIndexed += $pagedRecords->count();
 			$batch = $pagedRecords->toArray();
 			$this->refreshRecords($batch);
@@ -508,7 +508,7 @@ 
 
 		//Count the number of documents for this locale
 		$amount = 0;
-		echo "CURRENT LOCALE:".$this->locale;
+		echo "CURRENT LOCALE:" . $this->locale;
 		foreach ($classes as $class) {
 			$amount += $this->recordsByClassConsiderVersioned($class)->count();
 		}
@@ -584,7 +584,7 @@ 
 			$settingsClassName = $indexSettings[$this->locale];
 			$result = \Injector::inst()->create($settingsClassName);
 		} else {
-			throw new \Exception('ERROR: No index settings are provided for locale '.$this->locale."\n");
+			throw new \Exception('ERROR: No index settings are provided for locale ' . $this->locale . "\n");
 
 		}
 		return $result;
@@ -600,7 +600,7 @@ 
 		$classes = array();
 
 		$whitelist = array('SearchableTestPage', 'SearchableTestFatherPage', 'SearchableTestGrandFatherPage',
-			'FlickrPhotoTO','FlickrTagTO','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO');
+			'FlickrPhotoTO', 'FlickrTagTO', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO');
 
 		foreach (\ClassInfo::subclassesFor('DataObject') as $candidate) {
 			$instance = singleton($candidate);
@@ -663,7 +663,7 @@ 
 			if (isset($mapping['fields'])) {
 				$subFields = array_keys($mapping['fields']);
 				foreach ($subFields as $subField) {
-					$name = $field.'.'.$subField;
+					$name = $field . '.' . $subField;
 					array_push($allFields, $name);
 				}
 			}
@@ -683,7 +683,7 @@ 
 		);
 
 		//FlickrPhoto/3829/_termvector
-		$path = $this->getIndex()->getName().'/'.$searchable->ClassName.'/'.$searchable->ID.'/_termvector';
+		$path = $this->getIndex()->getName() . '/' . $searchable->ClassName . '/' . $searchable->ID . '/_termvector';
 		$response = $this->getClient()->request(
 	            $path,
 	            \Elastica\Request::GET,

Doc Comments +1 added lines, -1 removed lines

@@ -133,7 +133,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

Indentation +41 added lines, -41 removed lines

@@ -141,7 +141,7 @@ 
 			$types = explode(',', $types);
 		}
 
-        $data = $query->toArray();
+		$data = $query->toArray();
 		if (isset($data['query']['more_like_this'])) {
 			$query->MoreLikeThis = true;
 		} else {
@@ -164,21 +164,21 @@ 
 		if ($query->MoreLikeThis) {
 			$path = $search->getPath();
 
-	        $termData = array();
-	        $termData['query'] = $data['query'];
+			$termData = array();
+			$termData['query'] = $data['query'];
 
-	        $path = str_replace('_search', '_validate/query', $path);
-	        $params = array('explain' => true, 'rewrite' => true);
-	        if ($this->test_mode) {
-	        	$params['search_type'] = Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH;
-	        }
+			$path = str_replace('_search', '_validate/query', $path);
+			$params = array('explain' => true, 'rewrite' => true);
+			if ($this->test_mode) {
+				$params['search_type'] = Search::OPTION_SEARCH_TYPE_DFS_QUERY_THEN_FETCH;
+			}
 
-	        $response = $this->getClient()->request(
-	            $path,
-	            \Elastica\Request::GET,
-	            $termData,
-	            $params
-	        );
+			$response = $this->getClient()->request(
+				$path,
+				\Elastica\Request::GET,
+				$termData,
+				$params
+			);
 
 			$r = $response->getData();
 			$terms = null; // keep in scope
@@ -194,14 +194,14 @@ 
 			}
 		}
 
-        if (!$empty($types)) {
-        	foreach($types as $type) {
-        		$search->addType($type);
-        	}
-        }
+		if (!$empty($types)) {
+			foreach($types as $type) {
+				$search->addType($type);
+			}
+		}
 
-        $path = $search->getPath();
-        $params = $search->getOptions();
+		$path = $search->getPath();
+		$params = $search->getOptions();
 
 		$highlightsCfg = \Config::inst()->get('Elastica', 'Highlights');
 		$preTags = $highlightsCfg['PreTags'];
@@ -269,14 +269,14 @@ 
 		}
 
 
-        $path = $search->getPath();
-        $params = $search->getOptions();
+		$path = $search->getPath();
+		$params = $search->getOptions();
 		$searchResults = $search->search($query, $params);
 		if (isset($this->MoreLikeThisTerms)) {
 			$searchResults->MoreLikeThisTerms = $this->MoreLikeThisTerms;
 		}
 
-        return $searchResults;
+		return $searchResults;
 	}
 
 
@@ -350,11 +350,11 @@ 
 
 	public function listIndexes($trace) {
 		$command = "curl 'localhost:9200/_cat/indices?v'";
-        exec($command,$op);
-        ElasticaUtil::message("\n++++ $trace ++++\n");
-        ElasticaUtil::message(print_r($op,1));
-        ElasticaUtil::message("++++ /{$trace} ++++\n\n");
-        return $op;
+		exec($command,$op);
+		ElasticaUtil::message("\n++++ $trace ++++\n");
+		ElasticaUtil::message(print_r($op,1));
+		ElasticaUtil::message("++++ /{$trace} ++++\n\n");
+		return $op;
 	}
 
 
@@ -525,11 +525,11 @@ 
 			} else {
 				$class = new \ReflectionClass($classname);
 				while ($class = $class->getParentClass()) {
-				    $parentClass = $class->getName();
-				    if ($parentClass == 'SiteTree') {
-				    	$inSiteTree = true;
-				    	break;
-				    }
+					$parentClass = $class->getName();
+					if ($parentClass == 'SiteTree') {
+						$inSiteTree = true;
+						break;
+					}
 				}
 				self::$site_tree_classes[$classname] = $inSiteTree;
 			}
@@ -683,15 +683,15 @@ 
 		//FlickrPhoto/3829/_termvector
 		$path = $this->getIndex()->getName().'/'.$searchable->ClassName.'/'.$searchable->ID.'/_termvector';
 		$response = $this->getClient()->request(
-	            $path,
-	            \Elastica\Request::GET,
-	            $data,
-	            $params
-	    );
+				$path,
+				\Elastica\Request::GET,
+				$data,
+				$params
+		);
 
 
-	    $data = $response->getData();
-	    return $data['term_vectors'];
+		$data = $response->getData();
+		return $data['term_vectors'];
 	}
 
 }

src/SilverStripe/Elastica/FindElasticaSearchPageExtension.php

Spacing +3 added lines, -3 removed lines

@@ -40,10 +40,10 @@
 
 		$cache = SS_Cache::factory('searchpagecache');
 		$searchPage = null;
-		$cachekeyname = 'searchpageuri'.$identifier.$this->owner->Locale.$ck;
+		$cachekeyname = 'searchpageuri' . $identifier . $this->owner->Locale . $ck;
 
-		if(!($searchPage = unserialize($cache->load($cachekeyname)))) {
-			$searchPage = ElasticSearchPage::get()->filter('Identifier',$identifier)->first();
+		if (!($searchPage = unserialize($cache->load($cachekeyname)))) {
+			$searchPage = ElasticSearchPage::get()->filter('Identifier', $identifier)->first();
 			$cache->save(serialize($searchPage), $cachekeyname);
 		}
 		return $searchPage;

searchpage/ElasticSearchPage_Validator.php

Spacing +5 added lines, -5 removed lines

@@ -43,11 +43,11 @@ 
 					try {
 						$instance = Injector::inst()->create($clazz);
 						if (!$instance->hasExtension('SilverStripe\Elastica\Searchable')) {
-							$this->validationError('ClassesToSearch', 'The class '.$clazz.' must have the Searchable extension');
+							$this->validationError('ClassesToSearch', 'The class ' . $clazz . ' must have the Searchable extension');
 						}
 					} catch (ReflectionException $e) {
 						$this->validationError("ClassesToSearch",
-							'The class '.$clazz.' does not exist',
+							'The class ' . $clazz . ' does not exist',
 							'error'
 						);
 					}
@@ -58,16 +58,16 @@ 
 
 		// Check the identifier is unique
 		$mode = Versioned::get_reading_mode();
-		$suffix =  '';
+		$suffix = '';
 		if ($mode == 'Stage.Live') {
 			$suffix = '_Live';
 		}
-		$where = 'ElasticSearchPage'.$suffix.'.ID != '.$data['ID']." AND `Identifier` = '".$data['Identifier']."'";
+		$where = 'ElasticSearchPage' . $suffix . '.ID != ' . $data['ID'] . " AND `Identifier` = '" . $data['Identifier'] . "'";
 		$existing = ElasticSearchPage::get()->where($where)->count();
 		if ($existing > 0) {
 			$valid = false;
 			$this->validationError('Identifier',
-					'The identifier '.$data['Identifier'].' already exists',
+					'The identifier ' . $data['Identifier'] . ' already exists',
 					'error'
 			);
 		}

searchpage/ElasticSearchForm.php

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
 
         $this->SubmitButton = $fa;
 
-		if(class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
+		if (class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
 			$fields->push(new HiddenField('searchlocale', 'searchlocale', Translatable::get_current_locale()));
 		}
 

Indentation +12 added lines, -12 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 /**
- * Elastica Search Form
- */
+	 * Elastica Search Form
+	 */
 
 use Elastica\Document;
 use Elastica\Query;
@@ -27,17 +27,17 @@ 
 	 */
 	public function __construct($controller, $name, $fields = null, $actions = null) {
 		$searchText = isset($this->Query) ? $this->Query : '';
-        $fields = new FieldList(
-           $tf = new TextField("q", "", $searchText)
-        );
+		$fields = new FieldList(
+		   $tf = new TextField("q", "", $searchText)
+		);
 
 
-        $buttonText = _t('SearchPage.SEARCH', 'Search');
-        $actions = new FieldList(
-            $fa = new FormAction('submit', $buttonText)
-        );
+		$buttonText = _t('SearchPage.SEARCH', 'Search');
+		$actions = new FieldList(
+			$fa = new FormAction('submit', $buttonText)
+		);
 
-        $this->SubmitButton = $fa;
+		$this->SubmitButton = $fa;
 
 		if(class_exists('Translatable') && singleton('SiteTree')->hasExtension('Translatable')) {
 			$fields->push(new HiddenField('searchlocale', 'searchlocale', Translatable::get_current_locale()));
@@ -64,7 +64,7 @@ 
 	 */
 	public function setButtonText($newButtonText) {
 		$this->actions = new FieldList(
-            $fa = new FormAction('submit', $newButtonText)
-        );
+			$fa = new FormAction('submit', $newButtonText)
+		);
 	}
 }

tests/TranslatableSearchableTest.php

Spacing +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 	public function setUp() {
 		// this needs to be called in order to create the list of searchable
 		// classes and fields that are available.  Simulates part of a build
-		$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
+		$classes = array('SearchableTestPage', 'SiteTree', 'Page', 'FlickrPhotoTO', 'FlickrSetTO',
 			'FlickrTagTO', 'FlickrAuthorTO', 'FlickrSetTO');
 		$this->requireDefaultRecordsFrom = $classes;
 

searchpage/ElasticSearchPage.php

Indentation +27 added lines, -27 removed lines

@@ -62,7 +62,7 @@ 
 	);
 
 	private static $many_many_extraFields = array(
-    	'ElasticaSearchableFields' => array(
+		'ElasticaSearchableFields' => array(
 		'Searchable' => 'Boolean', // allows the option of turning off a single field for searching
 		'SimilarSearchable' => 'Boolean', // allows field to be used in more like this queries.
 		'Active' => 'Boolean', // preserve previous edits of weighting when classes changed
@@ -104,10 +104,10 @@ 
 		$sortedWords = $this->SimilarityStopWords;
 
 		$stopwordsField = StringTagField::create(
-		    'SimilarityStopWords',
-		    'Stop Words for Similar Search',
-		    $sortedWords,
-		    $sortedWords
+			'SimilarityStopWords',
+			'Stop Words for Similar Search',
+			$sortedWords,
+			$sortedWords
 		);
 
 		$stopwordsField->setShouldLazyLoad(true); // tags should be lazy loaded
@@ -190,15 +190,15 @@ 
 		$fields->addFieldToTab('Root.Search.Aggregations', new TextField('SearchHelper',
 			'ClassName of object to manipulate search details and results.  Leave blank for standard search'));
 
-        $ottos = AutoCompleteOption::get()->Filter('Locale', $this->Locale)->map('ID', 'Name')->
-        									toArray();
-        $df = DropdownField::create('AutoCompleteFunctionID', 'Autocomplete Function')->
-        							setSource($ottos);
-        $df->setEmptyString('-- Please select what do do after find as you type has occurred --');
+		$ottos = AutoCompleteOption::get()->Filter('Locale', $this->Locale)->map('ID', 'Name')->
+											toArray();
+		$df = DropdownField::create('AutoCompleteFunctionID', 'Autocomplete Function')->
+									setSource($ottos);
+		$df->setEmptyString('-- Please select what do do after find as you type has occurred --');
 
-        $ottos = $this->ElasticaSearchableFields()->filter('EnableAutocomplete',1)->Map('ID', 'Name')->toArray();
-        $autoCompleteFieldDF = DropDownField::create('AutoCompleteFieldID', 'Field to use for autocomplete')->setSource($ottos);
-        $autoCompleteFieldDF->setEmptyString('-- Please select which field to use for autocomplete --');
+		$ottos = $this->ElasticaSearchableFields()->filter('EnableAutocomplete',1)->Map('ID', 'Name')->toArray();
+		$autoCompleteFieldDF = DropDownField::create('AutoCompleteFieldID', 'Field to use for autocomplete')->setSource($ottos);
+		$autoCompleteFieldDF->setEmptyString('-- Please select which field to use for autocomplete --');
 
 		$fields->addFieldToTab("Root.Search.AutoComplete",
 		  		FieldGroup::create(
@@ -223,7 +223,7 @@ 
 		$pickerConfig->removeComponentsByType(new PickerFieldAddExistingSearchButton());
 		$pickerConfig->getComponentByType('GridFieldPaginator')->setItemsPerPage(100);
 
-        $searchPicker->enableEdit();
+		$searchPicker->enableEdit();
 		$edittest = $pickerConfig->getComponentByType('GridFieldDetailForm');
 		$edittest->setFields(FieldList::create(
 			TextField::create('Name', 'Field Name'),
@@ -257,23 +257,23 @@ 
 
 		// What do display on the grid of searchable fields
 		$dataColumns = $pickerConfig->getComponentByType('GridFieldDataColumns');
-        $dataColumns->setDisplayFields(array(
+		$dataColumns->setDisplayFields(array(
 			'Name' => 'Name',
-        	'ClazzName' => 'Class',
+			'ClazzName' => 'Class',
 			'Type' => 'Type',
 			'Searchable' => 'Use for Search?',
 			'SimilarSearchable' => 'Use for Similar Search?',
 			'ShowHighlights' => 'Show Search Highlights',
 			'Weight' => 'Weighting'
-        ));
+		));
 
 		return $fields;
 	}
 
 
 	public function getCMSValidator() {
-        return new ElasticSearchPage_Validator();
-    }
+		return new ElasticSearchPage_Validator();
+	}
 
 
 	/**
@@ -358,7 +358,7 @@ 
 		$esfs = $this->ElasticaSearchableFields();
 
 		// Remove existing searchable fields for this page from the list of all available
-    	$delta = array_keys($esfs->map()->toArray());
+		$delta = array_keys($esfs->map()->toArray());
 		$newSearchableFields = $sfs->exclude('ID', $delta);
 
 		if ($newSearchableFields->count() > 0) {
@@ -448,7 +448,7 @@ 
 		Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
 		Requirements::javascript("elastica/javascript/jquery.autocomplete.js");
 		Requirements::javascript("elastica/javascript/elastica.js");
-        Requirements::css("elastica/css/elastica.css");
+		Requirements::css("elastica/css/elastica.css");
 	}
 
 
@@ -522,9 +522,9 @@ 
 
 		try {
 			// Simulate server being down for testing purposes
-	        if (isset($_GET['ServerDown'])) {
-	        	throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
-	        }
+			if (isset($_GET['ServerDown'])) {
+				throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
+			}
 			if (class_exists($class)) {
 				$instance = \DataObject::get_by_id($class,$instanceID);
 
@@ -664,9 +664,9 @@ 
 		$paginated = null;
 		try {
 			// Simulate server being down for testing purposes
-	        if (isset($_GET['ServerDown'])) {
-	        	throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
-	        }
+			if (isset($_GET['ServerDown'])) {
+				throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
+			}
 
 			// now actually perform the search using the original query
 			$paginated = $es->search($queryText, $fieldsToSearch, $testMode);

Spacing +37 added lines, -37 removed lines

@@ -118,29 +118,29 @@ 
 			'Default values are those used by Elastica'));
 		$fields->addFieldToTab("Root.Search.Similarity", $lf);
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MinTermFreq',
-			'The minimum term frequency below which the terms will be ignored from the input '.
+			'The minimum term frequency below which the terms will be ignored from the input ' .
 			'document. Defaults to 2.'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MaxTermFreq',
-			'The maximum number of query terms that will be selected. Increasing this value gives '.
+			'The maximum number of query terms that will be selected. Increasing this value gives ' .
 			'greater accuracy at the expense of query execution speed. Defaults to 25.'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MinWordLength',
 			'The minimum word length below which the terms will be ignored.  Defaults to 0.'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MinDocFreq',
-			'The minimum document frequency below which the terms will be ignored from the input '.
+			'The minimum document frequency below which the terms will be ignored from the input ' .
 			'document. Defaults to 5.'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MaxDocFreq',
-			'The maximum document frequency above which the terms will be ignored from the input '.
-			'document. This could be useful in order to ignore highly frequent words such as stop '.
+			'The maximum document frequency above which the terms will be ignored from the input ' .
+			'document. This could be useful in order to ignore highly frequent words such as stop ' .
 			'words. Defaults to unbounded (0).'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MinWordLength',
-			'The minimum word length below which the terms will be ignored. The old name min_'.
+			'The minimum word length below which the terms will be ignored. The old name min_' .
 			'word_len is deprecated. Defaults to 0.'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MaxWordLength',
-			'The maximum word length above which the terms will be ignored. The old name max_word_'.
+			'The maximum word length above which the terms will be ignored. The old name max_word_' .
 			'len is deprecated. Defaults to unbounded (0).'));
 		$fields->addFieldToTab("Root.Search.Similarity", new TextField('MinShouldMatch',
-			'This parameter controls the number of terms that must match. This can be either a '.
-			'number or a percentage.  See '.
+			'This parameter controls the number of terms that must match. This can be either a ' .
+			'number or a percentage.  See ' .
 			'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html'));
 
 		// ---- search details tab ----
@@ -177,9 +177,9 @@ 
 
 		$html = '<div class="field text" id="SiteTreeOnlyInfo">';
 		$html .= "<p>Copy the following into the above field to ensure that all SiteTree classes are searched</p>";
-		$html .= '<p class="message">'.$list;
+		$html .= '<p class="message">' . $list;
 		$html .= "</p></div>";
-		$infoField = new LiteralField('InfoField',$html);
+		$infoField = new LiteralField('InfoField', $html);
 		$fields->addFieldToTab('Root.Search.SearchFor', $infoField);
 
 		$fields->addFieldToTab('Root.Main', new HTMLEditorField('ContentForEmptySearch'));
@@ -196,7 +196,7 @@ 
         							setSource($ottos);
         $df->setEmptyString('-- Please select what do do after find as you type has occurred --');
 
-        $ottos = $this->ElasticaSearchableFields()->filter('EnableAutocomplete',1)->Map('ID', 'Name')->toArray();
+        $ottos = $this->ElasticaSearchableFields()->filter('EnableAutocomplete', 1)->Map('ID', 'Name')->toArray();
         $autoCompleteFieldDF = DropDownField::create('AutoCompleteFieldID', 'Field to use for autocomplete')->setSource($ottos);
         $autoCompleteFieldDF->setEmptyString('-- Please select which field to use for autocomplete --');
 
@@ -208,9 +208,9 @@ 
 		 );
 
 		// ---- grid of searchable fields ----
-		$html = '<p id="SearchFieldIntro">'._t('SiteConfig.ELASTICA_SEARCH_INFO',
-				"Select a field to edit it's properties").'</p>';
-		$fields->addFieldToTab('Root.Search.Fields', $h1=new LiteralField('SearchInfo', $html));
+		$html = '<p id="SearchFieldIntro">' . _t('SiteConfig.ELASTICA_SEARCH_INFO',
+				"Select a field to edit it's properties") . '</p>';
+		$fields->addFieldToTab('Root.Search.Fields', $h1 = new LiteralField('SearchInfo', $html));
 		$searchPicker = new PickerField('ElasticaSearchableFields', 'Searchable Fields',
 			$this->ElasticaSearchableFields()->filter('Active', 1)->sort('Name'));
 
@@ -283,7 +283,7 @@ 
 	public function validate() {
 		$result = parent::validate();
 		$mode = Versioned::get_reading_mode();
-		$suffix =  '';
+		$suffix = '';
 		if ($mode == 'Stage.Live') {
 			$suffix = '_Live';
 		}
@@ -292,17 +292,17 @@ 
 			$result->error('The identifier cannot be blank');
 		}
 
-		$where = 'ElasticSearchPage'.$suffix.'.ID != '.$this->ID." AND `Identifier` = '{$this->Identifier}'";
+		$where = 'ElasticSearchPage' . $suffix . '.ID != ' . $this->ID . " AND `Identifier` = '{$this->Identifier}'";
 		$existing = ElasticSearchPage::get()->where($where)->count();
 		if ($existing > 0) {
-			$result->error('The identifier '.$this->Identifier.' already exists');
+			$result->error('The identifier ' . $this->Identifier . ' already exists');
 		}
 
 
-		error_log('CTS:'.$this->ClassesToSearch);
+		error_log('CTS:' . $this->ClassesToSearch);
 
 		// now check classes to search actually exist, assuming in site tree not set
-		error_log('STO:'.$this->SiteTreeOnly);
+		error_log('STO:' . $this->SiteTreeOnly);
 		if (!$this->SiteTreeOnly) {
 			if ($this->ClassesToSearch == '') {
 				$result->error('At least one searchable class must be available, or SiteTreeOnly flag set');
@@ -312,10 +312,10 @@ 
 					try {
 						$instance = Injector::inst()->create($clazz);
 						if (!$instance->hasExtension('SilverStripe\Elastica\Searchable')) {
-							$result->error('The class '.$clazz.' must have the Searchable extension');
+							$result->error('The class ' . $clazz . ' must have the Searchable extension');
 						}
 					} catch (ReflectionException $e) {
-						$result->error('The class '.$clazz.' does not exist');
+						$result->error('The class ' . $clazz . ' does not exist');
 					}
 				}
 			}
@@ -363,7 +363,7 @@ 
 
 		if ($newSearchableFields->count() > 0) {
 			foreach ($newSearchableFields->getIterator() as $newSearchableField) {
-				error_log('NEW FIELD:'.$newSearchableField->Name);
+				error_log('NEW FIELD:' . $newSearchableField->Name);
 				$newSearchableField->Active = true;
 				$newSearchableField->Weight = 1;
 
@@ -371,7 +371,7 @@ 
 
 				// Note 1 used instead of true for SQLite3 testing compatibility
 				$sql = "UPDATE ElasticSearchPage_ElasticaSearchableFields SET ";
-				$sql .= 'Active=1, Weight=1 WHERE ElasticSearchPageID = '.$this->ID;
+				$sql .= 'Active=1, Weight=1 WHERE ElasticSearchPageID = ' . $this->ID;
 				DB::query($sql);
 			}
 		}
@@ -418,7 +418,7 @@ 
 			$qField->setAttribute('data-autocomplete-field', 'Title');
 			$qField->setAttribute('data-autocomplete-classes', $this->ClassesToSearch);
 			$qField->setAttribute('data-autocomplete-sitetree', $this->SiteTreeOnly);
-			$qField->setAttribute('data-autocomplete-source',$this->Link());
+			$qField->setAttribute('data-autocomplete-source', $this->Link());
 			$qField->setAttribute('data-autocomplete-function',
 			$this->AutocompleteFunction()->Slug);
 		}
@@ -440,7 +440,7 @@ 
 
 class ElasticSearchPage_Controller extends Page_Controller {
 
-	private static $allowed_actions = array('SearchForm', 'submit','index','similar');
+	private static $allowed_actions = array('SearchForm', 'submit', 'index', 'similar');
 
 	public function init() {
 		parent::init();
@@ -516,7 +516,7 @@ 
 
 		// Use the standard field for more like this, ie not stemmed
 		foreach ($fieldsToSearch as $field => $value) {
-			$fieldsToSearch[$field.'.standard'] = $value;
+			$fieldsToSearch[$field . '.standard'] = $value;
 			unset($fieldsToSearch[$field]);
 		}
 
@@ -526,7 +526,7 @@ 
 	        	throw new Elastica\Exception\Connection\HttpException('Unable to reach search server');
 	        }
 			if (class_exists($class)) {
-				$instance = \DataObject::get_by_id($class,$instanceID);
+				$instance = \DataObject::get_by_id($class, $instanceID);
 
 				$paginated = $es->moreLikeThis($instance, $fieldsToSearch);
 
@@ -570,7 +570,7 @@ 
 
 		// calculate time
 		$endTime = microtime(true);
-		$elapsed = round(100*($endTime-$startTime))/100;
+		$elapsed = round(100 * ($endTime - $startTime)) / 100;
 
 		// store variables for the template to use
 		$data['ElapsedTime'] = $elapsed;
@@ -624,11 +624,11 @@ 
 		$testMode = isset($_GET['TestMode']);
 
 		// filters for aggregations
-		$ignore = array('url', 'start','q','is');
+		$ignore = array('url', 'start', 'q', 'is');
 		$ignore = \Config::inst()->get('Elastica', 'BlackList');
 		foreach ($this->request->getVars() as $key => $value) {
 			if (!in_array($key, $ignore)) {
-				$es->addFilter($key,$value);
+				$es->addFilter($key, $value);
 			}
 		}
 
@@ -677,7 +677,7 @@ 
 				$data['SuggestedQuery'] = $es->getSuggestedQuery();
 				$data['SuggestedQueryHighlighted'] = $es->getSuggestedQueryHighlighted();
 				//Link for if the user really wants to try their original query
-				$sifLink = rtrim($this->Link(),'/').'?q='.$queryText.'&is=1';
+				$sifLink = rtrim($this->Link(), '/') . '?q=' . $queryText . '&is=1';
 				$data['SearchInsteadForLink'] = $sifLink;
 				$paginated = $es->search($es->getSuggestedQuery(), $fieldsToSearch);
 
@@ -685,7 +685,7 @@ 
 
 			// calculate time
 			$endTime = microtime(true);
-			$elapsed = round(100*($endTime-$startTime))/100;
+			$elapsed = round(100 * ($endTime - $startTime)) / 100;
 
 			// store variables for the template to use
 			$data['ElapsedTime'] = $elapsed;
@@ -716,7 +716,7 @@ 
 	 */
 	public function QueryIsEmpty() {
 		$result = !isset($_GET['q']);
-		if (isset($_GET['q']))	{
+		if (isset($_GET['q'])) {
 			$queryText = $_GET['q'];
 			if ($queryText == '') {
 				$result = true;
@@ -735,7 +735,7 @@ 
 		$queryText = $data['q'];
 		$url = $this->Link();
 		$url = rtrim($url, '/');
-		$link = rtrim($url, '/').'?q='.$queryText.'&sfid='.$data['identifier'];
+		$link = rtrim($url, '/') . '?q=' . $queryText . '&sfid=' . $data['identifier'];
 		$this->redirect($link);
 	}
 
@@ -759,7 +759,7 @@ 
 
 		}
 
-		if($this->action == 'similar') {
+		if ($this->action == 'similar') {
 			$queryField->setDisabled(true);
 			$actions = $form->Actions();
 			foreach ($actions as $field) {
@@ -775,7 +775,7 @@ 
 			$queryField->setAttribute('data-autocomplete-field', 'Title');
 			$queryField->setAttribute('data-autocomplete-classes', $this->ClassesToSearch);
 			$queryField->setAttribute('data-autocomplete-sitetree', $this->SiteTreeOnly);
-			$queryField->setAttribute('data-autocomplete-source',$this->Link());
+			$queryField->setAttribute('data-autocomplete-source', $this->Link());
 			$queryField->setAttribute('data-autocomplete-function',
 			$this->AutocompleteFunction()->Slug);
 		}