ListStrategy Interface Reference

Detailed Description

ListStrategy defines the interface for classes that retrieve value lists.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

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 (   $options,
  $valuePattern = null,
  $key = null,
  $language = null 
)

Get a list of key/value pairs defined by the given configuration.

Parameters
$optionsAssociative array of implementation specific configuration
$valuePatternA regular expression pattern that the returned values should match (optional)
$keyA key value, if only one item should be returned (optional)
$languageThe 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, FixedListStrategy, FunctionListStrategy, and ConfigListStrategy.

isStatic (   $options)

Check if the list values are static or changing.

Parameters
$optionsAssociative array of implementation specific configuration
Returns
Boolean

Implemented in NodeListStrategy, FixedListStrategy, FileListStrategy, FunctionListStrategy, and ConfigListStrategy.