TestFilter Class Reference
Simple filter to use in tests. More...
Inheritance diagram for TestFilter:
Public Member Functions | ||||
| getConfigurationValue (string $optionName) | ||||
| Retrieve a configuration value for a named option. More... | ||||
| getAllConfigurationValues () | ||||
| Retrieve a list of all available configuration values. More... | ||||
| filter (Record $record) | ||||
Decide whether a data record should be processed.
| ||||
Detailed Description
Simple filter to use in tests.
One configuration option is supported, 'criteria', which consists of an array containing two values: the name of the property whose value will be checked, and the value to compare it to. Some examples:
// This filter accepts only data records whose id property is equal to 5.
$filter = new Select(['criteria' => ['id', 5]]);
Member Function Documentation
◆ getConfigurationValue()
| getConfigurationValue | ( | string | $optionName | ) |
Retrieve a configuration value for a named option.
- Parameters
-
string $optionName Name of the option to retrieve.
- Returns
- mixed|null Retrieved value, or NULL if unset.
Implements ConfigurableComponent.
Referenced by TestFilter\filter().
◆ getAllConfigurationValues()
| getAllConfigurationValues | ( | ) |
Retrieve a list of all available configuration values.
- Returns
- iterable Option values keyed by names.
Implements ConfigurableComponent.
