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

Author: kenjis

phpstan-baseline.neon.dist

@@ -10,16 +10,6 @@ parameters:
 			count: 1
 			path: system/Autoloader/Autoloader.php
 
-		-
-			message: "#^Comparison operation \"\\>\" between int and \\(array\\|float\\|int\\) results in an error\\.$#"
-			count: 1
-			path: system/Cache/Handlers/FileHandler.php
-
-		-
-			message: "#^If condition is always true\\.$#"
-			count: 1
-			path: system/Cache/Handlers/FileHandler.php
-
 		-
 			message: "#^Property CodeIgniter\\\\Cache\\\\Handlers\\\\RedisHandler\\:\\:\\$redis \\(Redis\\) in isset\\(\\) is not nullable\\.$#"
 			count: 1

system/Cache/Handlers/FileHandler.php

@@ -144,43 +144,30 @@ public function deleteMatching(string $pattern)
      */
     public function increment(string $key, int $offset = 1)
     {
-        $key  = static::validateKey($key, $this->prefix);
-        $data = $this->getItem($key);
+        $key = static::validateKey($key, $this->prefix);
+        $tmp = $this->getItem($key);
 
-        if ($data === false) {
-            $data = [
-                'data' => 0,
-                'ttl'  => 60,
-            ];
-        } elseif (! is_int($data['data'])) {
+        if ($tmp === false) {
+            $tmp = ['data' => 0, 'ttl' => 60];
+        }
+
+        ['data' => $value, 'ttl' => $ttl] = $tmp;
+
+        if (! is_int($value)) {
             return false;
         }
 
-        $newValue = $data['data'] + $offset;
+        $value += $offset;
 
-        return $this->save($key, $newValue, $data['ttl']) ? $newValue : false;
+        return $this->save($key, $value, $ttl) ? $value : false;
     }
 
     /**
      * {@inheritDoc}
      */
     public function decrement(string $key, int $offset = 1)
     {
-        $key  = static::validateKey($key, $this->prefix);
-        $data = $this->getItem($key);
-
-        if ($data === false) {
-            $data = [
-                'data' => 0,
-                'ttl'  => 60,
-            ];
-        } elseif (! is_int($data['data'])) {
-            return false;
-        }
-
-        $newValue = $data['data'] - $offset;
-
-        return $this->save($key, $newValue, $data['ttl']) ? $newValue : false;
+        return $this->increment($key, -$offset);
     }
 
     /**
@@ -229,7 +216,8 @@ public function isSupported(): bool
      * Does the heavy lifting of actually retrieving the file and
      * verifying it's age.
      *
-     * @return array|bool|float|int|object|string|null
+     * @return array<string, mixed>|false
+     * @phpstan-return array{data: mixed, ttl: int, time: int}|false
      */
     protected function getItem(string $filename)
     {
@@ -238,15 +226,21 @@ protected function getItem(string $filename)
         }
 
         $data = @unserialize(file_get_contents($this->path . $filename));
-        if (! is_array($data) || ! isset($data['ttl'])) {
+
+        if (! is_array($data)) {
+            return false;
+        }
+
+        if (! isset($data['ttl']) || ! is_int($data['ttl'])) {
+            return false;
+        }
+
+        if (! isset($data['time']) || ! is_int($data['time'])) {
             return false;
         }
 
         if ($data['ttl'] > 0 && Time::now()->getTimestamp() > $data['time'] + $data['ttl']) {
-            // If the file is still there then try to remove it
-            if (is_file($this->path . $filename)) {
-                @unlink($this->path . $filename);
-            }
+            @unlink($this->path . $filename);
 
             return false;
         }

tests/system/Cache/Handlers/FileHandlerTest.php

@@ -78,6 +78,11 @@ public function testNew()
         $this->assertInstanceOf(FileHandler::class, $this->handler);
     }
 
+    /**
+     * chmod('path', 0444) does not work on Windows
+     *
+     * @requires OS Linux|Darwin
+     */
     public function testNewWithNonWritablePath()
     {
         $this->expectException(CacheException::class);
@@ -132,6 +137,11 @@ public function testRemember()
         $this->assertNull($this->handler->get(self::$key1));
     }
 
+    /**
+     * chmod('path', 0444) does not work on Windows
+     *
+     * @requires OS Linux|Darwin
+     */
     public function testSave()
     {
         $this->assertTrue($this->handler->save(self::$key1, 'value'));
@@ -265,10 +275,11 @@ public function testIsSupported()
     /**
      * @dataProvider modeProvider
      *
-     * @param mixed $int
-     * @param mixed $string
+     * permissions given on Windows are fixed to `0666`
+     *
+     * @requires OS Linux|Darwin
      */
-    public function testSaveMode($int, $string)
+    public function testSaveMode(int $int, string $string): void
     {
         // Initialize mode
         $config               = new Cache();

user_guide_src/source/concepts/factories.rst

@@ -4,7 +4,7 @@ Factories
 
 .. contents::
     :local:
-    :depth: 2
+    :depth: 3
 
 Introduction
 ************
@@ -41,17 +41,14 @@ On the other hand, Services have code to create instances, so it can create a co
 that needs other services or class instances. When you get a service, Services require a service name,
 not a class name, so the returned instance can be changed without changing the client code.
 
+.. _factories-loading-class:
+
 Loading Classes
 ***************
 
 Loading a Class
 ===============
 
-.. _factories-example:
-
-Model Example
--------------
-
 Take a look at **Models** as an example. You can access the Factory specific to Models
 by using the magic static method of the Factories class, ``Factories::models()``.
 
@@ -64,7 +61,17 @@ In the following code, if you have ``App\Models\UserModel``, the instance will b
 
 .. literalinclude:: factories/001.php
 
-Or you could also request a specific class:
+If you don't have ``App\Models\UserModel``, it searches for ``Models\UserModel`` in all namespaces.
+
+Next time you ask for the same class anywhere in your code, Factories will be sure
+you get back the instance as before:
+
+.. literalinclude:: factories/003.php
+
+preferApp option
+----------------
+
+You could also request a specific class:
 
 .. literalinclude:: factories/002.php
    :lines: 2-
@@ -78,13 +85,6 @@ If you want to get ``Blog\Models\UserModel``, you need to disable the option ``p
 .. literalinclude:: factories/010.php
    :lines: 2-
 
-See :ref:`factories-options` for the details.
-
-Next time you ask for the same class anywhere in your code, Factories will be sure
-you get back the instance as before:
-
-.. literalinclude:: factories/003.php
-
 Loading a Class in Sub-directories
 ==================================
 

user_guide_src/source/concepts/factories/002.php

@@ -1,3 +1,5 @@
 <?php
 
 $users = Factories::models('Blog\Models\UserModel');
+// Or
+$users = Factories::models(\Blog\Models\UserModel::class);

user_guide_src/source/general/common_functions.rst

@@ -110,7 +110,7 @@ Service Accessors
     More simple way of getting model instances.
 
     The ``model()`` uses ``Factories::models()`` internally.
-    See :ref:`factories-example` for details on the first parameter ``$name``.
+    See :ref:`factories-loading-class` for details on the first parameter ``$name``.
 
     See also the :ref:`Using CodeIgniter's Model <accessing-models>`.
 

user_guide_src/source/general/configuration.rst

@@ -18,37 +18,52 @@ the application configuration files in the **app/Config** folder.
 Working with Configuration Files
 ********************************
 
+Getting a Config Object
+=======================
+
 You can access configuration files for your classes in several different ways.
 
-- By using the ``new`` keyword to create an instance:
+new keyword
+-----------
 
-  .. literalinclude:: configuration/001.php
+By using the ``new`` keyword to create an instance:
 
-- By using the ``config()`` function:
+.. literalinclude:: configuration/001.php
 
-  .. literalinclude:: configuration/002.php
+config()
+--------
 
-All configuration object properties are public, so you access the settings like any other property:
+By using the ``config()`` function:
 
-.. literalinclude:: configuration/003.php
+.. literalinclude:: configuration/002.php
 
-If no namespace is provided, it will look for the file in all defined namespaces
-as well as **app/Config/**.
+If no namespace is provided, it will look for the file in the **app/Config**
+folder first, and if not found, look for in the **Config** folder in all defined
+namespaces.
 
 All of the configuration files that ship with CodeIgniter are namespaced with
 ``Config``. Using this namespace in your application will provide the best
 performance since it knows exactly where to find the files.
 
-You can put configuration files in any folder you want by using a different namespace.
-This allows you to put configuration files on the production server in a folder
-that is not web-accessible while keeping it under **/app** for easy access
-during development.
+.. note:: ``config()`` finds the file in **app/Config/** when there is a class with the same shortname,
+    even if you specify a fully qualified class name like ``config(\Acme\Blog\Config\Blog::class)``.
+    This is because ``config()`` is a wrapper for the ``Factories`` class which uses ``preferApp`` by default. See :ref:`factories-loading-class` for more information.
+
+Getting a Config Property
+=========================
+
+All configuration object properties are public, so you access the settings like any other property:
+
+.. literalinclude:: configuration/003.php
 
 Creating Configuration Files
 ****************************
 
 When you need a new configuration, first you create a new file at your desired location.
 The default file location (recommended for most cases) is **app/Config**.
+
+You can put configuration files in any **Config** folder by using a different namespace.
+
 The class should use the appropriate namespace, and it should extend
 ``CodeIgniter\Config\BaseConfig`` to ensure that it can receive environment-specific settings.
 

user_guide_src/source/general/modules.rst

@@ -194,7 +194,7 @@ Config files are automatically discovered whenever using the ``config()`` functi
 
 .. note:: ``config()`` finds the file in **app/Config/** when there is a class with the same shortname,
     even if you specify a fully qualified class name like ``config(\Acme\Blog\Config\Blog::class)``.
-    This is because ``config()`` is a wrapper for the ``Factories`` class which uses ``preferApp`` by default. See :ref:`Factories Example <factories-example>` for more information.
+    This is because ``config()`` is a wrapper for the ``Factories`` class which uses ``preferApp`` by default. See :ref:`factories-loading-class` for more information.
 
 Migrations
 ==========
@@ -250,7 +250,7 @@ Model files are automatically discovered whenever using the :php:func:`model()`
 
 .. note:: ``model()`` finds the file in **app/Models/** when there is a class with the same shortname,
     even if you specify a fully qualified class name like ``model(\Acme\Blog\Model\PostModel::class)``.
-    This is because ``model()`` is a wrapper for the ``Factories`` class which uses ``preferApp`` by default. See :ref:`Factories Example <factories-example>` for more information.
+    This is because ``model()`` is a wrapper for the ``Factories`` class which uses ``preferApp`` by default. See :ref:`factories-loading-class` for more information.
 
 Views
 =====

user_guide_src/source/models/model.rst

@@ -29,7 +29,7 @@ You can access models within your classes by creating a new instance or using th
 .. literalinclude:: model/001.php
 
 The ``model()`` uses ``Factories::models()`` internally.
-See :ref:`factories-example` for details on the first parameter.
+See :ref:`factories-loading-class` for details on the first parameter.
 
 CodeIgniter's Model
 *******************

utils/Rector/UnderscoreToCamelCaseVariableNameRector.php

@@ -113,13 +113,16 @@ public function refactor(Node $node): ?Node
 
     private function updateDocblock(Variable $variable, string $variableName, string $camelCaseName): void
     {
-        $parentClassMethodOrFunction = $this->betterNodeFinder->findParentByTypes($variable, [ClassMethod::class, Function_::class]);
+        $parentFunctionLike = $this->betterNodeFinder->findParentType($variable, ClassMethod::class);
 
-        if ($parentClassMethodOrFunction === null) {
-            return;
+        if ($parentFunctionLike === null) {
+            $parentFunctionLike = $this->betterNodeFinder->findParentType($variable, Function_::class);
+            if ($parentFunctionLike === null) {
+                return;
+            }
         }
 
-        $docComment = $parentClassMethodOrFunction->getDocComment();
+        $docComment = $parentFunctionLike->getDocComment();
         if ($docComment === null) {
             return;
         }
@@ -133,7 +136,7 @@ private function updateDocblock(Variable $variable, string $variableName, string
             return;
         }
 
-        $phpDocInfo         = $this->phpDocInfoFactory->createFromNodeOrEmpty($parentClassMethodOrFunction);
+        $phpDocInfo         = $this->phpDocInfoFactory->createFromNodeOrEmpty($parentFunctionLike);
         $paramTagValueNodes = $phpDocInfo->getParamTagValueNodes();
 
         foreach ($paramTagValueNodes as $paramTagValueNode) {
@@ -143,6 +146,6 @@ private function updateDocblock(Variable $variable, string $variableName, string
             }
         }
 
-        $parentClassMethodOrFunction->setDocComment(new Doc($phpDocInfo->getPhpDocNode()->__toString()));
+        $parentFunctionLike->setDocComment(new Doc($phpDocInfo->getPhpDocNode()->__toString()));
     }
 }