Selector maintains a single selector consisting of field name, operator, and value.

  • Serves as the base class for the different Selector types (SelectorEqual, SelectorNotEqual, SelectorLessThan, etc.)
  • The constructor requires $field and $value properties which may either be an array or string. An array indicates multiple items in an OR condition. Multiple items may also be specified by pipe “|” separated strings.
  • Operator is determined by the Selector class name, and thus may not be changed without replacing the entire Selector.
// very basic usage example
// constructor takes ($field, $value) which can be strings or arrays
$s = new SelectorEqual('title', 'About Us');
// $page can be any kind of Wire-derived object
if($s->matches($page)) {
  // $page has title "About Us"
}
// another usage example
$s = new SelectorContains('title|body|summary', 'foo|bar');
if($s->matches($page)) {
  // the title, body or summary properties of $page contain either the text "foo" or "bar"
}

List of core selector-derived classes

  • SelectorEqual
  • SelectorNotEqual
  • SelectorGreaterThan
  • SelectorLessThan
  • SelectorGreaterThanEqual
  • SelectorLessThanEqual
  • SelectorContains
  • SelectorContainsLike
  • SelectorContainsWords
  • SelectorStarts
  • SelectorStartsLike
  • SelectorEnds
  • SelectorEndsLike
  • SelectorBitwiseAnd

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Selector class also inherits all the methods and properties of: WireData and Wire.

Common / Properties

Show “Selector”             Show Arguments        

Common

NameReturnSummary 
Selector::field()
string, array or nullGet the field(s) of this Selector
Can also be used as property: Selector::field
Selector::fields()
arrayReturn array of field(s) for this Selector
Can also be used as property: Selector::fields
Selector::get($key)
mixed or nullRetrieve the value for a previously set property, or retrieve an API variable
Selector::matches($value)
boolDoes this Selector match the given value?
Selector::operator()
stringReturn the operator used by this Selector
Can also be used as property: Selector::operator
Selector::set(string $key, mixed $value)
$thisSet a property of the Selector
Selector::value()
string, array or nullGet the value(s) of this Selector
Can also be used as property: Selector::value
Selector::values()
arrayReturn array of value(s) for this Selector
Can also be used as property: Selector::values

Properties

NameReturnSummary 
Selector::forceMatch null or bool When boolean, it forces match (true) or non-match (false). (default=null)
Selector::group string or null Group name for this selector (if field was prepended with a "group_name@").
Selector::not bool Is this a NOT selector? Indicates the selector returns the opposite if what it would otherwise.
Selector::quote string Type of quotes value was in, or blank if it was not quoted. One of: '"[{(
Selector::str string String value of selector, i.e. “a=b”.

Additional methods and properties

In addition to the methods and properties above, Selector also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.62