EventDefinableOptions
extends DefinableOptions
in package
Base class for a set of options that have definitions that can be modified through an event
Table of Contents
- EVENT_OPTIONS_DEFINITIONS = 'options-definitions'
- $_defaultValues : array<string|int, mixed>
- $_definitions : array<string|int, mixed>
- $_values : array<string|int, mixed>
- __get() : mixed
- __isset() : mixed
- __set() : mixed
- attributes() : mixed
- defineDefaultValues() : array<string|int, mixed>
- Define the default values
- defineOptions() : array<string|int, mixed>
- Define the options
- fields() : mixed
- getConfig() : array<string|int, mixed>
- getDefaultValues() : array<string|int, mixed>
- Get all default values
- getDefinitions() : array<string|int, mixed>
- Get the options definitions.
- getValue() : mixed
- Get the value for an option
- getValues() : array<string|int, mixed>
- Get all values
- hasOption() : bool
- Is an options defined
- replaceValues() : mixed
- Replace all values
- setValue() : mixed
- Set value for an option
- setValues() : mixed
- Set all values
- register() : mixed
- Register options definitions and default values through an event
- reservedWords() : array<string|int, mixed>
- Reserved words that options can't take
Constants
EVENT_OPTIONS_DEFINITIONS
public
mixed
EVENT_OPTIONS_DEFINITIONS
= 'options-definitions'
Properties
$_defaultValues
protected
array<string|int, mixed>
$_defaultValues
$_definitions
protected
array<string|int, mixed>
$_definitions
$_values
protected
array<string|int, mixed>
$_values
= []
Methods
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Tags
Return values
mixed —__isset()
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
Tags
Return values
mixed —__set()
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Tags
Return values
mixed —attributes()
public
attributes() : mixed
Tags
Return values
mixed —defineDefaultValues()
Define the default values
public
defineDefaultValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —defineOptions()
Define the options
public
defineOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —fields()
public
fields() : mixed
Tags
Return values
mixed —getConfig()
public
getConfig() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getDefaultValues()
Get all default values
public
getDefaultValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefinitions()
Get the options definitions.
public
getDefinitions() : array<string|int, mixed>
Throws an event to allow other plugins to modify the options
Return values
array<string|int, mixed> —getValue()
Get the value for an option
public
getValue(string $name) : mixed
Parameters
- $name : string
Return values
mixed —getValues()
Get all values
public
getValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasOption()
Is an options defined
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
bool —replaceValues()
Replace all values
public
replaceValues(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
Return values
mixed —setValue()
Set value for an option
public
setValue(string $name, mixed $value) : mixed
Parameters
- $name : string
- $value : mixed
Return values
mixed —setValues()
Set all values
public
setValues(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
Return values
mixed —register()
Register options definitions and default values through an event
protected
register() : mixed
Return values
mixed —reservedWords()
Reserved words that options can't take
protected
reservedWords() : array<string|int, mixed>