add trashes
This commit is contained in:
Diskette Guy
@@ -0,0 +1,40 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class ArrayCast
|
||||
*/
|
||||
class ArrayCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): array
|
||||
{
|
||||
if (is_string($value) && (str_starts_with($value, 'a:') || str_starts_with($value, 's:'))) {
|
||||
$value = unserialize($value);
|
||||
}
|
||||
|
||||
return (array) $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function set($value, array $params = []): string
|
||||
{
|
||||
return serialize($value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class BaseCast
|
||||
*/
|
||||
abstract class BaseCast implements CastInterface
|
||||
{
|
||||
/**
|
||||
* Get
|
||||
*
|
||||
* @param array|bool|float|int|object|string|null $value Data
|
||||
* @param array $params Additional param
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*/
|
||||
public static function get($value, array $params = [])
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set
|
||||
*
|
||||
* @param array|bool|float|int|object|string|null $value Data
|
||||
* @param array $params Additional param
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*/
|
||||
public static function set($value, array $params = [])
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class BooleanCast
|
||||
*/
|
||||
class BooleanCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): bool
|
||||
{
|
||||
return (bool) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class CSVCast
|
||||
*/
|
||||
class CSVCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): array
|
||||
{
|
||||
return explode(',', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function set($value, array $params = []): string
|
||||
{
|
||||
return implode(',', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Interface CastInterface
|
||||
*
|
||||
* The methods work at (1)(4) only.
|
||||
* [App Code] --- (1) --> [Entity] --- (2) --> [Database]
|
||||
* [App Code] <-- (4) --- [Entity] <-- (3) --- [Database]
|
||||
*/
|
||||
interface CastInterface
|
||||
{
|
||||
/**
|
||||
* Takes a raw value from Entity, returns its value for PHP.
|
||||
*
|
||||
* @param array|bool|float|int|object|string|null $value Data
|
||||
* @param array $params Additional param
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*/
|
||||
public static function get($value, array $params = []);
|
||||
|
||||
/**
|
||||
* Takes a PHP value, returns its raw value for Entity.
|
||||
*
|
||||
* @param array|bool|float|int|object|string|null $value Data
|
||||
* @param array $params Additional param
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*/
|
||||
public static function set($value, array $params = []);
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
use CodeIgniter\I18n\Time;
|
||||
use DateTime;
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Class DatetimeCast
|
||||
*/
|
||||
class DatetimeCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @return Time
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function get($value, array $params = [])
|
||||
{
|
||||
if ($value instanceof Time) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
if ($value instanceof DateTime) {
|
||||
return Time::createFromInstance($value);
|
||||
}
|
||||
|
||||
if (is_numeric($value)) {
|
||||
return Time::createFromTimestamp((int) $value, date_default_timezone_get());
|
||||
}
|
||||
|
||||
if (is_string($value)) {
|
||||
return Time::parse($value);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class FloatCast
|
||||
*/
|
||||
class FloatCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): float
|
||||
{
|
||||
return (float) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Int Bool Cast
|
||||
*
|
||||
* DB column: int (0/1) <--> Class property: bool
|
||||
*/
|
||||
final class IntBoolCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* @param int $value
|
||||
*/
|
||||
public static function get($value, array $params = []): bool
|
||||
{
|
||||
return (bool) $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param bool|int|string $value
|
||||
*/
|
||||
public static function set($value, array $params = []): int
|
||||
{
|
||||
return (int) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class IntegerCast
|
||||
*/
|
||||
class IntegerCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): int
|
||||
{
|
||||
return (int) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
use CodeIgniter\Entity\Exceptions\CastException;
|
||||
use JsonException;
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* Class JsonCast
|
||||
*/
|
||||
class JsonCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = [])
|
||||
{
|
||||
$associative = in_array('array', $params, true);
|
||||
|
||||
$tmp = $value !== null ? ($associative ? [] : new stdClass()) : null;
|
||||
|
||||
if (function_exists('json_decode')
|
||||
&& (
|
||||
(is_string($value)
|
||||
&& strlen($value) > 1
|
||||
&& in_array($value[0], ['[', '{', '"'], true))
|
||||
|| is_numeric($value)
|
||||
)
|
||||
) {
|
||||
try {
|
||||
$tmp = json_decode($value, $associative, 512, JSON_THROW_ON_ERROR);
|
||||
} catch (JsonException $e) {
|
||||
throw CastException::forInvalidJsonFormat($e->getCode());
|
||||
}
|
||||
}
|
||||
|
||||
return $tmp;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function set($value, array $params = []): string
|
||||
{
|
||||
if (function_exists('json_encode')) {
|
||||
try {
|
||||
$value = json_encode($value, JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR);
|
||||
} catch (JsonException $e) {
|
||||
throw CastException::forInvalidJsonFormat($e->getCode());
|
||||
}
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class ObjectCast
|
||||
*/
|
||||
class ObjectCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): object
|
||||
{
|
||||
return (object) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
/**
|
||||
* Class StringCast
|
||||
*/
|
||||
class StringCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): string
|
||||
{
|
||||
return (string) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
use CodeIgniter\Entity\Exceptions\CastException;
|
||||
|
||||
/**
|
||||
* Class TimestampCast
|
||||
*/
|
||||
class TimestampCast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = [])
|
||||
{
|
||||
$value = strtotime($value);
|
||||
|
||||
if ($value === false) {
|
||||
throw CastException::forInvalidTimestamp();
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Cast;
|
||||
|
||||
use CodeIgniter\HTTP\URI;
|
||||
|
||||
/**
|
||||
* Class URICast
|
||||
*/
|
||||
class URICast extends BaseCast
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public static function get($value, array $params = []): URI
|
||||
{
|
||||
return $value instanceof URI ? $value : new URI($value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,572 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity;
|
||||
|
||||
use CodeIgniter\DataCaster\DataCaster;
|
||||
use CodeIgniter\Entity\Cast\ArrayCast;
|
||||
use CodeIgniter\Entity\Cast\BooleanCast;
|
||||
use CodeIgniter\Entity\Cast\CSVCast;
|
||||
use CodeIgniter\Entity\Cast\DatetimeCast;
|
||||
use CodeIgniter\Entity\Cast\FloatCast;
|
||||
use CodeIgniter\Entity\Cast\IntBoolCast;
|
||||
use CodeIgniter\Entity\Cast\IntegerCast;
|
||||
use CodeIgniter\Entity\Cast\JsonCast;
|
||||
use CodeIgniter\Entity\Cast\ObjectCast;
|
||||
use CodeIgniter\Entity\Cast\StringCast;
|
||||
use CodeIgniter\Entity\Cast\TimestampCast;
|
||||
use CodeIgniter\Entity\Cast\URICast;
|
||||
use CodeIgniter\Entity\Exceptions\CastException;
|
||||
use CodeIgniter\I18n\Time;
|
||||
use DateTime;
|
||||
use Exception;
|
||||
use JsonSerializable;
|
||||
use ReturnTypeWillChange;
|
||||
|
||||
/**
|
||||
* Entity encapsulation, for use with CodeIgniter\Model
|
||||
*
|
||||
* @see \CodeIgniter\Entity\EntityTest
|
||||
*/
|
||||
class Entity implements JsonSerializable
|
||||
{
|
||||
/**
|
||||
* Maps names used in sets and gets against unique
|
||||
* names within the class, allowing independence from
|
||||
* database column names.
|
||||
*
|
||||
* Example:
|
||||
* $datamap = [
|
||||
* 'class_property_name' => 'db_column_name'
|
||||
* ];
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
protected $datamap = [];
|
||||
|
||||
/**
|
||||
* The date fields.
|
||||
*
|
||||
* @var list<string>
|
||||
*/
|
||||
protected $dates = [
|
||||
'created_at',
|
||||
'updated_at',
|
||||
'deleted_at',
|
||||
];
|
||||
|
||||
/**
|
||||
* Array of field names and the type of value to cast them as when
|
||||
* they are accessed.
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
protected $casts = [];
|
||||
|
||||
/**
|
||||
* Custom convert handlers
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
protected $castHandlers = [];
|
||||
|
||||
/**
|
||||
* Default convert handlers
|
||||
*
|
||||
* @var array<string, string>
|
||||
*/
|
||||
private array $defaultCastHandlers = [
|
||||
'array' => ArrayCast::class,
|
||||
'bool' => BooleanCast::class,
|
||||
'boolean' => BooleanCast::class,
|
||||
'csv' => CSVCast::class,
|
||||
'datetime' => DatetimeCast::class,
|
||||
'double' => FloatCast::class,
|
||||
'float' => FloatCast::class,
|
||||
'int' => IntegerCast::class,
|
||||
'integer' => IntegerCast::class,
|
||||
'int-bool' => IntBoolCast::class,
|
||||
'json' => JsonCast::class,
|
||||
'object' => ObjectCast::class,
|
||||
'string' => StringCast::class,
|
||||
'timestamp' => TimestampCast::class,
|
||||
'uri' => URICast::class,
|
||||
];
|
||||
|
||||
/**
|
||||
* Holds the current values of all class vars.
|
||||
*
|
||||
* @var array<string, mixed>
|
||||
*/
|
||||
protected $attributes = [];
|
||||
|
||||
/**
|
||||
* Holds original copies of all class vars so we can determine
|
||||
* what's actually been changed and not accidentally write
|
||||
* nulls where we shouldn't.
|
||||
*
|
||||
* @var array<string, mixed>
|
||||
*/
|
||||
protected $original = [];
|
||||
|
||||
/**
|
||||
* The data caster.
|
||||
*/
|
||||
protected DataCaster $dataCaster;
|
||||
|
||||
/**
|
||||
* Holds info whenever properties have to be casted
|
||||
*/
|
||||
private bool $_cast = true;
|
||||
|
||||
/**
|
||||
* Allows filling in Entity parameters during construction.
|
||||
*/
|
||||
public function __construct(?array $data = null)
|
||||
{
|
||||
$this->dataCaster = new DataCaster(
|
||||
array_merge($this->defaultCastHandlers, $this->castHandlers),
|
||||
null,
|
||||
null,
|
||||
false,
|
||||
);
|
||||
|
||||
$this->syncOriginal();
|
||||
|
||||
$this->fill($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes an array of key/value pairs and sets them as class
|
||||
* properties, using any `setCamelCasedProperty()` methods
|
||||
* that may or may not exist.
|
||||
*
|
||||
* @param array<string, array|bool|float|int|object|string|null> $data
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function fill(?array $data = null)
|
||||
{
|
||||
if (! is_array($data)) {
|
||||
return $this;
|
||||
}
|
||||
|
||||
foreach ($data as $key => $value) {
|
||||
$this->__set($key, $value);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* General method that will return all public and protected values
|
||||
* of this entity as an array. All values are accessed through the
|
||||
* __get() magic method so will have any casts, etc applied to them.
|
||||
*
|
||||
* @param bool $onlyChanged If true, only return values that have changed since object creation
|
||||
* @param bool $cast If true, properties will be cast.
|
||||
* @param bool $recursive If true, inner entities will be cast as array as well.
|
||||
*/
|
||||
public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recursive = false): array
|
||||
{
|
||||
$this->_cast = $cast;
|
||||
|
||||
$keys = array_filter(array_keys($this->attributes), static fn ($key): bool => ! str_starts_with($key, '_'));
|
||||
|
||||
if (is_array($this->datamap)) {
|
||||
$keys = array_unique(
|
||||
[...array_diff($keys, $this->datamap), ...array_keys($this->datamap)],
|
||||
);
|
||||
}
|
||||
|
||||
$return = [];
|
||||
|
||||
// Loop over the properties, to allow magic methods to do their thing.
|
||||
foreach ($keys as $key) {
|
||||
if ($onlyChanged && ! $this->hasChanged($key)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$return[$key] = $this->__get($key);
|
||||
|
||||
if ($recursive) {
|
||||
if ($return[$key] instanceof self) {
|
||||
$return[$key] = $return[$key]->toArray($onlyChanged, $cast, $recursive);
|
||||
} elseif (is_callable([$return[$key], 'toArray'])) {
|
||||
$return[$key] = $return[$key]->toArray();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->_cast = true;
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the raw values of the current attributes.
|
||||
*
|
||||
* @param bool $onlyChanged If true, only return values that have changed since object creation
|
||||
* @param bool $recursive If true, inner entities will be cast as array as well.
|
||||
*/
|
||||
public function toRawArray(bool $onlyChanged = false, bool $recursive = false): array
|
||||
{
|
||||
$return = [];
|
||||
|
||||
if (! $onlyChanged) {
|
||||
if ($recursive) {
|
||||
return array_map(static function ($value) use ($onlyChanged, $recursive) {
|
||||
if ($value instanceof self) {
|
||||
$value = $value->toRawArray($onlyChanged, $recursive);
|
||||
} elseif (is_callable([$value, 'toRawArray'])) {
|
||||
$value = $value->toRawArray();
|
||||
}
|
||||
|
||||
return $value;
|
||||
}, $this->attributes);
|
||||
}
|
||||
|
||||
return $this->attributes;
|
||||
}
|
||||
|
||||
foreach ($this->attributes as $key => $value) {
|
||||
if (! $this->hasChanged($key)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($recursive) {
|
||||
if ($value instanceof self) {
|
||||
$value = $value->toRawArray($onlyChanged, $recursive);
|
||||
} elseif (is_callable([$value, 'toRawArray'])) {
|
||||
$value = $value->toRawArray();
|
||||
}
|
||||
}
|
||||
|
||||
$return[$key] = $value;
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures our "original" values match the current values.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function syncOriginal()
|
||||
{
|
||||
$this->original = $this->attributes;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks a property to see if it has changed since the entity
|
||||
* was created. Or, without a parameter, checks if any
|
||||
* properties have changed.
|
||||
*
|
||||
* @param string|null $key class property
|
||||
*/
|
||||
public function hasChanged(?string $key = null): bool
|
||||
{
|
||||
// If no parameter was given then check all attributes
|
||||
if ($key === null) {
|
||||
return $this->original !== $this->attributes;
|
||||
}
|
||||
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
// Key doesn't exist in either
|
||||
if (! array_key_exists($dbColumn, $this->original) && ! array_key_exists($dbColumn, $this->attributes)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// It's a new element
|
||||
if (! array_key_exists($dbColumn, $this->original) && array_key_exists($dbColumn, $this->attributes)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $this->original[$dbColumn] !== $this->attributes[$dbColumn];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set raw data array without any mutations
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function injectRawData(array $data)
|
||||
{
|
||||
$this->attributes = $data;
|
||||
|
||||
$this->syncOriginal();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set raw data array without any mutations
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @deprecated Use injectRawData() instead.
|
||||
*/
|
||||
public function setAttributes(array $data)
|
||||
{
|
||||
return $this->injectRawData($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the datamap to see if this property name is being mapped,
|
||||
* and returns the db column name, if any, or the original property name.
|
||||
*
|
||||
* @return string db column name
|
||||
*/
|
||||
protected function mapProperty(string $key)
|
||||
{
|
||||
if ($this->datamap === []) {
|
||||
return $key;
|
||||
}
|
||||
|
||||
if (! empty($this->datamap[$key])) {
|
||||
return $this->datamap[$key];
|
||||
}
|
||||
|
||||
return $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the given string|timestamp|DateTime|Time instance
|
||||
* into the "CodeIgniter\I18n\Time" object.
|
||||
*
|
||||
* @param DateTime|float|int|string|Time $value
|
||||
*
|
||||
* @return Time
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
protected function mutateDate($value)
|
||||
{
|
||||
return DatetimeCast::get($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides the ability to cast an item as a specific data type.
|
||||
* Add ? at the beginning of the type (i.e. ?string) to get `null`
|
||||
* instead of casting $value when $value is null.
|
||||
*
|
||||
* @param bool|float|int|string|null $value Attribute value
|
||||
* @param string $attribute Attribute name
|
||||
* @param string $method Allowed to "get" and "set"
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*
|
||||
* @throws CastException
|
||||
*/
|
||||
protected function castAs($value, string $attribute, string $method = 'get')
|
||||
{
|
||||
return $this->dataCaster
|
||||
// @TODO if $casts is readonly, we don't need the setTypes() method.
|
||||
->setTypes($this->casts)
|
||||
->castAs($value, $attribute, $method);
|
||||
}
|
||||
|
||||
/**
|
||||
* Support for json_encode()
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
#[ReturnTypeWillChange]
|
||||
public function jsonSerialize()
|
||||
{
|
||||
return $this->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Change the value of the private $_cast property
|
||||
*
|
||||
* @return bool|Entity
|
||||
*/
|
||||
public function cast(?bool $cast = null)
|
||||
{
|
||||
if ($cast === null) {
|
||||
return $this->_cast;
|
||||
}
|
||||
|
||||
$this->_cast = $cast;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Magic method to all protected/private class properties to be
|
||||
* easily set, either through a direct access or a
|
||||
* `setCamelCasedProperty()` method.
|
||||
*
|
||||
* Examples:
|
||||
* $this->my_property = $p;
|
||||
* $this->setMyProperty() = $p;
|
||||
*
|
||||
* @param array|bool|float|int|object|string|null $value
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
public function __set(string $key, $value = null)
|
||||
{
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
// Check if the field should be mutated into a date
|
||||
if (in_array($dbColumn, $this->dates, true)) {
|
||||
$value = $this->mutateDate($value);
|
||||
}
|
||||
|
||||
$value = $this->castAs($value, $dbColumn, 'set');
|
||||
|
||||
// if a setter method exists for this key, use that method to
|
||||
// insert this value. should be outside $isNullable check,
|
||||
// so maybe wants to do sth with null value automatically
|
||||
$method = 'set' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $dbColumn)));
|
||||
|
||||
// If a "`_set` + $key" method exists, it is a setter.
|
||||
if (method_exists($this, '_' . $method)) {
|
||||
$this->{'_' . $method}($value);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// If a "`set` + $key" method exists, it is also a setter.
|
||||
if (method_exists($this, $method) && $method !== 'setAttributes') {
|
||||
$this->{$method}($value);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Otherwise, just the value. This allows for creation of new
|
||||
// class properties that are undefined, though they cannot be
|
||||
// saved. Useful for grabbing values through joins, assigning
|
||||
// relationships, etc.
|
||||
$this->attributes[$dbColumn] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Magic method to allow retrieval of protected and private class properties
|
||||
* either by their name, or through a `getCamelCasedProperty()` method.
|
||||
*
|
||||
* Examples:
|
||||
* $p = $this->my_property
|
||||
* $p = $this->getMyProperty()
|
||||
*
|
||||
* @return array|bool|float|int|object|string|null
|
||||
*
|
||||
* @throws Exception
|
||||
*
|
||||
* @params string $key class property
|
||||
*/
|
||||
public function __get(string $key)
|
||||
{
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
$result = null;
|
||||
|
||||
// Convert to CamelCase for the method
|
||||
$method = 'get' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $dbColumn)));
|
||||
|
||||
// if a getter method exists for this key,
|
||||
// use that method to insert this value.
|
||||
if (method_exists($this, '_' . $method)) {
|
||||
// If a "`_get` + $key" method exists, it is a getter.
|
||||
$result = $this->{'_' . $method}();
|
||||
} elseif (method_exists($this, $method)) {
|
||||
// If a "`get` + $key" method exists, it is also a getter.
|
||||
$result = $this->{$method}();
|
||||
}
|
||||
|
||||
// Otherwise return the protected property
|
||||
// if it exists.
|
||||
elseif (array_key_exists($dbColumn, $this->attributes)) {
|
||||
$result = $this->attributes[$dbColumn];
|
||||
}
|
||||
|
||||
// Do we need to mutate this into a date?
|
||||
if (in_array($dbColumn, $this->dates, true)) {
|
||||
$result = $this->mutateDate($result);
|
||||
}
|
||||
// Or cast it as something?
|
||||
elseif ($this->_cast) {
|
||||
$result = $this->castAs($result, $dbColumn);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if a property exists names $key, or a getter method
|
||||
* exists named like for __get().
|
||||
*/
|
||||
public function __isset(string $key): bool
|
||||
{
|
||||
if ($this->isMappedDbColumn($key)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
$method = 'get' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $dbColumn)));
|
||||
|
||||
if (method_exists($this, $method)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return isset($this->attributes[$dbColumn]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsets an attribute property.
|
||||
*/
|
||||
public function __unset(string $key): void
|
||||
{
|
||||
if ($this->isMappedDbColumn($key)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
unset($this->attributes[$dbColumn]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether this key is mapped db column name?
|
||||
*/
|
||||
protected function isMappedDbColumn(string $key): bool
|
||||
{
|
||||
$dbColumn = $this->mapProperty($key);
|
||||
|
||||
// The $key is a property name which has mapped db column name
|
||||
if ($key !== $dbColumn) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $this->hasMappedProperty($key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether this key has mapped property?
|
||||
*/
|
||||
protected function hasMappedProperty(string $key): bool
|
||||
{
|
||||
$property = array_search($key, $this->datamap, true);
|
||||
|
||||
return $property !== false;
|
||||
}
|
||||
}
|
||||
+75
@@ -0,0 +1,75 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Entity\Exceptions;
|
||||
|
||||
use CodeIgniter\Exceptions\FrameworkException;
|
||||
use CodeIgniter\Exceptions\HasExitCodeInterface;
|
||||
|
||||
/**
|
||||
* CastException is thrown for invalid cast initialization and management.
|
||||
*/
|
||||
class CastException extends FrameworkException implements HasExitCodeInterface
|
||||
{
|
||||
public function getExitCode(): int
|
||||
{
|
||||
return EXIT_CONFIG;
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when the cast class does not extends BaseCast.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public static function forInvalidInterface(string $class)
|
||||
{
|
||||
return new static(lang('Cast.baseCastMissing', [$class]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when the Json format is invalid.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public static function forInvalidJsonFormat(int $error)
|
||||
{
|
||||
return match ($error) {
|
||||
JSON_ERROR_DEPTH => new static(lang('Cast.jsonErrorDepth')),
|
||||
JSON_ERROR_STATE_MISMATCH => new static(lang('Cast.jsonErrorStateMismatch')),
|
||||
JSON_ERROR_CTRL_CHAR => new static(lang('Cast.jsonErrorCtrlChar')),
|
||||
JSON_ERROR_SYNTAX => new static(lang('Cast.jsonErrorSyntax')),
|
||||
JSON_ERROR_UTF8 => new static(lang('Cast.jsonErrorUtf8')),
|
||||
default => new static(lang('Cast.jsonErrorUnknown')),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when the cast method is not `get` or `set`.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public static function forInvalidMethod(string $method)
|
||||
{
|
||||
return new static(lang('Cast.invalidCastMethod', [$method]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when the casting timestamp is not correct timestamp.
|
||||
*
|
||||
* @return static
|
||||
*/
|
||||
public static function forInvalidTimestamp()
|
||||
{
|
||||
return new static(lang('Cast.invalidTimestamp'));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user