-
Notifications
You must be signed in to change notification settings - Fork 0
/
EntityInterface.php
64 lines (56 loc) · 1.58 KB
/
EntityInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?php
namespace Charcoal\Config;
use ArrayAccess;
use JsonSerializable;
use Serializable;
/**
* Describes a conceptual data model.
*/
interface EntityInterface extends
ArrayAccess,
JsonSerializable,
Serializable
{
/**
* Gets the data keys on this entity.
*
* @return array
*/
public function keys();
/**
* Gets all data, or a subset, from this entity.
*
* @param string[] $keys Optional. Extracts only the requested data.
* @return array An associative array.
*/
public function data(array $keys = null);
/**
* Sets data on this entity.
*
* @param array $data An associative array.
* @return EntityInterface Chainable
*/
public function setData(array $data);
/**
* Determines if this entity contains the specified key and if its value is not NULL.
*
* @param string $key The data key to check.
* @return boolean TRUE if $key exists and has a value other than NULL, FALSE otherwise.
*/
public function has($key);
/**
* Find an entry of the configuration by its key and retrieve it.
*
* @param string $key The data key to retrieve.
* @return mixed Value of the requested $key on success, NULL if the $key is not set.
*/
public function get($key);
/**
* Assign a value to the specified key on this entity.
*
* @param string $key The data key to assign $value to.
* @param mixed $value The data value to assign to $key.
* @return EntityInterface Chainable
*/
public function set($key, $value);
}