XenForo options accessor class.
| package | XenForo_Options |
|---|
__construct(array $options)
Sets up the accessor using the provided options.
arrayCollection of options. Keys represent option names.
__get(string $option) : null | mixed
This method cannot be used for getting a sub-option! You must use get() for that.
This is equivalent to calling get() with no sub-option, which means the "main" sub-option will be returned (if applicable).
string
nullmixed
__isset(string $option) : boolean
Do not use this approach for sub-options!
This is equivalent to calling get() with no sub-option, which means the "main" sub-option will be returned (if applicable).
string
boolean__set(string $name, mixed $value)
Only sets whole options.
string
mixed
get(string $optionName, null | false | string $subOption) : null | mixed
If the option exists and is an array, then... * if no sub-option is specified but an $optionName key exists in the option, return the value for that key * if no sub-option is specified and no $optionName key exists, return the whole option array * if the sub-option === false, the entire option is returned, regardless of what keys exist * if a sub-option is specified and the key exists, return the value for that key * if a sub-option is specified and the key does not exist, return null If the option is not an array, then the value of the option is returned (provided no sub-option is specified). Otherwise, null is returned.
stringName of the option
nullfalsestringSub-option. See above for usage.
nullmixedNull if the option doesn't exist (see above) or the option's value.getOptions() : array
arrayset(string $option, mixed $subOption, mixed | null $value)
string
mixedIf $value is null, then this is treated as the value; otherwise, a specific array key to change
mixednullIf null, ignored
setOptions(array $options)
array