perform code style formatting

Author: skie

src/ApiInitializer.php

@@ -20,8 +20,8 @@
 use Authorization\Policy\MapResolver;
 use Authorization\Policy\OrmResolver;
 use Authorization\Policy\ResolverCollection;
-use Cake\Http\ServerRequest;
 use Cake\Core\Configure;
+use Cake\Http\ServerRequest;
 use CakeDC\Api\Rbac\ApiRbac;
 use CakeDC\Auth\Policy\CollectionPolicy;
 use CakeDC\Auth\Policy\RbacPolicy;
@@ -34,7 +34,6 @@ class ApiInitializer implements AuthorizationServiceProviderInterface
      */
     public function getAuthenticationService(): AuthenticationService
     {
-
         $service = new AuthenticationService();
         $service->loadIdentifier('Authentication.JwtSubject', []);
 

src/Exception/MethodNotAllowedException.php

@@ -13,8 +13,6 @@
 
 namespace CakeDC\Api\Exception;
 
-use Cake\Core\Exception\Exception;
-
 /**
  * Class MethodNotAllowedException
  * Used to configure an exception for a service error.

src/Exception/ServiceException.php

@@ -13,8 +13,6 @@
 
 namespace CakeDC\Api\Exception;
 
-use Cake\Core\Exception\Exception;
-
 /**
  * Class ServiceException
  * Used to configure an exception for a service error.

src/Exception/UnauthenticatedException.php

@@ -13,8 +13,6 @@
 
 namespace CakeDC\Api\Exception;
 
-use Cake\Core\Exception\Exception;
-
 /**
  * Class UnauthenticatedException
  * Used to configure an exception for a service error.

src/Exception/UnauthorizedException.php

@@ -13,8 +13,6 @@
 
 namespace CakeDC\Api\Exception;
 
-use Cake\Core\Exception\Exception;
-
 /**
  * Class UnauthorizedException
  *

src/Middleware/ApiMiddleware.php

@@ -27,6 +27,7 @@
 /**
  * Applies routing rules to the request and creates the controller
  * instance if possible.
+ *
  * @deprecated use ParseApiRequestMiddleware and ProcessApiRequestMiddleware instead
  */
 class ApiMiddleware implements MiddlewareInterface
@@ -40,7 +41,6 @@ class ApiMiddleware implements MiddlewareInterface
      *
      * @param \Psr\Http\Message\ServerRequestInterface $request The request.
      * @param \Psr\Http\Server\RequestHandlerInterface $handler The request handler.
-     *
      * @return \Psr\Http\Message\ResponseInterface A response.
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface

src/Middleware/ParseApiRequestMiddleware.php

@@ -71,10 +71,10 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     }
 
     /**
-     * @param ServerRequestInterface $request
-     * @param RequestHandlerInterface $handler
-     * @param $matches
-     * @return Response|ResponseInterface|null
+     * @param \Psr\Http\Message\ServerRequestInterface $request Request object.
+     * @param \Psr\Http\Server\RequestHandlerInterface $handler Request handler.
+     * @param mixed $matches Matches definition.
+     * @return \Cake\Http\Response|\Psr\Http\Message\ResponseInterface|null
      */
     protected function _matchRequest(ServerRequestInterface $request, RequestHandlerInterface $handler, $matches)
     {

src/Middleware/ProcessApiRequestMiddleware.php

@@ -34,7 +34,6 @@ class ProcessApiRequestMiddleware implements MiddlewareInterface
      *
      * @param \Psr\Http\Message\ServerRequestInterface $request The request.
      * @param \Psr\Http\Server\RequestHandlerInterface $handler The request handler.
-     *
      * @return \Psr\Http\Message\ResponseInterface A response.
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface

src/Middleware/RequestHandlerMiddleware.php

@@ -18,6 +18,7 @@
 /**
  * Applies routing rules to the request and creates the controller
  * instance if possible.
+ *
  * @deprecated
  */
 class RequestHandlerMiddleware extends BodyParserMiddleware

src/Middleware/UnauthorizedHandler/ApiExceptionHandler.php

@@ -25,7 +25,7 @@
 class ApiExceptionHandler implements HandlerInterface
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function handle(Exception $exception, Request $request, array $options = []): Response
     {

src/Plugin.php

@@ -22,7 +22,7 @@
 class Plugin extends BasePlugin
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function routes($routes): void
     {

src/Rbac/ApiRbac.php

@@ -140,7 +140,6 @@ public function checkPermissions($user, ServerRequestInterface $request)
      * @param array|\ArrayAccess $user Current user data
      * @param string $role Effective user's role
      * @param \Psr\Http\Message\ServerRequestInterface $request Current request
-     *
      * @return null|\CakeDC\Auth\Rbac\PermissionMatchResult Null if permission is discarded, PermissionMatchResult if a final
      * result is produced
      */
@@ -225,29 +224,22 @@ protected function _matchPermission(array $permission, $user, $role, ServerReque
      * @param string|array|null $possibleValues Values that are accepted (from permission config)
      * @param string|mixed|null $value Value to check with. We'll check the 'dasherized' value too
      * @param bool $allowEmpty If true and $value is null, the rule will pass
-     *
      * @return bool
      */
     protected function _matchOrAsterisk($possibleValues, $value, $allowEmpty = false)
     {
         $possibleArray = (array)$possibleValues;
 
-        if (
-            $possibleValues === '*' ||
-            $value === $possibleValues ||
-            in_array($value, $possibleArray) ||
-            in_array($this->_camelizeByChars((string)$value), $possibleArray)
-        ) {
-            return true;
-        }
-
-        return false;
+        return $possibleValues === '*' ||
+        $value === $possibleValues ||
+        in_array($value, $possibleArray) ||
+        in_array($this->_camelizeByChars((string)$value), $possibleArray);
     }
 
     /**
      * Camelize by breaking chars.
      *
-     * @param string $value
+     * @param string $value String to camelize.
      * @return string
      */
     protected function _camelizeByChars(string $value)
@@ -264,10 +256,8 @@ protected function _camelizeByChars(string $value)
      * Checks if $haystack begins with $needle
      *
      * @see http://stackoverflow.com/a/7168986/2588539
-     *
      * @param string $haystack The whole string
      * @param string $needle The beginning to check
-     *
      * @return bool
      */
     protected function _startsWith($haystack, $needle)

src/Rbac/Permissions/AbstractProvider.php

@@ -32,6 +32,7 @@ abstract class AbstractProvider
 
     /**
      * AbstractProvider constructor.
+     *
      * @param array $config config
      */
     public function __construct($config = [])

src/Service/Action/Action.php

@@ -245,13 +245,8 @@ public function process()
             return $event->getResult();
         }
 
-        // thrown before execute action event (with stop on false)
-        if (method_exists($this, 'action')) {
-            $result = $this->_executeAction();
-        } else {
-            $result = $this->execute();
-        }
-        $this->dispatchEvent('Action.afterProcess', compact('result'));
+        $result = method_exists($this, 'action') ? $this->_executeAction() : $this->execute();
+        $this->dispatchEvent('Action.afterProcess', ['result' => $result]);
 
         return $result;
     }
@@ -279,18 +274,15 @@ protected function _executeAction(string $methodName = 'action')
                 } else {
                     throw new Exception('Missing required param: ' . $paramName, 409);
                 }
+            } elseif ($params[$paramName] === '' && $param->isOptional()) {
+                $arguments[] = $param->getDefaultValue();
             } else {
-                if ($params[$paramName] === '' && $param->isOptional()) {
-                    $arguments[] = $param->getDefaultValue();
-                } else {
-                    $value = $params[$paramName];
-                    $arguments[] = is_numeric($value) ? 0 + $value : $value;
-                }
+                $value = $params[$paramName];
+                $arguments[] = is_numeric($value) ? 0 + $value : $value;
             }
         }
-        $result = call_user_func_array([$this, $methodName], $arguments);
 
-        return $result;
+        return call_user_func_array([$this, $methodName], $arguments);
     }
 
     /**

src/Service/Action/Auth/JwtTokenTrait.php

@@ -17,14 +17,12 @@
 use Cake\ORM\TableRegistry;
 use Cake\Routing\Router;
 use Cake\Utility\Hash;
-
 use DateInterval;
 use DateTimeImmutable;
 use Lcobucci\JWT\Configuration;
-use Lcobucci\JWT\Signer\Key\InMemory;
 use Lcobucci\JWT\Signer\Hmac\Sha256;
-use Lcobucci\JWT\Builder;
 use Lcobucci\JWT\Signer\Hmac\Sha512;
+use Lcobucci\JWT\Signer\Key\InMemory;
 
 trait JwtTokenTrait
 {
@@ -50,7 +48,7 @@ public function generateTokenResponse($user)
      * Generates access token.
      *
      * @param \Cake\Datasource\EntityInterface|array $user User info.
-     * @param DateTimeImmutable $timestamp Timestamp.
+     * @param \DateTimeImmutable $timestamp Timestamp.
      * @return bool|string
      */
     public function generateAccessToken($user, $timestamp)
@@ -82,7 +80,7 @@ public function generateAccessToken($user, $timestamp)
      * Generates refresh token.
      *
      * @param \Cake\Datasource\EntityInterface|array $user User info.
-     * @param DateTimeImmutable $timestamp Timestamp.
+     * @param \DateTimeImmutable $timestamp Timestamp.
      * @return bool|string
      */
     public function generateRefreshToken($user, $timestamp)
@@ -138,26 +136,26 @@ public function generateRefreshToken($user, $timestamp)
     /**
      * Generates access token with life time.
      *
-     * @param DateTimeImmutable $timestamp Timestamp.
-     * @return DateTimeImmutable
+     * @param \DateTimeImmutable $timestamp Timestamp.
+     * @return \DateTimeImmutable
      */
     private function accessTokenLifeTime(DateTimeImmutable $timestamp): DateTimeImmutable
     {
         $accessTokenLifeTime = Configure::read('Api.Jwt.AccessToken.lifetime');
 
-        return $timestamp->add(new DateInterval("PT" . $accessTokenLifeTime . "S"));
+        return $timestamp->add(new DateInterval('PT' . $accessTokenLifeTime . 'S'));
     }
 
     /**
      * Generates refresh token with life time.
      *
-     * @param DateTimeImmutable $timestamp Timestamp.
-     * @return DateTimeImmutable
+     * @param \DateTimeImmutable $timestamp Timestamp.
+     * @return \DateTimeImmutable
      */
     private function refreshTokenLifeTime(DateTimeImmutable $timestamp): DateTimeImmutable
     {
         $refreshTokenLifeTime = Configure::read('Api.Jwt.RefreshToken.lifetime');
 
-        return $timestamp->add(new DateInterval("PT" . $refreshTokenLifeTime . "S"));
+        return $timestamp->add(new DateInterval('PT' . $refreshTokenLifeTime . 'S'));
     }
 }

src/Service/Action/Auth/LoginAction.php

@@ -108,7 +108,7 @@ protected function _afterIdentifyUser($user, $socialLogin = false)
 //            $this->dispatchEvent(UsersAuthComponent::EVENT_AFTER_LOGIN, ['user' => $user]);
         }
 
-        $event = $this->dispatchEvent('Action.Auth.onLoginFormat', compact('user'));
+        $event = $this->dispatchEvent('Action.Auth.onLoginFormat', ['user' => $user]);
         if ($event->getResult()) {
             $user = $event->getResult();
         }

src/Service/Action/Auth/RegisterAction.php

@@ -148,12 +148,11 @@ protected function _registerOptions(): array
         $validateEmail = (bool)Configure::read('Users.Email.validate');
         $useTos = (bool)Configure::read('Users.Tos.required');
         $tokenExpiration = Configure::read('Users.Token.expiration');
-        $options = [
+
+        return [
             'token_expiration' => $tokenExpiration,
             'validate_email' => $validateEmail,
             'use_tos' => $useTos,
         ];
-
-        return $options;
     }
 }

src/Service/Action/Auth/ResetPasswordAction.php

@@ -83,11 +83,11 @@ public function execute()
                 throw new Exception(__d('CakeDC/Api', 'Reset password token could not be validated'));
             }
         } catch (UserAlreadyActiveException $exception) {
-            throw new Exception(__d('CakeDC/Api', 'User already active'), 500);
+            throw new Exception(__d('CakeDC/Api', 'User already active'), 500, $exception);
         } catch (UserNotFoundException $ex) {
-            throw new Exception(__d('CakeDC/Api', 'Invalid token or user account already validated'), 500);
+            throw new Exception(__d('CakeDC/Api', 'Invalid token or user account already validated'), 500, $ex);
         } catch (TokenExpiredException $ex) {
-            throw new Exception(__d('CakeDC/Api', 'Token already expired'), 500);
+            throw new Exception(__d('CakeDC/Api', 'Token already expired'), 500, $ex);
         }
     }
 
@@ -117,11 +117,11 @@ protected function _changePassword($userId)
                 }
             }
         } catch (UserNotFoundException $exception) {
-            throw new Exception(__d('CakeDC/Api', 'User was not found'), 404);
+            throw new Exception(__d('CakeDC/Api', 'User was not found'), 404, $exception);
         } catch (WrongPasswordException $wpe) {
-            throw new Exception(__d('CakeDC/Api', '{0}', $wpe->getMessage()), 500);
+            throw new Exception(__d('CakeDC/Api', '{0}', $wpe->getMessage()), 500, $wpe);
         } catch (Exception $exception) {
-            throw new Exception(__d('CakeDC/Api', 'Password could not be changed'), 500);
+            throw new Exception(__d('CakeDC/Api', 'Password could not be changed'), 500, $exception);
         }
     }
 

src/Service/Action/Auth/ResetPasswordRequestAction.php

@@ -82,19 +82,17 @@ public function execute()
                 'ensureActive' => Configure::read('Users.Registration.ensureActive'),
             ]);
             if ($resetUser) {
-                $message = __d('CakeDC/Api', 'Please check your email to continue with password reset process');
-
-                return $message;
+                return __d('CakeDC/Api', 'Please check your email to continue with password reset process');
             } else {
                 $message = __d('CakeDC/Api', 'The password token could not be generated. Please try again');
                 throw new Exception($message, 500);
             }
         } catch (UserNotFoundException $exception) {
-            throw new Exception(__d('CakeDC/Api', 'User {0} was not found', $reference), 404);
+            throw new Exception(__d('CakeDC/Api', 'User {0} was not found', $reference), 404, $exception);
         } catch (UserNotActiveException $exception) {
-            throw new Exception(__d('CakeDC/Api', 'The user is not active'), 404);
+            throw new Exception(__d('CakeDC/Api', 'The user is not active'), 404, $exception);
         } catch (Exception $exception) {
-            throw new Exception(__d('CakeDC/Api', 'Token could not be reset'), 500);
+            throw new Exception(__d('CakeDC/Api', 'Token could not be reset'), 500, $exception);
         }
     }
 

src/Service/Action/Auth/SocialLoginAction.php

@@ -87,17 +87,17 @@ public function execute()
 
             return $result;
         } catch (UserNotActiveException $ex) {
-            throw new Exception(__d('CakeDC/Api', 'User account has not validated yet'), 501);
+            throw new Exception(__d('CakeDC/Api', 'User account has not validated yet'), 501, $ex);
         } catch (UserAlreadyActiveException $ex) {
-            throw new Exception($ex->getMessage(), 502);
+            throw new Exception($ex->getMessage(), 502, $ex);
         } catch (UserNotFoundException $ex) {
-            throw new Exception(__d('CakeDC/Api', 'Invalid token or user account already validated'), 503);
+            throw new Exception(__d('CakeDC/Api', 'Invalid token or user account already validated'), 503, $ex);
         } catch (TokenExpiredException $ex) {
-            throw new Exception($ex->getMessage(), 504);
+            throw new Exception($ex->getMessage(), 504, $ex);
         } catch (MissingEmailException $ex) {
-            throw new Exception($ex->getMessage(), 505);
+            throw new Exception($ex->getMessage(), 505, $ex);
         } catch (\Exception $ex) {
-            throw new Exception($ex->getMessage(), 500);
+            throw new Exception($ex->getMessage(), 500, $ex);
         }
     }