fix: TypeError in DataCaster initialization (#9738)

* fix: TypeError in `DataCaster` init * fix: Apply suggestion * refactor: Remove unnecessary comments * fix: Revert to phpstan types

Author: neznaika0

system/DataCaster/DataCaster.php

@@ -28,6 +28,12 @@
 use CodeIgniter\Entity\Exceptions\CastException;
 use CodeIgniter\Exceptions\InvalidArgumentException;
 
+/**
+ * @phpstan-type cast_handlers array<string, class-string<EntityCastInterface|CastInterface>>
+ *
+ * @see CodeIgniter\DataCaster\DataCasterTest
+ * @see CodeIgniter\Entity\EntityTest
+ */
 final class DataCaster
 {
  /**
@@ -38,9 +44,9 @@ final class DataCaster
  private array $types = [];
 
  /**
- * Convert handlers
+ * Convert handlers.
  *
- * @var array<string, class-string> [type => classname]
+ * @var cast_handlers [type => classname]
  */
  private array $castHandlers = [
  'array' => ArrayCast::class,
@@ -59,18 +65,18 @@ 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 cast_handlers|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.
  */
  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);
@@ -113,12 +119,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;

system/Entity/Cast/ArrayCast.php

@@ -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:'))) {
@@ -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);

system/Entity/Cast/BaseCast.php

@@ -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;

system/Entity/Cast/BooleanCast.php

@@ -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;

system/Entity/Cast/CSVCast.php

@@ -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);

system/Entity/Cast/CastInterface.php

@@ -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]

system/Entity/Cast/DatetimeCast.php

@@ -17,9 +17,6 @@
 use DateTime;
 use Exception;
 
-/**
- * Class DatetimeCast
- */
 class DatetimeCast extends BaseCast
 {
  /**

system/Entity/Cast/FloatCast.php

@@ -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;

system/Entity/Cast/IntBoolCast.php

@@ -14,8 +14,6 @@
 namespace CodeIgniter\Entity\Cast;
 
 /**
- * Int Bool Cast
- *
  * DB column: int (0/1) <--> Class property: bool
  */
 final class IntBoolCast extends BaseCast

system/Entity/Cast/IntegerCast.php

@@ -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;