Entity rework

phpstan-baseline.php

@@ -2056,26 +2056,6 @@
 	'count' => 2,
 	'path' => __DIR__ . '/system/Encryption/Handlers/SodiumHandler.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Parameter \\#1 \\$value \\(bool\\|int\\|string\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\IntBoolCast\\:\\:set\\(\\) should be contravariant with parameter \\$value \\(array\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\BaseCast\\:\\:set\\(\\)$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Entity/Cast/IntBoolCast.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Parameter \\#1 \\$value \\(bool\\|int\\|string\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\IntBoolCast\\:\\:set\\(\\) should be contravariant with parameter \\$value \\(array\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\CastInterface\\:\\:set\\(\\)$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Entity/Cast/IntBoolCast.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Parameter \\#1 \\$value \\(int\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\IntBoolCast\\:\\:get\\(\\) should be contravariant with parameter \\$value \\(array\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\BaseCast\\:\\:get\\(\\)$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Entity/Cast/IntBoolCast.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Parameter \\#1 \\$value \\(int\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\IntBoolCast\\:\\:get\\(\\) should be contravariant with parameter \\$value \\(array\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method CodeIgniter\\\\Entity\\\\Cast\\\\CastInterface\\:\\:get\\(\\)$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Entity/Cast/IntBoolCast.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 4,

rector.php

@@ -77,6 +77,12 @@
         __DIR__ . '/tests/system/Config/fixtures',
         __DIR__ . '/tests/system/Filters/fixtures',
         __DIR__ . '/tests/_support',
+
+        // Error: ] Could not process "tests/system/Entity/EntityLiveTest.php" file, due
+        //         to:
+        //         "Call to a member function getValue() on bool". On line: 172
+        __DIR__ . '/tests/system/Entity/EntityLiveTest.php',
+
         JsonThrowOnErrorRector::class,
         YieldDataProviderRector::class,
 

system/BaseModel.php

@@ -17,6 +17,7 @@
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use CodeIgniter\Database\Exceptions\DataException;
 use CodeIgniter\Database\Query;
+use CodeIgniter\Entity\Entity;
 use CodeIgniter\Exceptions\ModelException;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Pager\Pager;
@@ -1684,8 +1685,11 @@ protected function objectToArray($data, bool $onlyChanged = true, bool $recursiv
      */
     protected function objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): array
     {
+        if ($data instanceof Entity) {
+            $properties = $data->toDatabase($onlyChanged, $recursive);
+        }
         // @TODO Should define Interface or Class. Entity has toRawArray() now.
-        if (method_exists($data, 'toRawArray')) {
+        elseif (method_exists($data, 'toRawArray')) {
             $properties = $data->toRawArray($onlyChanged, $recursive);
         } else {
             $mirror = new ReflectionClass($data);
@@ -1706,7 +1710,7 @@ protected function objectToRawArray($data, bool $onlyChanged = true, bool $recur
     }
 
     /**
-     * Transform data to array.
+     * Transform data to array that can be save to database.
      *
      * @param array|object|null $data Data
      * @param string            $type Type of data (insert|update)

system/Database/MySQLi/Result.php

@@ -148,7 +148,7 @@ protected function fetchAssoc()
     protected function fetchObject(string $className = 'stdClass')
     {
         if (is_subclass_of($className, Entity::class)) {
-            return empty($data = $this->fetchAssoc()) ? false : (new $className())->injectRawData($data);
+            return empty($data = $this->fetchAssoc()) ? false : (new $className())->fromDatabase($data);
         }
 
         return $this->resultID->fetch_object($className);

system/Database/OCI8/Result.php

@@ -103,7 +103,7 @@ protected function fetchObject(string $className = 'stdClass')
             return $row;
         }
         if (is_subclass_of($className, Entity::class)) {
-            return (new $className())->injectRawData((array) $row);
+            return (new $className())->fromDatabase((array) $row);
         }
 
         $instance = new $className();

system/Database/Postgre/Result.php

@@ -114,7 +114,7 @@ protected function fetchAssoc()
     protected function fetchObject(string $className = 'stdClass')
     {
         if (is_subclass_of($className, Entity::class)) {
-            return empty($data = $this->fetchAssoc()) ? false : (new $className())->injectRawData($data);
+            return empty($data = $this->fetchAssoc()) ? false : (new $className())->fromDatabase($data);
         }
 
         return pg_fetch_object($this->resultID, null, $className);

system/Database/SQLSRV/Result.php

@@ -154,7 +154,7 @@ protected function fetchAssoc()
     protected function fetchObject(string $className = 'stdClass')
     {
         if (is_subclass_of($className, Entity::class)) {
-            return empty($data = $this->fetchAssoc()) ? false : (new $className())->injectRawData($data);
+            return empty($data = $this->fetchAssoc()) ? false : (new $className())->fromDatabase($data);
         }
 
         return sqlsrv_fetch_object($this->resultID, $className);

system/Database/SQLite3/Result.php

@@ -142,7 +142,7 @@ protected function fetchObject(string $className = 'stdClass')
         $classObj = new $className();
 
         if (is_subclass_of($className, Entity::class)) {
-            return $classObj->injectRawData($row);
+            return $classObj->fromDatabase($row);
         }
 
         $classSet = Closure::bind(function ($key, $value) {

system/Entity/Cast/ArrayCast.php

@@ -19,10 +19,14 @@ class ArrayCast extends BaseCast
     /**
      * {@inheritDoc}
      */
-    public static function get($value, array $params = []): array
+    public static function fromDatabase($value, array $params = []): array
     {
-        if (is_string($value) && (strpos($value, 'a:') === 0 || strpos($value, 's:') === 0)) {
-            $value = unserialize($value);
+        if (! is_string($value)) {
+            self::invalidTypeValueError($value);
+        }
+
+        if ((strpos($value, 'a:') === 0 || strpos($value, 's:') === 0)) {
+            $value = unserialize($value, ['allowed_classes' => false]);
         }
 
         return (array) $value;
@@ -31,8 +35,12 @@ public static function get($value, array $params = []): array
     /**
      * {@inheritDoc}
      */
-    public static function set($value, array $params = []): string
+    public static function toDatabase($value, array $params = []): string
     {
+        if (! is_array($value) && ! is_string($value)) {
+            self::invalidTypeValueError($value);
+        }
+
         return serialize($value);
     }
 }

system/Entity/Cast/BaseCast.php

@@ -11,13 +11,16 @@
 
 namespace CodeIgniter\Entity\Cast;
 
+use TypeError;
+
 /**
  * Class BaseCast
  */
 abstract class BaseCast implements CastInterface
 {
     /**
-     * Get
+     * Returns value when getting the Entity property.
+     * This method is normally returns the value as it is.
      *
      * @param array|bool|float|int|object|string|null $value  Data
      * @param array                                   $params Additional param
@@ -30,7 +33,7 @@ public static function get($value, array $params = [])
     }
 
     /**
-     * Set
+     * Returns value for Entity property when setting the Entity property.
      *
      * @param array|bool|float|int|object|string|null $value  Data
      * @param array                                   $params Additional param
@@ -41,4 +44,42 @@ public static function set($value, array $params = [])
     {
         return $value;
     }
+
+    /**
+     * Takes the Entity property value, returns its value for database.
+     *
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
+     *
+     * @return bool|float|int|string|null
+     */
+    public static function toDatabase($value, array $params = [])
+    {
+        return $value;
+    }
+
+    /**
+     * Takes value from database, returns its value for the Entity property.
+     *
+     * @param bool|float|int|string|null $value  Data
+     * @param array                      $params Additional param
+     *
+     * @return array|bool|float|int|object|string|null
+     */
+    public static function fromDatabase($value, array $params = [])
+    {
+        return $value;
+    }
+
+    /**
+     * Throws TypeError
+     *
+     * @param mixed $value
+     *
+     * @return never
+     */
+    protected static function invalidTypeValueError($value)
+    {
+        throw new TypeError('Invalid type value: ' . var_export($value, true));
+    }
 }

system/Entity/Cast/BooleanCast.php

@@ -19,8 +19,20 @@ class BooleanCast extends BaseCast
     /**
      * {@inheritDoc}
      */
-    public static function get($value, array $params = []): bool
+    public static function set($value, array $params = []): bool
     {
         return (bool) $value;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function fromDatabase($value, array $params = []): bool
+    {
+        if (! is_string($value)) {
+            self::invalidTypeValueError($value);
+        }
+
+        return (bool) $value;
+    }
 }

system/Entity/Cast/CSVCast.php

@@ -19,16 +19,24 @@ class CSVCast extends BaseCast
     /**
      * {@inheritDoc}
      */
-    public static function get($value, array $params = []): array
+    public static function fromDatabase($value, array $params = []): array
     {
+        if (! is_string($value)) {
+            self::invalidTypeValueError($value);
+        }
+
         return explode(',', $value);
     }
 
     /**
      * {@inheritDoc}
      */
-    public static function set($value, array $params = []): string
+    public static function toDatabase($value, array $params = []): string
     {
+        if (! is_array($value)) {
+            self::invalidTypeValueError($value);
+        }
+
         return implode(',', $value);
     }
 }

system/Entity/Cast/CastInterface.php

@@ -13,11 +13,15 @@
 
 /**
  * Interface CastInterface
+ *
+ * [App Code] --- set() --> [Entity] --- toDatabase() ---> [Database]
+ * [App Code] <-- get() --- [Entity] <-- fromDatabase() -- [Database]
  */
 interface CastInterface
 {
     /**
-     * Get
+     * Returns value when getting the Entity property.
+     * This method is normally returns the value as it is.
      *
      * @param array|bool|float|int|object|string|null $value  Data
      * @param array                                   $params Additional param
@@ -27,12 +31,32 @@ interface CastInterface
     public static function get($value, array $params = []);
 
     /**
-     * Set
+     * Returns value for the Entity property when setting the Entity property.
      *
      * @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 = []);
+
+    /**
+     * Takes the Entity property value, returns its value for database.
+     *
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
+     *
+     * @return bool|float|int|string|null
+     */
+    public static function toDatabase($value, array $params = []);
+
+    /**
+     * Takes value from database, returns its value for the Entity property.
+     *
+     * @param bool|float|int|string|null $value  Data
+     * @param array                      $params Additional param
+     *
+     * @return array|bool|float|int|object|string|null
+     */
+    public static function fromDatabase($value, array $params = []);
 }

system/Entity/Cast/DatetimeCast.php

@@ -27,7 +27,7 @@ class DatetimeCast extends BaseCast
      *
      * @throws Exception
      */
-    public static function get($value, array $params = [])
+    public static function set($value, array $params = [])
     {
         if ($value instanceof Time) {
             return $value;
@@ -45,6 +45,34 @@ public static function get($value, array $params = [])
             return Time::parse($value);
         }
 
-        return $value;
+        self::invalidTypeValueError($value);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return Time
+     *
+     * @throws Exception
+     */
+    public static function fromDatabase($value, array $params = [])
+    {
+        if (is_string($value)) {
+            return Time::parse($value);
+        }
+
+        self::invalidTypeValueError($value);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function toDatabase($value, array $params = []): string
+    {
+        if (! $value instanceof Time) {
+            self::invalidTypeValueError($value);
+        }
+
+        return (string) $value;
     }
 }

system/Entity/Cast/FloatCast.php

@@ -19,7 +19,15 @@ class FloatCast extends BaseCast
     /**
      * {@inheritDoc}
      */
-    public static function get($value, array $params = []): float
+    public static function set($value, array $params = []): float
+    {
+        return (float) $value;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function fromDatabase($value, array $params = []): float
     {
         return (float) $value;
     }