1. class
  2. Khill
  3. Lavacharts
  4. Configs
  5. MagnifyingGlass

MagnifyingGlass

class MagnifyingGlass extends ConfigObject (View source)

Properties

bool $enable Enabled state of the magnifying glass.
int $zoomFactor Zoom factor of the magnifying glass.

Methods

mixed
__construct( bool $zoomFactor = 5)

Builds the MagnifyingGlass object.

array
toArray( string $keyName = null)

Returns an array representation of the object.

from  ConfigObject
array
getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

from  ConfigObject
MagnifyingGlass
zoomFactor( int $zoomFactor)

The zoom factor of the magnifying glass.

Details

at line 52
mixed __construct( bool $zoomFactor = 5)

Builds the MagnifyingGlass object.

If created with no parameter, it defaults to enabled with a zoom factor of 5. Passing a number in upon creation, then the zoomFactor will be set.

Parameters

bool $zoomFactor

Return Value

mixed

Exceptions

InvalidConfigValue
InvalidConfigProperty

in ConfigObject at line 93
array toArray( string $keyName = null)

Returns an array representation of the object.

If passed a label, then the array will be returned with the label as the key.

Called with no label returns an array with the classname as the key.

Parameters

string $keyName Key name to be applied to generated array.

Return Value

array Assoc. array of the options of the object.

in ConfigObject at line 115
array getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

Return Value

array Array of the options of the object.

at line 65
MagnifyingGlass zoomFactor( int $zoomFactor)

The zoom factor of the magnifying glass.

Parameters

int $zoomFactor Can be any number greater than 0.

Return Value

MagnifyingGlass