Merge remote-tracking branch 'upstream/develop' into 4.3

kenjis · kenjis · commit 7808f18ae156 · 2022-07-24T09:30:44.000+09:00
diff --git a/system/Database/Exceptions/DatabaseException.php b/system/Database/Exceptions/DatabaseException.php
@@ -20,5 +20,5 @@ class DatabaseException extends Error implements ExceptionInterface
      *
      * @var int
      */
-    protected $code = 8;
+    protected $code = EXIT_DATABASE;
 }
diff --git a/system/Entity/Cast/BaseCast.php b/system/Entity/Cast/BaseCast.php
@@ -19,10 +19,10 @@ abstract class BaseCast implements CastInterface
     /**
      * Get
      *
-     * @param mixed $value  Data
-     * @param array $params Additional param
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
      *
-     * @return mixed
+     * @return array|bool|float|int|object|string|null
      */
     public static function get($value, array $params = [])
     {
@@ -32,10 +32,10 @@ public static function get($value, array $params = [])
     /**
      * Set
      *
-     * @param mixed $value  Data
-     * @param array $params Additional param
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
      *
-     * @return mixed
+     * @return array|bool|float|int|object|string|null
      */
     public static function set($value, array $params = [])
     {
diff --git a/system/Entity/Cast/CastInterface.php b/system/Entity/Cast/CastInterface.php
@@ -19,20 +19,20 @@ interface CastInterface
     /**
      * Get
      *
-     * @param mixed $value  Data
-     * @param array $params Additional param
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
      *
-     * @return mixed
+     * @return array|bool|float|int|object|string|null
      */
     public static function get($value, array $params = []);
 
     /**
      * Set
      *
-     * @param mixed $value  Data
-     * @param array $params Additional param
+     * @param array|bool|float|int|object|string|null $value  Data
+     * @param array                                   $params Additional param
      *
-     * @return mixed
+     * @return array|bool|float|int|object|string|null
      */
     public static function set($value, array $params = []);
 }
diff --git a/system/Entity/Cast/DatetimeCast.php b/system/Entity/Cast/DatetimeCast.php
@@ -24,6 +24,8 @@ class DatetimeCast extends BaseCast
      * {@inheritDoc}
      *
      * @throws Exception
+     *
+     * @return Time
      */
     public static function get($value, array $params = [])
     {
diff --git a/system/Entity/Entity.php b/system/Entity/Entity.php
@@ -146,7 +146,7 @@ public function fill(?array $data = null)
      * __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 casted.
+     * @param bool $cast        If true, properties will be cast.
      * @param bool $recursive   If true, inner entities will be casted as array as well.
      */
     public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recursive = false): array
@@ -256,6 +256,8 @@ public function hasChanged(?string $key = null): bool
             return $this->original !== $this->attributes;
         }
 
+        $key = $this->mapProperty($key);
+
         // Key doesn't exist in either
         if (! array_key_exists($key, $this->original) && ! array_key_exists($key, $this->attributes)) {
             return false;
@@ -287,7 +289,7 @@ public function setAttributes(array $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
+     * @return string db column name
      */
     protected function mapProperty(string $key)
     {
@@ -480,7 +482,7 @@ public function __get(string $key)
         // Convert to CamelCase for the method
         $method = 'get' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $key)));
 
-        // if a set* method exists for this key,
+        // if a get* method exists for this key,
         // use that method to insert this value.
         if (method_exists($this, $method)) {
             $result = $this->{$method}();
diff --git a/system/Entity/Exceptions/CastException.php b/system/Entity/Exceptions/CastException.php
@@ -15,6 +15,10 @@
 
 /**
  * CastException is thrown for invalid cast initialization and management.
+ *
+ * @TODO CodeIgniter\Exceptions\CastException is deprecated and this class is used.
+ *      CodeIgniter\Exceptions\CastException has the property $code = EXIT_CONFIG,
+ *      but this class does not have the code.
  */
 class CastException extends FrameworkException
 {
diff --git a/system/Exceptions/CastException.php b/system/Exceptions/CastException.php
@@ -23,11 +23,11 @@ class CastException extends CriticalError
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * Exit status code
      *
      * @var int
      */
-    protected $code = 3;
+    protected $code = EXIT_CONFIG;
 
     public static function forInvalidJsonFormatException(int $error)
     {
diff --git a/system/Exceptions/ConfigException.php b/system/Exceptions/ConfigException.php
@@ -19,11 +19,11 @@ class ConfigException extends CriticalError
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * Exit status code
      *
      * @var int
      */
-    protected $code = 3;
+    protected $code = EXIT_CONFIG;
 
     public static function forDisabledMigrations()
     {
diff --git a/system/Exceptions/PageNotFoundException.php b/system/Exceptions/PageNotFoundException.php
@@ -19,7 +19,7 @@ class PageNotFoundException extends OutOfBoundsException implements ExceptionInt
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * HTTP status code
      *
      * @var int
      */
diff --git a/system/Router/Exceptions/RedirectException.php b/system/Router/Exceptions/RedirectException.php
@@ -19,7 +19,7 @@
 class RedirectException extends Exception
 {
     /**
-     * Status code for redirects
+     * HTTP status code for redirects
      *
      * @var int
      */
diff --git a/tests/system/Debug/ExceptionsTest.php b/tests/system/Debug/ExceptionsTest.php
@@ -11,6 +11,9 @@
 
 namespace CodeIgniter\Debug;
 
+use CodeIgniter\Database\Exceptions\DatabaseException;
+use CodeIgniter\Entity\Exceptions\CastException;
+use CodeIgniter\Exceptions\ConfigException;
 use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\ReflectionHelper;
@@ -57,9 +60,16 @@ public function testDetermineCodes(): void
     {
         $determineCodes = $this->getPrivateMethodInvoker($this->exception, 'determineCodes');
 
-        $this->assertSame([500, 9], $determineCodes(new RuntimeException('This.')));
-        $this->assertSame([500, 1], $determineCodes(new RuntimeException('That.', 600)));
-        $this->assertSame([404, 1], $determineCodes(new RuntimeException('There.', 404)));
+        $this->assertSame([500, EXIT__AUTO_MIN], $determineCodes(new RuntimeException('This.')));
+        $this->assertSame([500, EXIT_ERROR], $determineCodes(new RuntimeException('That.', 600)));
+        $this->assertSame([404, EXIT_ERROR], $determineCodes(new RuntimeException('There.', 404)));
+        $this->assertSame([167, EXIT_ERROR], $determineCodes(new RuntimeException('This.', 167)));
+        // @TODO This exit code should be EXIT_CONFIG.
+        $this->assertSame([500, 12], $determineCodes(new ConfigException('This.')));
+        // @TODO This exit code should be EXIT_CONFIG.
+        $this->assertSame([500, 9], $determineCodes(new CastException('This.')));
+        // @TODO This exit code should be EXIT_DATABASE.
+        $this->assertSame([500, 17], $determineCodes(new DatabaseException('This.')));
     }
 
     public function testRenderBacktrace(): void
diff --git a/tests/system/Entity/EntityTest.php b/tests/system/Entity/EntityTest.php
@@ -929,6 +929,24 @@ public function testHasChangedNoChange()
         $this->assertFalse($entity->hasChanged('default'));
     }
 
+    public function testHasChangedMappedNoChange()
+    {
+        $entity = $this->getEntity();
+
+        $entity->createdAt = null;
+
+        $this->assertFalse($entity->hasChanged('createdAt'));
+    }
+
+    public function testHasChangedMappedChanged()
+    {
+        $entity = $this->getEntity();
+
+        $entity->createdAt = '2022-11-11 11:11:11';
+
+        $this->assertTrue($entity->hasChanged('createdAt'));
+    }
+
     public function testHasChangedWholeEntity()
     {
         $entity = $this->getEntity();
diff --git a/user_guide_src/source/models/entities.rst b/user_guide_src/source/models/entities.rst
@@ -144,9 +144,9 @@ As an example, imagine you have the simplified User Entity that is used througho
 .. literalinclude:: entities/008.php
 
 Your boss comes to you and says that no one uses usernames anymore, so you're switching to just use emails for login.
-But they do want to personalize the application a bit, so they want you to change the name field to represent a user's
+But they do want to personalize the application a bit, so they want you to change the ``name`` field to represent a user's
 full name now, not their username like it does currently. To keep things tidy and ensure things continue making sense
-in the database you whip up a migration to rename the `name` field to `full_name` for clarity.
+in the database you whip up a migration to rename the ``name`` field to ``full_name`` for clarity.
 
 Ignoring how contrived this example is, we now have two choices on how to fix the User class. We could modify the class
 property from ``$name`` to ``$full_name``, but that would require changes throughout the application. Instead, we can
@@ -164,6 +164,10 @@ through the original ``$user->full_name``, also, as this is needed for the model
 to the database. However, ``unset()`` and ``isset()`` only work on the mapped property, ``$user->name``, not on the database column name,
 ``$user->full_name``.
 
+.. note:: When you use Data Mapping, you must define ``set*()`` and ``get*()`` method
+    for the database column name. In this example, you must define ``setFullName()`` and
+    ``getFullName()``.
+
 Mutators
 ========
 
diff --git a/user_guide_src/source/models/entities/009.php b/user_guide_src/source/models/entities/009.php
@@ -8,14 +8,15 @@ class User extends Entity
 {
     protected $attributes = [
         'id'         => null,
-        'full_name'  => null, // In the $attributes, the key is the column name
+        'full_name'  => null, // In the $attributes, the key is the db column name
         'email'      => null,
         'password'   => null,
         'created_at' => null,
         'updated_at' => null,
     ];
 
     protected $datamap = [
+        // property_name => db_column_name
         'name' => 'full_name',
     ];
 }

Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,5 @@ class DatabaseException extends Error implements ExceptionInterface`
`20`	`20`	`*`
`21`	`21`	`* @var int`
`22`	`22`	`*/`
`23`		`- protected $code = 8;`
	`23`	`+ protected $code = EXIT_DATABASE;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@ abstract class BaseCast implements CastInterface`
`19`	`19`	`/**`
`20`	`20`	`* Get`
`21`	`21`	`*`
`22`		`- * @param mixed $value Data`
`23`		`- * @param array $params Additional param`
	`22`	`+ * @param array\|bool\|float\|int\|object\|string\|null $value Data`
	`23`	`+ * @param array $params Additional param`
`24`	`24`	`*`
`25`		`- * @return mixed`
	`25`	`+ * @return array\|bool\|float\|int\|object\|string\|null`
`26`	`26`	`*/`
`27`	`27`	`public static function get($value, array $params = [])`
`28`	`28`	`{`
`@@ -32,10 +32,10 @@ public static function get($value, array $params = [])`
`32`	`32`	`/**`
`33`	`33`	`* Set`
`34`	`34`	`*`
`35`		`- * @param mixed $value Data`
`36`		`- * @param array $params Additional param`
	`35`	`+ * @param array\|bool\|float\|int\|object\|string\|null $value Data`
	`36`	`+ * @param array $params Additional param`
`37`	`37`	`*`
`38`		`- * @return mixed`
	`38`	`+ * @return array\|bool\|float\|int\|object\|string\|null`
`39`	`39`	`*/`
`40`	`40`	`public static function set($value, array $params = [])`
`41`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,20 +19,20 @@ interface CastInterface`
`19`	`19`	`/**`
`20`	`20`	`* Get`
`21`	`21`	`*`
`22`		`- * @param mixed $value Data`
`23`		`- * @param array $params Additional param`
	`22`	`+ * @param array\|bool\|float\|int\|object\|string\|null $value Data`
	`23`	`+ * @param array $params Additional param`
`24`	`24`	`*`
`25`		`- * @return mixed`
	`25`	`+ * @return array\|bool\|float\|int\|object\|string\|null`
`26`	`26`	`*/`
`27`	`27`	`public static function get($value, array $params = []);`
`28`	`28`
`29`	`29`	`/**`
`30`	`30`	`* Set`
`31`	`31`	`*`
`32`		`- * @param mixed $value Data`
`33`		`- * @param array $params Additional param`
	`32`	`+ * @param array\|bool\|float\|int\|object\|string\|null $value Data`
	`33`	`+ * @param array $params Additional param`
`34`	`34`	`*`
`35`		`- * @return mixed`
	`35`	`+ * @return array\|bool\|float\|int\|object\|string\|null`
`36`	`36`	`*/`
`37`	`37`	`public static function set($value, array $params = []);`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@ class DatetimeCast extends BaseCast`
`24`	`24`	`* {@inheritDoc}`
`25`	`25`	`*`
`26`	`26`	`* @throws Exception`
	`27`	`+ *`
	`28`	`+ * @return Time`
`27`	`29`	`*/`
`28`	`30`	`public static function get($value, array $params = [])`
`29`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ class CastException extends CriticalError`
`23`	`23`	`use DebugTraceableTrait;`
`24`	`24`
`25`	`25`	`/**`
`26`		`- * Error code`
	`26`	`+ * Exit status code`
`27`	`27`	`*`
`28`	`28`	`* @var int`
`29`	`29`	`*/`
`30`		`- protected $code = 3;`
	`30`	`+ protected $code = EXIT_CONFIG;`
`31`	`31`
`32`	`32`	`public static function forInvalidJsonFormatException(int $error)`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,11 @@ class ConfigException extends CriticalError`
`19`	`19`	`use DebugTraceableTrait;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * Error code`
	`22`	`+ * Exit status code`
`23`	`23`	`*`
`24`	`24`	`* @var int`
`25`	`25`	`*/`
`26`		`- protected $code = 3;`
	`26`	`+ protected $code = EXIT_CONFIG;`
`27`	`27`
`28`	`28`	`public static function forDisabledMigrations()`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class PageNotFoundException extends OutOfBoundsException implements ExceptionInt`
`19`	`19`	`use DebugTraceableTrait;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * Error code`
	`22`	`+ * HTTP status code`
`23`	`23`	`*`
`24`	`24`	`* @var int`
`25`	`25`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`class RedirectException extends Exception`
`20`	`20`	`{`
`21`	`21`	`/**`
`22`		`- * Status code for redirects`
	`22`	`+ * HTTP status code for redirects`
`23`	`23`	`*`
`24`	`24`	`* @var int`
`25`	`25`	`*/`