Update Doc

src/Controller/ApiController.php

@@ -17,6 +17,7 @@ class ApiController extends AppController
     /**Before render callback.
      *
      * @param Event $event The beforeRender event.
+     *
      * @return \Cake\Http\Response|null
      * @throws \Exception
      */

src/Controller/ApiErrorController.php

@@ -19,6 +19,7 @@ class ApiErrorController extends AppController
      * beforeRender callback.
      *
      * @param \Cake\Event\Event $event Event.
+     *
      * @return null
      * @throws \Exception
      */
@@ -27,7 +28,9 @@ public function beforeRender(Event $event)
         $this->httpStatusCode = $this->getResponse()->getStatusCode();
 
         if (Configure::read('ApiRequest.debug') && isset($this->viewVars['error'])) {
-            $this->apiResponse[$this->responseFormat['messageKey']] = $this->viewVars['error']->getMessage();
+            $error = $this->viewVars['error'];
+            /** @var \Exception $error */
+            $this->apiResponse[$this->responseFormat['messageKey']] = $error->getMessage();
         } else {
             $this->apiResponse[$this->responseFormat['messageKey']] = !empty($messageArr[$this->httpStatusCode]) ? $messageArr[$this->httpStatusCode] : 'Unknown error!';
         }

src/Controller/AppController.php

@@ -101,6 +101,7 @@ public function initialize()
      * Before render callback.
      *
      * @param Event $event The beforeRender event.
+     *
      * @return \Cake\Http\Response|null
      * @throws \Exception
      */
@@ -130,6 +131,7 @@ public function beforeRender(Event $event)
 
     /**
      * @param $data
+     *
      * @return array
      * @throws \Exception
      * @throws \Exception
@@ -166,7 +168,8 @@ public function getSerializer()
 
     /**
      * @param \League\Fractal\Manager $manager
-     * @param $var
+     * @param                         $var
+     *
      * @return array
      * @throws \Exception
      */
@@ -189,6 +192,7 @@ protected function transform(Manager $manager, $var)
 
     /**
      * @param $var
+     *
      * @return bool|\League\Fractal\TransformerAbstract
      * @throws \Exception
      */
@@ -218,6 +222,7 @@ protected function getTransformer($var)
 
     /**
      * @param $var
+     *
      * @return bool|string
      */
     protected function getTransformerClass($var)

src/Controller/Component/AccessControlComponent.php

@@ -26,6 +26,7 @@ class AccessControlComponent extends Component
      * Handles request authentication using JWT.
      *
      * @param Event $event The startup event
+     *
      * @return \Cake\Http\Response|boolean
      */
     public function startup(Event $event)
@@ -41,6 +42,7 @@ public function startup(Event $event)
      * Performs token validation.
      *
      * @param Event $event The startup event
+     *
      * @return bool
      */
     protected function _performTokenValidation(Event $event)

src/Error/ApiExceptionRenderer.php

@@ -19,6 +19,7 @@ class ApiExceptionRenderer extends ExceptionRenderer
      * Handles MissingTokenException.
      *
      * @param $exception
+     *
      * @return \Cake\Http\Response
      */
     public function missingToken($exception)
@@ -30,7 +31,8 @@ public function missingToken($exception)
      * Prepare response.
      *
      * @param \Exception $exception Exception
-     * @param array $options Array of options
+     * @param array      $options   Array of options
+     *
      * @return \Cake\Http\Response
      */
     private function __prepareResponse($exception, $options = [])
@@ -70,6 +72,7 @@ protected function _getController()
     /**Handles InvalidTokenFormatException.
      *
      * @param \RestApi\Routing\Exception\InvalidTokenFormatException $exception InvalidTokenFormatException
+     *
      * @return \Cake\Http\Response
      */
     public function invalidTokenFormat($exception)
@@ -81,6 +84,7 @@ public function invalidTokenFormat($exception)
      * Handles InvalidTokenException.
      *
      * @param \RestApi\Routing\Exception\InvalidTokenException $exception InvalidTokenException
+     *
      * @return \Cake\Http\Response
      */
     public function invalidToken($exception)

src/Event/ApiRequestHandler.php

@@ -44,6 +44,7 @@ public function implementedEvents()
      * Handles incoming request and its data.
      *
      * @param Event $event The beforeDispatch event
+     *
      * @return array|mixed|null
      */
     public function beforeDispatch(Event $event)

src/Middleware/RestApiMiddleware.php

@@ -18,9 +18,10 @@ class RestApiMiddleware extends ErrorHandlerMiddleware
     /**
      * Override ErrorHandlerMiddleware and add custom exception renderer
      *
-     * @param \Psr\Http\Message\ServerRequestInterface $request The request.
-     * @param \Psr\Http\Message\ResponseInterface $response The response.
-     * @param callable $next Callback to invoke the next middleware.
+     * @param \Psr\Http\Message\ServerRequestInterface $request  The request.
+     * @param \Psr\Http\Message\ResponseInterface      $response The response.
+     * @param callable                                 $next     Callback to invoke the next middleware.
+     *
      * @return \Psr\Http\Message\ResponseInterface A response
      */
     public function __invoke($request, $response, $next)

src/Model/Entity/ApiRequest.php

@@ -7,15 +7,15 @@
 /**
  * Class ApiRequest
  *
- * @property string $id
- * @property string $http_method
- * @property string $endpoint
- * @property string $token
- * @property string $ip_address
- * @property string $request_data
- * @property int $response_code
- * @property string $response_data
- * @property string $exception
+ * @property string          $id
+ * @property string          $http_method
+ * @property string          $endpoint
+ * @property string          $token
+ * @property string          $ip_address
+ * @property string          $request_data
+ * @property int             $response_code
+ * @property string          $response_data
+ * @property string          $exception
  * @property \Cake\I18n\Time $created
  * @property \Cake\I18n\Time $modified
  *

src/Model/Table/ApiRequestsTable.php

@@ -18,6 +18,7 @@ class ApiRequestsTable extends Table
      * Initialize method
      *
      * @param array $config The configuration for the Table.
+     *
      * @return void
      */
     public function initialize(array $config)

src/Routing/Exception/InvalidTokenException.php

@@ -18,9 +18,9 @@ class InvalidTokenException extends Exception
     /**
      * InvalidTokenException constructor.
      *
-     * @param string|array $message Either the string of the error message, or an array of attributes
-     *   that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-     * @param int $code The code of the error, is also the HTTP status code for the error.
+     * @param string|array    $message  Either the string of the error message, or an array of attributes
+     *                                  that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
+     * @param int             $code     The code of the error, is also the HTTP status code for the error.
      * @param \Exception|null $previous the previous exception.
      */
     public function __construct($message = null, $code = 401, $previous = null)

src/Routing/Exception/InvalidTokenFormatException.php

@@ -18,9 +18,9 @@ class InvalidTokenFormatException extends Exception
     /**
      * InvalidTokenFormatException constructor.
      *
-     * @param string|array $message Either the string of the error message, or an array of attributes
-     *   that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-     * @param int $code The code of the error, is also the HTTP status code for the error.
+     * @param string|array    $message  Either the string of the error message, or an array of attributes
+     *                                  that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
+     * @param int             $code     The code of the error, is also the HTTP status code for the error.
      * @param \Exception|null $previous the previous exception.
      */
     public function __construct($message = null, $code = 401, $previous = null)

src/Routing/Exception/MissingTokenException.php

@@ -18,9 +18,9 @@ class MissingTokenException extends Exception
     /**
      * MissingTokenException constructor.
      *
-     * @param string|array $message Either the string of the error message, or an array of attributes
-     *   that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-     * @param int $code The code of the error, is also the HTTP status code for the error.
+     * @param string|array    $message  Either the string of the error message, or an array of attributes
+     *                                  that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
+     * @param int             $code     The code of the error, is also the HTTP status code for the error.
      * @param \Exception|null $previous the previous exception.
      */
     public function __construct($message = null, $code = 401, $previous = null)

src/Serializer/ArraySerializer.php

@@ -16,7 +16,7 @@ class ArraySerializer extends Serializer
      * Serialize a collection.
      *
      * @param string $resourceKey resource key
-     * @param array $data data
+     * @param array  $data        data
      *
      * @return array
      */

src/Utility/ApiRequestLogger.php

@@ -22,8 +22,8 @@ class ApiRequestLogger
     /**
      * Logs the request and response data into database.
      *
-     * @param \Cake\Http\ServerRequest $request The \Cake\Network\Request object
-     * @param \Cake\Http\Response $response The \Cake\Http\Response object
+     * @param \Cake\Http\ServerRequest $request  The \Cake\Network\Request object
+     * @param \Cake\Http\Response      $response The \Cake\Http\Response object
      */
     public static function log(ServerRequest $request, Response $response)
     {

src/Utility/JwtToken.php

@@ -19,6 +19,7 @@ class JwtToken
      * Generates a token based on payload
      *
      * @param mixed $payload Payload data to generate token
+     *
      * @return string|bool Token or false
      */
     public static function generateToken($payload = null)

src/View/ApiErrorView.php

@@ -23,8 +23,9 @@ public function initialize()
     /**
      * Renders custom api error view
      *
-     * @param string|null $view Name of view file to use
+     * @param string|null $view   Name of view file to use
      * @param string|null $layout Layout to use.
+     *
      * @return string|null Rendered content or null if content already rendered and returned earlier.
      * @throws \Cake\Core\Exception\Exception If there is an error in the view.
      */

src/View/ApiView.php

@@ -23,8 +23,9 @@ public function initialize()
     /**
      * Renders api response
      *
-     * @param string|null $view Name of view file to use
+     * @param string|null $view   Name of view file to use
      * @param string|null $layout Layout to use.
+     *
      * @return string|null Rendered content or null if content already rendered and returned earlier.
      * @throws \Cake\Core\Exception\Exception If there is an error in the view.
      */