PHP Class Devise\Pages\Fields\LiveFieldValue

Show file Open project: devisephp/cms Class Usage Examples

Protected Properties

Property	Type	Description
$__	string	stores all the relavent data for us in here so we don't conflict with outside values

Public Methods

Method	Description
__call ( string $name, mixed $args ) : mixed	Allows us to set default values on a key if we do not have that key set in this FieldValue object
__construct ( string $json, $fieldId, $type )	Create a new FieldValue object from json string
__get ( string $name ) : FieldValue	Avoids null pointer exceptions by treating this like the empty string we only ever reach this magical method when we have attempted to fetch a key that does not exist on this FieldValue object
__id ( ) : [type]	[__id description]
__toString ( ) : string	This thing is just a string.
__type ( ) : [type]	[__type description]
extract ( ) : void	This extracts the variables so they may be used.
get ( string $name, mixed $default = null ) : mixed	Gets this field with this name, returns default if nothing is found.
merge ( array $input ) : void	Merges in the array data into the field object json
override ( array $input ) : void	Overrides this data with the new input array
toArray ( ) : array	Returns this object as array
toJSON ( ) : string	Returns this object as json string
unextract ( ) : void	Un extracts all the keys on this thing could be useful if we need to undo an extract

Method Details

__call() public method

Allows us to set default values on a key if we do not have that key set in this FieldValue object

public __call ( string $name, mixed $args ) : mixed
$name	string
$args	mixed
return	mixed

__construct() public method

Create a new FieldValue object from json string

public __construct ( string $json, $fieldId, $type )
$json	string

__get() public method

Avoids null pointer exceptions by treating this like the empty string we only ever reach this magical method when we have attempted to fetch a key that does not exist on this FieldValue object

public __get ( string $name ) : FieldValue
$name	string
return	FieldValue

__id() public method

[__id description]

public __id ( ) : [type]
return	[type]

__toString() public method

public __toString ( ) : string
return	string

__type() public method

[__type description]

public __type ( ) : [type]
return	[type]

extract() public method

This is not recommended to do as it will mess up LiveUpdate, but it is needed in certain cases (for example in FieldManager)

public extract ( ) : void
return	void

get() public method

public get ( string $name, mixed $default = null ) : mixed
$name	string
$default	mixed
return	mixed

merge() public method

Merges in the array data into the field object json

public merge ( array $input ) : void
$input	array
return	void

override() public method

Overrides this data with the new input array

public override ( array $input ) : void
$input	array
return	void

toArray() public method

Returns this object as array

public toArray ( ) : array
return	array

toJSON() public method

Returns this object as json string

public toJSON ( ) : string
return	string

unextract() public method

Un extracts all the keys on this thing could be useful if we need to undo an extract

public unextract ( ) : void
return	void

Property Details

$__ protected property

stores all the relavent data for us in here so we don't conflict with outside values

protected string $__
return	string