Documentation

Less_Configurable
in package

Configurable

Tags
subpackage

Core

Table of Contents

$defaultOptions  : array<string|int, mixed>
Array of default options
$options  : array<string|int, mixed>
Array of options
getOption()  : mixed
Get an option value by name
setOption()  : mixed
Set an option
setOptions()  : mixed
Set options

Properties

$defaultOptions

Array of default options

protected array<string|int, mixed> $defaultOptions = array()

$options

Array of options

protected array<string|int, mixed> $options = array()

Methods

getOption()

Get an option value by name

public getOption(string $name[, mixed $default = null ]) : mixed

If the option is empty or not set a NULL value will be returned.

Parameters
$name : string
$default : mixed = null

Default value if confiuration of $name is not present

Return values
mixed

setOption()

Set an option

public setOption(string $name, mixed $value) : mixed
Parameters
$name : string
$value : mixed
Return values
mixed

setOptions()

Set options

public setOptions(array<string|int, mixed>|object $options) : mixed

If $options is an object it will be converted into an array by called it's toArray method.

Parameters
$options : array<string|int, mixed>|object
Tags
throws
Exception
Return values
mixed

Search results