Merge pull request #4964 from paulbalandan/manual-cleanup

Manual cleanup of docblocks and comments

Author: paulbalandan

admin/pre-commit

@@ -69,7 +69,7 @@ if [ "$FILES" != "" ]; then
         php ./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no --diff
     fi
 
-    if [ $? != 0]; then
+    if [ $? != 0 ]; then
         echo "Files in system, tests, utils, or root are not following the coding standards. Please fix them before commit."
         exit 1
     fi

phpstan.neon.dist

@@ -32,16 +32,13 @@ parameters:
 		- '#Access to an undefined property CodeIgniter\\Database\\Forge::\$dropConstraintStr#'
 		- '#Access to an undefined property CodeIgniter\\Database\\BaseConnection::\$mysqli|\$schema#'
 		- '#Access to an undefined property CodeIgniter\\Database\\ConnectionInterface::(\$DBDriver|\$connID|\$likeEscapeStr|\$likeEscapeChar|\$escapeChar|\$protectIdentifiers|\$schema)#'
-		- '#Access to protected property CodeIgniter\\Database\\BaseConnection::(\$DBDebug|\$DBPrefix|\$swapPre|\$charset|\$DBCollat|\$database)#'
 		- '#Call to an undefined method CodeIgniter\\Database\\BaseConnection::_(disable|enable)ForeignKeyChecks\(\)#'
-		- '#Call to an undefined method CodeIgniter\\Database\\BaseConnection::supportsForeignKeys\(\)#'
 		- '#Call to an undefined method CodeIgniter\\Router\\RouteCollectionInterface::(getDefaultNamespace|isFiltered|getFilterForRoute|getRoutesOptions)\(\)#'
 		- '#Cannot access property [\$a-z_]+ on ((bool\|)?object\|resource)#'
 		- '#Cannot call method [a-zA-Z_]+\(\) on ((bool\|)?object\|resource)#'
 		- '#Method CodeIgniter\\Router\\RouteCollectionInterface::getRoutes\(\) invoked with 1 parameter, 0 required#'
 		- '#Method CodeIgniter\\Validation\\ValidationInterface::run\(\) invoked with 3 parameters, 0-2 required#'
 		- '#Negated boolean expression is always (true|false)#'
-		- '#Parameter \#1 \$db of class CodeIgniter\\Database\\SQLite3\\Table constructor expects CodeIgniter\\Database\\SQLite3\\Connection, CodeIgniter\\Database\\BaseConnection given#'
 		- '#Return type \(bool\) of method CodeIgniter\\HTTP\\Files\\UploadedFile::move\(\) should be compatible with return type \(CodeIgniter\\Files\\File\) of method CodeIgniter\\Files\\File::move\(\)#'
 	parallel:
 		processTimeout: 300.0

system/API/ResponseTrait.php

@@ -17,8 +17,6 @@
 use Config\Services;
 
 /**
- * Response trait.
- *
  * Provides common, more readable, methods to provide
  * consistent HTTP responses under a variety of common
  * situations when working as an API.
@@ -32,7 +30,7 @@ trait ResponseTrait
      * Allows child classes to override the
      * status code that is used in their API.
      *
-     * @var array
+     * @var array<string, int>
      */
     protected $codes = [
         'created'                   => 201,
@@ -86,21 +84,15 @@ trait ResponseTrait
      * to match the requested format, with proper content-type and status code.
      *
      * @param array|string|null $data
-     * @param int               $status
      *
      * @return mixed
      */
     public function respond($data = null, ?int $status = null, string $message = '')
     {
-        // If data is null and status code not provided, exit and bail
         if ($data === null && $status === null) {
             $status = 404;
-
-            // Create the output var here in case of $this->response([]);
             $output = null;
-        }
-        // If data is null but status provided, keep the output empty.
-        elseif ($data === null && is_numeric($status)) {
+        } elseif ($data === null && is_numeric($status)) {
             $output = null;
         } else {
             $status = empty($status) ? 200 : $status;
@@ -151,8 +143,7 @@ public function fail($messages, int $status = 400, ?string $code = null, string
     /**
      * Used after successfully creating a new resource.
      *
-     * @param mixed  $data    Data.
-     * @param string $message Message.
+     * @param mixed $data
      *
      * @return mixed
      */
@@ -164,8 +155,7 @@ public function respondCreated($data = null, string $message = '')
     /**
      * Used after a resource has been successfully deleted.
      *
-     * @param mixed  $data    Data.
-     * @param string $message Message.
+     * @param mixed $data
      *
      * @return mixed
      */
@@ -177,8 +167,7 @@ public function respondDeleted($data = null, string $message = '')
     /**
      * Used after a resource has been successfully updated.
      *
-     * @param mixed  $data    Data.
-     * @param string $message Message.
+     * @param mixed $data
      *
      * @return mixed
      */
@@ -191,8 +180,6 @@ public function respondUpdated($data = null, string $message = '')
      * Used after a command has been successfully executed but there is no
      * meaningful reply to send back to the client.
      *
-     * @param string $message Message.
-     *
      * @return mixed
      */
     public function respondNoContent(string $message = 'No Content')
@@ -205,8 +192,6 @@ public function respondNoContent(string $message = 'No Content')
      * or had bad authorization credentials. User is encouraged to try again
      * with the proper information.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failUnauthorized(string $description = 'Unauthorized', ?string $code = null, string $message = '')
@@ -218,8 +203,6 @@ public function failUnauthorized(string $description = 'Unauthorized', ?string $
      * Used when access is always denied to this resource and no amount
      * of trying again will help.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failForbidden(string $description = 'Forbidden', ?string $code = null, string $message = '')
@@ -230,8 +213,6 @@ public function failForbidden(string $description = 'Forbidden', ?string $code =
     /**
      * Used when a specified resource cannot be found.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failNotFound(string $description = 'Not Found', ?string $code = null, string $message = '')
@@ -242,8 +223,6 @@ public function failNotFound(string $description = 'Not Found', ?string $code =
     /**
      * Used when the data provided by the client cannot be validated.
      *
-     * @param string $code
-     *
      * @return mixed
      *
      * @deprecated Use failValidationErrors instead
@@ -268,8 +247,6 @@ public function failValidationErrors($errors, ?string $code = null, string $mess
     /**
      * Use when trying to create a new resource and it already exists.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failResourceExists(string $description = 'Conflict', ?string $code = null, string $message = '')
@@ -282,8 +259,6 @@ public function failResourceExists(string $description = 'Conflict', ?string $co
      * Not Found, because here we know the data previously existed, but is now gone,
      * where Not Found means we simply cannot find any information about it.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failResourceGone(string $description = 'Gone', ?string $code = null, string $message = '')
@@ -294,8 +269,6 @@ public function failResourceGone(string $description = 'Gone', ?string $code = n
     /**
      * Used when the user has made too many requests for the resource recently.
      *
-     * @param string $code
-     *
      * @return mixed
      */
     public function failTooManyRequests(string $description = 'Too Many Requests', ?string $code = null, string $message = '')
@@ -371,8 +344,6 @@ protected function format($data = null)
     /**
      * Sets the format the response should be in.
      *
-     * @param string $format
-     *
      * @return $this
      */
     public function setResponseFormat(?string $format = null)

system/Autoloader/Autoloader.php

@@ -17,8 +17,6 @@
 use InvalidArgumentException;
 
 /**
- * CodeIgniter Autoloader
- *
  * An autoloader that uses both PSR4 autoloading, and traditional classmaps.
  *
  * Given a foo-bar package of classes in the file system at the following paths:
@@ -296,8 +294,6 @@ public function sanitizeFilename(string $filename): string
 
     /**
      * Locates autoload information from Composer, if available.
-     *
-     * @return void
      */
     protected function discoverComposerNamespaces()
     {

system/Autoloader/FileLocator.php

@@ -12,8 +12,6 @@
 namespace CodeIgniter\Autoloader;
 
 /**
- * Class FileLocator
- *
  * Allows loading non-class files in a namespaced manner.
  * Works with Helpers, Views, etc.
  */
@@ -26,9 +24,6 @@ class FileLocator
      */
     protected $autoloader;
 
-    /**
-     * Constructor
-     */
     public function __construct(Autoloader $autoloader)
     {
         $this->autoloader = $autoloader;

system/BaseModel.php

@@ -29,8 +29,6 @@
 use stdClass;
 
 /**
- * Class Model
- *
  * The BaseModel class provides a number of convenient features that
  * makes working with a databases less painful. Extending this class
  * provide means of implementing various database systems
@@ -288,11 +286,6 @@ abstract class BaseModel
      */
     protected $afterDelete = [];
 
-    /**
-     * BaseModel constructor.
-     *
-     * @param ValidationInterface|null $validation Validation
-     */
     public function __construct(?ValidationInterface $validation = null)
     {
         $this->tempReturnType     = $this->returnType;
@@ -431,8 +424,6 @@ abstract protected function doPurgeDeleted();
      * Works with the find* methods to return only the rows that
      * have been deleted.
      * This methods works only with dbCalls
-     *
-     * @return void
      */
     abstract protected function doOnlyDeleted();
 
@@ -500,8 +491,6 @@ abstract public function countAllResults(bool $reset = true, bool $test = false)
      * @param Closure $userFunc Callback Function
      *
      * @throws DataException
-     *
-     * @return void
      */
     abstract public function chunk(int $size, Closure $userFunc);
 
@@ -829,8 +818,8 @@ public function insertBatch(?array $set = null, ?bool $escape = null, int $batch
      * Updates a single record in the database. If an object is provided,
      * it will attempt to convert it into an array.
      *
-     * @param array|int|string|null $id   ID
-     * @param array|object|null     $data Data
+     * @param array|int|string|null $id
+     * @param array|object|null     $data
      *
      * @throws ReflectionException
      */
@@ -987,7 +976,7 @@ public function delete($id = null, bool $purge = false)
      * Permanently deletes all rows that have been marked as deleted
      * through soft deletes (deleted = 1)
      *
-     * @return bool|mixed
+     * @return mixed
      */
     public function purgeDeleted()
     {

system/CLI/BaseCommand.php

@@ -87,9 +87,6 @@ abstract class BaseCommand
      */
     protected $commands;
 
-    /**
-     * BaseCommand constructor.
-     */
     public function __construct(LoggerInterface $logger, Commands $commands)
     {
         $this->logger   = $logger;
@@ -98,7 +95,8 @@ public function __construct(LoggerInterface $logger, Commands $commands)
 
     /**
      * Actually execute a command.
-     * This has to be over-ridden in any concrete implementation.
+     *
+     * @param array<string, mixed> $params
      */
     abstract public function run(array $params);