FilterScope
class FilterScope
Filter scope definition A translation of the filter scope configuration
Adapted from october\backend\classes\FilterScope
Properties
| string | $scopeName | ||
| string | $idPrefix | ||
| string | $nameFrom | ||
| string | $descriptionFrom | ||
| string | $label | ||
| string | $value | ||
| string | $type | ||
| string | $options | ||
| string | $context | ||
| bool | $disabled | ||
| string | $defaults | ||
| string | $conditions | ||
| string | $scope | ||
| string | $cssClass | ||
| string | $mode | ||
| array | $config |
Methods
__construct($scopeName, $label)
No description
$this
displayAs(string $type, array $config = [])
Specifies a scope control rendering mode. Supported modes are:
- group - filter by a group of IDs. Default.
array
evalConfig(array $config)
Process options and apply them to this object.
string
getId(null $suffix = null)
Returns a value suitable for the scope id property.
Details
at line 93
__construct($scopeName, $label)
No description
at line 109
$this
displayAs(string $type, array $config = [])
Specifies a scope control rendering mode. Supported modes are:
- group - filter by a group of IDs. Default.
- checkbox - filter by a simple toggle switch.
at line 124
protected array
evalConfig(array $config)
Process options and apply them to this object.
at line 166
string
getId(null $suffix = null)
Returns a value suitable for the scope id property.