Selectors class

Processes a selector string into a WireArray of Selector objects.

This Selectors class is used internally by ProcessWire to provide selector string (and array) matching throughout the core.

$selectors = new Selectors(); 
$selectors->init("sale_price|retail_price>100, currency=USD|EUR");
if($selectors->matches($page)) {
  // selector string matches the given $page (which can be any Wire-derived item)
}

// iterate and display what's in this Selectors object
foreach($selectors as $selector) {
  echo "<p>";
  echo "Field(s): " . implode('|', $selector->fields) . "<br>";
  echo "Operator: " . $selector->operator . "<br>";
  echo "Value(s): " . implode('|', $selector->values) . "<br>";
  echo "</p>";
}

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

Common

Name	Return	Summary
Selectors::debugInfoItem() Selectors::debugInfoItem($item) Selectors::debugInfoItem($item)	`array` `mixed` `null` `string`	Debug info for Selector item
Selectors::getAllFields() Selectors::getAllFields() Selectors::getAllFields(bool $subfields = true)	`array`	Return array of all field names referenced in all of the Selector objects here
Selectors::getAllValues() Selectors::getAllValues() Selectors::getAllValues()	`array`	Return array of all values referenced in all Selector objects here
Selectors::getSelectorByField() Selectors::getSelectorByField(string $fieldName) Selectors::getSelectorByField(string $fieldName, bool $or = false, bool $all = false)	`Selector` `array` `null`	Get the first selector that uses given field name
Selectors::getSelectorByFieldValue() Selectors::getSelectorByFieldValue(string $fieldName, $value) Selectors::getSelectorByFieldValue(string $fieldName, $value, bool $or = false, bool $all = false)	`Selector` `array` `null`	Get the first selector that uses given field name AND has the given value
Selectors::init() Selectors::init($selector) Selectors::init($selector)	(nothing)	Set the selector string or array (if not set already from the constructor)
Selectors::matches() Selectors::matches(Wire $item) Selectors::matches(Wire $item)	`bool`	Does the given Wire match these Selectors?

Advanced

Name	Return	Summary
Selectors::create() Selectors::create(string $field, string $operator, $value) Selectors::create(string $field, string $operator, $value)	`Selector`	Create a new Selector object from a field name, operator, and value

Static helpers

Static helper methods useful in analyzing selector strings outside of this class.

Name	Return	Summary
Selectors::arrayToKeyValueString() Selectors::arrayToKeyValueString(array $a) Selectors::arrayToKeyValueString(array $a)	`string`	Given an assoc array, convert to a key=value selector-style string
Selectors::getOperatorChars() Selectors::getOperatorChars() Selectors::getOperatorChars()	`array`	Return array of all valid operator characters
Selectors::getOperatorType() Selectors::getOperatorType(string $operator) Selectors::getOperatorType(string $operator, bool $is = false)	`bool` `string`	Return a string indicating the type of operator that it is, or false if not an operator
Selectors::getOperators() Selectors::getOperators() Selectors::getOperators(array $options = [])	`array` `string` `int`	Get all operators allowed by selectors
Selectors::getReservedChars() Selectors::getReservedChars() Selectors::getReservedChars()	`array`	Return array of other characters that have meaning in a selector outside of operators
Selectors::getSelectorByOperator() Selectors::getSelectorByOperator(string $operator) Selectors::getSelectorByOperator(string $operator, string $property = 'instance')	`Selector` `int` `string` `false`	Given an operator, return Selector instance (or other requested Selector property)
Selectors::isOperator() Selectors::isOperator(string $operator) Selectors::isOperator(string $operator, bool $returnOperator = false)	`bool` `string`	Returns true if given string is a recognized operator, or false if not
Selectors::keyValueStringToArray() Selectors::keyValueStringToArray(string $s) Selectors::keyValueStringToArray(string $s)	`array`	Simple "a=b, c=d" selector-style string conversion to associative array, for fast/simple needs
Selectors::selectorHasField() Selectors::selectorHasField($selectors, $fieldName) Selectors::selectorHasField($selectors, $fieldName, array $options = [])	`array` `bool`	Does given selector have given field (and optionally operator and/or value)?
Selectors::stringHasOperator() Selectors::stringHasOperator(string $str) Selectors::stringHasOperator(string $str, bool $getOperator = false)	`bool`	Does the given string have an operator in it?
Selectors::stringHasSelector() Selectors::stringHasSelector(string $str) Selectors::stringHasSelector(string $str)	`bool`	Is the given string a Selector string?

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Processes a selector string into a WireArray of Selector objects.

Common

Advanced

Static helpers

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news