Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions system/DataCaster/DataCaster.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
use CodeIgniter\Entity\Exceptions\CastException;
use CodeIgniter\Exceptions\InvalidArgumentException;

/**
* @phpstan-type cast_handlers array<string, CastInterface|class-string|EntityCastInterface>
*
* @see CodeIgniter\DataCaster\DataCasterTest
* @see CodeIgniter\Entity\EntityTest
*/
final class DataCaster
{
/**
Expand All @@ -38,9 +44,10 @@ final class DataCaster
private array $types = [];

/**
* Convert handlers
* Convert handlers.
*
* @var array<string, class-string> [type => classname]
* @var array<string, class-string> [type => classname]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this also have the CastInterface and EnityCastInterface as above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we've decided on separate typing, I'm unsure about specifying the types...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm now wondering if the framework should be the one adjusting for this missing support of phpDocumentor. I feel we are being redundant in our PHPDocs just because our API tool does not yet support a feature that is widely used now. Should this be a feature request to them (to support phpstan types and conditional returns?).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an alternative to phpDocumentor that would handle it better?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a small project, I would ignore the duplication and rely on the phpstan. types.
Looking at symfony, they don't bother with this.
There is a slightly different option, which is more complex - to use a Value Object, DTO instead of an array.

* @phpstan-var cast_handlers
*/
private array $castHandlers = [
'array' => ArrayCast::class,
Expand All @@ -59,18 +66,19 @@ final class DataCaster
];

/**
* @param array<string, class-string>|null $castHandlers Custom convert handlers
* @param array<string, string>|null $types [field => type]
* @param object|null $helper Helper object.
* @param bool $strict Strict mode? Set to false for casts for Entity.
* @param array<string, class-string>|null $castHandlers Custom convert handlers
* @param array<string, string>|null $types [field => type]
* @param object|null $helper Helper object.
* @param bool $strict Strict mode? Set to false for casts for Entity.
* @phpstan-param cast_handlers|null $castHandlers
*/
public function __construct(
?array $castHandlers = null,
?array $types = null,
private readonly ?object $helper = null,
private readonly bool $strict = true,
) {
$this->castHandlers = array_merge($this->castHandlers, $castHandlers);
$this->castHandlers = array_merge($this->castHandlers, $castHandlers ?? []);

if ($types !== null) {
$this->setTypes($types);
Expand Down Expand Up @@ -113,12 +121,16 @@ public function setTypes(array $types): static
* Add ? at the beginning of the type (i.e. ?string) to get `null`
* instead of casting $value when $value is null.
*
* @param mixed $value The value to convert
* @param string $field The field name
* @param 'get'|'set' $method Allowed to "get" and "set"
* @param mixed $value The value to convert
* @param string $field The field name
* @param string $method Allowed to "get" and "set"
*/
public function castAs(mixed $value, string $field, string $method = 'get'): mixed
{
if ($method !== 'get' && $method !== 'set') {
throw CastException::forInvalidMethod($method);
}

// If the type is not defined, return as it is.
if (! isset($this->types[$field])) {
return $value;
Expand Down
9 changes: 0 additions & 9 deletions system/Entity/Cast/ArrayCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

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:'))) {
Expand All @@ -30,9 +24,6 @@ public static function get($value, array $params = []): array
return (array) $value;
}

/**
* {@inheritDoc}
*/
public static function set($value, array $params = []): string
{
return serialize($value);
Expand Down
19 changes: 0 additions & 19 deletions system/Entity/Cast/BaseCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,13 @@

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;
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/BooleanCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

namespace CodeIgniter\Entity\Cast;

/**
* Class BooleanCast
*/
class BooleanCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = []): bool
{
return (bool) $value;
Expand Down
9 changes: 0 additions & 9 deletions system/Entity/Cast/CSVCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,13 @@

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);
Expand Down
2 changes: 0 additions & 2 deletions system/Entity/Cast/CastInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
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]
Expand Down
3 changes: 0 additions & 3 deletions system/Entity/Cast/DatetimeCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
use DateTime;
use Exception;

/**
* Class DatetimeCast
*/
class DatetimeCast extends BaseCast
{
/**
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/FloatCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

namespace CodeIgniter\Entity\Cast;

/**
* Class FloatCast
*/
class FloatCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = []): float
{
return (float) $value;
Expand Down
2 changes: 0 additions & 2 deletions system/Entity/Cast/IntBoolCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
namespace CodeIgniter\Entity\Cast;

/**
* Int Bool Cast
*
* DB column: int (0/1) <--> Class property: bool
*/
final class IntBoolCast extends BaseCast
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/IntegerCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

namespace CodeIgniter\Entity\Cast;

/**
* Class IntegerCast
*/
class IntegerCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = []): int
{
return (int) $value;
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/JsonCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,8 @@
use JsonException;
use stdClass;

/**
* Class JsonCast
*/
class JsonCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = [])
{
$associative = in_array('array', $params, true);
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/ObjectCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

namespace CodeIgniter\Entity\Cast;

/**
* Class ObjectCast
*/
class ObjectCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = []): object
{
return (object) $value;
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/StringCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,8 @@

namespace CodeIgniter\Entity\Cast;

/**
* Class StringCast
*/
class StringCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = []): string
{
return (string) $value;
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/TimestampCast.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,8 @@

use CodeIgniter\Entity\Exceptions\CastException;

/**
* Class TimestampCast
*/
class TimestampCast extends BaseCast
{
/**
* {@inheritDoc}
*/
public static function get($value, array $params = [])
{
$value = strtotime($value);
Expand Down
6 changes: 0 additions & 6 deletions system/Entity/Cast/URICast.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,8 @@

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);
Expand Down
34 changes: 34 additions & 0 deletions tests/system/DataCaster/DataCasterTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?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\DataCaster;

use CodeIgniter\Entity\Exceptions\CastException;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\Attributes\Group;

/**
* @internal
*/
#[Group('Others')]
final class DataCasterTest extends CIUnitTestCase
{
public function testCastInvalidMethodException(): void
{
$this->expectException(CastException::class);
$this->expectExceptionMessage('The "add" is invalid cast method, valid methods are: ["get", "set"].');

$dataCaster = new DataCaster();
$dataCaster->castAs([], 'name', 'add');
}
}
Loading