ListStrategy Interface Reference
Detailed Description
ListStrategy defines the interface for classes that retrieve value lists.
Definition at line 19 of file ListStrategy.php.
Inheritance diagram for ListStrategy:Public Member Functions | |
| getList ($options, $valuePattern=null, $key=null, $language=null) | |
| isStatic ($options) | |
Member Function Documentation
◆ getList()
| getList | ( | $options, | |
$valuePattern = null, |
|||
$key = null, |
|||
$language = null |
|||
| ) |
Get a list of key/value pairs defined by the given configuration.
- Parameters
-
$options Associative array of implementation specific configuration $valuePattern A regular expression pattern that the returned values should match (optional) $key A key value, if only one item should be returned (optional) $language The language if the values should be localized. Optional, default is Localization::getDefaultLanguage()
- Returns
- An assoziative array containing the key/value pairs
Implemented in NodeListStrategy, FileListStrategy, FunctionListStrategy, FixedListStrategy, and ConfigListStrategy.
◆ isStatic()
| isStatic | ( | $options | ) |
Check if the list values are static or changing.
- Parameters
-
$options Associative array of implementation specific configuration
- Returns
- Boolean
Implemented in NodeListStrategy, FunctionListStrategy, FixedListStrategy, FileListStrategy, and ConfigListStrategy.