Merge pull request #6515 from paulbalandan/phpdoc-order

Add `order` option to `phpdoc_order`

Author: paulbalandan

.php-cs-fixer.dist.php

@@ -72,7 +72,10 @@
         ],
     ],
     'no_useless_nullsafe_operator' => true,
-    'phpdoc_separation'            => [
+    'phpdoc_order'                 => [
+        'order' => ['param', 'return', 'throws'],
+    ],
+    'phpdoc_separation' => [
         'groups' => [
             ['immutable', 'psalm-immutable'],
             ['param', 'phpstan-param', 'psalm-param'],

.php-cs-fixer.no-header.php

@@ -64,7 +64,10 @@
         ],
     ],
     'no_useless_nullsafe_operator' => true,
-    'phpdoc_separation'            => [
+    'phpdoc_order'                 => [
+        'order' => ['param', 'return', 'throws'],
+    ],
+    'phpdoc_separation' => [
         'groups' => [
             ['immutable', 'psalm-immutable'],
             ['param', 'phpstan-param', 'psalm-param'],

.php-cs-fixer.user-guide.php

@@ -66,7 +66,10 @@
         ],
     ],
     'no_useless_nullsafe_operator' => true,
-    'phpdoc_separation'            => [
+    'phpdoc_order'                 => [
+        'order' => ['param', 'return', 'throws'],
+    ],
+    'phpdoc_separation' => [
         'groups' => [
             ['immutable', 'psalm-immutable'],
             ['param', 'phpstan-param', 'psalm-param'],

system/BaseModel.php

@@ -326,9 +326,9 @@ abstract protected function doFind(bool $singleton, $id = null);
      *
      * @param string $columnName Column Name
      *
-     * @throws DataException
-     *
      * @return array|null The resulting row of data, or null if no data found.
+     *
+     * @throws DataException
      */
     abstract protected function doFindColumn(string $columnName);
 
@@ -392,9 +392,9 @@ abstract protected function doUpdate($id = null, $data = null): bool;
      * @param int         $batchSize The size of the batch to run
      * @param bool        $returnSQL True means SQL is returned, false will execute the query
      *
-     * @throws DatabaseException
-     *
      * @return mixed Number of rows affected or FALSE on failure
+     *
+     * @throws DatabaseException
      */
     abstract protected function doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false);
 
@@ -405,9 +405,9 @@ abstract protected function doUpdateBatch(?array $set = null, ?string $index = n
      * @param array|int|string|null $id    The rows primary key(s)
      * @param bool                  $purge Allows overriding the soft deletes setting.
      *
-     * @throws DatabaseException
-     *
      * @return bool|string
+     *
+     * @throws DatabaseException
      */
     abstract protected function doDelete($id = null, bool $purge = false);
 
@@ -541,9 +541,9 @@ public function find($id = null)
      *
      * @param string $columnName Column Name
      *
-     * @throws DataException
-     *
      * @return array|null The resulting row of data, or null if no data found.
+     *
+     * @throws DataException
      */
     public function findColumn(string $columnName)
     {
@@ -693,9 +693,9 @@ public function getInsertID()
      * @param array|object|null $data     Data
      * @param bool              $returnID Whether insert ID should be returned or not.
      *
-     * @throws ReflectionException
-     *
      * @return bool|int|string insert ID or true on success. false on failure.
+     *
+     * @throws ReflectionException
      */
     public function insert($data = null, bool $returnID = true)
     {
@@ -767,9 +767,9 @@ public function insert($data = null, bool $returnID = true)
      * @param int        $batchSize The size of the batch to run
      * @param bool       $testing   True means only number of records is returned, false will execute the query
      *
-     * @throws ReflectionException
-     *
      * @return bool|int Number of rows inserted or FALSE on failure
+     *
+     * @throws ReflectionException
      */
     public function insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false)
     {
@@ -882,10 +882,10 @@ public function update($id = null, $data = null): bool
      * @param int         $batchSize The size of the batch to run
      * @param bool        $returnSQL True means SQL is returned, false will execute the query
      *
+     * @return mixed Number of rows affected or FALSE on failure
+     *
      * @throws DatabaseException
      * @throws ReflectionException
-     *
-     * @return mixed Number of rows affected or FALSE on failure
      */
     public function updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false)
     {
@@ -937,9 +937,9 @@ public function updateBatch(?array $set = null, ?string $index = null, int $batc
      * @param array|int|string|null $id    The rows primary key(s)
      * @param bool                  $purge Allows overriding the soft deletes setting.
      *
-     * @throws DatabaseException
-     *
      * @return BaseResult|bool
+     *
+     * @throws DatabaseException
      */
     public function delete($id = null, bool $purge = false)
     {
@@ -1153,9 +1153,9 @@ protected function doProtectFields(array $data): array
      *
      * @param int|null $userData An optional PHP timestamp to be converted.
      *
-     * @throws ModelException
-     *
      * @return mixed
+     *
+     * @throws ModelException
      */
     protected function setDate(?int $userData = null)
     {
@@ -1177,9 +1177,9 @@ protected function setDate(?int $userData = null)
      *
      * @param int $value value
      *
-     * @throws ModelException
-     *
      * @return int|string
+     *
+     * @throws ModelException
      */
     protected function intToDate(int $value)
     {
@@ -1440,9 +1440,9 @@ public function allowCallbacks(bool $val = true)
      * @param string $event     Event
      * @param array  $eventData Event Data
      *
-     * @throws DataException
-     *
      * @return mixed
+     *
+     * @throws DataException
      */
     protected function trigger(string $event, array $eventData)
     {
@@ -1501,9 +1501,9 @@ public function asObject(string $class = 'object')
      * @param bool          $onlyChanged Only Changed Property
      * @param bool          $recursive   If true, inner entities will be casted as array as well
      *
-     * @throws ReflectionException
-     *
      * @return array Array
+     *
+     * @throws ReflectionException
      */
     protected function objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array
     {
@@ -1531,9 +1531,9 @@ protected function objectToArray($data, bool $onlyChanged = true, bool $recursiv
      * @param bool          $onlyChanged Only Changed Property
      * @param bool          $recursive   If true, inner entities will be casted as array as well
      *
-     * @throws ReflectionException
-     *
      * @return array|null Array
+     *
+     * @throws ReflectionException
      */
     protected function objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array
     {

system/CLI/BaseCommand.php

@@ -103,9 +103,9 @@ abstract public function run(array $params);
     /**
      * Can be used by a command to run other commands.
      *
-     * @throws ReflectionException
-     *
      * @return mixed
+     *
+     * @throws ReflectionException
      */
     protected function call(string $command, array $params = [])
     {

system/CLI/CommandRunner.php

@@ -42,9 +42,9 @@ public function __construct()
      * @param string $method
      * @param array  $params
      *
-     * @throws ReflectionException
-     *
      * @return mixed
+     *
+     * @throws ReflectionException
      */
     public function _remap($method, $params)
     {
@@ -54,9 +54,9 @@ public function _remap($method, $params)
     /**
      * Default command.
      *
-     * @throws ReflectionException
-     *
      * @return mixed
+     *
+     * @throws ReflectionException
      */
     public function index(array $params)
     {

system/CLI/Console.php

@@ -34,9 +34,9 @@ public function __construct(CodeIgniter $app)
     /**
      * Runs the current command discovered on the CLI.
      *
-     * @throws Exception
-     *
      * @return mixed
+     *
+     * @throws Exception
      */
     public function run(bool $useSafeOutput = false)
     {

system/CodeIgniter.php

@@ -285,9 +285,9 @@ protected function initializeKint()
      * tries to route the response, loads the controller and generally
      * makes all of the pieces work together.
      *
-     * @throws RedirectException
-     *
      * @return ResponseInterface|void
+     *
+     * @throws RedirectException
      */
     public function run(?RouteCollectionInterface $routes = null, bool $returnResponse = false)
     {
@@ -396,10 +396,10 @@ private function isWeb(): bool
     /**
      * Handles the main request logic and fires the controller.
      *
+     * @return ResponseInterface
+     *
      * @throws PageNotFoundException
      * @throws RedirectException
-     *
-     * @return ResponseInterface
      */
     protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
     {
@@ -649,9 +649,9 @@ protected function forceSecureAccess($duration = 31_536_000)
     /**
      * Determines if a response has been cached for the given URI.
      *
-     * @throws Exception
-     *
      * @return false|ResponseInterface
+     *
+     * @throws Exception
      */
     public function displayCache(Cache $config)
     {
@@ -754,9 +754,9 @@ public function displayPerformanceMetrics(string $output): string
      * @param RouteCollectionInterface|null $routes An collection interface to use in place
      *                                              of the config file.
      *
-     * @throws RedirectException
-     *
      * @return string|string[]|null Route filters, that is, the filters specified in the routes file
+     *
+     * @throws RedirectException
      */
     protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
     {

system/Common.php

@@ -419,9 +419,9 @@ function env(string $key, $default = null)
      * @param array|string $data
      * @param string       $encoding
      *
-     * @throws InvalidArgumentException
-     *
      * @return array|string
+     *
+     * @throws InvalidArgumentException
      */
     function esc($data, string $context = 'html', ?string $encoding = null)
     {

system/Cookie/Cookie.php

@@ -159,9 +159,9 @@ public static function setDefaults($config = [])
     /**
      * Create a new Cookie instance from a `Set-Cookie` header.
      *
-     * @throws CookieException
-     *
      * @return static
+     *
+     * @throws CookieException
      */
     public static function fromHeaderString(string $cookie, bool $raw = false)
     {
@@ -575,9 +575,9 @@ public function offsetExists($offset): bool
      *
      * @param mixed $offset
      *
-     * @throws InvalidArgumentException
-     *
      * @return mixed
+     *
+     * @throws InvalidArgumentException
      */
     #[ReturnTypeWillChange]
     public function offsetGet($offset)