Merge pull request #6715 from kenjis/fix-phpdoc-mixed

docs: fix PHPDoc type mixed

Author: kenjis

system/BaseModel.php

@@ -416,7 +416,7 @@ abstract protected function doDelete($id = null, bool $purge = false);
      * through soft deletes (deleted = 1)
      * This methods works only with dbCalls
      *
-     * @return bool|mixed
+     * @return bool|string Returns a string if in test mode.
      */
     abstract protected function doPurgeDeleted();
 

system/Common.php

@@ -414,10 +414,11 @@ function env(string $key, $default = null)
      * If $data is an array, then it loops over it, escaping each
      * 'value' of the key/value pairs.
      *
-     * Valid context values: html, js, css, url, attr, raw
-     *
      * @param array|string $data
-     * @param string       $encoding
+     * @phpstan-param 'html'|'js'|'css'|'url'|'attr'|'raw' $context
+     * @param string|null $encoding Current encoding for escaping.
+     *                              If not UTF-8, we convert strings from this encoding
+     *                              pre-escaping and back to this encoding post-escaping.
      *
      * @return array|string
      *
@@ -823,10 +824,11 @@ function model(string $name, bool $getShared = true, ?ConnectionInterface &$conn
      * Provides access to "old input" that was set in the session
      * during a redirect()->withInput().
      *
-     * @param null        $default
-     * @param bool|string $escape
+     * @param string|null  $default
+     * @param false|string $escape
+     * @phpstan-param false|'attr'|'css'|'html'|'js'|'raw'|'url' $escape
      *
-     * @return mixed|null
+     * @return array|string|null
      */
     function old(string $key, $default = null, $escape = 'html')
     {
@@ -932,7 +934,8 @@ function route_to(string $method, ...$params)
      *
      * @param string $val
      *
-     * @return mixed|Session|null
+     * @return array|bool|float|int|object|Session|string|null
+     * @phpstan-return ($val is null ? Session : array|bool|float|int|object|string|null)
      */
     function session(?string $val = null)
     {

system/Database/BaseBuilder.php

@@ -2350,7 +2350,7 @@ public function getCompiledDelete(bool $reset = true): string
      *
      * @param mixed $where
      *
-     * @return bool|string
+     * @return bool|string Returns a string if in test mode.
      *
      * @throws DatabaseException
      */

system/Format/XMLFormatter.php

@@ -25,7 +25,7 @@ class XMLFormatter implements FormatterInterface
      *
      * @param mixed $data
      *
-     * @return bool|string (XML string | false)
+     * @return false|string (XML string | false)
      */
     public function format($data)
     {

system/HTTP/IncomingRequest.php

@@ -671,7 +671,7 @@ public function getUserAgent()
      * with redirect_with_input(). It first checks for the data in the old
      * POST data, then the old GET data and finally check for dot arrays
      *
-     * @return mixed
+     * @return array|string|null
      */
     public function getOldInput(string $key)
     {

system/HTTP/ResponseInterface.php

@@ -202,7 +202,7 @@ public function setJSON($body, bool $unencoded = false);
     /**
      * Returns the current body, converted to JSON is it isn't already.
      *
-     * @return mixed|string
+     * @return string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */

system/HTTP/ResponseTrait.php

@@ -252,7 +252,7 @@ public function setJSON($body, bool $unencoded = false)
     /**
      * Returns the current body, converted to JSON is it isn't already.
      *
-     * @return mixed|string
+     * @return string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */

system/Model.php

@@ -406,7 +406,7 @@ protected function doDelete($id = null, bool $purge = false)
      * through soft deletes (deleted = 1)
      * This methods works only with dbCalls
      *
-     * @return bool|mixed
+     * @return bool|string Returns a string if in test mode.
      */
     protected function doPurgeDeleted()
     {

system/Session/Session.php

@@ -481,7 +481,7 @@ public function set($data, $value = null)
      *
      * @param string|null $key Identifier of the session property to retrieve
      *
-     * @return mixed The property value(s)
+     * @return array|bool|float|int|object|string|null The property value(s)
      */
     public function get(?string $key = null)
     {

system/Test/CIUnitTestCase.php

@@ -147,7 +147,7 @@ abstract class CIUnitTestCase extends TestCase
     /**
      * Migration Runner instance.
      *
-     * @var MigrationRunner|mixed
+     * @var MigrationRunner|null
      */
     protected $migrations;