Properties

$userControllable

$userControllable : 

Type

$userControllable

$userControllable : 

Type

$preferredStartingPosition

$preferredStartingPosition : 

Type

Methods

__construct()

__construct() 

Implements __construct().

getType()

getType() 

Getter for type.

jsonSerialize()

jsonSerialize() 

Implements JsonSerializable::jsonSerialize().

__toString()

__toString() 

Implements __toString().

json()

json() : boolean|string

Generates json representation.

Returns

boolean|string —

JSON string, or FALSE on error.

triggerError()

triggerError(string  $message, integer  $message_type = E_USER_NOTICE) 

Error handler.

Parameters

string $message

Message.

integer $message_type

Matching E_USER_ERROR|E_USER_WARNING|E_USER_NOTICE|E_USER_DEPRECATED.

getPreferredStartingPosition()

getPreferredStartingPosition() 

Getter for preferredStartingPosition.

setPreferredStartingPosition()

setPreferredStartingPosition(mixed  $value) : $this

Setter for preferredStartingPosition.

Parameters

mixed $value

preferredStartingPosition.

Returns

$this

optional()

optional() 

Define optional properties.

setType()

setType(boolean  $value) : $this

Setter for type.

Concrete classes are expected to set this explicitly.

Parameters

boolean $value

Type.

Returns

$this

isSupportedUnit()

isSupportedUnit(mixed  $value) : boolean

Helper function to determine if a value is suffixed by a supported unit.

Parameters

mixed $value

Value.

Returns

boolean —

Result.

isUnitInterval()

isUnitInterval(float|integer  $value) : boolean

Helper function to determine if a value is a unit interval.

A unit interval is the closed interval [0,1], that is, the set of all real numbers that are greater than or equal to 0 and less than or equal to 1.

Parameters

float|integer $value

Value.

Returns

boolean —

Result.

isHexColor()

isHexColor(string  $value) : boolean

Helper to validate color hex code.

Valid codes are hexadecimal numbers of length 3, 6 or 8 (with opacity), prefixed with "#".

Parameters

string $value

Value.

Returns

boolean —

Result.

validatePreferredStartingPosition()

validatePreferredStartingPosition(  $value) 

Validates the preferredStartingPosition attribute.

Parameters

$value