<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM;
use Cake\Datasource\EntityInterface;
use Cake\Datasource\EntityTrait;
use Cake\Datasource\InvalidPropertyInterface;
/**
* 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, InvalidPropertyInterface
{
use EntityTrait;
/**
* Initializes the internal properties of this entity out of the
* keys in an array. 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
*
* ### 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
*/
public function __construct(array $properties = [], array $options = [])
{
$options += [
'useSetters' => true,
'markClean' => false,
'markNew' => null,
'guard' => false,
'source' => null,
];
if (!empty($options['source'])) {
$this->setSource($options['source']);
}
if ($options['markNew'] !== null) {
$this->isNew($options['markNew']);
}
if (!empty($properties) && $options['markClean'] && !$options['useSetters']) {
$this->_properties = $properties;
return;
}
if (!empty($properties)) {
$this->set($properties, [
'setter' => $options['useSetters'],
'guard' => $options['guard'],
]);
}
if ($options['markClean']) {
$this->clean();
}
}
}