1: <?php
 2: /**
 3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 5:  *
 6:  * Licensed under The MIT License
 7:  * For full copyright and license information, please see the LICENSE.txt
 8:  * Redistributions of files must retain the above copyright notice.
 9:  *
10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
11:  * @link          https://cakephp.org CakePHP(tm) Project
12:  * @since         3.0.0
13:  * @license       https://opensource.org/licenses/mit-license.php MIT License
14:  */
15: namespace Cake\ORM;
16: 
17: use Cake\Datasource\EntityInterface;
18: use Cake\Datasource\EntityTrait;
19: use Cake\Datasource\InvalidPropertyInterface;
20: 
21: /**
22:  * An entity represents a single result row from a repository. It exposes the
23:  * methods for retrieving and storing properties associated in this row.
24:  */
25: class Entity implements EntityInterface, InvalidPropertyInterface
26: {
27:     use EntityTrait;
28: 
29:     /**
30:      * Initializes the internal properties of this entity out of the
31:      * keys in an array. The following list of options can be used:
32:      *
33:      * - useSetters: whether use internal setters for properties or not
34:      * - markClean: whether to mark all properties as clean after setting them
35:      * - markNew: whether this instance has not yet been persisted
36:      * - guard: whether to prevent inaccessible properties from being set (default: false)
37:      * - source: A string representing the alias of the repository this entity came from
38:      *
39:      * ### Example:
40:      *
41:      * ```
42:      *  $entity = new Entity(['id' => 1, 'name' => 'Andrew'])
43:      * ```
44:      *
45:      * @param array $properties hash of properties to set in this entity
46:      * @param array $options list of options to use when creating this entity
47:      */
48:     public function __construct(array $properties = [], array $options = [])
49:     {
50:         $options += [
51:             'useSetters' => true,
52:             'markClean' => false,
53:             'markNew' => null,
54:             'guard' => false,
55:             'source' => null
56:         ];
57: 
58:         if (!empty($options['source'])) {
59:             $this->setSource($options['source']);
60:         }
61: 
62:         if ($options['markNew'] !== null) {
63:             $this->isNew($options['markNew']);
64:         }
65: 
66:         if (!empty($properties) && $options['markClean'] && !$options['useSetters']) {
67:             $this->_properties = $properties;
68: 
69:             return;
70:         }
71: 
72:         if (!empty($properties)) {
73:             $this->set($properties, [
74:                 'setter' => $options['useSetters'],
75:                 'guard' => $options['guard']
76:             ]);
77:         }
78: 
79:         if ($options['markClean']) {
80:             $this->clean();
81:         }
82:     }
83: }
84: