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

kenjis · kenjis · commit 75d8b56eded8 · 2023-07-28T11:22:23.000+09:00
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -45,6 +45,23 @@
 
 $overrides = [
     'php_unit_data_provider_return_type' => true,
+    'no_extra_blank_lines'               => [
+        'tokens' => [
+            'attribute',
+            'break',
+            'case',
+            'continue',
+            'curly_brace_block',
+            'default',
+            'extra',
+            'parenthesis_brace_block',
+            'return',
+            'square_brace_block',
+            'switch',
+            'throw',
+            'use',
+        ],
+    ],
 ];
 
 $options = [
diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -31,6 +31,23 @@
 
 $overrides = [
     'php_unit_data_provider_return_type' => true,
+    'no_extra_blank_lines'               => [
+        'tokens' => [
+            'attribute',
+            'break',
+            'case',
+            'continue',
+            'curly_brace_block',
+            'default',
+            'extra',
+            'parenthesis_brace_block',
+            'return',
+            'square_brace_block',
+            'switch',
+            'throw',
+            'use',
+        ],
+    ],
 ];
 
 $options = [
diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -24,8 +24,10 @@
     ])
     ->notPath([
         'ci3sample/',
-        'libraries/sessions/016.php',
         'database/query_builder/075.php',
+        'libraries/sessions/016.php',
+        'outgoing/response/031.php',
+        'outgoing/response/032.php',
     ]);
 
 $overrides = [
@@ -34,6 +36,23 @@
     'no_unused_imports'                  => false,
     'class_attributes_separation'        => false,
     'php_unit_data_provider_return_type' => true,
+    'no_extra_blank_lines'               => [
+        'tokens' => [
+            'attribute',
+            'break',
+            'case',
+            'continue',
+            'curly_brace_block',
+            'default',
+            'extra',
+            'parenthesis_brace_block',
+            'return',
+            'square_brace_block',
+            'switch',
+            'throw',
+            'use',
+        ],
+    ],
 ];
 
 $options = [
diff --git a/app/Config/Filters.php b/app/Config/Filters.php
@@ -55,7 +55,7 @@ class Filters extends BaseConfig
      *
      * If you use this, you should disable auto-routing because auto-routing
      * permits any HTTP method to access a controller. Accessing the controller
-     * with a method you don’t expect could bypass the filter.
+     * with a method you don't expect could bypass the filter.
      */
     public array $methods = [];
 
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,12 @@ class Kint extends BaseConfig
     |--------------------------------------------------------------------------
     */
 
+    /**
+     * @var array<int, ConstructablePluginInterface|string>
+     * @phpstan-var list<class-string<ConstructablePluginInterface>|ConstructablePluginInterface>
+     */
     public $plugins;
+
     public int $maxDepth           = 6;
     public bool $displayCalledFrom = true;
     public bool $expanded          = false;
@@ -36,7 +44,17 @@ class Kint extends BaseConfig
     public string $richTheme = 'aante-light.css';
     public bool $richFolder  = false;
     public int $richSort     = AbstractRenderer::SORT_FULL;
+
+    /**
+     * @var array<string, string>
+     * @phpstan-var array<string, class-string<ValuePluginInterface>>
+     */
     public $richObjectPlugins;
+
+    /**
+     * @var array<string, string>
+     * @phpstan-var array<string, class-string<TabPluginInterface>>
+     */
     public $richTabPlugins;
 
     /*
diff --git a/app/Config/Logger.php b/app/Config/Logger.php
@@ -74,14 +74,12 @@ class Logger extends BaseConfig
      * the handler on top and continuing down.
      */
     public array $handlers = [
-
         /*
          * --------------------------------------------------------------------
          * File Handler
          * --------------------------------------------------------------------
          */
         FileHandler::class => [
-
             // The log levels that this handler will handle.
             'handles' => [
                 'critical',
diff --git a/app/Controllers/BaseController.php b/app/Controllers/BaseController.php
@@ -44,7 +44,7 @@ abstract class BaseController extends Controller
     // protected $session;
 
     /**
-     * Constructor.
+     * @return void
      */
     public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
     {
diff --git a/app/Controllers/Home.php b/app/Controllers/Home.php
@@ -4,7 +4,7 @@
 
 class Home extends BaseController
 {
-    public function index()
+    public function index(): string
     {
         return view('welcome_message');
     }
diff --git a/changelogs/CHANGELOG_4.0.md b/changelogs/CHANGELOG_4.0.md
@@ -515,7 +515,7 @@ These changes increase security when handling uploaded files as the client can n
 - Add hex2bin prefix handling for encryption key [\#3307](https://github.com/codeigniter4/CodeIgniter4/pull/3307) ([michalsn](https://github.com/michalsn))
 - add break; in foreach at Time::getDst\(\) when daylightSaving set [\#3305](https://github.com/codeigniter4/CodeIgniter4/pull/3305) ([samsonasik](https://github.com/samsonasik))
 - New command: cache:clear [\#3304](https://github.com/codeigniter4/CodeIgniter4/pull/3304) ([lonnieezell](https://github.com/lonnieezell))
-- force\_https didn’t force https [\#3302](https://github.com/codeigniter4/CodeIgniter4/pull/3302) ([colethorsen](https://github.com/colethorsen))
+- force\_https didn't force https [\#3302](https://github.com/codeigniter4/CodeIgniter4/pull/3302) ([colethorsen](https://github.com/colethorsen))
 - add test for CommandRunner::\_remap\(\) with empty first params [\#3301](https://github.com/codeigniter4/CodeIgniter4/pull/3301) ([samsonasik](https://github.com/samsonasik))
 - FieldData -\> add typeName field and length field  [\#3299](https://github.com/codeigniter4/CodeIgniter4/pull/3299) ([devorama](https://github.com/devorama))
 - reduce repetitive getDefaultNamespace\(\) and controllerName\(\) function call in Router [\#3298](https://github.com/codeigniter4/CodeIgniter4/pull/3298) ([samsonasik](https://github.com/samsonasik))
@@ -2380,7 +2380,7 @@ These changes increase security when handling uploaded files as the client can n
 - Database can't save connect instances because var "$group" default is NULL [\#466](https://github.com/codeigniter4/CodeIgniter4/issues/466)
 - redirect\(\) issue [\#465](https://github.com/codeigniter4/CodeIgniter4/issues/465)
 - Join not working in Query Builder [\#464](https://github.com/codeigniter4/CodeIgniter4/issues/464)
-- If the controller’s method's parameter has a default value , the program will show 500 error [\#461](https://github.com/codeigniter4/CodeIgniter4/issues/461)
+- If the controller's method's parameter has a default value , the program will show 500 error [\#461](https://github.com/codeigniter4/CodeIgniter4/issues/461)
 - Wrong ROOTPATH on console [\#460](https://github.com/codeigniter4/CodeIgniter4/issues/460)
 - Rename "public" Folder Not Working [\#453](https://github.com/codeigniter4/CodeIgniter4/issues/453)
 - Environment File [\#452](https://github.com/codeigniter4/CodeIgniter4/issues/452)
diff --git a/contributing/pull_request.md b/contributing/pull_request.md
@@ -28,7 +28,7 @@ Before we look into how to contribute to CodeIgniter4, here are some guidelines.
 Your Pull Requests (PRs) need to meet our guidelines.
 
 If your Pull Requests fail to pass these guidelines, they will be declined,
-and you will need to re-submit when you’ve made the changes.
+and you will need to re-submit when you've made the changes.
 This might sound a bit tough, but it is required for us to maintain the quality of the codebase.
 
 ### PHP Style
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -1,31 +1,6 @@
 <?php declare(strict_types = 1);
 
 $ignoreErrors = [];
-$ignoreErrors[] = [
-	'message' => '#^Property Config\\\\Kint\\:\\:\\$plugins has no type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Config/Kint.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Property Config\\\\Kint\\:\\:\\$richObjectPlugins has no type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Config/Kint.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Property Config\\\\Kint\\:\\:\\$richTabPlugins has no type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Config/Kint.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method App\\\\Controllers\\\\BaseController\\:\\:initController\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Controllers/BaseController.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method App\\\\Controllers\\\\Home\\:\\:index\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Controllers/Home.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Autoloader\\\\Autoloader\\:\\:discoverComposerNamespaces\\(\\) has no return type specified\\.$#',
 	'count' => 1,
diff --git a/system/Database/OCI8/Forge.php b/system/Database/OCI8/Forge.php
@@ -187,7 +187,7 @@ protected function _attributeAutoIncrement(array &$attributes, array &$field)
     protected function _processColumn(array $field): string
     {
         $constraint = '';
-        // @todo: can’t cover multi pattern when set type.
+        // @todo: can't cover multi pattern when set type.
         if ($field['type'] === 'VARCHAR2' && strpos($field['length'], "('") === 0) {
             $constraint = ' CHECK(' . $this->db->escapeIdentifiers($field['name'])
                 . ' IN ' . $field['length'] . ')';
diff --git a/system/HTTP/ContentSecurityPolicy.php b/system/HTTP/ContentSecurityPolicy.php
@@ -327,7 +327,7 @@ public function reportOnly(bool $value = true)
     /**
      * Adds a new base_uri value. Can be either a URI class or a simple string.
      *
-     * base_uri restricts the URLs that can appear in a page’s <base> element.
+     * base_uri restricts the URLs that can appear in a page's <base> element.
      *
      * @see http://www.w3.org/TR/CSP/#directive-base-uri
      *
diff --git a/tests/system/Database/Live/OCI8/CallStoredProcedureTest.php b/tests/system/Database/Live/OCI8/CallStoredProcedureTest.php
@@ -51,7 +51,6 @@ public function testCallPackageProcedure()
                 'name'  => ':output',
                 'value' => &$result,
             ],
-
         ]);
 
         $this->assertSame($result, '7');
@@ -74,7 +73,6 @@ public function testCallStoredProcedure()
                 'name'  => ':output',
                 'value' => &$result,
             ],
-
         ]);
 
         $this->assertSame($result, '7');
@@ -90,7 +88,6 @@ public function testCallStoredProcedureForCursor()
                 'type'  => OCI_B_CURSOR,
                 'value' => &$result,
             ],
-
         ]);
 
         oci_execute($result);
diff --git a/tests/system/Database/Live/UpdateTest.php b/tests/system/Database/Live/UpdateTest.php
@@ -342,7 +342,6 @@ public function testUpdateBatchUpdateFieldsAndAlias()
                 'country' => 'Greece',
             ],
             [
-
                 'email'   => 'ahmadinejad@world.com',
                 'name'    => 'Ahmadinejad No change',
                 'country' => 'Greece',
diff --git a/tests/system/Database/Live/UpsertTest.php b/tests/system/Database/Live/UpsertTest.php
@@ -98,11 +98,8 @@ public function testUpsertAndUpsertBatchWithObject()
                 break;
 
             case 'Postgre':
-
             case 'SQLite3':
-
             case 'SQLSRV':
-
             case 'OCI8':
                 // postgre, sqlite, sqlsrv, oracle - counts row with no change
                 $this->assertSame(3, $affectedRows1);
diff --git a/tests/system/Test/TestCaseTest.php b/tests/system/Test/TestCaseTest.php
@@ -14,7 +14,6 @@
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\Events\Events;
 use CodeIgniter\HTTP\Response;
-
 use Config\App;
 
 /**
diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst
@@ -182,13 +182,86 @@ The above configuration assumes the project folder is located as follows:
        │      └── public/  (DocumentRoot for myproject.local)
        └── htdocs/
 
+Restart Apache.
+
 Testing
 -------
 
 With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
 
 Apache needs to be restarted whenever you change its configuration.
 
+Hosting with Subfolder
+======================
+
+If you want a baseURL like **http://localhost/myproject/** with a subfolder,
+there are three ways.
+
+Making Symlink
+--------------
+
+Place your project folder as follows, where **htdocs** is the Apache document root::
+
+    ├── myproject/ (project folder)
+    │      └── public/
+    └── htdocs/
+
+Navigate to the **htdocs** folder and create a symbolic link as follows::
+
+    > cd htdocs/
+    > ln -s ../myproject/public/ myproject
+
+Using Alias
+-----------
+
+Place your project folder as follows, where **htdocs** is the Apache document root::
+
+    ├── myproject/ (project folder)
+    │      └── public/
+    └── htdocs/
+
+Add the following in the main configuration file, e.g., **apache2/conf/httpd.conf**:
+
+.. code-block:: apache
+
+    Alias /myproject /opt/lamp/apache2/myproject/public
+    <Directory "/opt/lamp/apache2/myproject/public">
+        AllowOverride All
+        Require all granted
+    </Directory>
+
+Restart Apache.
+
+Adding .htaccess
+----------------
+
+The last resort is to add **.htaccess** to the project root.
+
+It is not recommended that you place the project folder in the document root.
+However, if you have no other choice, like on a shared server, you can use this.
+
+Place your project folder as follows, where **htdocs** is the Apache document root,
+and create the **.htaccess** file::
+
+    └── htdocs/
+        └── myproject/ (project folder)
+            ├── .htaccess
+            └── public/
+
+And edit **.htaccess** as follows:
+
+.. code-block:: apache
+
+    <IfModule mod_rewrite.c>
+        RewriteEngine On
+        RewriteRule ^(.*)$ public/$1 [L]
+    </IfModule>
+
+    <FilesMatch "^\.">
+        Require all denied
+        Satisfy All
+    </FilesMatch>
+
 Hosting with mod_userdir (Shared Hosts)
 =======================================
 
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
@@ -416,7 +416,7 @@ necessary with our new implementation. However, it may happen that your
 application relied on these values, so here are alternative methods of
 accessing them:
 
-  - session_id: ``$session->session_id`` or ``session_id()`` (PHP’s built-in function)
+  - session_id: ``$session->session_id`` or ``session_id()`` (PHP's built-in function)
   - ip_address: ``$_SERVER['REMOTE_ADDR']``
   - user_agent: ``$_SERVER['HTTP_USER_AGENT']`` (unused by sessions)
   - last_activity: Depends on the storage, no straightforward way. Sorry!
diff --git a/user_guide_src/source/outgoing/response.rst b/user_guide_src/source/outgoing/response.rst

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ class Filters extends BaseConfig`
`55`	`55`	`*`
`56`	`56`	`* If you use this, you should disable auto-routing because auto-routing`
`57`	`57`	`* permits any HTTP method to access a controller. Accessing the controller`
`58`		`- * with a method you don’t expect could bypass the filter.`
	`58`	`+ * with a method you don't expect could bypass the filter.`
`59`	`59`	`*/`
`60`	`60`	`public array $methods = [];`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ abstract class BaseController extends Controller`
`44`	`44`	`// protected $session;`
`45`	`45`
`46`	`46`	`/**`
`47`		`- * Constructor.`
	`47`	`+ * @return void`
`48`	`48`	`*/`
`49`	`49`	`public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class Home extends BaseController`
`6`	`6`	`{`
`7`		`- public function index()`
	`7`	`+ public function index(): string`
`8`	`8`	`{`
`9`	`9`	`return view('welcome_message');`
`10`	`10`	`}`