MarcinOrlowski / laravel-api-response-builder

config/response_builder.php

Indentation +99 added lines, -99 removed lines

@@ -12,100 +12,100 @@ 
  */
 
 return [
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Code range settings
     |-----------------------------------------------------------------------------------------------------------
     */
-    'min_code'          => 100,
-    'max_code'          => 1024,
+	'min_code'          => 100,
+	'max_code'          => 1024,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Error code to message mapping
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'map'               => [
-        // YOUR_API_CODE => '<MESSAGE_KEY>',
-    ],
+	'map'               => [
+		// YOUR_API_CODE => '<MESSAGE_KEY>',
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Response Builder data converter
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'converter'         => [
-	    'primitives' => [
-		    /* Configuration for primitives used when such data is passed directly as payload (i.e. `success(15)`;) */
-		    'array'   => [
-			    'key' => 'values',
-		    ],
-		    'boolean' => [
-			    'key' => 'value',
-		    ],
-		    'double'  => [
-			    'key' => 'value',
-		    ],
-		    'integer' => [
-			    'key' => 'value',
-		    ],
-		    'string'  => [
-			    'key' => 'value',
-		    ],
-	    ],
+	'converter'         => [
+		'primitives' => [
+			/* Configuration for primitives used when such data is passed directly as payload (i.e. `success(15)`;) */
+			'array'   => [
+				'key' => 'values',
+			],
+			'boolean' => [
+				'key' => 'value',
+			],
+			'double'  => [
+				'key' => 'value',
+			],
+			'integer' => [
+				'key' => 'value',
+			],
+			'string'  => [
+				'key' => 'value',
+			],
+		],
 
-	    /* Object converters configuration for supported classes */
-    	'classes' => [
-	        \Illuminate\Database\Eloquent\Model::class          => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'item',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Support\Collection::class               => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'items',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Database\Eloquent\Collection::class     => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'items',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Http\Resources\Json\JsonResource::class => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'item',
-	            'pri'     => 0,
-	        ],
+		/* Object converters configuration for supported classes */
+		'classes' => [
+			\Illuminate\Database\Eloquent\Model::class          => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'item',
+				'pri'     => 0,
+			],
+			\Illuminate\Support\Collection::class               => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'items',
+				'pri'     => 0,
+			],
+			\Illuminate\Database\Eloquent\Collection::class     => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'items',
+				'pri'     => 0,
+			],
+			\Illuminate\Http\Resources\Json\JsonResource::class => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'item',
+				'pri'     => 0,
+			],
 
-	        /*
+			/*
 	        |-----------------------------------------------------------------------------------------------------------
 	        | Generic converters should have lower pri to allow dedicated ones to kick in first when class matches
 	        |-----------------------------------------------------------------------------------------------------------
 	        */
-	        \JsonSerializable::class                            => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
-	             'key'     => 'item',
-	            'pri'     => -10,
-	        ],
-	        \Illuminate\Contracts\Support\Arrayable::class      => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
-	            'key'     => 'items',
-	            'pri'     => -10,
-	        ],
-        ],
+			\JsonSerializable::class                            => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
+				 'key'     => 'item',
+				'pri'     => -10,
+			],
+			\Illuminate\Contracts\Support\Arrayable::class      => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+				'key'     => 'items',
+				'pri'     => -10,
+			],
+		],
 
-    ],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Exception handler error codes
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'exception_handler' => [
-	    /*
+	'exception_handler' => [
+		/*
 	     * The following keys are supported for each handler specified.
 	     *   `handler`
 	     *   `pri`
@@ -125,19 +125,19 @@ 
 		 *                  message ($ex->getMessage()).
 		 */
 
-    	\Illuminate\Validation\ValidationException::class => [
-		    'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
-		    'pri'     => -100,
-		    'config' => [
+		\Illuminate\Validation\ValidationException::class => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
+			'pri'     => -100,
+			'config' => [
 //		        'api_code'  => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION,
 //		        'http_code' => HttpResponse::HTTP_UNPROCESSABLE_ENTITY,
-		    	],
-	    ],
+				],
+		],
 
 		\Symfony\Component\HttpKernel\Exception\HttpException::class => [
-	        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-	        'pri'     => -100,
-	        'config'  => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+			'pri'     => -100,
+			'config'  => [
 //		        HttpException::class => [
 //			        // used by unauthenticated() to obtain api and http code for the exception
 //			        HttpResponse::HTTP_UNAUTHORIZED         => [
@@ -153,47 +153,47 @@ 
 //				        'http_code' => HttpResponse::HTTP_BAD_REQUEST,
 //			        ],
 //		        ],
-	        ],
+			],
 //	        // This is final exception handler. If ex is not dealt with yet this is its last stop.
-	        // default handler is mandatory and MUST have both `api_code` and `http_code` set.
+			// default handler is mandatory and MUST have both `api_code` and `http_code` set.
 
-	        'default' => [
-		        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-		        'pri'     => -127,
-		        'config'  => [
+			'default' => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+				'pri'     => -127,
+				'config'  => [
 //			        'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION,
 //			        'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
-		        ],
-	        ],
-	    ],
-    ],
+				],
+			],
+		],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | data-to-json encoding options
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
+	'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Debug config
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'debug'             => [
-        'debug_key'         => 'debug',
-        'exception_handler' => [
-            'trace_key'     => 'trace',
-            'trace_enabled' => env('APP_DEBUG', false),
-        ],
+	'debug'             => [
+		'debug_key'         => 'debug',
+		'exception_handler' => [
+			'trace_key'     => 'trace',
+			'trace_enabled' => env('APP_DEBUG', false),
+		],
 
-        // Controls debugging features of payload converter class.
-        'converter' => [
-        	// Set to true to figure out what converter is used for given data payload and why.
-        	'debug_enabled' => env('RB_CONVERTER_DEBUG', false),
-        ],
-    ],
+		// Controls debugging features of payload converter class.
+		'converter' => [
+			// Set to true to figure out what converter is used for given data payload and why.
+			'debug_enabled' => env('RB_CONVERTER_DEBUG', false),
+		],
+	],
 
 ];

src/ExceptionHandlers/HttpExceptionHandler.php

Spacing +2 added lines, -2 removed lines

@@ -42,12 +42,12 @@
 		$config = \array_replace($default_config, $user_config);
 
 		$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/ResponseBuilder.php

Indentation +12 added lines, -12 removed lines

@@ -85,7 +85,7 @@ 
 	 * @return HttpResponse
 	 */
 	public static function success($data = null, $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)
@@ -113,7 +113,7 @@ 
 	 * @return HttpResponse
 	 */
 	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)
@@ -162,7 +162,7 @@ 
 	public function withHttpCode(int $http_code = null): self
 	{
 		Validator::assertIsType('http_code', $http_code, [Type::INTEGER,
-		                                                  Type::NULL]);
+														  Type::NULL]);
 		$this->http_code = $http_code;
 
 		return $this;
@@ -176,8 +176,8 @@ 
 	public function withData($data = null): self
 	{
 		Validator::assertIsType('data', $data, [Type::ARRAY,
-		                                        Type::OBJECT,
-		                                        Type::NULL]);
+												Type::OBJECT,
+												Type::NULL]);
 		$this->data = $data;
 
 		return $this;
@@ -191,7 +191,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;
@@ -205,7 +205,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;
@@ -219,7 +219,7 @@ 
 	public function withMessage(string $msg = null): self
 	{
 		Validator::assertIsType('message', $msg, [Type::STRING,
-		                                          Type::NULL]);
+												  Type::NULL]);
 		$this->message = $msg;
 
 		return $this;
@@ -306,8 +306,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);
@@ -346,8 +346,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);

Spacing +1 added lines, -1 removed lines

@@ -375,7 +375,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;

src/ResponseBuilderServiceProvider.php

Indentation +44 added lines, -44 removed lines

@@ -25,56 +25,56 @@
 
 class ResponseBuilderServiceProvider extends ServiceProvider
 {
-    protected $config_files = [
-        'response_builder.php',
-    ];
+	protected $config_files = [
+		'response_builder.php',
+	];
 
-    /**
-     * Register bindings in the container.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        foreach ($this->config_files as $file) {
-            $this->mergeConfigFrom(__DIR__ . "/../config/{$file}", RB::CONF_CONFIG);
-        }
-    }
+	/**
+	 * Register bindings in the container.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		foreach ($this->config_files as $file) {
+			$this->mergeConfigFrom(__DIR__ . "/../config/{$file}", RB::CONF_CONFIG);
+		}
+	}
 
-    /**
-     * Sets up package resources
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
+	/**
+	 * Sets up package resources
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
 
-        foreach ($this->config_files as $file) {
-            $this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
-        }
-    }
+		foreach ($this->config_files as $file) {
+			$this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
+		}
+	}
 
-    /**
-     * Merge the given configuration with the existing configuration.
-     *
-     * @param string $path
-     * @param string $key
-     *
-     * @return void
-     */
-    protected function mergeConfigFrom($path, $key)
-    {
-        $defaults = require $path;
-        $config = $this->app['config']->get($key, []);
+	/**
+	 * Merge the given configuration with the existing configuration.
+	 *
+	 * @param string $path
+	 * @param string $key
+	 *
+	 * @return void
+	 */
+	protected function mergeConfigFrom($path, $key)
+	{
+		$defaults = require $path;
+		$config = $this->app['config']->get($key, []);
 
-        $merged_config = Util::mergeConfig($defaults, $config);
+		$merged_config = Util::mergeConfig($defaults, $config);
 
-        if (\array_key_exists('converter', $merged_config)) {
-            Util::sortArrayByPri($merged_config['converter']);
-        }
+		if (\array_key_exists('converter', $merged_config)) {
+			Util::sortArrayByPri($merged_config['converter']);
+		}
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }

src/ExceptionHandlerHelper.php

Spacing +6 added lines, -6 removed lines

@@ -45,11 +45,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 {
@@ -147,7 +147,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];
 
 		return static::processException($exception, $cfg, HttpResponse::HTTP_UNAUTHORIZED);
 	}
@@ -277,13 +277,13 @@ 
 
 			// 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) {
 					if ($ex instanceof $class_name) {
-						$result = $cfg[ $class_name ];
+						$result = $cfg[$class_name];
 						break;
 					}
 				}

src/ApiCodesHelpers.php

Indentation +119 added lines, -119 removed lines

@@ -22,124 +22,124 @@
  */
 trait ApiCodesHelpers
 {
-    /**
-     * Returns lowest allowed error code for this module
-     *
-     * @return integer
-     *
-     * @throws \RuntimeException Throws exception if no min_code set up
-     */
-    public static function getMinCode(): int
-    {
-        $key = RB::CONF_KEY_MIN_CODE;
-        $min_code = Config::get($key, null);
-
-        if ($min_code === null) {
-            throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', $key));
-        }
-
-        return $min_code;
-    }
-
-    /**
-     * Returns highest allowed error code for this module
-     *
-     * @return integer
-     *
-     * @throws \RuntimeException Throws exception if no max_code set up
-     */
-    public static function getMaxCode(): int
-    {
-        $key = RB::CONF_KEY_MAX_CODE;
-        $max_code = Config::get($key, null);
-
-        if ($max_code === null) {
-            throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', $key));
-        }
-
-        return $max_code;
-    }
-
-    /**
-     * Returns array of error code constants defined in this class. Used mainly for debugging/tests
-     *
-     * @return array
-     */
-    public static function getApiCodeConstants(): array
-    {
-        /** @noinspection PhpUnhandledExceptionInspection */
-        return (new \ReflectionClass(static::class))->getConstants();
-    }
-
-    /**
-     * Returns complete error code to locale string mapping array
-     *
-     * @return array
-     *
-     * @throws \RuntimeException Thrown when builder map is not configured.
-     */
-    public static function getMap(): array
-    {
-        $user_map = Config::get(RB::CONF_KEY_MAP, null);
-        if ($user_map === null) {
-            throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', RB::CONF_KEY_MAP));
-        }
-        if (!\is_array($user_map)) {
-            throw new \RuntimeException(sprintf('CONFIG: "%s" must be an array', RB::CONF_KEY_MAP));
-        }
-        return Util::mergeConfig(BaseApiCodes::getBaseMap(), $user_map);
-    }
-
-    /**
-     * Returns locale mappings key for given api code or @null if there's no mapping
-     *
-     * @param integer $api_code Api code to look for mapped message for.
-     *
-     * @return string|null
-     *
-     * @throws \InvalidArgumentException If $code is not in allowed range.
-     */
-    public static function getCodeMessageKey(int $api_code): ?string
-    {
-        if (!static::isCodeValid($api_code)) {
-            $min = static::getMinCode();
-            $max = static::getMaxCode();
-            throw new \InvalidArgumentException("API code value ({$api_code}) is out of allowed range {$min}-{$max}");
-        }
-
-        $map = static::getMap();
-
-        return $map[ $api_code ] ?? null;
-    }
-
-    /**
-     * Checks if given API $code can be used in current configuration.
-     *
-     * @param int $code API code to validate
-     *
-     * @return bool
-     */
-    public static function isCodeValid(int $code): bool
-    {
-        return ($code === 0) || (($code >= static::getMinCode()) && ($code <= static::getMaxCode()));
-    }
-
-    /**
-     * Returns final API code for internal code, remapped to configured code range
-     *
-     * @param int $internal_code
-     *
-     * @return int
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function getCodeForInternalOffset(int $internal_code): int
-    {
-        $min = static::RESERVED_MIN_API_CODE_OFFSET;
-        $max = static::RESERVED_MAX_API_CODE_OFFSET;
-        Validator::assertIsIntRange('internal_code', $internal_code, $min, $max);
-
-        return ($internal_code === 0) ? 0 : $internal_code + static::getMinCode();
-    }
+	/**
+	 * Returns lowest allowed error code for this module
+	 *
+	 * @return integer
+	 *
+	 * @throws \RuntimeException Throws exception if no min_code set up
+	 */
+	public static function getMinCode(): int
+	{
+		$key = RB::CONF_KEY_MIN_CODE;
+		$min_code = Config::get($key, null);
+
+		if ($min_code === null) {
+			throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', $key));
+		}
+
+		return $min_code;
+	}
+
+	/**
+	 * Returns highest allowed error code for this module
+	 *
+	 * @return integer
+	 *
+	 * @throws \RuntimeException Throws exception if no max_code set up
+	 */
+	public static function getMaxCode(): int
+	{
+		$key = RB::CONF_KEY_MAX_CODE;
+		$max_code = Config::get($key, null);
+
+		if ($max_code === null) {
+			throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', $key));
+		}
+
+		return $max_code;
+	}
+
+	/**
+	 * Returns array of error code constants defined in this class. Used mainly for debugging/tests
+	 *
+	 * @return array
+	 */
+	public static function getApiCodeConstants(): array
+	{
+		/** @noinspection PhpUnhandledExceptionInspection */
+		return (new \ReflectionClass(static::class))->getConstants();
+	}
+
+	/**
+	 * Returns complete error code to locale string mapping array
+	 *
+	 * @return array
+	 *
+	 * @throws \RuntimeException Thrown when builder map is not configured.
+	 */
+	public static function getMap(): array
+	{
+		$user_map = Config::get(RB::CONF_KEY_MAP, null);
+		if ($user_map === null) {
+			throw new \RuntimeException(sprintf('CONFIG: Missing "%s" key', RB::CONF_KEY_MAP));
+		}
+		if (!\is_array($user_map)) {
+			throw new \RuntimeException(sprintf('CONFIG: "%s" must be an array', RB::CONF_KEY_MAP));
+		}
+		return Util::mergeConfig(BaseApiCodes::getBaseMap(), $user_map);
+	}
+
+	/**
+	 * Returns locale mappings key for given api code or @null if there's no mapping
+	 *
+	 * @param integer $api_code Api code to look for mapped message for.
+	 *
+	 * @return string|null
+	 *
+	 * @throws \InvalidArgumentException If $code is not in allowed range.
+	 */
+	public static function getCodeMessageKey(int $api_code): ?string
+	{
+		if (!static::isCodeValid($api_code)) {
+			$min = static::getMinCode();
+			$max = static::getMaxCode();
+			throw new \InvalidArgumentException("API code value ({$api_code}) is out of allowed range {$min}-{$max}");
+		}
+
+		$map = static::getMap();
+
+		return $map[ $api_code ] ?? null;
+	}
+
+	/**
+	 * Checks if given API $code can be used in current configuration.
+	 *
+	 * @param int $code API code to validate
+	 *
+	 * @return bool
+	 */
+	public static function isCodeValid(int $code): bool
+	{
+		return ($code === 0) || (($code >= static::getMinCode()) && ($code <= static::getMaxCode()));
+	}
+
+	/**
+	 * Returns final API code for internal code, remapped to configured code range
+	 *
+	 * @param int $internal_code
+	 *
+	 * @return int
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function getCodeForInternalOffset(int $internal_code): int
+	{
+		$min = static::RESERVED_MIN_API_CODE_OFFSET;
+		$max = static::RESERVED_MAX_API_CODE_OFFSET;
+		Validator::assertIsIntRange('internal_code', $internal_code, $min, $max);
+
+		return ($internal_code === 0) ? 0 : $internal_code + static::getMinCode();
+	}
 
 }

src/Validator.php

Indentation +150 added lines, -150 removed lines

@@ -17,165 +17,165 @@
  */
 class Validator
 {
-    /**
-     * Checks if given $val is of type boolean
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsBool(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::BOOLEAN]);
-    }
+	/**
+	 * Checks if given $val is of type boolean
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsBool(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [Type::BOOLEAN]);
+	}
 
-    /**
-     * Checks if given $val is of type integer
-     *
-     * @param string $key   Name of the key to be used if exception is thrown.
-     * @param mixed  $value Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsInt(string $key, $value): void
-    {
-        self::assertIsType($key, $value, [Type::INTEGER]);
-    }
+	/**
+	 * Checks if given $val is of type integer
+	 *
+	 * @param string $key   Name of the key to be used if exception is thrown.
+	 * @param mixed  $value Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsInt(string $key, $value): void
+	{
+		self::assertIsType($key, $value, [Type::INTEGER]);
+	}
 
-    /**
-     * Checks if given $val is of type array
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsArray(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::ARRAY]);
-    }
+	/**
+	 * Checks if given $val is of type array
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsArray(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [Type::ARRAY]);
+	}
 
-    /**
-     * Checks if given $val is an object
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsObject(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::OBJECT]);
-    }
+	/**
+	 * Checks if given $val is an object
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsObject(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [Type::OBJECT]);
+	}
 
-    /**
-     * Checks if given $val is of type string
-     *
-     * @param string $name  Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $value Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsString(string $name, $value): void
-    {
-        self::assertIsType($name, $value, [Type::STRING]);
-    }
+	/**
+	 * Checks if given $val is of type string
+	 *
+	 * @param string $name  Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $value Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsString(string $name, $value): void
+	{
+		self::assertIsType($name, $value, [Type::STRING]);
+	}
 
-    /**
-     * @param string $var_name Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $value    Variable to be asserted.
-     * @param int    $min      Min allowed value (inclusive)
-     * @param int    $max      Max allowed value (inclusive)
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     * @throws \RuntimeException
-     */
-    public static function assertIsIntRange(string $var_name, $value, int $min, int $max): void
-    {
-        self::assertIsInt($var_name, $value);
+	/**
+	 * @param string $var_name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $value    Variable to be asserted.
+	 * @param int    $min      Min allowed value (inclusive)
+	 * @param int    $max      Max allowed value (inclusive)
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws \RuntimeException
+	 */
+	public static function assertIsIntRange(string $var_name, $value, int $min, int $max): void
+	{
+		self::assertIsInt($var_name, $value);
 
-        if ($min > $max) {
-            throw new \RuntimeException(
-                \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name));
-        }
+		if ($min > $max) {
+			throw new \RuntimeException(
+				\sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name));
+		}
 
-        if (($min > $value) || ($value > $max)) {
-            throw new \InvalidArgumentException(
-                \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max));
-        }
-    }
+		if (($min > $value) || ($value > $max)) {
+			throw new \InvalidArgumentException(
+				\sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max));
+		}
+	}
 
-    /**
-     * Checks if $item (of name $key) is of type that is include in $allowed_types.
-     *
-     * @param string $var_name      Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $value         Variable to be asserted.
-     * @param array  $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER]
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsType(string $var_name, $value, array $allowed_types): void
-    {
-        $type = \gettype($value);
-        if (!\in_array($type, $allowed_types, true)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be one of allowed types: %s (%s given)',
-                    $var_name, implode(', ', $allowed_types), \gettype($value))
-            );
-        }
-    }
+	/**
+	 * Checks if $item (of name $key) is of type that is include in $allowed_types.
+	 *
+	 * @param string $var_name      Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $value         Variable to be asserted.
+	 * @param array  $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER]
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsType(string $var_name, $value, array $allowed_types): void
+	{
+		$type = \gettype($value);
+		if (!\in_array($type, $allowed_types, true)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be one of allowed types: %s (%s given)',
+					$var_name, implode(', ', $allowed_types), \gettype($value))
+			);
+		}
+	}
 
-    /**
-     * Ensures given $http_code is valid code for error response.
-     *
-     * @param int $http_code
-     */
-    public static function assertErrorHttpCode(int $http_code): void
-    {
-        self::assertIsInt('http_code', $http_code);
-        self::assertIsIntRange('http_code', $http_code,
-            RB::ERROR_HTTP_CODE_MIN, RB::ERROR_HTTP_CODE_MAX);
-    }
+	/**
+	 * Ensures given $http_code is valid code for error response.
+	 *
+	 * @param int $http_code
+	 */
+	public static function assertErrorHttpCode(int $http_code): void
+	{
+		self::assertIsInt('http_code', $http_code);
+		self::assertIsIntRange('http_code', $http_code,
+			RB::ERROR_HTTP_CODE_MIN, RB::ERROR_HTTP_CODE_MAX);
+	}
 
-    /**
-     * Ensures given $http_code is valid for response indicating sucessful operation.
-     *
-     * @param int $http_code
-     */
-    public static function assertOkHttpCode(int $http_code): void
-    {
-        self::assertIsInt('http_code', $http_code);
-        self::assertIsIntRange('http_code', $http_code, 200, 299);
-    }
+	/**
+	 * Ensures given $http_code is valid for response indicating sucessful operation.
+	 *
+	 * @param int $http_code
+	 */
+	public static function assertOkHttpCode(int $http_code): void
+	{
+		self::assertIsInt('http_code', $http_code);
+		self::assertIsIntRange('http_code', $http_code, 200, 299);
+	}
 
-    /**
-     * Ensures $obj (that is value coming from variable, which name is passed in $label) is instance of $cls class.
-     *
-     * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message.
-     * @param object $obj      Object to check instance of
-     * @param string $cls      Target class we want to check $obj agains.
-     */
-    public static function assertInstanceOf(string $var_name, object $obj, string $cls): void
-    {
-        if (!($obj instanceof $cls)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be instance of "%s".', $var_name, $cls)
-            );
-        }
-    }
+	/**
+	 * Ensures $obj (that is value coming from variable, which name is passed in $label) is instance of $cls class.
+	 *
+	 * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message.
+	 * @param object $obj      Object to check instance of
+	 * @param string $cls      Target class we want to check $obj agains.
+	 */
+	public static function assertInstanceOf(string $var_name, object $obj, string $cls): void
+	{
+		if (!($obj instanceof $cls)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be instance of "%s".', $var_name, $cls)
+			);
+		}
+	}
 }

src/Contracts/ConverterContract.php

Indentation +10 added lines, -10 removed lines

@@ -15,14 +15,14 @@
  */
 interface ConverterContract
 {
-    /**
-     * Returns array representation of the object.
-     *
-     * @param object $obj    Object to be converted
-     * @param array  $config Converter config array to be used for this object (based on exact class
-     *                       name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert(object $obj, array $config): array;
+	/**
+	 * Returns array representation of the object.
+	 *
+	 * @param object $obj    Object to be converted
+	 * @param array  $config Converter config array to be used for this object (based on exact class
+	 *                       name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert(object $obj, array $config): array;
 }

src/Converters/ToArrayConverter.php

Indentation +14 added lines, -14 removed lines

@@ -19,19 +19,19 @@
 
 final class ToArrayConverter implements ConverterContract
 {
-    /**
-     * Returns array representation of the object.
-     *
-     * @param object $obj    Object to be converted
-     * @param array  $config Converter config array to be used for this object (based on exact class
-     *                       name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
-    {
-        Validator::assertIsObject('obj', $obj);
+	/**
+	 * Returns array representation of the object.
+	 *
+	 * @param object $obj    Object to be converted
+	 * @param array  $config Converter config array to be used for this object (based on exact class
+	 *                       name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
+	{
+		Validator::assertIsObject('obj', $obj);
 
-        return $obj->toArray();
-    }
+		return $obj->toArray();
+	}
 }