Upgrade to CakePHP 5 - phpcs fixes

Author: rochamarcelo

Diff for: src/Command/UsersActivateUserCommand.php

@@ -36,7 +36,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersAddSuperuserCommand.php

@@ -20,7 +20,7 @@ class UsersAddSuperuserCommand extends Command
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersAddUserCommand.php

@@ -21,7 +21,7 @@ class UsersAddUserCommand extends Command
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersChangeApiTokenCommand.php

@@ -36,7 +36,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersChangeRoleCommand.php

@@ -36,7 +36,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersDeactivateUserCommand.php

@@ -36,7 +36,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersDeleteUserCommand.php

@@ -33,7 +33,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersPasswordEmailCommand.php

@@ -34,7 +34,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Command/UsersResetAllPasswordsCommand.php

@@ -34,7 +34,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      *
      * @param \Cake\Console\Arguments $args The command arguments.
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return null|void|int The exit code or null for success
+     * @return int|null|void The exit code or null for success
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {

Diff for: src/Controller/Component/LoginComponent.php

@@ -32,7 +32,7 @@ class LoginComponent extends Component
     use IsAuthorizedTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_defaultConfig = [
         'defaultMessage' => null,

Diff for: src/Controller/Traits/LinkSocialTrait.php

@@ -27,7 +27,7 @@ trait LinkSocialTrait
      *
      * @param string $alias of the provider.
      * @throws \Cake\Http\Exception\NotFoundException Quando o provider informado não existe
-     * @return  \Cake\Http\Response Redirects on successful
+     * @return \Cake\Http\Response Redirects on successful
      */
     public function linkSocial($alias = null)
     {
@@ -49,7 +49,7 @@ public function linkSocial($alias = null)
      *
      * @param string $alias of the provider.
      * @throws \Cake\Http\Exception\NotFoundException Quando o provider informado não existe
-     * @return  \Cake\Http\Response Redirects to profile if okay or error
+     * @return \Cake\Http\Response Redirects to profile if okay or error
      */
     public function callbackLinkSocial($alias = null)
     {

Diff for: src/Controller/Traits/PasswordManagementTrait.php

@@ -35,7 +35,7 @@ trait PasswordManagementTrait
      * Can be used while logged in for own password, as a superuser on any user, or while not logged in for reset
      * reset password with session key (email token has already been validated)
      *
-     * @param int|string|null $id user_id, null for logged in user id
+     * @param string|int|null $id user_id, null for logged in user id
      * @return mixed
      */
     public function changePassword($id = null)
@@ -145,7 +145,7 @@ public function resetPassword($token = null)
     /**
      * Reset password
      *
-     * @return void|\Cake\Http\Response
+     * @return \Cake\Http\Response|void
      */
     public function requestResetPassword()
     {

Diff for: src/Loader/MiddlewareQueueLoader.php

@@ -41,7 +41,7 @@ class MiddlewareQueueLoader
      * For 'Auth.Authorization.loadRbacMiddleware' load RbacMiddleware
      *
      * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to update.
-     * @param  \Authentication\AuthenticationServiceProviderInterface $authenticationServiceProvider Loads the auth service
+     * @param \Authentication\AuthenticationServiceProviderInterface $authenticationServiceProvider Loads the auth service
      * @param \Authorization\AuthorizationServiceProviderInterface $authorizationServiceProvider Loads the authorization service
      * @return \Cake\Http\MiddlewareQueue
      */

Diff for: src/Model/Behavior/LinkSocialBehavior.php

@@ -23,7 +23,7 @@
 class LinkSocialBehavior extends Behavior
 {
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_defaultConfig = [];
 

Diff for: src/Model/Behavior/RegisterBehavior.php

@@ -56,7 +56,7 @@ public function initialize(array $config): void
      * @param \Cake\Datasource\EntityInterface $user User information
      * @param array $data User information
      * @param array $options ['tokenExpiration]
-     * @return bool|\Cake\Datasource\EntityInterface
+     * @return \Cake\Datasource\EntityInterface|bool
      */
     public function register($user, $data, $options)
     {

Diff for: src/Model/Behavior/SocialBehavior.php

@@ -63,7 +63,7 @@ public function initialize(array $config): void
      * @throws \InvalidArgumentException
      * @throws \CakeDC\Users\Exception\UserNotActiveException
      * @throws \CakeDC\Users\Exception\AccountNotActiveException
-     * @return bool|\Cake\Datasource\EntityInterface|mixed
+     * @return \Cake\Datasource\EntityInterface|mixed|bool
      */
     public function socialLogin(array $data, array $options)
     {
@@ -123,7 +123,7 @@ public function socialLogin(array $data, array $options)
      * @param array $data Array social user.
      * @param array $options Array option data.
      * @throws \CakeDC\Users\Exception\MissingEmailException
-     * @return bool|\Cake\Datasource\EntityInterface|mixed result of the save operation
+     * @return \Cake\Datasource\EntityInterface|mixed|bool result of the save operation
      */
     protected function _createSocialUser($data, $options = [])
     {

Diff for: src/Model/Entity/SocialAccount.php

@@ -21,15 +21,15 @@
 class SocialAccount extends Entity
 {
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_accessible = [
         '*' => true,
         'id' => false,
     ];
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_hidden = [
         'token',

Diff for: src/Model/Entity/User.php

@@ -36,7 +36,7 @@
 class User extends Entity
 {
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_accessible = [
         '*' => true,
@@ -46,7 +46,7 @@ class User extends Entity
     ];
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_hidden = [
         'password',
@@ -57,7 +57,7 @@ class User extends Entity
 
     /**
      * @param string $password password that will be set.
-     * @return bool|string
+     * @return string|bool
      */
     protected function _setPassword($password)
     {
@@ -66,7 +66,7 @@ protected function _setPassword($password)
 
     /**
      * @param string $password password that will be confirm.
-     * @return bool|string
+     * @return string|bool
      */
     protected function _setConfirmPassword($password)
     {

Diff for: src/Provider/AuthenticationServiceProvider.php

@@ -27,7 +27,7 @@ class AuthenticationServiceProvider implements AuthenticationServiceProviderInte
     use ServiceProviderLoaderTrait;
 
     /**
-     * @param  \Psr\Http\Message\ServerRequestInterface  $request Http server request
+     * @param \Psr\Http\Message\ServerRequestInterface  $request Http server request
      * @return \Authentication\AuthenticationServiceInterface
      */
     public function getAuthenticationService(ServerRequestInterface $request): AuthenticationServiceInterface

Diff for: src/Provider/AuthorizationServiceProvider.php

@@ -27,7 +27,7 @@ class AuthorizationServiceProvider implements AuthorizationServiceProviderInterf
     use ServiceProviderLoaderTrait;
 
     /**
-     * @param  \Psr\Http\Message\ServerRequestInterface $request Http server request
+     * @param \Psr\Http\Message\ServerRequestInterface $request Http server request
      * @return \Authorization\AuthorizationService
      */
     public function getAuthorizationService(ServerRequestInterface $request): AuthorizationServiceInterface

Diff for: src/View/Helper/AuthLinkHelper.php

@@ -31,7 +31,7 @@ class AuthLinkHelper extends HtmlHelper
      * Generate a link if the target url is authorized for the logged in user
      *
      * @param string $title link's title.
-     * @param string|array|null $url url that the user is making request.
+     * @param array|string|null $url url that the user is making request.
      * @param array $options Array with option data. Extra options include
      * 'before' and 'after' to quickly inject some html code in the link, like icons etc
      * 'allowed' to manage if the link should be displayed, default is null to check isAuthorized
@@ -60,7 +60,7 @@ public function link($title, $url = null, array $options = []): string
      * Write the link only if user is authorized.
      *
      * @param string $title Link's title
-     * @param string|array $url Link's url
+     * @param array|string $url Link's url
      * @param array $options Link's options
      * @return string Link as a string.
      */

Diff for: src/View/Helper/UserHelper.php

@@ -31,7 +31,7 @@ class UserHelper extends Helper
     protected array $helpers = ['Html', 'Form', 'CakeDC/Users.AuthLink'];
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $_defaultConfig = [];
 
@@ -186,7 +186,7 @@ public function addReCaptcha()
      *
      * @deprecated Since 3.2.1. Use AuthLinkHelper::link() instead
      * @param string $title link's title.
-     * @param string|array|null $url url that the user is making request.
+     * @param array|string|null $url url that the user is making request.
      * @param array $options Array with option data.
      * @return string
      */

Diff for: src/Webauthn/BaseAdapter.php

@@ -27,7 +27,6 @@
 use Webauthn\AuthenticationExtensions\ExtensionOutputCheckerHandler;
 use Webauthn\PublicKeyCredentialRpEntity;
 use Webauthn\PublicKeyCredentialUserEntity;
-use Webauthn\Server;
 
 class BaseAdapter
 {
@@ -99,7 +98,7 @@ protected function getUserEntity(): PublicKeyCredentialUserEntity
     }
 
     /**
-     * @return array|mixed|null
+     * @return mixed|array|null
      */
     public function getUser()
     {
@@ -130,7 +129,7 @@ public function setAttestationStatementSupportManager(AttestationStatementSuppor
     protected function getAttestationStatementSupportManager(): AttestationStatementSupportManager
     {
         if ($this->attestationStatementSupportManager === null) {
-            $this->attestationStatementSupportManager = new AttestationStatementSupportManager;
+            $this->attestationStatementSupportManager = new AttestationStatementSupportManager();
             $this->attestationStatementSupportManager
                 ->add(new NoneAttestationStatementSupport());
         }

Diff for: src/Webauthn/PublicKeyCredentialLoader.php

@@ -22,13 +22,15 @@ class PublicKeyCredentialLoader extends \Webauthn\PublicKeyCredentialLoader
      */
     public function loadArray(array $json): PublicKeyCredential
     {
-        if (isset($json['response']['clientDataJSON'])
+        if (
+            isset($json['response']['clientDataJSON'])
             && is_string($json['response']['clientDataJSON'])
         ) {
             $json['response']['clientDataJSON'] = Base64Utility::complyEncodedNoPadding($json['response']['clientDataJSON']);
         }
 
-        if (isset($json['response']['authenticatorData'])
+        if (
+            isset($json['response']['authenticatorData'])
             && is_string($json['response']['authenticatorData'])
         ) {
             $json['response']['authenticatorData'] = Base64Utility::complyEncodedNoPadding($json['response']['authenticatorData']);

Diff for: src/Webauthn/RegisterAdapter.php

@@ -68,7 +68,7 @@ public function verifyResponse(): \Webauthn\PublicKeyCredentialSource
             $authenticatorAttestationResponseValidator = new AuthenticatorAttestationResponseValidator(
                 $attestationStatementSupportManager,
                 $this->repository,
-                null,//Token binding is deprecated
+                null, //Token binding is deprecated
                 $extensionOutputCheckerHandler
             );
             $credential = $authenticatorAttestationResponseValidator->check(
@@ -85,7 +85,7 @@ public function verifyResponse(): \Webauthn\PublicKeyCredentialSource
     }
 
     /**
-     * @return \Webauthn\PublicKeyCredentialParameters[]
+     * @return array<\Webauthn\PublicKeyCredentialParameters>
      */
     protected function getPubKeyCredParams(): array
     {

Diff for: src/Webauthn/Repository/UserCredentialSourceRepository.php

@@ -3,7 +3,6 @@
 
 namespace CakeDC\Users\Webauthn\Repository;
 
-use Base64Url\Base64Url;
 use Cake\Datasource\EntityInterface;
 use CakeDC\Users\Model\Table\UsersTable;
 use CakeDC\Users\Webauthn\Base64Utility;

Diff for: tests/TestCase/Command/UsersActivateUserCommandTest.php

@@ -17,7 +17,7 @@ class UsersActivateUserCommandTest extends TestCase
     use ConsoleIntegrationTestTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $fixtures = [
         'plugin.CakeDC/Users.Users',

Diff for: tests/TestCase/Command/UsersAddSuperuserCommandTest.php

@@ -17,7 +17,7 @@ class UsersAddSuperuserCommandTest extends TestCase
     use ConsoleIntegrationTestTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $fixtures = [
         'plugin.CakeDC/Users.Users',

Diff for: tests/TestCase/Command/UsersAddUserCommandTest.php

@@ -19,7 +19,7 @@ class UsersAddUserCommandTest extends TestCase
     use ConsoleIntegrationTestTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $fixtures = [
         'plugin.CakeDC/Users.Users',

Diff for: tests/TestCase/Command/UsersChangeApiTokenCommandTest.php

@@ -17,7 +17,7 @@ class UsersChangeApiTokenCommandTest extends TestCase
     use ConsoleIntegrationTestTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $fixtures = [
         'plugin.CakeDC/Users.Users',

Diff for: tests/TestCase/Command/UsersChangeRoleCommandTest.php

@@ -17,7 +17,7 @@ class UsersChangeRoleCommandTest extends TestCase
     use ConsoleIntegrationTestTrait;
 
     /**
-     * @inheritdoc
+     * @inheritDoc
      */
     protected array $fixtures = [
         'plugin.CakeDC/Users.Users',