Searchable - Code Metrics - Inspection of "FIX: (hopefully) Change tactic with testing testSi..." - gordonbanderson/silverstripe-elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev2 ( 764ed3...9e10b9 )

by Gordon

created 2015-12-30 12:30 UTC

Searchable F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	542
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	19

Test Coverage

Coverage

55.91%

Importance

Changes	16
Bugs	8	Features	1

Metric	Value
wmc	74
c	16
b	8
f	1
lcom	1
cbo	19
dl	0
loc	542
ccs	142
cts	254
cp	0.5591
rs	2.381

23 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getElasticaType()	3	1
A	getElasticaResult()	3	1
A	setElasticaResult()	3	1
B	getElasticaFields()	42	6
B	getElasticaMapping()	31	3
C	getElasticaDocument()	36	7
B	getFieldValuesAsArray()	17	5
A	showRecordInSearch()	3	2
B	onBeforeWrite()	10	5
A	onBeforePublish()	9	4
A	onAfterWrite()	3	1
A	onAfterPublish()	3	1
A	doIndexDocument()	5	3
A	onAfterDelete()	3	1
A	onAfterUnpublish()	3	1
A	doDeleteDocumentIfInSearch()	5	2
A	doDeleteDocument()	11	3
C	getAllSearchableFields()	54	10
A	requireDefaultRecords()	21	3
A	RenderResult()	5	1
A	getTermVectors()	3	1
C	updateCMSFields()	68	11

How to fix Complexity

<?php

namespace SilverStripe\Elastica;

use Elastica\Document;
use Elastica\Type\Mapping;
use ShortcodeParser;

/**
 * Adds elastic search integration to a data object.
 */
class Searchable extends \DataExtension {

	/**
	 * Counter used to display progress of indexing
	 * @var integer
	 */
	public static $index_ctr = 0;

	/**
	 * Everytime progressInterval divides $index_ctr exactly display progress
	 * @var integer
	 */
	private static $progressInterval = 0;

	public static $mappings = array(
		'Boolean'     => 'boolean',
		'Decimal'     => 'double',
		'Currency'    => 'double',
		'Double'      => 'double',
		'Enum'        => 'string',
		'Float'       => 'float',
		'HTMLText'    => 'string',
		'HTMLVarchar' => 'string',
		'Int'         => 'integer',
		'Text'        => 'string',
		'VarChar'     => 'string',
		'Varchar'     => 'string',
		'Year'        => 'integer',
		'Percentage'  => 'double',
		'Time'  => 'date',
		// The 2 different date types will be stored with different formats
		'Date'        => 'date',
		'SS_Datetime' => 'date',
		'Datetime' => 'date',
		'DBLocale'    => 'string'
	);


	/**
	 * @var ElasticaService associated elastica search service
	 */
	protected $service;


	/**
	 * Array of fields that need HTML parsed
	 * @var array
	 */
	protected $html_fields = array();

	/**
	 * Store a mapping of relationship name to result type
	 */
	protected $relationship_methods = array();


	/**
	 * If importing a large number of items from a fixtures file, or indeed some other source, then
	 * it is quicker to set a flag of value IndexingOff => false.  This has the effect of ensuring
	 * no indexing happens, a request is normally made per fixture when loading.  One can then run
	 * the reindexing teask to bulk index in one HTTP POST request to Elasticsearch
	 *
	 * @var boolean
	 */
	private static $IndexingOff = false;


	/**
	 * @see getElasticaResult
	 * @var \Elastica\Result
	 */
	protected $elastica_result;

	public function __construct(ElasticaService $service) {
		$this->service = $service;
		parent::__construct();
	}


	/**
	 * Get the elasticsearch type name
	 *
	 * @return string
	 */
	public function getElasticaType() {
		return get_class($this->owner);
	}


	/**
	 * If the owner is part of a search result
	 * the raw Elastica search result is returned
	 * if set via setElasticaResult
	 *
	 * @return \Elastica\Result
	 */
	public function getElasticaResult() {
		return $this->elastica_result;
	}


	/**
	 * Set the raw Elastica search result
	 *
	 * @param \Elastica\Result
	 */
	public function setElasticaResult(\Elastica\Result $result) {
		$this->elastica_result = $result;
	}


	/**
	 * Gets an array of elastic field definitions.
	 *
	 * @return array
	 */
	public function getElasticaFields($storeMethodName = false, $recurse = true) {
		$db = $this->owner->db();
		$fields = $this->getAllSearchableFields();
		$result = array();

		foreach($fields as $name => $params) {
			$spec = array();
			$name = str_replace('()', '', $name);

			if(array_key_exists($name, $db)) {
				$class = $db[$name];
				SearchableHelper::assignSpecForStandardFieldType($name, $class, $spec, $this->html_fields, self::$mappings);
			} else {
				// field name is not in the db, it could be a method
				$has_lists = SearchableHelper::getListRelationshipMethods($this->owner);
				$has_ones = $this->owner->has_one();

				// check has_many and many_many relations
				if(isset($has_lists[$name])) {
					// the classes returned by the list method
					$resultType = $has_lists[$name];
					SearchableHelper::assignSpecForRelationship($name, $resultType, $spec, $storeMethodName, $recurse);
				} else if(isset($has_ones[$name])) {
					$resultType = $has_ones[$name];
					SearchableHelper::assignSpecForRelationship($name, $resultType, $spec, $storeMethodName, $recurse);
				}
				// otherwise fall back to string - Enum is one such category
				else {
					$spec["type"] = "string";
				}
			}

			SearchableHelper::addIndexedFields($name, $spec, $this->owner->ClassName);
			$result[$name] = $spec;
		}

		if($this->owner->hasMethod('updateElasticHTMLFields')) {
			$this->html_fields = $this->owner->updateElasticHTMLFields($this->html_fields);
		}

		return $result;
	}



	/**
	 * Get the elasticsearch mapping for the current document/type
	 *
	 * @return \Elastica\Type\Mapping
	 */
	public function getElasticaMapping() {
		$mapping = new Mapping();

		$fields = $this->getElasticaFields(false);

		$localeMapping = array();

		if($this->owner->hasField('Locale')) {
			$localeMapping['type'] = 'string';
			// we wish the locale to be stored as is
			$localeMapping['index'] = 'not_analyzed';
			$fields['Locale'] = $localeMapping;
		}

		// ADD CUSTOM FIELDS HERE THAT ARE INDEXED BY DEFAULT
		// add a mapping to flag whether or not class is in SiteTree
		$fields['IsInSiteTree'] = array('type'=>'boolean');
		$fields['Link'] = array('type' => 'string', 'index' => 'not_analyzed');

		$mapping->setProperties($fields);

		//This concatenates all the fields together into a single field.
		//Initially added for suggestions compatibility, in that searching
		//_all field picks up all possible suggestions
		$mapping->enableAllField();

		if($this->owner->hasMethod('updateElasticsearchMapping')) {
			$mapping = $this->owner->updateElasticsearchMapping($mapping);
		}
		return $mapping;
	}


	/**
	 * Get an elasticsearch document
	 *
	 * @return \Elastica\Document
	 */
	public function getElasticaDocument() {
		self::$index_ctr++;
		$fields = $this->getFieldValuesAsArray();
		$progress = \Controller::curr()->request->getVar('progress');
		if(!empty($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...");
			}
		}

		// Optionally update the document
		$document = new Document($this->owner->ID, $fields);
		if($this->owner->hasMethod('updateElasticsearchDocument')) {
			$document = $this->owner->updateElasticsearchDocument($document);
		}

		// Check if the current classname is part of the site tree or not
		// Results are cached to save reprocessing the same
		$classname = $this->owner->ClassName;
		$inSiteTree = SearchableHelper::isInSiteTree($classname);

		$document->set('IsInSiteTree', $inSiteTree);
		if($inSiteTree) {
			$document->set('Link', $this->owner->AbsoluteLink());
		}

		if(isset($this->owner->Locale)) {
			$document->set('Locale', $this->owner->Locale);
		}

		return $document;
	}


	public function getFieldValuesAsArray($recurse = true) {
		$fields = array();
		foreach($this->getElasticaFields($recurse) as $field => $config) {
			//This is the case of calling a method to get a value, the field does not exist in the DB
			if(null === $this->owner->$field && is_callable(get_class($this->owner) . "::" . $field)) {
				// call a method to get a field value
				SearchableHelper::storeMethodTextValue($this->owner, $field, $fields, $this->html_fields);
			} else {
				if(in_array($field, $this->html_fields)) {
					SearchableHelper::storeFieldHTMLValue($this->owner, $field, $fields);
				} else {
					SearchableHelper::storeRelationshipValue($this->owner, $field, $fields, $config, $recurse);
				}
			}
		}
		return $fields;
	}


	/**
	 * Returns whether to include the document into the search index.
	 * All documents are added unless they have a field "ShowInSearch" which is set to false
	 *
	 * @return boolean
	 */
	public function showRecordInSearch() {
		return !($this->owner->hasField('ShowInSearch') && false == $this->owner->ShowInSearch);
	}


	/**
	 * Delete the record from the search index if ShowInSearch is deactivated (non-SiteTree).
	 */
	public function onBeforeWrite() {
		if(
			$this->owner instanceof \SiteTree &&
			$this->owner->hasField('ShowInSearch') &&
			$this->owner->isChanged('ShowInSearch', 2) &&
			false == $this->owner->ShowInSearch
		) {
			$this->doDeleteDocument();
		}
	}


	/**
	 * Delete the record from the search index if ShowInSearch is deactivated (SiteTree).
	 */
	public function onBeforePublish() {
		if(false == $this->owner->ShowInSearch && $this->owner->isPublished()) {
			$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
				byID($this->owner->ID);
			if($liveRecord->ShowInSearch != $this->owner->ShowInSearch) {
				$this->doDeleteDocument();
			}
		}
	}


	/**
	 * Updates the record in the search index (non-SiteTree).
	 */
	public function onAfterWrite() {
		$this->doIndexDocument();
	}


	/**
	 * Updates the record in the search index (SiteTree).
	 */
	public function onAfterPublish() {
		$this->doIndexDocument();
	}


	/**
	 * Updates the record in the search index.
	 */
	protected function doIndexDocument() {
		if($this->showRecordInSearch() && !$this->owner->IndexingOff) {
			$this->service->index($this->owner);
		}
	}


	/**
	 * Removes the record from the search index (non-SiteTree).
	 */
	public function onAfterDelete() {
		$this->doDeleteDocumentIfInSearch();
	}


	/**
	 * Removes the record from the search index (non-SiteTree).
	 */
	public function onAfterUnpublish() {
		$this->doDeleteDocumentIfInSearch();
	}


	/**
	 * Removes the record from the search index if the "ShowInSearch" attribute is set to true.
	 */
	protected function doDeleteDocumentIfInSearch() {
		if($this->showRecordInSearch()) {
			$this->doDeleteDocument();
		}
	}


	/**
	 * Removes the record from the search index.
	 */
	protected function doDeleteDocument() {
		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 .
				") not found in search index.", E_USER_NOTICE);
		}
	}


	/**
	 * Return all of the searchable fields defined in $this->owner::$searchable_fields and all the parent classes.
	 *
	 * @param  $recuse Whether or not to traverse relationships. First time round yes, subsequently no
	 * @return array searchable fields
	 */
	public function getAllSearchableFields($recurse = true) {
		$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);
		}

		// get the values of these fields
		$elasticaMapping = SearchableHelper::fieldsToElasticaConfig($fields);

		if($recurse) {
			// now for the associated methods and their results
			$methodDescs = \Config::inst()->get(get_class($this->owner), 'searchable_relationships');
			$has_ones = $this->owner->has_one();
			$has_lists = SearchableHelper::getListRelationshipMethods($this->owner);

			if(isset($methodDescs) && is_array($methodDescs)) {
				foreach($methodDescs as $methodDesc) {
					// split before the brackets which can optionally list which fields to index
					$splits = explode('(', $methodDesc);
					$methodName = $splits[0];

					if(isset($has_lists[$methodName])) {

						$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);
						}
						$rewrite = SearchableHelper::fieldsToElasticaConfig($fields);

						// mark as a method, the resultant fields are correct
						$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);
						}
						$rewrite = SearchableHelper::fieldsToElasticaConfig($fields);

						// mark as a method, the resultant fields are correct
						$elasticaMapping[$methodName . '()'] = $rewrite;
					} else {
						user_error('The method ' . $methodName . ' not found in class ' . $this->owner->ClassName .
								', please check configuration');
					}
				}
			}
		}

		return $elasticaMapping;
	}




	public function requireDefaultRecords() {
		parent::requireDefaultRecords();
		$searchableFields = $this->getElasticaFields(true, true);
		$doSC = SearchableHelper::findOrCreateSearchableClass($this->owner->ClassName);

		foreach($searchableFields as $name => $searchableField) {
			// check for existence of methods and if they exist use that as the name
			if(!isset($searchableField['type'])) {
				$name = $searchableField['properties']['__method'];
			}

			SearchableHelper::findOrCreateSearchableField(
				$this->owner->ClassName,
				$name,
				$searchableField,
				$doSC
			);

			// FIXME deal with deletions
		}
	}


	/*
	Allow the option of overriding the default template with one of <ClassName>ElasticSearchResult
	 */
	public function RenderResult($linkToContainer = '') {
		$vars = new \ArrayData(array('SearchResult' => $this->owner, 'ContainerLink' => $linkToContainer));
		$possibleTemplates = array($this->owner->ClassName . 'ElasticSearchResult', 'ElasticSearchResult');
		return $this->owner->customise($vars)->renderWith($possibleTemplates);
	}


	public function getTermVectors() {
		return $this->service->getTermVectors($this->owner);
	}


	public function updateCMSFields(\FieldList $fields) {
		$isIndexed = false;
		// SIteTree object must have a live record, ShowInSearch = true
		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);
				if(!empty($liveRecord) && $liveRecord->ShowInSearch) {
					$isIndexed = true;
				} else {
					$isIndexed = false;
				}
			} else {
				// In the case of a DataObject we use the ShowInSearchFlag
				$isIndexed = true;
			}
		}


		if($isIndexed) {
			$termVectors = $this->getTermVectors();
			$termFields = array_keys($termVectors);
			sort($termFields);

			foreach($termFields as $field) {
				$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);
				$config->getComponentByType('GridFieldDataColumns')->setDisplayFields(array(
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
					'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
				);
			   $fields->addFieldToTab('Root.ElasticaTerms.' . $underscored, $gridField);
			}

		}

		return $fields;
	}


}


Push — dev2 ( 764ed3...9e10b9 )

Searchable F

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

23 Methods

How to fix Complexity

Complex Class

Available Fixes

1		<?php
2
3		namespace SilverStripe\Elastica;
4
5		use Elastica\Document;
6		use Elastica\Type\Mapping;
7		use ShortcodeParser;
8
9		/**
10		* Adds elastic search integration to a data object.
11		*/
12		class Searchable extends \DataExtension {
13
14		/**
15		* Counter used to display progress of indexing
16		* @var integer
17		*/
18		public static $index_ctr = 0;
19
20		/**
21		* Everytime progressInterval divides $index_ctr exactly display progress
22		* @var integer
23		*/
24		private static $progressInterval = 0;
25
26		public static $mappings = array(
27		'Boolean' => 'boolean',
28		'Decimal' => 'double',
29		'Currency' => 'double',
30		'Double' => 'double',
31		'Enum' => 'string',
32		'Float' => 'float',
33		'HTMLText' => 'string',
34		'HTMLVarchar' => 'string',
35		'Int' => 'integer',
36		'Text' => 'string',
37		'VarChar' => 'string',
38		'Varchar' => 'string',
39		'Year' => 'integer',
40		'Percentage' => 'double',
41		'Time' => 'date',
42		// The 2 different date types will be stored with different formats
43		'Date' => 'date',
44		'SS_Datetime' => 'date',
45		'Datetime' => 'date',
46		'DBLocale' => 'string'
47		);
48
49
50		/**
51		* @var ElasticaService associated elastica search service
52		*/
53		protected $service;
54
55
56		/**
57		* Array of fields that need HTML parsed
58		* @var array
59		*/
60		protected $html_fields = array();
61
62		/**
63		* Store a mapping of relationship name to result type
64		*/
65		protected $relationship_methods = array();
66
67
68		/**
69		* If importing a large number of items from a fixtures file, or indeed some other source, then
70		* it is quicker to set a flag of value IndexingOff => false. This has the effect of ensuring
71		* no indexing happens, a request is normally made per fixture when loading. One can then run
72		* the reindexing teask to bulk index in one HTTP POST request to Elasticsearch
73		*
74		* @var boolean
75		*/
76		private static $IndexingOff = false;
77
78
79		/**
80		* @see getElasticaResult
81		* @var \Elastica\Result
82		*/
83		protected $elastica_result;
84
85		public function __construct(ElasticaService $service) {
86		$this->service = $service;
87		parent::__construct();
88		}
89
90
91		/**
92		* Get the elasticsearch type name
93		*
94		* @return string
95		*/
96	1	public function getElasticaType() {
97	1	return get_class($this->owner);
98		}
99
100
101		/**
102		* If the owner is part of a search result
103		* the raw Elastica search result is returned
104		* if set via setElasticaResult
105		*
106		* @return \Elastica\Result
107		*/
108		public function getElasticaResult() {
109		return $this->elastica_result;
110		}
111
112
113		/**
114		* Set the raw Elastica search result
115		*
116		* @param \Elastica\Result
117		*/
118	1	public function setElasticaResult(\Elastica\Result $result) {
119	1	$this->elastica_result = $result;
120	1	}
121
122
123		/**
124		* Gets an array of elastic field definitions.
125		*
126		* @return array
127		*/
128	1	public function getElasticaFields($storeMethodName = false, $recurse = true) {
129	1	$db = $this->owner->db();
130	1	$fields = $this->getAllSearchableFields();
131	1	$result = array();
132
133	1	foreach($fields as $name => $params) {
134	1	$spec = array();
135	1	$name = str_replace('()', '', $name);
136
137	1	if(array_key_exists($name, $db)) {
138	1	$class = $db[$name];
139	1	SearchableHelper::assignSpecForStandardFieldType($name, $class, $spec, $this->html_fields, self::$mappings);
140	1	} else {
141		// field name is not in the db, it could be a method
142	1	$has_lists = SearchableHelper::getListRelationshipMethods($this->owner);
143	1	$has_ones = $this->owner->has_one();
144
145		// check has_many and many_many relations
146	1	if(isset($has_lists[$name])) {
147		// the classes returned by the list method
148	1	$resultType = $has_lists[$name];
149	1	SearchableHelper::assignSpecForRelationship($name, $resultType, $spec, $storeMethodName, $recurse);
150	1	} else if(isset($has_ones[$name])) {
151	1	$resultType = $has_ones[$name];
152	1	SearchableHelper::assignSpecForRelationship($name, $resultType, $spec, $storeMethodName, $recurse);
153	1	}
154		// otherwise fall back to string - Enum is one such category
155	1	else {
156	1	$spec["type"] = "string";
157	1	}
158		}
159
160	1	SearchableHelper::addIndexedFields($name, $spec, $this->owner->ClassName);
161	1	$result[$name] = $spec;
162	1	}
163
164	1	if($this->owner->hasMethod('updateElasticHTMLFields')) {
165	1	$this->html_fields = $this->owner->updateElasticHTMLFields($this->html_fields);
166	1	}
167
168	1	return $result;
169		}
170
171
172
173		/**
174		* Get the elasticsearch mapping for the current document/type
175		*
176		* @return \Elastica\Type\Mapping
177		*/
178	1	public function getElasticaMapping() {
179	1	$mapping = new Mapping();
180
181	1	$fields = $this->getElasticaFields(false);
182
183	1	$localeMapping = array();
184
185	1	if($this->owner->hasField('Locale')) {
186		$localeMapping['type'] = 'string';
187		// we wish the locale to be stored as is
188		$localeMapping['index'] = 'not_analyzed';
189		$fields['Locale'] = $localeMapping;
190		}
191
192		// ADD CUSTOM FIELDS HERE THAT ARE INDEXED BY DEFAULT
193		// add a mapping to flag whether or not class is in SiteTree
194	1	$fields['IsInSiteTree'] = array('type'=>'boolean');
195	1	$fields['Link'] = array('type' => 'string', 'index' => 'not_analyzed');
196
197	1	$mapping->setProperties($fields);
198
199		//This concatenates all the fields together into a single field.
200		//Initially added for suggestions compatibility, in that searching
201		//_all field picks up all possible suggestions
202	1	$mapping->enableAllField();
203
204	1	if($this->owner->hasMethod('updateElasticsearchMapping')) {
205	1	$mapping = $this->owner->updateElasticsearchMapping($mapping);
206	1	}
207	1	return $mapping;
208		}
209
210
211		/**
212		* Get an elasticsearch document
213		*
214		* @return \Elastica\Document
215		*/
216	1	public function getElasticaDocument() {
217	1	self::$index_ctr++;
218	1	$fields = $this->getFieldValuesAsArray();
219	1	$progress = \Controller::curr()->request->getVar('progress');
220	1	if(!empty($progress)) {
221		self::$progressInterval = (int)$progress;
222	1	}
223
224	1	if(self::$progressInterval > 0) {
225	1	if(self::$index_ctr % self::$progressInterval === 0) {
226		ElasticaUtil::message("\t" . $this->owner->ClassName . " - Prepared " . self::$index_ctr . " for indexing...");
227		}
228	1	}
229
230		// Optionally update the document
231	1	$document = new Document($this->owner->ID, $fields);
232	1	if($this->owner->hasMethod('updateElasticsearchDocument')) {
233	1	$document = $this->owner->updateElasticsearchDocument($document);
234	1	}
235
236		// Check if the current classname is part of the site tree or not
237		// Results are cached to save reprocessing the same
238	1	$classname = $this->owner->ClassName;
239	1	$inSiteTree = SearchableHelper::isInSiteTree($classname);
240
241	1	$document->set('IsInSiteTree', $inSiteTree);
242	1	if($inSiteTree) {
243	1	$document->set('Link', $this->owner->AbsoluteLink());
244	1	}
245
246	1	if(isset($this->owner->Locale)) {
247		$document->set('Locale', $this->owner->Locale);
248	1	}
249
250	1	return $document;
251		}
252
253
254	1	public function getFieldValuesAsArray($recurse = true) {
255	1	$fields = array();
256	1	foreach($this->getElasticaFields($recurse) as $field => $config) {
257		//This is the case of calling a method to get a value, the field does not exist in the DB
258	1	if(null === $this->owner->$field && is_callable(get_class($this->owner) . "::" . $field)) {
259		// call a method to get a field value
260	1	SearchableHelper::storeMethodTextValue($this->owner, $field, $fields, $this->html_fields);
261	1	} else {
262	1	if(in_array($field, $this->html_fields)) {
263	1	SearchableHelper::storeFieldHTMLValue($this->owner, $field, $fields);
264	1	} else {
265	1	SearchableHelper::storeRelationshipValue($this->owner, $field, $fields, $config, $recurse);
266		}
267		}
268	1	}
269	1	return $fields;
270		}
271
272
273		/**
274		* Returns whether to include the document into the search index.
275		* All documents are added unless they have a field "ShowInSearch" which is set to false
276		*
277		* @return boolean
278		*/
279	1	public function showRecordInSearch() {
280	1	return !($this->owner->hasField('ShowInSearch') && false == $this->owner->ShowInSearch);
281		}
282
283
284		/**
285		* Delete the record from the search index if ShowInSearch is deactivated (non-SiteTree).
286		*/
287	1	public function onBeforeWrite() {
288		if(
289	1	$this->owner instanceof \SiteTree &&
290	1	$this->owner->hasField('ShowInSearch') &&
291	1	$this->owner->isChanged('ShowInSearch', 2) &&
292		false == $this->owner->ShowInSearch
293	1	) {
294		$this->doDeleteDocument();
295		}
296	1	}
297
298
299		/**
300		* Delete the record from the search index if ShowInSearch is deactivated (SiteTree).
301		*/
302		public function onBeforePublish() {
303		if(false == $this->owner->ShowInSearch && $this->owner->isPublished()) {
304		$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
305		byID($this->owner->ID);
306		if($liveRecord->ShowInSearch != $this->owner->ShowInSearch) {
307		$this->doDeleteDocument();
308		}
309		}
310		}
311
312
313		/**
314		* Updates the record in the search index (non-SiteTree).
315		*/
316	1	public function onAfterWrite() {
317	1	$this->doIndexDocument();
318	1	}
319
320
321		/**
322		* Updates the record in the search index (SiteTree).
323		*/
324		public function onAfterPublish() {
325		$this->doIndexDocument();
326		}
327
328
329		/**
330		* Updates the record in the search index.
331		*/
332	1	protected function doIndexDocument() {
333	1	if($this->showRecordInSearch() && !$this->owner->IndexingOff) {
334	1	$this->service->index($this->owner);
335	1	}
336	1	}
337
338
339		/**
340		* Removes the record from the search index (non-SiteTree).
341		*/
342		public function onAfterDelete() {
343		$this->doDeleteDocumentIfInSearch();
344		}
345
346
347		/**
348		* Removes the record from the search index (non-SiteTree).
349		*/
350		public function onAfterUnpublish() {
351		$this->doDeleteDocumentIfInSearch();
352		}
353
354
355		/**
356		* Removes the record from the search index if the "ShowInSearch" attribute is set to true.
357		*/
358		protected function doDeleteDocumentIfInSearch() {
359		if($this->showRecordInSearch()) {
360		$this->doDeleteDocument();
361		}
362		}
363
364
365		/**
366		* Removes the record from the search index.
367		*/
368		protected function doDeleteDocument() {
369		try {
370		if(!$this->owner->IndexingOff) {
371		// this goes to elastica service
372		$this->service->remove($this->owner);
373		}
374		} catch (\Elastica\Exception\NotFoundException $e) {
375		trigger_error("Deleted document " . $this->owner->ClassName . " (" . $this->owner->ID .
376		") not found in search index.", E_USER_NOTICE);
377		}
378		}
379
380
381		/**
382		* Return all of the searchable fields defined in $this->owner::$searchable_fields and all the parent classes.
383		*
384		* @param $recuse Whether or not to traverse relationships. First time round yes, subsequently no
385		* @return array searchable fields
386		*/
387	1	public function getAllSearchableFields($recurse = true) {
388	1	$fields = \Config::inst()->get(get_class($this->owner), 'searchable_fields');
389
390		// fallback to default method
391	1	if(!$fields) {
392		user_error('The field $searchable_fields must be set for the class ' . $this->owner->ClassName);
393		}
394
395		// get the values of these fields
396	1	$elasticaMapping = SearchableHelper::fieldsToElasticaConfig($fields);
397
398	1	if($recurse) {
399		// now for the associated methods and their results
400	1	$methodDescs = \Config::inst()->get(get_class($this->owner), 'searchable_relationships');
401	1	$has_ones = $this->owner->has_one();
402	1	$has_lists = SearchableHelper::getListRelationshipMethods($this->owner);
403
404	1	if(isset($methodDescs) && is_array($methodDescs)) {
405	1	foreach($methodDescs as $methodDesc) {
406		// split before the brackets which can optionally list which fields to index
407	1	$splits = explode('(', $methodDesc);
408	1	$methodName = $splits[0];
409
410	1	if(isset($has_lists[$methodName])) {
411
412	1	$relClass = $has_lists[$methodName];
413	1	$fields = \Config::inst()->get($relClass, 'searchable_fields');
414	1	if(!$fields) {
415		user_error('The field $searchable_fields must be set for the class ' . $relClass);
416		}
417	1	$rewrite = SearchableHelper::fieldsToElasticaConfig($fields);
418
419		// mark as a method, the resultant fields are correct
420	1	$elasticaMapping[$methodName . '()'] = $rewrite;
421	1	} else if(isset($has_ones[$methodName])) {
422	1	$relClass = $has_ones[$methodName];
423	1	$fields = \Config::inst()->get($relClass, 'searchable_fields');
424	1	if(!$fields) {
425		user_error('The field $searchable_fields must be set for the class ' . $relClass);
426		}
427	1	$rewrite = SearchableHelper::fieldsToElasticaConfig($fields);
428
429		// mark as a method, the resultant fields are correct
430	1	$elasticaMapping[$methodName . '()'] = $rewrite;
431	1	} else {
432		user_error('The method ' . $methodName . ' not found in class ' . $this->owner->ClassName .
433		', please check configuration');
434		}
435	1	}
436	1	}
437	1	}
438
439	1	return $elasticaMapping;
440		}
441
442
443
444
445	1	public function requireDefaultRecords() {
446	1	parent::requireDefaultRecords();
447	1	$searchableFields = $this->getElasticaFields(true, true);
448	1	$doSC = SearchableHelper::findOrCreateSearchableClass($this->owner->ClassName);
449
450	1	foreach($searchableFields as $name => $searchableField) {
451		// check for existence of methods and if they exist use that as the name
452	1	if(!isset($searchableField['type'])) {
453	1	$name = $searchableField['properties']['__method'];
454	1	}
455
456	1	SearchableHelper::findOrCreateSearchableField(
457	1	$this->owner->ClassName,
458	1	$name,
459	1	$searchableField,
460		$doSC
461	1	);
462
463		// FIXME deal with deletions
464	1	}
465	1	}
466
467
468		/*
469		Allow the option of overriding the default template with one of <ClassName>ElasticSearchResult
470		*/
471		public function RenderResult($linkToContainer = '') {
472		$vars = new \ArrayData(array('SearchResult' => $this->owner, 'ContainerLink' => $linkToContainer));
473		$possibleTemplates = array($this->owner->ClassName . 'ElasticSearchResult', 'ElasticSearchResult');
474		return $this->owner->customise($vars)->renderWith($possibleTemplates);
475		}
476
477
478		public function getTermVectors() {
479		return $this->service->getTermVectors($this->owner);
480		}
481
482
483		public function updateCMSFields(\FieldList $fields) {
484		$isIndexed = false;
485		// SIteTree object must have a live record, ShowInSearch = true
486		if (\DB::getConn()->hasTable($this->owner->ClassName)) {
		0 ignored issues – show Deprecated Code introduced 2015-12-29 09:15 UTC by Report Bug Copy Issue Report The method `DB::getConn()` has been deprecated with message: since version 4.0 Use DB::get_conn instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history... Deprecated Code introduced 2015-12-29 09:15 UTC by Report Bug Copy Issue Report The method `SS_Database::hasTable()` has been deprecated with message: since version 4.0 Use DB::get_schema()->hasTable() instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
487		if(SearchableHelper::isInSiteTree($this->owner->ClassName)) {
488		$liveRecord = \Versioned::get_by_stage(get_class($this->owner), 'Live')->
489		byID($this->owner->ID);
490		if(!empty($liveRecord) && $liveRecord->ShowInSearch) {
491		$isIndexed = true;
492		} else {
493		$isIndexed = false;
494		}
495		} else {
496		// In the case of a DataObject we use the ShowInSearchFlag
497		$isIndexed = true;
498		}
499		}
500
501
502		if($isIndexed) {
503		$termVectors = $this->getTermVectors();
504		$termFields = array_keys($termVectors);
505		sort($termFields);
506
507		foreach($termFields as $field) {
508		$terms = new \ArrayList();
509
510		foreach(array_keys($termVectors[$field]['terms']) as $term) {
511		$do = new \DataObject();
512		$do->Term = $term;
513		$stats = $termVectors[$field]['terms'][$term];
514		if(isset($stats['ttf'])) {
515		$do->TTF = $stats['ttf'];
516		}
517
518		if(isset($stats['doc_freq'])) {
519		$do->DocFreq = $stats['doc_freq'];
520		}
521
522		if(isset($stats['term_freq'])) {
523		$do->TermFreq = $stats['term_freq'];
524		}
525		$terms->push($do);
526		}
527
528		$config = \GridFieldConfig_RecordViewer::create(100);
529		$config->getComponentByType('GridFieldDataColumns')->setDisplayFields(array(
		0 ignored issues – show Bug introduced 2015-12-30 05:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setDisplayFields()` does only exist in the following implementations of said interface: `GridFieldDataColumns`, `GridFieldEditableColumns`, `GridFieldExternalLink`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
530		'Term' => 'Term',
531		'TTF' => 'Total term frequency (how often a term occurs in all documents)',
532		'DocFreq' => 'n documents with this term',
533		'TermFreq'=> 'n times this term appears in this field'
534		));
535
536		$underscored = str_replace('.', '_', $field);
537
538		$gridField = new \GridField(
539		'TermsFor' . $underscored, // Field name
540		$field . 'TITLE' . $field, // Field title
541		$terms,
542		$config
543		);
544		$fields->addFieldToTab('Root.ElasticaTerms.' . $underscored, $gridField);
545		}
546
547		}
548
549		return $fields;
550		}
551
552
553		}
554

gordonbanderson / silverstripe-elastica

Push — dev2 ( 764ed3...9e10b9 )

Searchable F

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

23 Methods

How to fix Complexity

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like