MarcinOrlowski / laravel-api-response-builder

src/ResponseBuilderServiceProvider.php

Indentation +3 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
 	 *
 	 * NOTE: not typehints due to compatibility with Laravel's method signature.
 	 * @noinspection PhpMissingReturnTypeInspection
- 	 * @noinspection ReturnTypeCanBeDeclaredInspection
+	 * @noinspection ReturnTypeCanBeDeclaredInspection
 	 * @noinspection PhpMissingParamTypeInspection
 	 */
 	protected function mergeConfigFrom($path, $key)
@@ -106,7 +106,7 @@ 
 
 		Util::sortArrayByPri($merged_config['converter']['classes']);
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }

src/ExceptionHandlers/HttpExceptionHandler.php

Spacing +2 added lines, -2 removed lines

@@ -47,12 +47,12 @@
 
 		/** @var \Symfony\Component\HttpKernel\Exception\HttpException $ex */
 		$http_code = $ex->getStatusCode();
-		$result = $config[ $http_code ] ?? null;
+		$result = $config[$http_code] ?? null;
 
 		// If we do not have dedicated entry fort this particular http_code,
 		// fall back to default value.
 		if ($result === null) {
-			$result = $config[ RB::KEY_DEFAULT ];
+			$result = $config[RB::KEY_DEFAULT];
 		}
 
 		// Some defaults to fall back to if not set in user config.

src/ExceptionHandlerHelper.php

Spacing +6 added lines, -6 removed lines

@@ -57,11 +57,11 @@ 
 		do {
 			if ($cfg === null) {
 				// Default handler MUST be present by design and always return something useful.
-				$cfg = self::getExceptionHandlerConfig()[ RB::KEY_DEFAULT ];
+				$cfg = self::getExceptionHandlerConfig()[RB::KEY_DEFAULT];
 			}
 
-			$handler = new $cfg[ RB::KEY_HANDLER ]();
-			$handler_result = $handler->handle($cfg[ RB::KEY_CONFIG ], $ex);
+			$handler = new $cfg[RB::KEY_HANDLER]();
+			$handler_result = $handler->handle($cfg[RB::KEY_CONFIG], $ex);
 			if ($handler_result !== null) {
 				$result = self::processException($ex, $handler_result);
 			} else {
@@ -185,7 +185,7 @@ 
 		$cfg = self::getExceptionHandlerConfig();
 
 		// This config entry is guaranted to exist. Enforced by tests.
-		$cfg = $cfg[ HttpException::class ][ RB::KEY_CONFIG ][ HttpResponse::HTTP_UNAUTHORIZED ];
+		$cfg = $cfg[HttpException::class][RB::KEY_CONFIG][HttpResponse::HTTP_UNAUTHORIZED];
 
 		/**
 		 * NOTE: no typehint due to compatibility with Laravel signature.
@@ -329,14 +329,14 @@ 
 
 			// check for exact class name match...
 			if (\array_key_exists($cls, $cfg)) {
-				$result = $cfg[ $cls ];
+				$result = $cfg[$cls];
 			} else {
 				// no exact match, then lets try with `instanceof`
 				// Config entries are already sorted by priority.
 				foreach (\array_keys($cfg) as $class_name) {
 					/** @var string $class_name */
 					if ($ex instanceof $class_name) {
-						$result = $cfg[ $class_name ];
+						$result = $cfg[$class_name];
 						break;
 					}
 				}

Indentation +3 added lines, -3 removed lines

@@ -97,7 +97,7 @@ 
 	 * @throws Ex\ArrayWithMixedKeysException
 	 */
 	protected static function processException(\Throwable $ex, array $ex_cfg,
-	                                           int $fallback_http_code = HttpResponse::HTTP_INTERNAL_SERVER_ERROR)
+											   int $fallback_http_code = HttpResponse::HTTP_INTERNAL_SERVER_ERROR)
 	{
 		$api_code = $ex_cfg['api_code'];
 		$http_code = $ex_cfg['http_code'] ?? $fallback_http_code;
@@ -195,7 +195,7 @@ 
 	 * @noinspection PhpMissingParamTypeInspection
 	 */
 	protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
-	                                                                     AuthException $exception): HttpResponse
+																		 AuthException $exception): HttpResponse
 	{
 		$cfg = self::getExceptionHandlerConfig();
 
@@ -227,7 +227,7 @@ 
 	 * @throws Ex\NotIntegerException
 	 */
 	protected static function error(Throwable $ex,
-	                                int $api_code, int $http_code = null, string $error_message = null): HttpResponse
+									int $api_code, int $http_code = null, string $error_message = null): HttpResponse
 	{
 		$ex_http_code = ($ex instanceof HttpException) ? $ex->getStatusCode() : $ex->getCode();
 		$http_code = $http_code ?? $ex_http_code;

src/ResponseBuilder.php

Spacing +3 added lines, -3 removed lines

@@ -391,11 +391,11 @@ 
 		$data = (new Converter())->convert($data);
 		if ($data !== null) {
 			// ensure we get object in final JSON structure in data node
-			$data = (object)$data;
+			$data = (object) $data;
 		}
 
 		if ($data === null && Config::get(RB::CONF_KEY_DATA_ALWAYS_OBJECT, false)) {
-			$data = (object)[];
+			$data = (object) [];
 		}
 
 		// get human readable message for API code or use message string (if given instead of API code)
@@ -417,7 +417,7 @@ 
 
 		if ($debug_data !== null) {
 			$debug_key = Config::get(RB::CONF_KEY_DEBUG_DEBUG_KEY, RB::KEY_DEBUG);
-			$response[ $debug_key ] = $debug_data;
+			$response[$debug_key] = $debug_data;
 		}
 
 		return $response;

Indentation +9 added lines, -9 removed lines

@@ -92,7 +92,7 @@ 
 	 * @throws Ex\NotIntegerException
 	 */
 	public static function success($data = null, int $api_code = null, array $placeholders = null,
-	                               int $http_code = null, int $json_opts = null): HttpResponse
+								   int $http_code = null, int $json_opts = null): HttpResponse
 	{
 		return static::asSuccess($api_code)
 			->withData($data)
@@ -127,7 +127,7 @@ 
 	 * @throws Ex\NotIntegerException
 	 */
 	public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
-	                             int $json_opts = null): HttpResponse
+								 int $json_opts = null): HttpResponse
 	{
 		return static::asError($api_code)
 			->withPlaceholders($placeholders)
@@ -229,7 +229,7 @@ 
 	public function withJsonOptions(int $json_opts = null): self
 	{
 		Validator::assertIsType('json_opts', $json_opts, [Type::INTEGER,
-		                                                  Type::NULL]);
+														  Type::NULL]);
 		$this->json_opts = $json_opts;
 
 		return $this;
@@ -245,7 +245,7 @@ 
 	public function withDebugData(array $debug_data = null): self
 	{
 		Validator::assertIsType('$debug_data', $debug_data, [Type::ARRAY,
-		                                                     Type::NULL]);
+															 Type::NULL]);
 		$this->debug_data = $debug_data;
 
 		return $this;
@@ -261,7 +261,7 @@ 
 	public function withMessage(string $msg = null): self
 	{
 		Validator::assertIsType('message', $msg, [Type::STRING,
-		                                          Type::NULL]);
+												  Type::NULL]);
 		$this->message = $msg;
 
 		return $this;
@@ -360,8 +360,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function make(bool $success, int $api_code, $msg_or_api_code, $data = null,
-	                        int $http_code = null, array $placeholders = null, array $http_headers = null,
-	                        int $json_opts = null, array $debug_data = null): HttpResponse
+							int $http_code = null, array $placeholders = null, array $http_headers = null,
+							int $json_opts = null, array $debug_data = null): HttpResponse
 	{
 		$http_headers = $http_headers ?? [];
 		$http_code = $http_code ?? ($success ? RB::DEFAULT_HTTP_CODE_OK : RB::DEFAULT_HTTP_CODE_ERROR);
@@ -405,8 +405,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function buildResponse(bool $success, int $api_code,
-	                                 $msg_or_api_code, array $placeholders = null,
-	                                 $data = null, array $debug_data = null): array
+									 $msg_or_api_code, array $placeholders = null,
+									 $data = null, array $debug_data = null): array
 	{
 		// ensure $data is either @null, array or object of class with configured mapping.
 		$data = (new Converter())->convert($data);

src/Converter.php

Spacing +10 added lines, -10 removed lines

@@ -62,7 +62,7 @@ 
 	protected function getPrimitiveMappingConfigOrThrow($data): array
 	{
 		$type = \gettype($data);
-		$result = $this->primitives[ $type ] ?? null;
+		$result = $this->primitives[$type] ?? null;
 
 		if ($result === null) {
 			throw new Ex\ConfigurationNotFoundException(
@@ -94,14 +94,14 @@ 
 		$cls = \get_class($data);
 		if (\is_string($cls)) {
 			if (\array_key_exists($cls, $this->classes)) {
-				$result = $this->classes[ $cls ];
+				$result = $this->classes[$cls];
 				$debug_result = 'exact config match';
 			} else {
 				// no exact match, then lets try with `instanceof`
 				foreach (\array_keys($this->classes) as $class_name) {
 					/** @var string $class_name */
 					if ($data instanceof $class_name) {
-						$result = $this->classes[ $class_name ];
+						$result = $this->classes[$class_name];
 						$debug_result = "subclass of {$class_name}";
 						break;
 					}
@@ -150,9 +150,9 @@ 
 
 		if ($result === null && \is_object($data)) {
 			$cfg = $this->getClassMappingConfigOrThrow($data);
-			$worker = new $cfg[ RB::KEY_HANDLER ]();
+			$worker = new $cfg[RB::KEY_HANDLER]();
 			$result = $worker->convert($data, $cfg);
-			$result = $cfg[ RB::KEY_KEY ] === null ? $result : [$cfg[ RB::KEY_KEY ] => $result];
+			$result = $cfg[RB::KEY_KEY] === null ? $result : [$cfg[RB::KEY_KEY] => $result];
         }
 
 		if ($result === null && \is_array($data)) {
@@ -160,12 +160,12 @@ 
 
 			$result = $this->convertArray($data);
 			if (!Util::isArrayWithNonNumericKeys($data)) {
-				$result = [$cfg[ RB::KEY_KEY ] => $result];
+				$result = [$cfg[RB::KEY_KEY] => $result];
 			}
 		}
 
 		if (\is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data];
+			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[RB::KEY_KEY] => $data];
 		}
 
 		return $result;
@@ -188,12 +188,12 @@ 
 
 		foreach ($data as $key => $val) {
 			if (\is_array($val)) {
-				$data[ $key ] = $this->convertArray($val);
+				$data[$key] = $this->convertArray($val);
 			} elseif (\is_object($val)) {
 				$cfg = $this->getClassMappingConfigOrThrow($val);
-				$worker = new $cfg[ RB::KEY_HANDLER ]();
+				$worker = new $cfg[RB::KEY_HANDLER]();
 				$converted_data = $worker->convert($val, $cfg);
-				$data[ $key ] = $converted_data;
+				$data[$key] = $converted_data;
 			}
 		}
 

src/Converters/JsonSerializableConverter.php

Spacing +1 added lines, -1 removed lines

@@ -43,6 +43,6 @@
 			$encoded = '';
 		}
 
-		return [$config[ RB::KEY_KEY ] => \json_decode($encoded, true)];
+		return [$config[RB::KEY_KEY] => \json_decode($encoded, true)];
 	}
 }

src/Validator.php

Indentation +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
 	 * @throws Ex\InvalidTypeException
 	 */
 	public static function assertIsType(string $var_name, $value, array $allowed_types,
-	                                    string $ex_class = Ex\InvalidTypeException::class): void
+										string $ex_class = Ex\InvalidTypeException::class): void
 	{
 		// Type::EXISTING_CLASS is artificial type, so we need separate logic to handle it.
 		$tmp = $allowed_types;

src/BaseApiCodes.php

Indentation +113 added lines, -113 removed lines

@@ -22,72 +22,72 @@ 
  */
 class BaseApiCodes
 {
-    use ApiCodesHelpers;
-
-    /**
-     * protected code range - lowest code for reserved range.
-     *
-     * @var int
-     */
-    public const RESERVED_MIN_API_CODE_OFFSET = 0;
-
-    /**
-     * protected code range - highest code for reserved range
-     *
-     * @var int
-     */
-    public const RESERVED_MAX_API_CODE_OFFSET = 19;
-
-    /**
-     * built-in codes: OK
-     *
-     * @var int
-     */
-    protected const OK_OFFSET = 0;
-    /**
-     * built-in code for fallback message mapping
-     *
-     * @var int
-     */
-    protected const NO_ERROR_MESSAGE_OFFSET = 1;
-    /**
-     * built-in error code for HTTP_NOT_FOUND exception
-     *
-     * @var int
-     */
-    protected const EX_HTTP_NOT_FOUND_OFFSET = 10;
-    /**
-     * built-in error code for HTTP_SERVICE_UNAVAILABLE exception
-     *
-     * @var int
-     */
-    protected const EX_HTTP_SERVICE_UNAVAILABLE_OFFSET = 11;
-    /**
-     * built-in error code for HTTP_EXCEPTION
-     *
-     * @var int
-     */
-    protected const EX_HTTP_EXCEPTION_OFFSET = 12;
-    /**
-     * built-in error code for UNCAUGHT_EXCEPTION
-     *
-     * @var int
-     */
-    protected const EX_UNCAUGHT_EXCEPTION_OFFSET = 13;
-
-    /**
-     * built-in error code for \Illuminate\Auth\AuthenticationException
-     *
-     * @var int
-     */
-    protected const EX_AUTHENTICATION_EXCEPTION_OFFSET = 14;
-
-    /**
-     * built-in error code for \Illuminate\Auth\AuthenticationException
-     *
-     * @var int
-     */
-    protected const EX_VALIDATION_EXCEPTION_OFFSET = 15;
+	use ApiCodesHelpers;
+
+	/**
+	 * protected code range - lowest code for reserved range.
+	 *
+	 * @var int
+	 */
+	public const RESERVED_MIN_API_CODE_OFFSET = 0;
+
+	/**
+	 * protected code range - highest code for reserved range
+	 *
+	 * @var int
+	 */
+	public const RESERVED_MAX_API_CODE_OFFSET = 19;
+
+	/**
+	 * built-in codes: OK
+	 *
+	 * @var int
+	 */
+	protected const OK_OFFSET = 0;
+	/**
+	 * built-in code for fallback message mapping
+	 *
+	 * @var int
+	 */
+	protected const NO_ERROR_MESSAGE_OFFSET = 1;
+	/**
+	 * built-in error code for HTTP_NOT_FOUND exception
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_NOT_FOUND_OFFSET = 10;
+	/**
+	 * built-in error code for HTTP_SERVICE_UNAVAILABLE exception
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_SERVICE_UNAVAILABLE_OFFSET = 11;
+	/**
+	 * built-in error code for HTTP_EXCEPTION
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_EXCEPTION_OFFSET = 12;
+	/**
+	 * built-in error code for UNCAUGHT_EXCEPTION
+	 *
+	 * @var int
+	 */
+	protected const EX_UNCAUGHT_EXCEPTION_OFFSET = 13;
+
+	/**
+	 * built-in error code for \Illuminate\Auth\AuthenticationException
+	 *
+	 * @var int
+	 */
+	protected const EX_AUTHENTICATION_EXCEPTION_OFFSET = 14;
+
+	/**
+	 * built-in error code for \Illuminate\Auth\AuthenticationException
+	 *
+	 * @var int
+	 */
+	protected const EX_VALIDATION_EXCEPTION_OFFSET = 15;
 
 	/**
 	 * Returns base code mapping array
@@ -100,21 +100,21 @@ 
 	 *
 	 * @noinspection PhpUnhandledExceptionInspection
 	 */
-    protected static function getBaseMap(): array
-    {
-        $tpl = 'response-builder::builder.http_%d';
-
-        return [
-            self::OK()                          => 'response-builder::builder.ok',
-            self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
-            self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
-            self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
-            self::EX_HTTP_NOT_FOUND()           => sprintf($tpl, HttpResponse::HTTP_NOT_FOUND),
-            self::EX_HTTP_SERVICE_UNAVAILABLE() => sprintf($tpl, HttpResponse::HTTP_SERVICE_UNAVAILABLE),
-            self::EX_AUTHENTICATION_EXCEPTION() => sprintf($tpl, HttpResponse::HTTP_UNAUTHORIZED),
-            self::EX_VALIDATION_EXCEPTION()     => sprintf($tpl, HttpResponse::HTTP_UNPROCESSABLE_ENTITY),
-        ];
-    }
+	protected static function getBaseMap(): array
+	{
+		$tpl = 'response-builder::builder.http_%d';
+
+		return [
+			self::OK()                          => 'response-builder::builder.ok',
+			self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
+			self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
+			self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
+			self::EX_HTTP_NOT_FOUND()           => sprintf($tpl, HttpResponse::HTTP_NOT_FOUND),
+			self::EX_HTTP_SERVICE_UNAVAILABLE() => sprintf($tpl, HttpResponse::HTTP_SERVICE_UNAVAILABLE),
+			self::EX_AUTHENTICATION_EXCEPTION() => sprintf($tpl, HttpResponse::HTTP_UNAUTHORIZED),
+			self::EX_VALIDATION_EXCEPTION()     => sprintf($tpl, HttpResponse::HTTP_UNPROCESSABLE_ENTITY),
+		];
+	}
 
 	/**
 	 * Returns API code for internal code OK
@@ -127,10 +127,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function OK(): int
-    {
-        return static::getCodeForInternalOffset(static::OK_OFFSET);
-    }
+	public static function OK(): int
+	{
+		return static::getCodeForInternalOffset(static::OK_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code NO_ERROR_MESSAGE
@@ -143,10 +143,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function NO_ERROR_MESSAGE(): int
-    {
-        return static::getCodeForInternalOffset(static::NO_ERROR_MESSAGE_OFFSET);
-    }
+	public static function NO_ERROR_MESSAGE(): int
+	{
+		return static::getCodeForInternalOffset(static::NO_ERROR_MESSAGE_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_HTTP_NOT_FOUND
@@ -159,10 +159,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_HTTP_NOT_FOUND(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_NOT_FOUND_OFFSET);
-    }
+	public static function EX_HTTP_NOT_FOUND(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_NOT_FOUND_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_HTTP_EXCEPTION
@@ -175,10 +175,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_HTTP_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
-    }
+	public static function EX_HTTP_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
@@ -191,10 +191,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_UNCAUGHT_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
-    }
+	public static function EX_UNCAUGHT_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
@@ -207,10 +207,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_AUTHENTICATION_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
-    }
+	public static function EX_AUTHENTICATION_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_VALIDATION_EXCEPTION
@@ -223,10 +223,10 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_VALIDATION_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_VALIDATION_EXCEPTION_OFFSET);
-    }
+	public static function EX_VALIDATION_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_VALIDATION_EXCEPTION_OFFSET);
+	}
 
 	/**
 	 * Returns API code for internal code EX_HTTP_SERVICE_UNAVAILABLE
@@ -239,9 +239,9 @@ 
 	 *
 	 * @noinspection PhpMethodNamingConventionInspection
 	 */
-    public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
-    }
+	public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
+	}
 
 }

src/Util.php

Spacing +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
 		$array = $original;
 		foreach ($merging as $m_key => $m_val) {
 			if (\array_key_exists($m_key, $original)) {
-				$orig_type = \gettype($original[ $m_key ]);
+				$orig_type = \gettype($original[$m_key]);
 				$m_type = \gettype($m_val);
 				if ($orig_type !== $m_type) {
 					throw new Ex\IncompatibleTypeException(
@@ -49,12 +49,12 @@ 
 
 				if (\is_array($m_val)) {
 					/** @noinspection PhpUnnecessaryStaticReferenceInspection */
-					$array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
+					$array[$m_key] = static::mergeConfig($original[$m_key], $m_val);
 				} else {
-					$array[ $m_key ] = $m_val;
+					$array[$m_key] = $m_val;
 				}
 			} else {
-				$array[ $m_key ] = $m_val;
+				$array[$m_key] = $m_val;
 			}
 		}