Merge branch 'codeigniter4projects-develop' into develop

CodeIgniter-Chinese · Jan 31, 2024 · 7a5d51f · 7a5d51f
2 parents 65c2146 + fe9ec00
commit 7a5d51f
Show file tree

Hide file tree

Showing 28 changed files with 565 additions and 434 deletions.
diff --git a/.github/workflows/infection.yml b/.github/workflows/infection.yml
@@ -48,7 +48,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

diff --git a/.github/workflows/phpcsfixer.yml b/.github/workflows/phpcsfixer.yml
@@ -49,7 +49,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -54,7 +54,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
@@ -64,7 +64,7 @@ jobs:
         run: mkdir -p build/phpstan
 
       - name: Cache PHPStan results
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: build/phpstan
           key: ${{ runner.os }}-phpstan-${{ github.sha }}

diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -45,7 +45,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

diff --git a/.github/workflows/rector.yml b/.github/workflows/rector.yml
@@ -54,7 +54,7 @@ jobs:
         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}

diff --git a/app/Config/App.php b/app/Config/App.php
@@ -27,8 +27,7 @@ class App extends BaseConfig
      *      'http://accounts.example.com/':
      *          ['media.example.com', 'accounts.example.com']
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public array $allowedHostnames = [];
 

diff --git a/app/Config/Autoload.php b/app/Config/Autoload.php
@@ -41,7 +41,7 @@ class Autoload extends AutoloadConfig
      *       'App'	       => APPPATH
      *   ];
      *
-     * @var array<string, string>
+     * @var array<string, list<string>|string>
      */
     public $psr4 = [
         APP_NAMESPACE => APPPATH, // For custom app namespace
@@ -80,8 +80,7 @@ class Autoload extends AutoloadConfig
      *       '/path/to/my/file.php',
      *   ];
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public $files = [];
 
@@ -94,8 +93,7 @@ class Autoload extends AutoloadConfig
      *       'form',
      *   ];
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public $helpers = [];
 }
diff --git a/app/Config/Cache.php b/app/Config/Cache.php
@@ -2,6 +2,7 @@
 
 namespace Config;
 
+use CodeIgniter\Cache\CacheInterface;
 use CodeIgniter\Cache\Handlers\DummyHandler;
 use CodeIgniter\Cache\Handlers\FileHandler;
 use CodeIgniter\Cache\Handlers\MemcachedHandler;
@@ -156,7 +157,7 @@ class Cache extends BaseConfig
      * This is an array of cache engine alias' and class names. Only engines
      * that are listed here are allowed to be used.
      *
-     * @var array<string, string>
+     * @var array<string, class-string<CacheInterface>>
      */
     public array $validHandlers = [
         'dummy'     => DummyHandler::class,

diff --git a/app/Config/Email.php b/app/Config/Email.php
@@ -26,7 +26,7 @@ class Email extends BaseConfig
     public string $mailPath = '/usr/sbin/sendmail';
 
     /**
-     * SMTP Server Address
+     * SMTP Server Hostname
      */
     public string $SMTPHost = '';
 

diff --git a/app/Config/Filters.php b/app/Config/Filters.php
@@ -15,8 +15,8 @@ class Filters extends BaseConfig
      * Configures aliases for Filter classes to
      * make reading things nicer and simpler.
      *
-     * @var array<string, string>
-     * @phpstan-var array<string, class-string>
+     * @var array<string, class-string|list<class-string>> [filter_name => classname]
+     *                                                     or [filter_name => [classname1, classname2, ...]]
      */
     public array $aliases = [
         'csrf'          => CSRF::class,
@@ -30,8 +30,7 @@ class Filters extends BaseConfig
      * List of filter aliases that are always
      * applied before and after every request.
      *
-     * @var array<string, array<string, array<string, string>>>|array<string, array<string>>
-     * @phpstan-var array<string, list<string>>|array<string, array<string, array<string, string>>>
+     * @var array<string, array<string, array<string, string>>>|array<string, list<string>>
      */
     public array $globals = [
         'before' => [

diff --git a/app/Config/Kint.php b/app/Config/Kint.php
@@ -3,7 +3,10 @@
 namespace Config;
 
 use CodeIgniter\Config\BaseConfig;
+use Kint\Parser\ConstructablePluginInterface;
 use Kint\Renderer\AbstractRenderer;
+use Kint\Renderer\Rich\TabPluginInterface;
+use Kint\Renderer\Rich\ValuePluginInterface;
 
 /**
  * --------------------------------------------------------------------------
@@ -23,7 +26,11 @@ class Kint extends BaseConfig
     |--------------------------------------------------------------------------
     */
 
+    /**
+     * @var list<class-string<ConstructablePluginInterface>|ConstructablePluginInterface>|null
+     */
     public $plugins;
+
     public int $maxDepth           = 6;
     public bool $displayCalledFrom = true;
     public bool $expanded          = false;
@@ -35,13 +42,16 @@ class Kint extends BaseConfig
     */
     public string $richTheme = 'aante-light.css';
     public bool $richFolder  = false;
+    public int $richSort     = AbstractRenderer::SORT_FULL;
 
     /**
-     * @psalm-suppress UndefinedClass
+     * @var array<string, class-string<ValuePluginInterface>>|null
      */
-    public int $richSort = AbstractRenderer::SORT_FULL;
-
     public $richObjectPlugins;
+
+    /**
+     * @var array<string, class-string<TabPluginInterface>>|null
+     */
     public $richTabPlugins;
 
     /*

diff --git a/app/Config/Migrations.php b/app/Config/Migrations.php
@@ -25,9 +25,7 @@ class Migrations extends BaseConfig
      *
      * This is the name of the table that will store the current migrations state.
      * When migrations runs it will store in a database table which migration
-     * level the system is at. It then compares the migration level in this
-     * table to the $config['migration_version'] if they are not the same it
-     * will migrate up. This must be set.
+     * files have already been run.
      */
     public string $table = 'migrations';
 

diff --git a/app/Config/Modules.php b/app/Config/Modules.php
@@ -58,7 +58,7 @@ class Modules extends BaseModules
      *       ],
      *   ]
      *
-     * @var array
+     * @var array{only?: list<string>, exclude?: list<string>}
      */
     public $composerPackages = [];
 
@@ -72,7 +72,7 @@ class Modules extends BaseModules
      *
      * If it is not listed, only the base application elements will be used.
      *
-     * @var string[]
+     * @var list<string>
      */
     public $aliases = [
         'events',

diff --git a/app/Config/Publisher.php b/app/Config/Publisher.php
@@ -19,7 +19,7 @@ class Publisher extends BasePublisher
      * result in a PublisherException. Files that do no fit the
      * pattern will cause copy/merge to fail.
      *
-     * @var array<string,string>
+     * @var array<string, string>
      */
     public $restrictions = [
         ROOTPATH => '*',

diff --git a/app/Config/Session.php b/app/Config/Session.php
@@ -19,7 +19,7 @@ class Session extends BaseConfig
      * - `CodeIgniter\Session\Handlers\MemcachedHandler`
      * - `CodeIgniter\Session\Handlers\RedisHandler`
      *
-     * @phpstan-var class-string<BaseHandler>
+     * @var class-string<BaseHandler>
      */
     public string $driver = FileHandler::class;
 

diff --git a/app/Config/View.php b/app/Config/View.php
@@ -5,6 +5,10 @@
 use CodeIgniter\Config\View as BaseView;
 use CodeIgniter\View\ViewDecoratorInterface;
 
+/**
+ * @phpstan-type ParserCallable (callable(mixed): mixed)
+ * @phpstan-type ParserCallableString (callable(mixed): mixed)&string
+ */
 class View extends BaseView
 {
     /**
@@ -31,7 +35,7 @@ class View extends BaseView
      *  { created_on|date(Y-m-d)|esc(attr) }
      *
      * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @phpstan-var array<string, ParserCallableString>
      */
     public $filters = [];
 
@@ -40,8 +44,8 @@ class View extends BaseView
      * by the core Parser by creating aliases that will be replaced with
      * any callable. Can be single or tag pair.
      *
-     * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @var array<string, array<string>|callable|string>
+     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     public $plugins = [];
 

diff --git a/app/Entities/GitHub/URITrait.php b/app/Entities/GitHub/URITrait.php
@@ -22,7 +22,7 @@ public function __get(string $key)
         $result = parent::__get($key);
 
         if (is_string($result) && is_int(strpos($key, 'url'))) {
-            return empty($result) ? null : new URI($result);
+            return ($result === '') ? null : new URI($result);
         }
 
         return $result;

diff --git a/app/Libraries/Blog.php b/app/Libraries/Blog.php
@@ -73,7 +73,7 @@ public function getRecentPosts(int $limit = 5, int $offset = 0, ?string $categor
                 $temp = $this->readPost($this->config->contentPath, $file);
 
                 // Only collect from the correct category.
-                if (! empty($category) && ! in_array($category, $temp->tags, true)) {
+                if ($category !== null && ! in_array($category, $temp->tags, true)) {
                     continue;
                 }
 
@@ -146,7 +146,7 @@ public function getPost(string $slug)
         if (! $post = cache($cacheKey)) {
             $files = glob("{$this->config->contentPath}*.{$slug}.md");
 
-            if (empty($files)) {
+            if ($files === [] || $files === false) {
                 throw PageNotFoundException::forPageNotFound();
             }
 
@@ -227,7 +227,7 @@ protected function readPost(string $folder, string $filename)
     {
         $contents = file($folder . $filename);
 
-        if (empty($contents)) {
+        if ($contents === [] || $contents === false) {
             return null;
         }
 

diff --git a/app/Views/errors/cli/error_exception.php b/app/Views/errors/cli/error_exception.php
@@ -3,17 +3,26 @@
 use CodeIgniter\CLI\CLI;
 
 // The main Exception
-CLI::newLine();
 CLI::write('[' . get_class($exception) . ']', 'light_gray', 'red');
-CLI::newLine();
 CLI::write($message);
-CLI::newLine();
 CLI::write('at ' . CLI::color(clean_path($exception->getFile()) . ':' . $exception->getLine(), 'green'));
 CLI::newLine();
 
+$last = $exception;
+
+while ($prevException = $last->getPrevious()) {
+    $last = $prevException;
+
+    CLI::write('  Caused by:');
+    CLI::write('  [' . get_class($prevException) . ']', 'red');
+    CLI::write('  ' . $prevException->getMessage());
+    CLI::write('  at ' . CLI::color(clean_path($prevException->getFile()) . ':' . $prevException->getLine(), 'green'));
+    CLI::newLine();
+}
+
 // The backtrace
 if (defined('SHOW_DEBUG_BACKTRACE') && SHOW_DEBUG_BACKTRACE) {
-    $backtraces = $exception->getTrace();
+    $backtraces = $last->getTrace();
 
     if ($backtraces) {
         CLI::write('Backtrace:', 'green');

diff --git a/app/Views/errors/html/error_exception.php b/app/Views/errors/html/error_exception.php
@@ -44,6 +44,30 @@
         <?php endif; ?>
     </div>
 
+    <div class="container">
+        <?php
+        $last = $exception;
+
+        while ($prevException = $last->getPrevious()) {
+            $last = $prevException;
+            ?>
+
+    <pre>
+    Caused by:
+    <?= esc(get_class($prevException)), esc($prevException->getCode() ? ' #' . $prevException->getCode() : '') ?>
+
+    <?= nl2br(esc($prevException->getMessage())) ?>
+    <a href="https://www.duckduckgo.com/?q=<?= urlencode(get_class($prevException) . ' ' . preg_replace('#\'.*\'|".*"#Us', '', $prevException->getMessage())) ?>"
+       rel="noreferrer" target="_blank">search &rarr;</a>
+    <?= esc(clean_path($prevException->getFile()) . ':' . $prevException->getLine()) ?>
+    </pre>
+
+        <?php
+        }
+        ?>
+    </div>
+
+    <?php if (defined('SHOW_DEBUG_BACKTRACE') && SHOW_DEBUG_BACKTRACE) : ?>
     <div class="container">
 
         <ul class="tabs" id="tabs">
@@ -66,7 +90,7 @@
                     <li>
                         <p>
                             <!-- Trace info -->
-                            <?php if (isset($row['file']) && is_file($row['file'])) :?>
+                            <?php if (isset($row['file']) && is_file($row['file'])) : ?>
                                 <?php
                                 if (isset($row['function']) && in_array($row['function'], ['include', 'include_once', 'require', 'require_once'], true)) {
                                     echo esc($row['function'] . ' ' . clean_path($row['file']));
@@ -375,14 +399,16 @@
         </div>  <!-- /tab-content -->
 
     </div> <!-- /container -->
+    <?php endif; ?>
 
     <div class="footer">
         <div class="container">
 
             <p>
                 Displayed at <?= esc(date('H:i:sa')) ?> &mdash;
                 PHP: <?= esc(PHP_VERSION) ?>  &mdash;
-                CodeIgniter: <?= esc(CodeIgniter::CI_VERSION) ?>
+                CodeIgniter: <?= esc(CodeIgniter::CI_VERSION) ?> --
+                Environment: <?= ENVIRONMENT ?>
             </p>
 
         </div>

diff --git a/composer.json b/composer.json
@@ -22,7 +22,7 @@
         "slack": "https://codeigniterchat.slack.com"
     },
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.1",
         "codeigniter4/cache": "^1.0",
         "codeigniter4/framework": "^4.2",
         "guzzlehttp/guzzle": "^7.0.1",