MarcinOrlowski / laravel-api-response-builder

src/lang/fa/builder.php

Indentation +49 added lines, -49 removed lines

@@ -10,56 +10,56 @@
  */
 return [
 
-    'ok'                       => 'موفق',
-    'no_error_message'         => 'خطای شماره :api_code',
+	'ok'                       => 'موفق',
+	'no_error_message'         => 'خطای شماره :api_code',
 
-    // can be used by Exception Handler (if enabled)
-    'uncaught_exception'       => 'استثناء مدیریت نشده :message',
-    // we talking API call here, hence we have http_not_found
-    'http_exception'           => 'استثناء HTTP :message',
+	// can be used by Exception Handler (if enabled)
+	'uncaught_exception'       => 'استثناء مدیریت نشده :message',
+	// we talking API call here, hence we have http_not_found
+	'http_exception'           => 'استثناء HTTP :message',
 
-    // HttpException handler (added in 6.4.0)
-    // Error messages for HttpException caught w/o custom messages
-    // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-    'http_400'                 => 'Bad Request',
-    'http_401'                 => 'اجازه دسترسی ندارید',
-    'http_402'                 => 'Payment Required',
-    'http_403'                 => 'Forbidden',
-    'http_404'                 => 'Not Found',
-    'http_405'                 => 'Method Not Allowed',
-    'http_406'                 => 'Not Acceptable',
-    'http_407'                 => 'Proxy Authentication Required',
-    'http_408'                 => 'Request Timeout',
-    'http_409'                 => 'Conflict',
-    'http_410'                 => 'Gone',
-    'http_411'                 => 'Length Required',
-    'http_412'                 => 'Precondition Failed',
-    'http_413'                 => 'Payload Too Large',
-    'http_414'                 => 'URI Too Long',
-    'http_415'                 => 'Unsupported Media Type',
-    'http_416'                 => 'Range Not Satisfiable',
-    'http_417'                 => 'Expectation Failed',
-    'http_421'                 => 'Misdirected Request',
-    'http_422'                 => 'داده معتبر نیست',
-    'http_423'                 => 'Locked',
-    'http_424'                 => 'Failed Dependency',
-    'http_425'                 => 'Too Early',
-    'http_426'                 => 'Upgrade Required',
-    'http_428'                 => 'Precondition Required',
-    'http_429'                 => 'Too Many Requests',
-    'http_431'                 => 'Request Header Fields Too Large',
-    'http_451'                 => 'Unavailable For Legal Reasons',
-    'http_500'                 => 'Internal Server Error',
-    'http_501'                 => 'Not Implemented',
-    'http_502'                 => 'Bad Gateway',
-    'http_503'                 => 'Service Unavailable',
-    'http_504'                 => 'Gateway Timeout',
-    'http_505'                 => 'HTTP Version Not Supported',
-    'http_506'                 => 'Variant Also Negotiates',
-    'http_507'                 => 'Insufficient Storage',
-    'http_508'                 => 'Loop Detected',
-    'http_509'                 => 'Unassigned',
-    'http_510'                 => 'Not Extended',
-    'http_511'                 => 'Network Authentication Required',
+	// HttpException handler (added in 6.4.0)
+	// Error messages for HttpException caught w/o custom messages
+	// https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+	'http_400'                 => 'Bad Request',
+	'http_401'                 => 'اجازه دسترسی ندارید',
+	'http_402'                 => 'Payment Required',
+	'http_403'                 => 'Forbidden',
+	'http_404'                 => 'Not Found',
+	'http_405'                 => 'Method Not Allowed',
+	'http_406'                 => 'Not Acceptable',
+	'http_407'                 => 'Proxy Authentication Required',
+	'http_408'                 => 'Request Timeout',
+	'http_409'                 => 'Conflict',
+	'http_410'                 => 'Gone',
+	'http_411'                 => 'Length Required',
+	'http_412'                 => 'Precondition Failed',
+	'http_413'                 => 'Payload Too Large',
+	'http_414'                 => 'URI Too Long',
+	'http_415'                 => 'Unsupported Media Type',
+	'http_416'                 => 'Range Not Satisfiable',
+	'http_417'                 => 'Expectation Failed',
+	'http_421'                 => 'Misdirected Request',
+	'http_422'                 => 'داده معتبر نیست',
+	'http_423'                 => 'Locked',
+	'http_424'                 => 'Failed Dependency',
+	'http_425'                 => 'Too Early',
+	'http_426'                 => 'Upgrade Required',
+	'http_428'                 => 'Precondition Required',
+	'http_429'                 => 'Too Many Requests',
+	'http_431'                 => 'Request Header Fields Too Large',
+	'http_451'                 => 'Unavailable For Legal Reasons',
+	'http_500'                 => 'Internal Server Error',
+	'http_501'                 => 'Not Implemented',
+	'http_502'                 => 'Bad Gateway',
+	'http_503'                 => 'Service Unavailable',
+	'http_504'                 => 'Gateway Timeout',
+	'http_505'                 => 'HTTP Version Not Supported',
+	'http_506'                 => 'Variant Also Negotiates',
+	'http_507'                 => 'Insufficient Storage',
+	'http_508'                 => 'Loop Detected',
+	'http_509'                 => 'Unassigned',
+	'http_510'                 => 'Not Extended',
+	'http_511'                 => 'Network Authentication Required',
 ];
 

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($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($obj, array $config): array;
 }

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}", ResponseBuilder::CONF_CONFIG);
-        }
-    }
+	/**
+	 * Register bindings in the container.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		foreach ($this->config_files as $file) {
+			$this->mergeConfigFrom(__DIR__ . "/../config/{$file}", ResponseBuilder::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/Util.php

Indentation +50 added lines, -50 removed lines

@@ -15,58 +15,58 @@
  */
 final class Util
 {
-    /**
-     * Merges the configs together and takes multi-dimensional arrays into account.
-     * Support for multi-dimensional config array. Built-in config merge only supports flat arrays.
-     * Throws \RuntimeException if arrays stucture causes type conflics (i.e. you want to merge
-     * array with int).
-     *
-     * @param array $original Array to merge other array into. Usually default values to overwrite.
-     * @param array $merging  Array with items to be merged into $original, overriding (primitives) or merging
-     *                        (arrays) entries in destination array.
-     *
-     * @return array
-     *
-     * @throws \RuntimeException
-     */
-    public static function mergeConfig(array $original, array $merging): array
-    {
-        $array = $original;
-        foreach ($merging as $m_key => $m_val) {
-            if (\array_key_exists($m_key, $original)) {
-                $orig_type = \gettype($original[ $m_key ]);
-                $m_type = \gettype($m_val);
-                if ($orig_type !== $m_type) {
-                    throw new \RuntimeException(
-                        "Incompatible types. Cannot merge {$m_type} into {$orig_type} (key '{$m_key}').");
-                }
+	/**
+	 * Merges the configs together and takes multi-dimensional arrays into account.
+	 * Support for multi-dimensional config array. Built-in config merge only supports flat arrays.
+	 * Throws \RuntimeException if arrays stucture causes type conflics (i.e. you want to merge
+	 * array with int).
+	 *
+	 * @param array $original Array to merge other array into. Usually default values to overwrite.
+	 * @param array $merging  Array with items to be merged into $original, overriding (primitives) or merging
+	 *                        (arrays) entries in destination array.
+	 *
+	 * @return array
+	 *
+	 * @throws \RuntimeException
+	 */
+	public static function mergeConfig(array $original, array $merging): array
+	{
+		$array = $original;
+		foreach ($merging as $m_key => $m_val) {
+			if (\array_key_exists($m_key, $original)) {
+				$orig_type = \gettype($original[ $m_key ]);
+				$m_type = \gettype($m_val);
+				if ($orig_type !== $m_type) {
+					throw new \RuntimeException(
+						"Incompatible types. Cannot merge {$m_type} into {$orig_type} (key '{$m_key}').");
+				}
 
-                if (\is_array($merging[ $m_key ])) {
-                    $array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
-                } else {
-                    $array[ $m_key ] = $m_val;
-                }
-            } else {
-                $array[ $m_key ] = $m_val;
-            }
-        }
+				if (\is_array($merging[ $m_key ])) {
+					$array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
+				} else {
+					$array[ $m_key ] = $m_val;
+				}
+			} else {
+				$array[ $m_key ] = $m_val;
+			}
+		}
 
-        return $array;
-    }
+		return $array;
+	}
 
-    /**
-     * Sorts array (in place) by value, assuming value is an array and contains `pri` key with integer
-     * (positive/negative) value which is used for sorting higher -> lower priority.
-     *
-     * @param array &$array
-     */
-    public static function sortArrayByPri(array &$array): void
-    {
-        uasort($array, static function(array $array_a, array $array_b) {
-            $pri_a = $array_a['pri'] ?? 0;
-            $pri_b = $array_b['pri'] ?? 0;
+	/**
+	 * Sorts array (in place) by value, assuming value is an array and contains `pri` key with integer
+	 * (positive/negative) value which is used for sorting higher -> lower priority.
+	 *
+	 * @param array &$array
+	 */
+	public static function sortArrayByPri(array &$array): void
+	{
+		uasort($array, static function(array $array_a, array $array_b) {
+			$pri_a = $array_a['pri'] ?? 0;
+			$pri_b = $array_b['pri'] ?? 0;
 
-            return $pri_b <=> $pri_a;
-        });
-    }
+			return $pri_b <=> $pri_a;
+		});
+	}
 }

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($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($obj, /** @scrutinizer ignore-unused */ array $config): array
+	{
+		Validator::assertIsObject('obj', $obj);
 
-        return $obj->toArray();
-    }
+		return $obj->toArray();
+	}
 }

src/Converters/ArrayableConverter.php

Indentation +14 added lines, -14 removed lines

@@ -19,19 +19,19 @@
 
 final class ArrayableConverter implements ConverterContract
 {
-    /**
-     * Returns array representation of the object implementing Arrayable interface
-     *
-     * @param Arrayable $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($obj, /** @scrutinizer ignore-unused */ array $config): array
-    {
-        Validator::assertInstanceOf('obj', $obj, Arrayable::class);
+	/**
+	 * Returns array representation of the object implementing Arrayable interface
+	 *
+	 * @param Arrayable $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($obj, /** @scrutinizer ignore-unused */ array $config): array
+	{
+		Validator::assertInstanceOf('obj', $obj, Arrayable::class);
 
-        return $obj->toArray();
-    }
+		return $obj->toArray();
+	}
 }

src/BaseApiCodes.php

Indentation +167 added lines, -167 removed lines

@@ -21,172 +21,172 @@
  */
 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;
-
-    /**
-     * Returns base code mapping array
-     *
-     * @return array
-     */
-    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
-     *
-     * @return int valid API code in current range
-     */
-    public static function OK(): int
-    {
-        return static::getCodeForInternalOffset(static::OK_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code NO_ERROR_MESSAGE
-     *
-     * @return int valid API code in current range
-     */
-    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
-     *
-     * @return int valid API code in current range
-     */
-    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
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_HTTP_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_UNCAUGHT_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_AUTHENTICATION_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_VALIDATION_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    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
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
-    }
+	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
+	 *
+	 * @return array
+	 */
+	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
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function OK(): int
+	{
+		return static::getCodeForInternalOffset(static::OK_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code NO_ERROR_MESSAGE
+	 *
+	 * @return int valid API code in current range
+	 */
+	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
+	 *
+	 * @return int valid API code in current range
+	 */
+	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
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_HTTP_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_UNCAUGHT_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_AUTHENTICATION_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_VALIDATION_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	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
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
+	}
 
 }

src/Validator.php

Indentation +179 added lines, -179 removed lines

@@ -15,183 +15,183 @@
  */
 class Validator
 {
-    /** @var string */
-    public const TYPE_STRING = 'string';
-
-    /** @var string */
-    public const TYPE_INTEGER = 'integer';
-
-    /** @var string */
-    public const TYPE_BOOL = 'boolean';
-
-    /** @var string */
-    public const TYPE_ARRAY = 'array';
-
-    /** @var string */
-    public const TYPE_OBJECT = 'object';
-
-    /** @var string */
-    public const TYPE_NULL = 'NULL';
-
-    /**
-     * Checks if given $val is of type boolean
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsBool(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_BOOL]);
-    }
-
-    /**
-     * Checks if given $val is of type integer
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsInt(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_INTEGER]);
-    }
-
-    /**
-     * Checks if given $val is of type array
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsArray(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_ARRAY]);
-    }
-
-    /**
-     * Checks if given $val is an object
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsObject(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::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  $var  Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsString(string $name, $var): void
-    {
-        self::assertIsType($name, $var, [self::TYPE_STRING]);
-    }
-
-    /**
-     * @param string $name Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $var  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 $name, $var, int $min, int $max): void
-    {
-        self::assertIsInt($name, $var);
-
-        if ($min > $max) {
-            throw new \RuntimeException(
-                \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name));
-        }
-
-        if (($min > $var) || ($var > $max)) {
-            throw new \InvalidArgumentException(
-                \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max));
-        }
-    }
-
-    /**
-     * Checks if $item (of name $key) is of type that is include in $allowed_types.
-     *
-     * @param string $name          Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $var           Variable to be asserted.
-     * @param array  $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER]
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsType(string $name, $var, array $allowed_types): void
-    {
-        $type = \gettype($var);
-        if (!\in_array($type, $allowed_types)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be one of allowed types: %s (%s given)',
-                    $name, implode(', ', $allowed_types), \gettype($var))
-            );
-        }
-    }
-
-    /**
-     * 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,
-            ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::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 $obj is instance of $cls.
-     *
-     * @param string $name
-     * @param object $obj
-     * @param string $cls
-     */
-    public static function assertInstanceOf(string $name, object $obj, string $cls): void
-    {
-        if (!($obj instanceof $cls)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be instance of "%s".', $name, $cls)
-            );
-        }
-    }
+	/** @var string */
+	public const TYPE_STRING = 'string';
+
+	/** @var string */
+	public const TYPE_INTEGER = 'integer';
+
+	/** @var string */
+	public const TYPE_BOOL = 'boolean';
+
+	/** @var string */
+	public const TYPE_ARRAY = 'array';
+
+	/** @var string */
+	public const TYPE_OBJECT = 'object';
+
+	/** @var string */
+	public const TYPE_NULL = 'NULL';
+
+	/**
+	 * Checks if given $val is of type boolean
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsBool(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_BOOL]);
+	}
+
+	/**
+	 * Checks if given $val is of type integer
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsInt(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_INTEGER]);
+	}
+
+	/**
+	 * Checks if given $val is of type array
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsArray(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_ARRAY]);
+	}
+
+	/**
+	 * Checks if given $val is an object
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsObject(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::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  $var  Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsString(string $name, $var): void
+	{
+		self::assertIsType($name, $var, [self::TYPE_STRING]);
+	}
+
+	/**
+	 * @param string $name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var  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 $name, $var, int $min, int $max): void
+	{
+		self::assertIsInt($name, $var);
+
+		if ($min > $max) {
+			throw new \RuntimeException(
+				\sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name));
+		}
+
+		if (($min > $var) || ($var > $max)) {
+			throw new \InvalidArgumentException(
+				\sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max));
+		}
+	}
+
+	/**
+	 * Checks if $item (of name $key) is of type that is include in $allowed_types.
+	 *
+	 * @param string $name          Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var           Variable to be asserted.
+	 * @param array  $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER]
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsType(string $name, $var, array $allowed_types): void
+	{
+		$type = \gettype($var);
+		if (!\in_array($type, $allowed_types)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be one of allowed types: %s (%s given)',
+					$name, implode(', ', $allowed_types), \gettype($var))
+			);
+		}
+	}
+
+	/**
+	 * 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,
+			ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::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 $obj is instance of $cls.
+	 *
+	 * @param string $name
+	 * @param object $obj
+	 * @param string $cls
+	 */
+	public static function assertInstanceOf(string $name, object $obj, string $cls): void
+	{
+		if (!($obj instanceof $cls)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be instance of "%s".', $name, $cls)
+			);
+		}
+	}
 }

src/ExceptionHandlerHelper.php

Indentation +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 	 * @return \Symfony\Component\HttpFoundation\Response
 	 */
 	protected static function processException(\Exception $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;
@@ -141,7 +141,7 @@ 
 	 * @return HttpResponse
 	 */
 	protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
-	                                                                     AuthException $exception): HttpResponse
+																		 AuthException $exception): HttpResponse
 	{
 		$cfg = self::getExceptionHandlerConfig();
 
@@ -162,7 +162,7 @@ 
 	 * @return HttpResponse
 	 */
 	protected static function error(Exception $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;