tonyair
/
silverstripe-fulltextsearch
mirror of https://github.com/silverstripe/silverstripe-fulltextsearch
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

MINOR Correct PHPDoc types and remove unused imports

This commit is contained in:
Robbie Averill 2018-01-10 19:55:09 +13:00
parent 0bb82bf71b
commit 345a45d532
2 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/Search/Indexes/SearchIndex.php
View File

@ -3,7 +3,6 @@
namespace SilverStripe\FullTextSearch\Search\Indexes; namespace SilverStripe\FullTextSearch\Search\Indexes;
use Exception; use Exception;
use InvalidArgumentException;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use SilverStripe\Core\ClassInfo; use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config; use SilverStripe\Core\Config\Config;
@ -93,30 +92,31 @@ abstract class SearchIndex extends ViewableData
} }
/** /**
* Examines the classes this index is built on to try and find defined fields in the class hierarchy for those classes. * Examines the classes this index is built on to try and find defined fields in the class hierarchy
* Looks for db and viewable-data fields, although can't nessecarily find type for viewable-data fields. * for those classes.
* Looks for db and viewable-data fields, although can't necessarily find type for viewable-data fields.
* If multiple classes have a relation with the same name all of these will be included in the search index * If multiple classes have a relation with the same name all of these will be included in the search index
* Note that only classes that have the relations uninherited (defined in them) will be listed * Note that only classes that have the relations uninherited (defined in them) will be listed
* this is because inherited relations do not need to be processed by index explicitly * this is because inherited relations do not need to be processed by index explicitly
*/ */
public function fieldData($field, $forceType = null, $extraOptions = array()) public function fieldData($field, $forceType = null, $extraOptions = [])
{ {
$fullfield = str_replace(".", "_", $field); $fullfield = str_replace(".", "_", $field);
$sources = $this->getClasses(); $sources = $this->getClasses();
foreach ($sources as $source => $options) { foreach ($sources as $source => $options) {
$sources[$source]['base'] = DataObject::getSchema()->baseDataClass($source); $sources[$source]['base'] = DataObject::getSchema()->baseDataClass($source);
$sources[$source]['lookup_chain'] = array(); $sources[$source]['lookup_chain'] = [];
} }
$found = array(); $found = [];
if (strpos($field, '.') !== false) { if (strpos($field, '.') !== false) {
$lookups = explode(".", $field); $lookups = explode(".", $field);
$field = array_pop($lookups); $field = array_pop($lookups);
foreach ($lookups as $lookup) { foreach ($lookups as $lookup) {
$next = array(); $next = [];
foreach ($sources as $source => $baseOptions) { foreach ($sources as $source => $baseOptions) {
$source = $this->getSourceName($source); $source = $this->getSourceName($source);
@ -273,7 +273,7 @@ abstract class SearchIndex extends ViewableData
* yet been called for this index instance * yet been called for this index instance
* *
* @throws Exception * @throws Exception
* @param String $class - The class to include * @param string $class - The class to include
* @param array $options - TODO: Remove * @param array $options - TODO: Remove
*/ */
public function addClass($class, $options = array()) public function addClass($class, $options = array())
@ -303,9 +303,9 @@ abstract class SearchIndex extends ViewableData
/** /**
* Add a field that should be fulltext searchable * Add a field that should be fulltext searchable
* @param String $field - The field to add * @param string $field - The field to add
* @param String $forceType - The type to force this field as (required in some cases, when not detectable from metadata) * @param string $forceType - The type to force this field as (required in some cases, when not detectable from metadata)
* @param String $extraOptions - Dependent on search implementation * @param string $extraOptions - Dependent on search implementation
*/ */
public function addFulltextField($field, $forceType = null, $extraOptions = array()) public function addFulltextField($field, $forceType = null, $extraOptions = array())
{ {
@ -319,9 +319,9 @@ abstract class SearchIndex extends ViewableData
/** /**
* Add a field that should be filterable * Add a field that should be filterable
* @param String $field - The field to add * @param string $field - The field to add
* @param String $forceType - The type to force this field as (required in some cases, when not detectable from metadata) * @param string $forceType - The type to force this field as (required in some cases, when not detectable from metadata)
* @param String $extraOptions - Dependent on search implementation * @param string $extraOptions - Dependent on search implementation
*/ */
public function addFilterField($field, $forceType = null, $extraOptions = array()) public function addFilterField($field, $forceType = null, $extraOptions = array())
{ {
@ -335,9 +335,9 @@ abstract class SearchIndex extends ViewableData
/** /**
* Add a field that should be sortable * Add a field that should be sortable
* @param String $field - The field to add * @param string $field - The field to add
* @param String $forceType - The type to force this field as (required in some cases, when not detectable from metadata) * @param string $forceType - The type to force this field as (required in some cases, when not detectable from metadata)
* @param String $extraOptions - Dependent on search implementation * @param string $extraOptions - Dependent on search implementation
*/ */
public function addSortField($field, $forceType = null, $extraOptions = array()) public function addSortField($field, $forceType = null, $extraOptions = array())
{ {
@ -467,9 +467,9 @@ abstract class SearchIndex extends ViewableData
/** /**
* Get the "document ID" (a database & variant unique id) given some "Base" class, DataObject ID and state array * Get the "document ID" (a database & variant unique id) given some "Base" class, DataObject ID and state array
* *
* @param String $base - The base class of the object * @param string $base - The base class of the object
* @param Integer $id - The ID of the object * @param integer $id - The ID of the object
* @param Array $state - The variant state of the object * @param array $state - The variant state of the object
* @return string - The document ID as a string * @return string - The document ID as a string
*/ */
public function getDocumentIDForState($base, $id, $state) public function getDocumentIDForState($base, $id, $state)
@ -483,8 +483,8 @@ abstract class SearchIndex extends ViewableData
* Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject * Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject
* *
* @param DataObject $object - The object * @param DataObject $object - The object
* @param String $base - The base class of the object * @param string $base - The base class of the object
* @param Boolean $includesubs - TODO: Probably going away * @param boolean $includesubs - TODO: Probably going away
* @return string - The document ID as a string * @return string - The document ID as a string
*/ */
public function getDocumentID($object, $base, $includesubs) public function getDocumentID($object, $base, $includesubs)
@ -496,8 +496,8 @@ abstract class SearchIndex extends ViewableData
* Given an object and a field definition (as returned by fieldData) get the current value of that field on that object * Given an object and a field definition (as returned by fieldData) get the current value of that field on that object
* *
* @param DataObject $object - The object to get the value from * @param DataObject $object - The object to get the value from
* @param Array $field - The field definition to use * @param array $field - The field definition to use
* @return Mixed - The value of the field, or null if we couldn't look it up for some reason * @return mixed - The value of the field, or null if we couldn't look it up for some reason
*/ */
protected function _getFieldValue($object, $field) protected function _getFieldValue($object, $field)
{ {
@ -577,10 +577,10 @@ abstract class SearchIndex extends ViewableData
* *
* Internal function used by SearchUpdater. * Internal function used by SearchUpdater.
* *
* @param $class * @param string $class
* @param $id * @param int $id
* @param $statefulids * @param array $statefulids
* @param $fields * @param array $fields
* @return array * @return array
*/ */
public function getDirtyIDs($class, $id, $statefulids, $fields) public function getDirtyIDs($class, $id, $statefulids, $fields)

2
src/Search/SearchIntrospection.php
View File

@ -33,7 +33,7 @@ class SearchIntrospection
* @param string $class - The class to query * @param string $class - The class to query
* @param bool $includeSubclasses - True to return subclasses as well as super classes * @param bool $includeSubclasses - True to return subclasses as well as super classes
* @param bool $dataOnly - True to only return classes that have tables * @param bool $dataOnly - True to only return classes that have tables
* @return Array - Integer keys, String values as classes sorted by depth (most super first) * @return array - Integer keys, String values as classes sorted by depth (most super first)
*/ */
public static function hierarchy($class, $includeSubclasses = true, $dataOnly = false) public static function hierarchy($class, $includeSubclasses = true, $dataOnly = false)
{ {