class JsonConfig implements JsonSerializable (View source)

JsonConfig Object

The parent object for all config objects. Adds JsonSerializable and methods for setting options.

Methods

__construct( Options $options, array $config = array())

Creates a new JsonConfig object

mixed
__get( string $option)

Get the value of a set option via magic method.

getOptions()

Gets the Options object for the JsonConfig

setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

array
jsonSerialize()

Custom serialization of the JsonConfig object.

Details

at line 40
__construct( Options $options, array $config = array())

Creates a new JsonConfig object

Parameters

Options $options
array $config

Exceptions

InvalidConfigProperty
InvalidConfigValue

at line 64
mixed __get( string $option)

Get the value of a set option via magic method.

Parameters

string $option Name of option.

Return Value

mixed

Exceptions

InvalidConfigProperty

at line 75
Options getOptions()

Gets the Options object for the JsonConfig

Return Value

Options

at line 90
JsonConfig setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

In order to maintain backwards compatibility, ConfigObjects will be unwrapped.

Parameters

string $option Option to set.
mixed $value Value of the option.

Return Value

JsonConfig

at line 106
setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

at line 275
array jsonSerialize()

Custom serialization of the JsonConfig object.

Return Value

array