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

Author: kenjis

contributing/pull_request.md

@@ -44,13 +44,13 @@ as the existing code and ensures that the codebase will be as readable as possib
 You can fix most of the coding style violations by running this command in your terminal:
 
 ```console
-> composer cs-fix
+composer cs-fix
 ```
 
 You can check the coding style violations:
 
 ```console
-> composer cs
+composer cs
 ```
 
 ### Unit Testing
@@ -213,19 +213,19 @@ so that you can fix whatever errors that pop up with your submission.
 PHPStan is expected to scan the entire framework by running this command in your terminal:
 
 ```console
-> vendor/bin/phpstan analyse
+vendor/bin/phpstan analyse
 ```
 
 Rector, on the other hand, can be run on the specific files you modified or added:
 
 ```console
-> vendor/bin/rector process --dry-run path/to/file
+vendor/bin/rector process --dry-run path/to/file
 ```
 
 If you run it without `--dry-run`, Rector will fix the code:
 
 ```console
-> vendor/bin/rector process path/to/file
+vendor/bin/rector process path/to/file
 ```
 
 [1]: https://github.com/phpstan/phpstan-src

phpstan-baseline.php

@@ -1176,71 +1176,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/I18n/TimeLegacy.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forEXIFUnsupported\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forFileNotSupported\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forImageProcessFailed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forInvalidDirection\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forInvalidImageCreate\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forInvalidImageLibraryPath\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forInvalidPath\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forMissingAngle\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forMissingImage\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Exceptions\\\\ImageException\\:\\:forSaveFailed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Exceptions/ImageException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\BaseHandler\\:\\:_text\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/BaseHandler.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\BaseHandler\\:\\:ensureResource\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/BaseHandler.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\BaseHandler\\:\\:reproportion\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/BaseHandler.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Property CodeIgniter\\\\Images\\\\Handlers\\\\BaseHandler\\:\\:\\$image \\(CodeIgniter\\\\Images\\\\Image\\) in empty\\(\\) is not falsy\\.$#',
 	'count' => 1,
@@ -1251,21 +1186,6 @@
 	'count' => 2,
 	'path' => __DIR__ . '/system/Images/Handlers/ImageMagickHandler.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\ImageMagickHandler\\:\\:_text\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/ImageMagickHandler.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\ImageMagickHandler\\:\\:ensureResource\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/ImageMagickHandler.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Images\\\\Handlers\\\\ImageMagickHandler\\:\\:supportedFormatCheck\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Images/Handlers/ImageMagickHandler.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^PHPDoc type string\\|null of property CodeIgniter\\\\Images\\\\Handlers\\\\ImageMagickHandler\\:\\:\\$resource is not covariant with PHPDoc type resource\\|null of overridden property CodeIgniter\\\\Images\\\\Handlers\\\\BaseHandler\\:\\:\\$resource\\.$#',
 	'count' => 1,
@@ -1301,61 +1221,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Model.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Exceptions\\\\PagerException\\:\\:forInvalidPaginationGroup\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Exceptions/PagerException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Exceptions\\\\PagerException\\:\\:forInvalidTemplate\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Exceptions/PagerException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Pager\\:\\:calculateCurrentPage\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Pager.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Pager\\:\\:ensureGroup\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Pager.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\PagerRenderer\\:\\:updatePages\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/PagerRenderer.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forCollision\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forDestinationNotAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forFileNotAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Publisher\\:\\:verifyAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Publisher.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\RESTful\\\\BaseResource\\:\\:initController\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/RESTful/BaseResource.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\RESTful\\\\BaseResource\\:\\:setModel\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/RESTful/BaseResource.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Router\\\\AutoRouter\\:\\:setDirectory\\(\\) has no return type specified\\.$#',
 	'count' => 1,

rector.php

@@ -38,7 +38,6 @@
 use Rector\Php71\Rector\FuncCall\CountOnNullRector;
 use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
 use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector;
-use Rector\PHPUnit\Rector\MethodCall\AssertPropertyExistsRector;
 use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
 use Rector\Set\ValueObject\LevelSetList;
@@ -78,8 +77,6 @@
         __DIR__ . '/tests/_support',
         JsonThrowOnErrorRector::class,
         StringifyStrNeedlesRector::class,
-        // assertObjectHasAttribute() is deprecated
-        AssertPropertyExistsRector::class,
 
         RemoveUnusedPrivateMethodRector::class => [
             // private method called via getPrivateMethodInvoker

system/BaseModel.php

@@ -760,7 +760,7 @@ public function insert($data = null, bool $returnID = true)
 
         // Must be called first, so we don't
         // strip out created_at values.
-        $data = $this->doProtectFields($data);
+        $data = $this->doProtectFieldsForInsert($data);
 
         // doProtectFields() can further remove elements from
         // $data so we need to check for empty dataset again

system/Images/Exceptions/ImageException.php

@@ -16,51 +16,101 @@
 
 class ImageException extends FrameworkException implements ExceptionInterface
 {
+    /**
+     * Thrown when the image is not found.
+     *
+     * @return static
+     */
     public static function forMissingImage()
     {
         return new static(lang('Images.sourceImageRequired'));
     }
 
+    /**
+     * Thrown when the file specific is not following the role.
+     *
+     * @return static
+     */
     public static function forFileNotSupported()
     {
         return new static(lang('Images.fileNotSupported'));
     }
 
+    /**
+     * Thrown when the angle is undefined.
+     *
+     * @return static
+     */
     public static function forMissingAngle()
     {
         return new static(lang('Images.rotationAngleRequired'));
     }
 
+    /**
+     * Thrown when the direction property is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidDirection(?string $dir = null)
     {
         return new static(lang('Images.invalidDirection', [$dir]));
     }
 
+    /**
+     * Thrown when the path property is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidPath()
     {
         return new static(lang('Images.invalidPath'));
     }
 
+    /**
+     * Thrown when the EXIF function is not supported.
+     *
+     * @return static
+     */
     public static function forEXIFUnsupported()
     {
         return new static(lang('Images.exifNotSupported'));
     }
 
+    /**
+     * Thrown when the image specific is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidImageCreate(?string $extra = null)
     {
         return new static(lang('Images.unsupportedImageCreate') . ' ' . $extra);
     }
 
+    /**
+     * Thrown when the image save failed.
+     *
+     * @return static
+     */
     public static function forSaveFailed()
     {
         return new static(lang('Images.saveFailed'));
     }
 
+    /**
+     * Thrown when the image library path is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidImageLibraryPath(?string $path = null)
     {
         return new static(lang('Images.libPathInvalid', [$path]));
     }
 
+    /**
+     * Thrown when the image process failed.
+     *
+     * @return static
+     */
     public static function forImageProcessFailed()
     {
         return new static(lang('Images.imageProcessFailed'));

system/Images/Handlers/BaseHandler.php

@@ -156,6 +156,8 @@ public function withFile(string $path)
 
     /**
      * Make the image resource object if needed
+     *
+     * @return void
      */
     abstract protected function ensureResource();
 
@@ -422,6 +424,8 @@ public function text(string $text, array $options = [])
 
     /**
      * Handler-specific method for overlaying text on an image.
+     *
+     * @return void
      */
     abstract protected function _text(string $text, array $options = []);
 
@@ -722,6 +726,8 @@ public function __call(string $name, array $args = [])
      *
      * This function lets us re-proportion the width/height
      * if users choose to maintain the aspect ratio when resizing.
+     *
+     * @return void
      */
     protected function reproportion()
     {

system/Images/Handlers/ImageMagickHandler.php

@@ -290,6 +290,8 @@ protected function getResourcePath()
     /**
      * Make the image resource object if needed
      *
+     * @return void
+     *
      * @throws Exception
      */
     protected function ensureResource()
@@ -302,6 +304,8 @@ protected function ensureResource()
     /**
      * Check if given image format is supported
      *
+     * @return void
+     *
      * @throws ImageException
      */
     protected function supportedFormatCheck()
@@ -318,6 +322,8 @@ protected function supportedFormatCheck()
     /**
      * Handler-specific method for overlaying text on an image.
      *
+     * @return void
+     *
      * @throws Exception
      */
     protected function _text(string $text, array $options = [])