MediaWiki  master
SearchIndexFieldDefinition Class Reference

Basic infrastructure of the field definition. More...

Inheritance diagram for SearchIndexFieldDefinition:
Collaboration diagram for SearchIndexFieldDefinition:

Public Member Functions

 __construct ( $name, $type)
 
 checkFlag ( $flag)
 Check if flag is set. More...
 
 getEngineHints (SearchEngine $engine)
 A list of search engine hints for this field.Hints are usually specific to a search engine implementation and allow to fine control how the search engine will handle this particular field.For example some search engine permits some optimizations at index time by ignoring an update if the updated value does not change by more than X% on a numeric value.
Parameters
SearchEngine$engine
Returns
array an array of hints generally indexed by hint name. The type of values is search engine specific
Since
1.30
More...
 
 getIndexType ()
 Get index type. More...
 
 getMapping (SearchEngine $engine)
 
 getName ()
 Get field name. More...
 
 getSubfields ()
 Get subfields. More...
 
 merge (SearchIndexField $that)
 Merge two field definitions if possible. More...
 
 setFlag ( $flag, $unset=false)
 Set global flag for this field. More...
 
 setMergeCallback ( $callback)
 Set field-specific merge strategy. More...
 
 setSubfields (array $subfields)
 Set subfields. More...
 

Protected Attributes

int $flags = 0
 Bit flags for the field. More...
 
string $name
 Name of the field. More...
 
SearchIndexFieldDefinition[] $subfields = []
 Subfields. More...
 
string $type
 Type of the field, one of the constants above. More...
 

Private Attributes

callable $mergeCallback
 

Additional Inherited Members

- Public Attributes inherited from SearchIndexField
const FLAG_CASEFOLD = 1
 Generic field flags. More...
 
const FLAG_NO_HIGHLIGHT = 4
 This field does not need highlight handling. More...
 
const FLAG_NO_INDEX = 8
 Do not index this field, just store it. More...
 
const FLAG_SCORING = 2
 This field contains secondary information, which is already present in other fields, but can be used for scoring. More...
 
const INDEX_TYPE_BOOL = 'bool'
 
const INDEX_TYPE_DATETIME = 'datetime'
 
const INDEX_TYPE_INTEGER = 'integer'
 
const INDEX_TYPE_KEYWORD = 'keyword'
 KEYWORD fields are indexed without any processing, so are appropriate for e.g. More...
 
const INDEX_TYPE_NESTED = 'nested'
 
const INDEX_TYPE_NUMBER = 'number'
 
const INDEX_TYPE_SHORT_TEXT = 'short_text'
 SHORT_TEXT is meant to be used with short text made of mostly ascii technical information. More...
 
const INDEX_TYPE_TEXT = 'text'
 TEXT fields are suitable for natural language and may be subject to analysis such as stemming. More...
 

Detailed Description

Basic infrastructure of the field definition.

Specific engines should extend this class and at at least, override the getMapping method, but can reuse other parts.

Stable to extend

Since
1.28

Definition at line 12 of file SearchIndexFieldDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

SearchIndexFieldDefinition::__construct (   $name,
  $type 
)
Parameters
string$nameField name
string$typeIndex type

Definition at line 50 of file SearchIndexFieldDefinition.php.

References $name, and $type.

Member Function Documentation

◆ checkFlag()

SearchIndexFieldDefinition::checkFlag (   $flag)

Check if flag is set.

Stable to override

Parameters
int$flag
Returns
int 0 if unset, !=0 if set

Implements SearchIndexField.

Definition at line 95 of file SearchIndexFieldDefinition.php.

◆ getEngineHints()

SearchIndexFieldDefinition::getEngineHints ( SearchEngine  $engine)

A list of search engine hints for this field.Hints are usually specific to a search engine implementation and allow to fine control how the search engine will handle this particular field.For example some search engine permits some optimizations at index time by ignoring an update if the updated value does not change by more than X% on a numeric value.

Parameters
SearchEngine$engine
Returns
array an array of hints generally indexed by hint name. The type of values is search engine specific
Since
1.30

Implements SearchIndexField.

Definition at line 155 of file SearchIndexFieldDefinition.php.

◆ getIndexType()

SearchIndexFieldDefinition::getIndexType ( )

Get index type.

Returns
string

Definition at line 67 of file SearchIndexFieldDefinition.php.

References $type.

◆ getMapping()

SearchIndexFieldDefinition::getMapping ( SearchEngine  $engine)
abstract
Parameters
SearchEngine$engine
Returns
array

Implements SearchIndexField.

Reimplemented in DummySearchIndexFieldDefinition.

◆ getName()

SearchIndexFieldDefinition::getName ( )

Get field name.

Returns
string

Definition at line 59 of file SearchIndexFieldDefinition.php.

References $name.

◆ getSubfields()

SearchIndexFieldDefinition::getSubfields ( )

Get subfields.

Returns
SearchIndexFieldDefinition[]

Definition at line 123 of file SearchIndexFieldDefinition.php.

References $subfields.

◆ merge()

SearchIndexFieldDefinition::merge ( SearchIndexField  $that)

Merge two field definitions if possible.

Stable to override

Parameters
SearchIndexField$that
Returns
SearchIndexField|false New definition or false if not mergeable.

Implements SearchIndexField.

Definition at line 106 of file SearchIndexFieldDefinition.php.

◆ setFlag()

SearchIndexFieldDefinition::setFlag (   $flag,
  $unset = false 
)

Set global flag for this field.

Stable to override

Parameters
int$flagBit flag to set/unset
bool$unsetTrue if flag should be unset, false by default
Returns
$this

Implements SearchIndexField.

Definition at line 79 of file SearchIndexFieldDefinition.php.

◆ setMergeCallback()

SearchIndexFieldDefinition::setMergeCallback (   $callback)

Set field-specific merge strategy.

Parameters
callable$callback

Definition at line 148 of file SearchIndexFieldDefinition.php.

◆ setSubfields()

SearchIndexFieldDefinition::setSubfields ( array  $subfields)

Set subfields.

Parameters
SearchIndexFieldDefinition[]$subfields
Returns
$this

Definition at line 132 of file SearchIndexFieldDefinition.php.

References $subfields.

Member Data Documentation

◆ $flags

int SearchIndexFieldDefinition::$flags = 0
protected

Bit flags for the field.

Definition at line 33 of file SearchIndexFieldDefinition.php.

Referenced by DummySearchIndexFieldDefinition\getMapping().

◆ $mergeCallback

callable SearchIndexFieldDefinition::$mergeCallback
private

Definition at line 44 of file SearchIndexFieldDefinition.php.

◆ $name

string SearchIndexFieldDefinition::$name
protected

Name of the field.

Definition at line 19 of file SearchIndexFieldDefinition.php.

Referenced by __construct(), DummySearchIndexFieldDefinition\getMapping(), and getName().

◆ $subfields

SearchIndexFieldDefinition [] SearchIndexFieldDefinition::$subfields = []
protected

Subfields.

Definition at line 39 of file SearchIndexFieldDefinition.php.

Referenced by getSubfields(), and setSubfields().

◆ $type

string SearchIndexFieldDefinition::$type
protected

Type of the field, one of the constants above.

Definition at line 26 of file SearchIndexFieldDefinition.php.

Referenced by __construct(), getIndexType(), and DummySearchIndexFieldDefinition\getMapping().


The documentation for this class was generated from the following file: