/
Entity.php
75 lines (67 loc) · 2.21 KB
/
Entity.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
65
66
67
68
69
70
71
72
73
74
75
<?php
/**
* PHP Version 5.4
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\ORM;
use Cake\Datasource\EntityInterface;
use Cake\Datasource\EntityTrait;
/**
* An entity represents a single result row from a repository. It exposes the
* methods for retrieving and storing properties associated in this row.
*/
class Entity implements EntityInterface {
use EntityTrait;
/**
* Initializes the internal properties of this entity out of the
* keys in an array
*
* ### Example:
*
* ``$entity = new Entity(['id' => 1, 'name' => 'Andrew'])``
*
* @param array $properties hash of properties to set in this entity
* @param array $options list of options to use when creating this entity
* the following list of options can be used:
*
* - useSetters: whether use internal setters for properties or not
* - markClean: whether to mark all properties as clean after setting them
* - markNew: whether this instance has not yet been persisted
* - guard: whether to prevent inaccessible properties from being set (default: false)
* - source: A string representing the alias of the repository this entity came from
*/
public function __construct(array $properties = [], array $options = []) {
$options += [
'useSetters' => true,
'markClean' => false,
'markNew' => null,
'guard' => false,
'source' => null
];
$this->_className = get_class($this);
$this->set($properties, [
'setter' => $options['useSetters'],
'guard' => $options['guard']
]);
if ($options['markClean']) {
$this->clean();
}
if ($options['markNew'] !== null) {
$this->isNew($options['markNew']);
}
if (!empty($options['source'])) {
$this->source($options['source']);
}
}
}