cubicmushroom/options-trait

Trait to make it easy to add options arrays to object classes

, _(*1)

Options Trait

This trait is used to provide basic options setting, getting, checking, and merging with defaults, _(*2)

Properties

The trait add the following properties to the class..., _(*3)

$options

An array to the stroe the array of options in., _(*4)

Methods

The trait adds the following methods to the class..., _(*5)

hasOption

Returns: boolean, _(*6)

Checks if an option is set or not, _(*7)

getOption

Returns: mixed, _(*8)

Gets a requested option., _(*9)

If a second arguments is passed, will return this as the default if the option is not set. If not passed, null is returned., _(*10)

setOption

Return: $this, _(*11)

Sets an option value, _(*12)

setOptions

Return: $this, _(*13)

Sets the options to the values given., _(*14)

An optional second parameter allows for default values to be passed for options not included in the $options array., _(*15)