Constants

CLASS_NAME

CLASS_NAME

TYPE_STRING

TYPE_STRING

TYPE_INT

TYPE_INT

TYPE_REAL

TYPE_REAL

TYPE_BOOL

TYPE_BOOL

TYPE_SET

TYPE_SET

VALUE_DELIMITER

VALUE_DELIMITER

Properties

$index

$index : 

Type

$class

$class : 

Type

$setting

$setting : 

Type

$type

$type : 

Type

$value

$value : 

Type

$default

$default : 

Type

$set

$set : 

Type

$fetchTime

$fetchTime : 

Type

Methods

getUsageInformation()

getUsageInformation() 

Gets Information about the Class, and a List of the Public Method

__construct()

__construct(mixed  $object, string  $settingName, mixed  $defaultValue) 

Construct a new setting instance

Parameters

mixed $object
string $settingName
mixed $defaultValue

isPersisted()

isPersisted() : boolean

Get whether the Setting has been persisted at some point

Returns

boolean

getFormattedValue()

getFormattedValue() : string

Get the Formatted Value of the Setting

Returns

string

getFormattedDefault()

getFormattedDefault() : string

Get the Formatted Default of the Setting

Returns

string

getFormattedSet()

getFormattedSet() : string

Get the Formatted Set of the Setting

Returns

string

belongsToClass()

belongsToClass(mixed  $object) : boolean

Check if the Settings belongs to the given Class

Parameters

mixed $object

Returns

boolean

castValue()

castValue(mixed  $value, string  $type = null) : mixed

Cast the Value based on the Setting Type

Parameters

mixed $value
string $type

Returns

mixed

getValueType()

getValueType(mixed  $value) : string

Get Type of a Value Parameter

Parameters

mixed $value

Returns

string

formatValue()

formatValue(mixed  $value, string  $type = null) : string

Format the given Value based on the Type

Parameters

mixed $value
string $type

Returns

string