Selector class

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
• SelectorContainsWordsPartial (3.0.160+)
• SelectorContainsWordsLive (3.0.160)
• SelectorContainsWordsLike (3.0.160)
• SelectorContainsWordsExpand (3.0.160)
• SelectorContainsAnyWords (3.0.160)
• SelectorContainsAnyWordsPartial (3.0.160)
• SelectorContainsAnyWordsLike (3.0.160)
• SelectorContainsExpand (3.0.160)
• SelectorContainsMatch (3.0.160)
• SelectorContainsMatchExpand (3.0.160)
• SelectorContainsAdvanced (3.0.160)
• 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

Additional methods and properties

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

• WireData
• Wire