PHP Class GDS\Entity

Author: Tom Walder ([email protected])
Show file Open project: tomwalder/php-gds Class Usage Examples

Public Methods

Method Description
__get ( $str_key ) : null Magic getter.
__isset ( $str_key ) : boolean Is a data value set?
__set ( $str_key, $mix_value ) Magic setter.
getAncestry ( ) : null | array Get the ancestry of the entity
getData ( ) : array Get the entire data array
getKeyId ( ) : string Get the key ID
getKeyName ( ) : string Get the key name
getKind ( ) : null Get the Entity Kind
getSchema ( ) : Schema | null The Schema for the Entity, if known.
setAncestry ( $mix_path ) Set the Entity's ancestry. This either an array of paths OR another Entity
setKeyId ( $str_key_id ) Set the key ID
setKeyName ( $str_key_name ) Set the key name
setKind ( $str_kind )
setSchema ( Schema $obj_schema ) Set the Schema for the Entity

Method Details

__get() public method

. sorry
public __get ( $str_key ) : null
$str_key
return null

__isset() public method

Is a data value set?
public __isset ( $str_key ) : boolean
$str_key
return boolean

__set() public method

. sorry
public __set ( $str_key, $mix_value )
$str_key
$mix_value

getAncestry() public method

Get the ancestry of the entity
public getAncestry ( ) : null | array
return null | array

getData() public method

Get the entire data array
public getData ( ) : array
return array

getKeyId() public method

Get the key ID
public getKeyId ( ) : string
return string

getKeyName() public method

Get the key name
public getKeyName ( ) : string
return string

getKind() public method

Get the Entity Kind
public getKind ( ) : null
return null

getSchema() public method

The Schema for the Entity, if known.
public getSchema ( ) : Schema | null
return Schema | null

setAncestry() public method

Set the Entity's ancestry. This either an array of paths OR another Entity
public setAncestry ( $mix_path )
$mix_path

setKeyId() public method

Set the key ID
public setKeyId ( $str_key_id )
$str_key_id

setKeyName() public method

Set the key name
public setKeyName ( $str_key_name )
$str_key_name

setKind() public method

public setKind ( $str_kind )
$str_kind

setSchema() public method

Set the Schema for the Entity
public setSchema ( Schema $obj_schema )
$obj_schema Schema