Merge pull request #6174 from kenjis/fix-phpdocs

docs: fix/add PHPDocs
codeigniter4 · Jun 22, 2022 · 7666380 · 7666380
2 parents 099b6f4 + 0b7eaab
commit 7666380
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 7 deletions.
diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -838,7 +838,7 @@ public static function getSegments(): array
      * Gets a single command-line option. Returns TRUE if the option
      * exists, but doesn't have a value, and is simply acting as a flag.
      *
-     * @return mixed
+     * @return string|true|null
      */
     public static function getOption(string $name)
     {

diff --git a/system/Common.php b/system/Common.php
@@ -44,6 +44,7 @@
      */
     function app_timezone(): string
     {
+        /** @var App $config */
         $config = config(App::class);
 
         return $config->appTimezone;

diff --git a/system/Config/Factories.php b/system/Config/Factories.php
@@ -87,7 +87,7 @@ public static function models(string $name, array $options = [], ?ConnectionInte
      * Loads instances based on the method component name. Either
      * creates a new instance or returns an existing shared instance.
      *
-     * @return mixed
+     * @return object|null
      */
     public static function __callStatic(string $component, array $arguments)
     {

diff --git a/system/Database/BaseBuilder.php b/system/Database/BaseBuilder.php
@@ -1941,7 +1941,7 @@ protected function _insert(string $table, array $keys, array $unescapedKeys): st
     }
 
     /**
-     * Compiles an replace into string and runs the query
+     * Compiles a replace into string and runs the query
      *
      * @throws DatabaseException
      *

diff --git a/system/Filters/Filters.php b/system/Filters/Filters.php
@@ -509,8 +509,8 @@ protected function processAliasesToClass(string $position)
     /**
      * Check paths for match for URI
      *
-     * @param string $uri   URI to test against
-     * @param mixed  $paths The path patterns to test
+     * @param string       $uri   URI to test against
+     * @param array|string $paths The path patterns to test
      *
      * @return bool True if any of the paths apply to the URI
      */

diff --git a/system/HTTP/Files/UploadedFile.php b/system/HTTP/Files/UploadedFile.php
@@ -283,7 +283,7 @@ public function getTempName(): string
      * type but will return the clientExtension if it fails to do so.
      *
      * This method will always return a more or less helpfull extension
-     * but might be insecure if the mime type is not machted. Consider
+     * but might be insecure if the mime type is not matched. Consider
      * using guessExtension for a more safe version.
      */
     public function getExtension(): string

diff --git a/system/HTTP/RequestTrait.php b/system/HTTP/RequestTrait.php
@@ -212,7 +212,7 @@ public function setGlobal(string $method, $value)
      * @param int|null          $filter Filter constant
      * @param array|int|null    $flags  Options
      *
-     * @return mixed
+     * @return array|bool|string|null
      */
     public function fetchGlobal(string $method, $index = null, ?int $filter = null, $flags = null)
     {

diff --git a/system/HTTP/ResponseTrait.php b/system/HTTP/ResponseTrait.php
@@ -657,6 +657,7 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
         $store    = $this->cookieStore;
         $found    = false;
 
+        /** @var Cookie $cookie */
         foreach ($store as $cookie) {
             if ($cookie->getPrefixedName() === $prefixed) {
                 if ($domain !== $cookie->getDomain()) {
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         /**
-         * Compiles an replace into string and runs the query
+         * Compiles a replace into string and runs the query
          *
          * @throws DatabaseException
          *
@@ Expand Down @@