Apply fixes from StyleCI

Napp · Jul 2, 2019 · b96ddd3 · b96ddd3
1 parent fbd5437
commit b96ddd3
Show file tree

Hide file tree

Showing 44 changed files with 427 additions and 346 deletions.
diff --git a/src/Auth/ApiGuard.php b/src/Auth/ApiGuard.php
@@ -7,14 +7,13 @@
 use Illuminate\Http\Request;
 
 /**
- * Class ApiGuard
- * @package Napp\Core\Api\Auth
+ * Class ApiGuard.
  */
 class ApiGuard extends TokenGuard
 {
     /**
      * @param UserProvider $provider
-     * @param Request $request
+     * @param Request      $request
      */
     public function __construct(UserProvider $provider, Request $request)
     {
@@ -25,6 +24,7 @@ public function __construct(UserProvider $provider, Request $request)
 
     /**
      * @param array $credentials
+     *
      * @return bool
      */
     public function attempt(array $credentials = []): bool

diff --git a/src/Auth/AuthServiceProvider.php b/src/Auth/AuthServiceProvider.php
@@ -6,8 +6,7 @@
 use Illuminate\Support\ServiceProvider;
 
 /**
- * Class AuthServiceProvider
- * @package Napp\Core\Api\Auth
+ * Class AuthServiceProvider.
  */
 class AuthServiceProvider extends ServiceProvider
 {

diff --git a/src/Auth/NappHttpHeaders.php b/src/Auth/NappHttpHeaders.php
@@ -3,8 +3,7 @@
 namespace Napp\Core\Api\Auth;
 
 /**
- * Class NappHttpHeaders
- * @package Napp\Core\Api\Auth
+ * Class NappHttpHeaders.
  */
 class NappHttpHeaders
 {

diff --git a/src/Controllers/ApiController.php b/src/Controllers/ApiController.php
@@ -7,8 +7,7 @@
 use Illuminate\Support\Facades\Response;
 
 /**
- * Class ApiController
- * @package Napp\Core\Api\Controllers
+ * Class ApiController.
  */
 class ApiController extends BaseController
 {
@@ -40,6 +39,7 @@ public function getStatusCode()
 
     /**
      * @param int $code
+     *
      * @return $this
      */
     public function setStatusCode($code)
@@ -51,6 +51,7 @@ public function setStatusCode($code)
 
     /**
      * @param int $code
+     *
      * @return $this
      */
     public function setResponseCode($code)
@@ -62,6 +63,7 @@ public function setResponseCode($code)
 
     /**
      * @param string $currentETag
+     *
      * @return JsonResponse
      */
     public function checkETag($currentETag): ?JsonResponse
@@ -76,6 +78,7 @@ public function checkETag($currentETag): ?JsonResponse
     /**
      * @param array $data
      * @param array $headers
+     *
      * @return JsonResponse
      */
     public function respond(array $data, array $headers = []): JsonResponse
@@ -86,6 +89,7 @@ public function respond(array $data, array $headers = []): JsonResponse
     /**
      * @param array $data
      * @param array $headers
+     *
      * @return JsonResponse
      */
     public function respondWithSingleObject(array $data, array $headers = []): JsonResponse
@@ -95,21 +99,23 @@ public function respondWithSingleObject(array $data, array $headers = []): JsonR
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function respondWithError(string $message): JsonResponse
     {
         return $this->respond([
             'error' => [
                 'message' => $message,
-                'code'    => $this->getStatusCode()
-            ]
+                'code'    => $this->getStatusCode(),
+            ],
         ]);
     }
 
     /**
      * @param array $data
      * @param array $headers
+     *
      * @return JsonResponse
      */
     public function responseCreated(array $data, array $headers = []): JsonResponse
@@ -120,7 +126,8 @@ public function responseCreated(array $data, array $headers = []): JsonResponse
 
     /**
      * @param string $message
-     * @param array $headers
+     * @param array  $headers
+     *
      * @return JsonResponse
      */
     public function responseNoContent(
@@ -130,24 +137,25 @@ public function responseNoContent(
         return $this->setResponseCode(204)
             ->respond(['message' => $message], $headers);
     }
-    
-        /**
+
+    /**
      * @param string $message
-     * @param array $headers
+     * @param array  $headers
+     *
      * @return JsonResponse
      */
     public function responseAccepted(
         string $message = 'The request was accepted for processing',
         array $headers = []
     ): JsonResponse {
-
         return $this->setResponseCode(202)
             ->setStatusCode(224)
             ->respond(['message' => $message], $headers);
     }
 
     /**
      * @param array $headers
+     *
      * @return JsonResponse
      */
     public function responseNotModified(array $headers = []): JsonResponse
@@ -158,6 +166,7 @@ public function responseNotModified(array $headers = []): JsonResponse
 
     /**
      * @param string $message
+     *
      * @return \Illuminate\Http\JsonResponse
      */
     public function responseBadRequest(string $message = 'The request failed due to an application error.'): JsonResponse
@@ -169,6 +178,7 @@ public function responseBadRequest(string $message = 'The request failed due to
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseValidationFailed(string $message = 'Validation error.'): JsonResponse
@@ -180,6 +190,7 @@ public function responseValidationFailed(string $message = 'Validation error.'):
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseUnprocessableEntity(string $message = 'The request was well-formed but was unable to be followed due to semantic errors.'): JsonResponse
@@ -191,6 +202,7 @@ public function responseUnprocessableEntity(string $message = 'The request was w
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseUnauthorized(string $message = 'Authentication credentials were missing or incorrect.'): JsonResponse
@@ -202,6 +214,7 @@ public function responseUnauthorized(string $message = 'Authentication credentia
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseUnauthorization(string $message = 'Authorization error. Requested resource is restricted.'): JsonResponse
@@ -213,6 +226,7 @@ public function responseUnauthorization(string $message = 'Authorization error.
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseForbidden(string $message = 'Forbidden.'): JsonResponse
@@ -224,6 +238,7 @@ public function responseForbidden(string $message = 'Forbidden.'): JsonResponse
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseNotFound(string $message = 'Not found.'): JsonResponse
@@ -235,6 +250,7 @@ public function responseNotFound(string $message = 'Not found.'): JsonResponse
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseClientNotFound(string $message = 'Client not found.'): JsonResponse
@@ -246,6 +262,7 @@ public function responseClientNotFound(string $message = 'Client not found.'): J
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseInternalServerError(string $message = 'Internal Server Error.'): JsonResponse
@@ -257,6 +274,7 @@ public function responseInternalServerError(string $message = 'Internal Server E
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseNotImplemented(string $message = 'The request has not been implemented.'): JsonResponse
@@ -268,6 +286,7 @@ public function responseNotImplemented(string $message = 'The request has not be
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseServiceUnavailable(string $message = 'Service Unavailable.'): JsonResponse
@@ -279,6 +298,7 @@ public function responseServiceUnavailable(string $message = 'Service Unavailabl
 
     /**
      * @param string $message
+     *
      * @return JsonResponse
      */
     public function responseHTTPVersionNotSupported(string $message = 'This is returned if you use the HTTP protocol.'): JsonResponse
@@ -290,6 +310,7 @@ public function responseHTTPVersionNotSupported(string $message = 'This is retur
 
     /**
      * @param Request $request
+     *
      * @return int
      */
     public function getLimit(Request $request): int
@@ -305,6 +326,7 @@ public function getLimit(Request $request): int
 
     /**
      * @param Request $request
+     *
      * @return int
      */
     protected function getOffset(Request $request): int
@@ -313,9 +335,10 @@ protected function getOffset(Request $request): int
     }
 
     /**
-     * Get the page for pagination
+     * Get the page for pagination.
      *
      * @param Request $request
+     *
      * @return int
      */
     public function getPage(Request $request): int
@@ -324,9 +347,10 @@ public function getPage(Request $request): int
     }
 
     /**
-     * Get the page size for pagination
+     * Get the page size for pagination.
      *
      * @param Request $request
+     *
      * @return int
      */
     public function getPageSize(Request $request): int

diff --git a/src/Controllers/ApiInternalController.php b/src/Controllers/ApiInternalController.php
@@ -5,13 +5,12 @@
 use Illuminate\Auth\AuthManager;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Response;
+use Napp\Core\Api\Auth\NappHttpHeaders;
 use Napp\Core\Api\Exceptions\Exceptions\ApiInternalCallException;
 use Napp\Core\Api\Router\Router;
-use Napp\Core\Api\Auth\NappHttpHeaders;
 
 /**
- * Class ApiInternalController
- * @package Napp\Core\Api\Controllers
+ * Class ApiInternalController.
  */
 class ApiInternalController extends BaseController
 {
@@ -27,7 +26,7 @@ class ApiInternalController extends BaseController
 
     /**
      * @param AuthManager $auth
-     * @param Router $router
+     * @param Router      $router
      */
     public function __construct(AuthManager $auth, Router $router)
     {
@@ -45,7 +44,8 @@ public function getInternalRouter(): Router
 
     /**
      * @param string $uri
-     * @param array $headers
+     * @param array  $headers
+     *
      * @return array
      */
     public function get(string $uri, array $headers = []): array
@@ -57,8 +57,9 @@ public function get(string $uri, array $headers = []): array
 
     /**
      * @param string $uri
-     * @param array $data
-     * @param array $headers
+     * @param array  $data
+     * @param array  $headers
+     *
      * @return array
      */
     public function post(string $uri, array $data, array $headers = []): array
@@ -70,8 +71,9 @@ public function post(string $uri, array $data, array $headers = []): array
 
     /**
      * @param string $uri
-     * @param array $data
-     * @param array $headers
+     * @param array  $data
+     * @param array  $headers
+     *
      * @return array
      */
     public function put(string $uri, array $data, array $headers = []): array
@@ -83,7 +85,8 @@ public function put(string $uri, array $data, array $headers = []): array
 
     /**
      * @param string $uri
-     * @param array $headers
+     * @param array  $headers
+     *
      * @return array
      */
     public function delete(string $uri, array $headers = []): array
@@ -95,20 +98,23 @@ public function delete(string $uri, array $headers = []): array
 
     /**
      * @param array $headers
+     *
      * @return array
      */
     protected function getInternalCallHeaders(array $headers): array
     {
         return array_merge($headers, [
-            NappHttpHeaders::NAPP_API_CALL_TYPE => 'internal',
+            NappHttpHeaders::NAPP_API_CALL_TYPE       => 'internal',
             NappHttpHeaders::NAPP_AUTH_GLOBAL_USER_ID => $this->auth->guard()->id(),
         ]);
     }
 
     /**
      * @param Response|JsonResponse $response
-     * @return array
+     *
      * @throws ApiInternalCallException
+     *
+     * @return array
      */
     protected function formatResponse($response): array
     {