PHP Class Xpressengine\Config\ConfigEntity

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\Support\Entity, implements IteratorAggregat\IteratorAggregate
Datei anzeigen Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property Type Description
$guarded array The attributes that aren't mass assignable.
$parent ConfigEntity parent by this config object
$vo ConfigVO config value object

Public Methods

Method Description
__construct ( array $attributes = [] ) constructor
__get ( string $key ) : mixed Dynamically retrieve the value of an attribute.
all ( ) : array Get all of the items in the config entity.
clear ( ) : void entities clear
fill ( array $attributes ) : void Fill all attributes
get ( string $name, mixed $default = null ) : mixed get value, chain of responsibility
getAttributes ( ) : array returns current attributes
getDepth ( ) : integer depth level
getIterator ( ) : ArrayIterator Get an iterator for the items.
getParent ( ) : ConfigEntity get adjacency parent
getPure ( string $name, mixed $default = null ) : mixed get pure value
getPureAll ( ) : array get pure object to array
offsetExists ( string $offset ) : boolean Determine if a given offset exists.
offsetGet ( string $offset ) : mixed Get the value at a given offset.
offsetSet ( string $offset, mixed $value ) : void Set the value at a given offset.
offsetUnset ( string $offset ) : void Unset the value at a given offset.
set ( string $name, mixed $value ) : void set entity value
setParent ( ConfigEntity $ancestor ) : void make hierarchy to upper

Private Methods

Method Description
isAdjacency ( string $ancestorName, string $descendantName ) : boolean check adjacency
setValueObject ( array $attributes ) : void Set value object

Method Details

__construct() public method

constructor
public __construct ( array $attributes = [] )
$attributes array name and variables

__get() public method

Dynamically retrieve the value of an attribute.
public __get ( string $key ) : mixed
$key string key
return mixed

all() public method

Get all of the items in the config entity.
public all ( ) : array
return array

clear() public method

entities clear
public clear ( ) : void
return void

fill() public method

Fill all attributes
public fill ( array $attributes ) : void
$attributes array attributes in object
return void

get() public method

get value, chain of responsibility
public get ( string $name, mixed $default = null ) : mixed
$name string variable name
$default mixed default value
return mixed

getAttributes() public method

returns current attributes
public getAttributes ( ) : array
return array

getDepth() public method

depth level
public getDepth ( ) : integer
return integer

getIterator() public method

Get an iterator for the items.
public getIterator ( ) : ArrayIterator
return ArrayIterator

getParent() public method

get adjacency parent
public getParent ( ) : ConfigEntity
return ConfigEntity

getPure() public method

get pure value
public getPure ( string $name, mixed $default = null ) : mixed
$name string variable name
$default mixed default value
return mixed

getPureAll() public method

get pure object to array
public getPureAll ( ) : array
return array

offsetExists() public method

Determine if a given offset exists.
public offsetExists ( string $offset ) : boolean
$offset string array key name
return boolean

offsetGet() public method

Get the value at a given offset.
public offsetGet ( string $offset ) : mixed
$offset string array key name
return mixed

offsetSet() public method

Set the value at a given offset.
public offsetSet ( string $offset, mixed $value ) : void
$offset string array key name
$value mixed array value
return void

offsetUnset() public method

Unset the value at a given offset.
public offsetUnset ( string $offset ) : void
$offset string array key name
return void

set() public method

set entity value
public set ( string $name, mixed $value ) : void
$name string variable name
$value mixed variable value
return void

setParent() public method

make hierarchy to upper
public setParent ( ConfigEntity $ancestor ) : void
$ancestor ConfigEntity config object
return void

Property Details

$guarded protected_oe property

The attributes that aren't mass assignable.
protected array $guarded
return array

$parent protected_oe property

parent by this config object
protected ConfigEntity,Xpressengine\Config $parent
return ConfigEntity

$vo protected_oe property

config value object
protected ConfigVO,Xpressengine\Config $vo
return ConfigVO