MediaWiki  REL1_31
SearchIndexFieldDefinition.php
Go to the documentation of this file.
1 <?php
2 
11 abstract class SearchIndexFieldDefinition implements SearchIndexField {
12 
18  protected $name;
19 
25  protected $type;
26 
32  protected $flags = 0;
33 
38  protected $subfields = [];
39 
43  private $mergeCallback;
44 
49  public function __construct( $name, $type ) {
50  $this->name = $name;
51  $this->type = $type;
52  }
53 
58  public function getName() {
59  return $this->name;
60  }
61 
66  public function getIndexType() {
67  return $this->type;
68  }
69 
77  public function setFlag( $flag, $unset = false ) {
78  if ( $unset ) {
79  $this->flags &= ~$flag;
80  } else {
81  $this->flags |= $flag;
82  }
83  return $this;
84  }
85 
91  public function checkFlag( $flag ) {
92  return $this->flags & $flag;
93  }
94 
101  public function merge( SearchIndexField $that ) {
102  if ( !empty( $this->mergeCallback ) ) {
103  return call_user_func( $this->mergeCallback, $this, $that );
104  }
105  // TODO: which definitions may be compatible?
106  if ( ( $that instanceof self ) && $this->type === $that->type &&
107  $this->flags === $that->flags && $this->type !== self::INDEX_TYPE_NESTED
108  ) {
109  return $that;
110  }
111  return false;
112  }
113 
118  public function getSubfields() {
119  return $this->subfields;
120  }
121 
127  public function setSubfields( array $subfields ) {
128  $this->subfields = $subfields;
129  return $this;
130  }
131 
137  abstract public function getMapping( SearchEngine $engine );
138 
143  public function setMergeCallback( $callback ) {
144  $this->mergeCallback = $callback;
145  }
146 
150  public function getEngineHints( SearchEngine $engine ) {
151  return [];
152  }
153 }
type
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:30
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SearchIndexFieldDefinition\merge
merge(SearchIndexField $that)
Merge two field definitions if possible.
Definition: SearchIndexFieldDefinition.php:101
SearchIndexFieldDefinition\checkFlag
checkFlag( $flag)
Check if flag is set.
Definition: SearchIndexFieldDefinition.php:91
SearchIndexFieldDefinition\getName
getName()
Get field name.
Definition: SearchIndexFieldDefinition.php:58
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
flags
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical it also represents a few features of articles that don t involve their such as access rights See also title txt Article Encapsulates access to the page table of the database The object represents a an and maintains state such as flags
Definition: design.txt:34
SearchIndexFieldDefinition\getEngineHints
getEngineHints(SearchEngine $engine)
@inheritDoc
Definition: SearchIndexFieldDefinition.php:150
SearchIndexFieldDefinition\getIndexType
getIndexType()
Get index type.
Definition: SearchIndexFieldDefinition.php:66
SearchIndexFieldDefinition\$flags
int $flags
Bit flags for the field.
Definition: SearchIndexFieldDefinition.php:32
SearchIndexFieldDefinition\$name
string $name
Name of the field.
Definition: SearchIndexFieldDefinition.php:18
SearchIndexFieldDefinition\setSubfields
setSubfields(array $subfields)
Set subfields.
Definition: SearchIndexFieldDefinition.php:127
SearchIndexFieldDefinition\__construct
__construct( $name, $type)
Definition: SearchIndexFieldDefinition.php:49
SearchIndexFieldDefinition\getMapping
getMapping(SearchEngine $engine)
SearchIndexFieldDefinition\setMergeCallback
setMergeCallback( $callback)
Set field-specific merge strategy.
Definition: SearchIndexFieldDefinition.php:143
$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2881
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:34
SearchIndexFieldDefinition\getSubfields
getSubfields()
Get subfields.
Definition: SearchIndexFieldDefinition.php:118
SearchIndexFieldDefinition\$type
int $type
Type of the field, one of the constants above.
Definition: SearchIndexFieldDefinition.php:25
SearchIndexFieldDefinition
Basic infrastructure of the field definition.
Definition: SearchIndexFieldDefinition.php:11
name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
SearchIndexFieldDefinition\$subfields
SearchIndexFieldDefinition[] $subfields
Subfields.
Definition: SearchIndexFieldDefinition.php:38
SearchIndexField
Definition of a mapping for the search index field.
Definition: SearchIndexField.php:6
SearchIndexFieldDefinition\setFlag
setFlag( $flag, $unset=false)
Set global flag for this field.
Definition: SearchIndexFieldDefinition.php:77
SearchIndexFieldDefinition\$mergeCallback
callable $mergeCallback
Definition: SearchIndexFieldDefinition.php:43