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

kenjis · kenjis · commit 4c3ff531757d · 2023-01-09T09:00:01.000+09:00
diff --git a/.github/scripts/deploy-userguide b/.github/scripts/deploy-userguide
@@ -23,6 +23,12 @@ cd $TARGET
 git checkout master
 rm -rf docs
 
+# Copy common files
+cp -Rf ${SOURCE}/LICENSE ./
+
+# Copy repo-specific files
+cp -Rf ${SOURCE}/admin/userguide/. ./
+
 # Copy files
 cp -Rf ${SOURCE}/user_guide_src/build/html ./docs
 cp -Rf ${SOURCE}/user_guide_src/build/epub/CodeIgniter.epub ./CodeIgniter${VERSION}.epub
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2014-2019 British Columbia Institute of Technology
-Copyright (c) 2019-2022 CodeIgniter Foundation
+Copyright (c) 2019-2023 CodeIgniter Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/admin/userguide/.github/scripts/deploy b/admin/userguide/.github/scripts/deploy
@@ -0,0 +1,15 @@
+#!/bin/sh -e
+
+# Deploys the User Guide to the production
+# website. Triggered by updates to the GitHub
+# repo's master branch.
+
+REPO=/opt/userguide
+SITE=/home/public_html/userguides/userguide4
+
+cd "$REPO"
+git switch master
+git pull
+
+rm -rf "$SITE"
+cp -R "$REPO/docs" "$SITE"
diff --git a/admin/userguide/.github/workflows/deploy.yml b/admin/userguide/.github/workflows/deploy.yml
@@ -0,0 +1,22 @@
+# Deploys the User Guide to the production
+# website whenever master branch is updated
+name: Deploy Production
+
+on:
+  push:
+    branches: 
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: executing remote ssh commands using ssh key
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: ${{ secrets.PORT }}
+          script: /opt/userguide/.github/scripts/deploy
diff --git a/admin/userguide/.gitignore b/admin/userguide/.gitignore
@@ -0,0 +1,13 @@
+*/config/development
+*/logs/log-*.php
+!*/logs/index.html
+*/cache/*
+!*/cache/index.html
+!*/cache/.htaccess
+
+user_guide_src/build/*
+user_guide_src/cilexer/build/*
+user_guide_src/cilexer/dist/*
+user_guide_src/cilexer/pycilexer.egg-info/*
+
+/vendor/
diff --git a/admin/userguide/README.md b/admin/userguide/README.md
@@ -1,20 +1,15 @@
 # CodeIgniter 4 User Guide
 
-## What is CodeIgniter?
-
-CodeIgniter is a PHP full-stack web framework that is light, fast, flexible and secure. 
+CodeIgniter 4 is a PHP web framework that is light, fast, flexible, and secure.
 More information can be found at the [official site](http://codeigniter.com).
 
-This repository holds a composer-installable pre-built user guide for the framework.
-It has been built from the 
-[development repository](https://github.com/codeigniter4/CodeIgniter4).
-
-More information about the plans for version 4 can be found in [the announcement](http://forum.codeigniter.com/thread-62615.html) on the forums.
-
-## Installation & updates
+**This is a read-only repository used to publish the user guide for the current release.**
+It is built automatically as part of the framework release workflow, and pull
+requests are not accepted here.
 
-`composer require codeigniter4/userguide` will install a copy
-of the user guide inside your project, at
-`vendor/codeigniter4/userguide`. You can then `composer update` whenever
-there is a new release of the framework.
+Development is done in the [main repository](https://github.com/codeigniter4/codeigniter4).
+If you find problems with the user guide, please submit a correcting pull request there.
 
+If you feel that features are missing or unclear, please comment on our
+[forum](https://forum.codeigniter.com/index.php),
+in the appropriate CodeIgniter4 subforum.
diff --git a/admin/userguide/composer.json b/admin/userguide/composer.json
diff --git a/app/Config/Cache.php b/app/Config/Cache.php
@@ -122,7 +122,7 @@ class Cache extends BaseConfig
      *
      * @see https://codeigniter.com/user_guide/libraries/caching.html#memcached
      *
-     * @var array<string, boolean|int|string>
+     * @var array<string, bool|int|string>
      */
     public array $memcached = [
         'host'   => '127.0.0.1',
diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -161,9 +161,10 @@ public static function init()
             static::parseCommandLine();
 
             static::$initialized = true;
-        } else {
+        } elseif (! defined('STDOUT')) {
             // If the command is being called from a controller
             // we need to define STDOUT ourselves
+            // For "! defined('STDOUT')" see: https://github.com/codeigniter4/CodeIgniter4/issues/7047
             define('STDOUT', 'php://output'); // @codeCoverageIgnore
         }
     }
diff --git a/system/Email/Email.php b/system/Email/Email.php
@@ -2101,6 +2101,11 @@ protected function getHostname()
             return '[' . $_SERVER['SERVER_ADDR'] . ']';
         }
 
+        $hostname = gethostname();
+        if ($hostname !== false) {
+            return $hostname;
+        }
+
         return '[127.0.0.1]';
     }
 
diff --git a/system/Encryption/Encryption.php b/system/Encryption/Encryption.php
@@ -71,7 +71,7 @@ class Encryption
     /**
      * Handlers that are to be installed
      *
-     * @var array<string, boolean>
+     * @var array<string, bool>
      */
     protected $handlers = [];
 
diff --git a/system/Events/Events.php b/system/Events/Events.php
@@ -246,7 +246,7 @@ public static function setFiles(array $files)
      *
      * @return string[]
      */
-    public function getFiles()
+    public static function getFiles()
     {
         return static::$files;
     }
diff --git a/system/Router/Router.php b/system/Router/Router.php
@@ -581,8 +581,6 @@ public function setDirectory(?string $dir = null, bool $append = false, bool $va
     {
         if (empty($dir)) {
             $this->directory = null;
-
-            return;
         }
 
         if ($this->autoRouter instanceof AutoRouter) {
diff --git a/system/Test/Interfaces/FabricatorModel.php b/system/Test/Interfaces/FabricatorModel.php
@@ -67,7 +67,7 @@ public function insert($data = null, bool $returnID = true);
      * Sets $useSoftDeletes value so that we can temporarily override
      * the softdeletes settings. Can be used for all find* methods.
      *
-     * @param boolean $val
+     * @param bool $val
      *
      * @return Model
      */
diff --git a/tests/system/Events/EventsTest.php b/tests/system/Events/EventsTest.php
@@ -55,21 +55,21 @@ public function testInitialize()
 
         // it should start out empty
         MockEvents::setFiles([]);
-        $this->assertEmpty($this->manager->getFiles());
+        $this->assertEmpty(Events::getFiles());
 
         // make sure we have a default events file
         $default = [APPPATH . 'Config' . DIRECTORY_SEPARATOR . 'Events.php'];
         $this->manager->unInitialize();
         MockEvents::initialize();
-        $this->assertSame($default, $this->manager->getFiles());
+        $this->assertSame($default, Events::getFiles());
 
         // but we should be able to change it through the backdoor
         MockEvents::setFiles(['/peanuts']);
-        $this->assertSame(['/peanuts'], $this->manager->getFiles());
+        $this->assertSame(['/peanuts'], Events::getFiles());
 
         // re-initializing should have no effect
         MockEvents::initialize();
-        $this->assertSame(['/peanuts'], $this->manager->getFiles());
+        $this->assertSame(['/peanuts'], Events::getFiles());
     }
 
     public function testPerformance()
diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py
@@ -12,13 +12,15 @@
 #
 # import os
 # import sys
+import datetime
 # sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'CodeIgniter'
 author = 'CodeIgniter Foundation'
-copyright = '2019-2022 CodeIgniter Foundation'
+year_now = datetime.date.today().year
+copyright = '2019-' + str(year_now) + ' CodeIgniter Foundation'
 
 # The short X.Y version.
 version = '4.2'
@@ -137,4 +139,4 @@
 epub_title = 'CodeIgniter4'
 epub_author = 'CodeIgniter Foundation'
 epub_publisher = 'CodeIgniter Foundation'
-epub_copyright = '2019-2022 CodeIgniter Foundation'
+epub_copyright = copyright
diff --git a/user_guide_src/source/general/urls.rst b/user_guide_src/source/general/urls.rst
@@ -50,6 +50,8 @@ Route    /blog/news/2022/10
 Query    page=2
 ======== ====================================
 
+.. _urls-remove-index-php:
+
 Removing the index.php file
 ===========================
 
diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst
@@ -27,6 +27,7 @@ If a URL like ``/mypage/find/apple`` doesn't work, but the similar
 URL ``/index.php/mypage/find/apple`` does, that sounds like your **.htaccess** rules
 (for Apache) are not set up properly, or the ``mod_rewrite`` extension
 in Apache's **httpd.conf** is commented out.
+See :ref:`urls-remove-index-php`.
 
 Only the default page loads
 ---------------------------
diff --git a/user_guide_src/source/license.rst b/user_guide_src/source/license.rst
@@ -3,7 +3,7 @@ The MIT License (MIT)
 #####################
 
 | Copyright (c) 2014-2019 British Columbia Institute of Technology
-| Copyright (c) 2019-2022 CodeIgniter Foundation
+| Copyright (c) 2019-2023 CodeIgniter Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ class Cache extends BaseConfig`
`122`	`122`	`*`
`123`	`123`	`* @see https://codeigniter.com/user_guide/libraries/caching.html#memcached`
`124`	`124`	`*`
`125`		`- * @var array<string, boolean\|int\|string>`
	`125`	`+ * @var array<string, bool\|int\|string>`
`126`	`126`	`*/`
`127`	`127`	`public array $memcached = [`
`128`	`128`	`'host' => '127.0.0.1',`
Original file line number	Diff line number	Diff line change
`@@ -161,9 +161,10 @@ public static function init()`
`161`	`161`	`static::parseCommandLine();`
`162`	`162`
`163`	`163`	`static::$initialized = true;`
`164`		`- } else {`
	`164`	`+ } elseif (! defined('STDOUT')) {`
`165`	`165`	`// If the command is being called from a controller`
`166`	`166`	`// we need to define STDOUT ourselves`
	`167`	`+ // For "! defined('STDOUT')" see: https://github.com/codeigniter4/CodeIgniter4/issues/7047`
`167`	`168`	`define('STDOUT', 'php://output'); // @codeCoverageIgnore`
`168`	`169`	`}`
`169`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2101,6 +2101,11 @@ protected function getHostname()`
`2101`	`2101`	`return '[' . $_SERVER['SERVER_ADDR'] . ']';`
`2102`	`2102`	`}`
`2103`	`2103`
	`2104`	`+ $hostname = gethostname();`
	`2105`	`+ if ($hostname !== false) {`
	`2106`	`+ return $hostname;`
	`2107`	`+ }`
	`2108`	`+`
`2104`	`2109`	`return '[127.0.0.1]';`
`2105`	`2110`	`}`
`2106`	`2111`