Interface EntityInterface
Describes a conceptual data model.
-
Charcoal\Config\EntityInterface
implements
ArrayAccess,
JsonSerializable,
Serializable
Methods summary
public
array
|
#
keys( )
Gets the data keys on this entity.
Gets the data keys on this entity.
Returns
array
|
public
array
|
#
data( array $keys = null )
Gets all data, or a subset, from this entity.
Gets all data, or a subset, from this entity.
Parameters
- $keys
- Optional. Extracts only the requested data.
Returns
array An associative array.
|
public
Charcoal\Config\EntityInterface
|
#
setData( array $data )
Sets data on this entity.
Sets data on this entity.
Parameters
- $data
- An associative array.
Returns
|
public
boolean
|
#
has( string $key )
Determines if this entity contains the specified key and if its value is not NULL.
Determines if this entity contains the specified key and if its value is not NULL.
Parameters
- $key
- The data key to check.
Returns
boolean TRUE if $key exists and has a value other than NULL, FALSE otherwise.
|
public
mixed
|
#
get( string $key )
Find an entry of the configuration by its key and retrieve it.
Find an entry of the configuration by its key and retrieve it.
Parameters
- $key
- The data key to retrieve.
Returns
mixed Value of the requested $key on success, NULL if the $key is not set.
|
public
Charcoal\Config\EntityInterface
|
#
set( string $key, mixed $value )
Assign a value to the specified key on this entity.
Assign a value to the specified key on this entity.
Parameters
- $key
- The data key to assign $value to.
- $value
- The data value to assign to $key.
Returns
|
Methods inherited from ArrayAccess
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset()
|
Methods inherited from JsonSerializable
jsonSerialize()
|
Methods inherited from Serializable
serialize(),
unserialize()
|