PHP Класс DMS\Filter\Rules\Rule

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( mixed $options = null ) Initializes the filter rule with its options
getDefaultOption ( ) : string Returns the name of the default option
getFilter ( ) : string Retrieves the Filter class that is responsible for executing this filter It may also be a service name. By default it loads a class with the same name from the Filters namespace.
getRequiredOptions ( ) : array Returns the name of the required options

Приватные методы

Метод Описание
parseOptions ( mixed $options ) : stdClass Parses provided options into their properties and returns results for the parsing process
parseOptionsArray ( array $options, stdClass $result ) Parses Options in the array format
parseSingleOption ( string $options, stdClass $result ) Parses single option received

Описание методов

__construct() публичный Метод

Initializes the filter rule with its options
public __construct ( mixed $options = null )
$options mixed The options (as associative array) or the value for the default option (any other type)

getDefaultOption() публичный Метод

Override this method to define a default option.
См. также: __construct()
public getDefaultOption ( ) : string
Результат string

getFilter() публичный Метод

Retrieves the Filter class that is responsible for executing this filter It may also be a service name. By default it loads a class with the same name from the Filters namespace.
public getFilter ( ) : string
Результат string

getRequiredOptions() публичный Метод

Override this method if you want to define required options.
См. также: __construct()
public getRequiredOptions ( ) : array
Результат array