class Gradient extends JsonConfig (View source)

Gradient ConfigObject

An object that specifies a color gradient

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the gradient object with specified options

mixed
__get( string $option)

Get the value of a set option via magic method.

from  JsonConfig
getOptions()

Gets the Options object for the JsonConfig

from  JsonConfig
setOption( string $option, mixed $value)

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

from  JsonConfig
setOptions( array $config)

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

from  JsonConfig
array
jsonSerialize()

Custom serialization of the JsonConfig object.

from  JsonConfig
color1( string $color1)

If present, specifies the start color for the gradient.

color2( string $color2)

If present, specifies the finish color for the gradient.

x1( string $x1)

Sets where on the boundary to start in X.

y1( string $y1)

Sets where on the boundary to start in Y.

x2( string $x2)

Sets where on the boundary to end in X, relative to x1.

y2( string $y2)

Sets where on the boundary to end in Y, relative to y1.

Details

at line 53
__construct( array $config = array())

Builds the gradient object with specified options

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

in JsonConfig 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

in JsonConfig at line 75
Options getOptions()

Gets the Options object for the JsonConfig

Return Value

Options

in JsonConfig 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

in 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

in JsonConfig at line 275
array jsonSerialize()

Custom serialization of the JsonConfig object.

Return Value

array

at line 67
Gradient color1( string $color1)

If present, specifies the start color for the gradient.

Parameters

string $color1

Return Value

Gradient

Exceptions

InvalidConfigValue

at line 79
Gradient color2( string $color2)

If present, specifies the finish color for the gradient.

Parameters

string $color2

Return Value

Gradient

Exceptions

InvalidConfigValue

at line 91
Gradient x1( string $x1)

Sets where on the boundary to start in X.

Parameters

string $x1

Return Value

Gradient

Exceptions

InvalidConfigValue

at line 103
Gradient y1( string $y1)

Sets where on the boundary to start in Y.

Parameters

string $y1

Return Value

Gradient

Exceptions

InvalidConfigValue

at line 115
Gradient x2( string $x2)

Sets where on the boundary to end in X, relative to x1.

Parameters

string $x2

Return Value

Gradient

Exceptions

InvalidConfigValue

at line 127
Gradient y2( string $y2)

Sets where on the boundary to end in Y, relative to y1.

Parameters

string $y2

Return Value

Gradient

Exceptions

InvalidConfigValue