MarcinOrlowski / laravel-api-response-builder

src/lang/en/builder.php

Indentation +48 added lines, -48 removed lines

@@ -10,56 +10,56 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Error #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Error #:api_code',
 
-    // Used by Exception Handler Helper (when used)
-    'uncaught_exception'       => 'Uncaught exception: :message',
-    'http_exception'           => 'HTTP exception: :message',
+	// Used by Exception Handler Helper (when used)
+	'uncaught_exception'       => 'Uncaught exception: :message',
+	'http_exception'           => 'HTTP exception: :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'                 => 'Unauthorized',
-    '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'                 => 'Unprocessable Entity',
-    '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',
+	// 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'                 => 'Unauthorized',
+	'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'                 => 'Unprocessable Entity',
+	'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',
+	'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/lang/pl/builder.php

Indentation +48 added lines, -48 removed lines

@@ -10,55 +10,55 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Błąd #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Błąd #:api_code',
 
-    // Used by Exception Handler Helper (when used)
-    'uncaught_exception'       => 'Nieprzechwycony wyjątek: :message',
-    'http_exception'           => 'Wyjątek HTTP: :message',
+	// Used by Exception Handler Helper (when used)
+	'uncaught_exception'       => 'Nieprzechwycony wyjątek: :message',
+	'http_exception'           => 'Wyjątek 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'                 => 'Unauthorized',
-    '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'                 => 'Unprocessable Entity',
-    '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',
+	// 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'                 => 'Unauthorized',
+	'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'                 => 'Unprocessable Entity',
+	'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',
+	'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/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[ ResponseBuilder::KEY_DEFAULT ];
+			$result = $config[ResponseBuilder::KEY_DEFAULT];
 		}
 
 		// Some defaults to fall back to if not set in user config.

src/ResponseBuilder.php

Indentation +12 added lines, -12 removed lines

@@ -84,7 +84,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)
@@ -112,7 +112,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)
@@ -161,7 +161,7 @@ 
 	public function withHttpCode(int $http_code = null): self
 	{
 		Validator::assertIsType('http_code', $http_code, [Validator::TYPE_INTEGER,
-		                                                  Validator::TYPE_NULL]);
+														  Validator::TYPE_NULL]);
 		$this->http_code = $http_code;
 
 		return $this;
@@ -175,8 +175,8 @@ 
 	public function withData($data = null): self
 	{
 		Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
-		                                        Validator::TYPE_OBJECT,
-		                                        Validator::TYPE_NULL]);
+												Validator::TYPE_OBJECT,
+												Validator::TYPE_NULL]);
 		$this->data = $data;
 
 		return $this;
@@ -190,7 +190,7 @@ 
 	public function withJsonOptions(int $json_opts = null): self
 	{
 		Validator::assertIsType('json_opts', $json_opts, [Validator::TYPE_INTEGER,
-		                                                  Validator::TYPE_NULL]);
+														  Validator::TYPE_NULL]);
 		$this->json_opts = $json_opts;
 
 		return $this;
@@ -204,7 +204,7 @@ 
 	public function withDebugData(array $debug_data = null): self
 	{
 		Validator::assertIsType('$debug_data', $debug_data, [Validator::TYPE_ARRAY,
-		                                                     Validator::TYPE_NULL]);
+															 Validator::TYPE_NULL]);
 		$this->debug_data = $debug_data;
 
 		return $this;
@@ -218,7 +218,7 @@ 
 	public function withMessage(string $msg = null): self
 	{
 		Validator::assertIsType('message', $msg, [Validator::TYPE_STRING,
-		                                          Validator::TYPE_NULL]);
+												  Validator::TYPE_NULL]);
 		$this->message = $msg;
 
 		return $this;
@@ -305,8 +305,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 ? ResponseBuilder::DEFAULT_HTTP_CODE_OK : ResponseBuilder::DEFAULT_HTTP_CODE_ERROR);
@@ -345,8 +345,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

@@ -374,7 +374,7 @@
 
 		if ($debug_data !== null) {
 			$debug_key = Config::get(ResponseBuilder::CONF_KEY_DEBUG_DEBUG_KEY, ResponseBuilder::KEY_DEBUG);
-			$response[ $debug_key ] = $debug_data;
+			$response[$debug_key] = $debug_data;
 		}
 
 		return $response;

src/Validator.php

Indentation +173 added lines, -173 removed lines

@@ -15,186 +15,186 @@
  */
 class Validator
 {
-    /** @var string */
-    public const TYPE_STRING = 'string';
+	/** @var string */
+	public const TYPE_STRING = 'string';
 
-    /** @var string */
-    public const TYPE_INTEGER = 'integer';
+	/** @var string */
+	public const TYPE_INTEGER = 'integer';
 
-    /** @var string */
-    public const TYPE_BOOL = 'boolean';
+	/** @var string */
+	public const TYPE_BOOL = 'boolean';
 
-    /** @var string */
-    public const TYPE_ARRAY = 'array';
+	/** @var string */
+	public const TYPE_ARRAY = 'array';
 
-    /** @var string */
-    public const TYPE_OBJECT = 'object';
+	/** @var string */
+	public const TYPE_OBJECT = 'object';
 
 	/** @var string */
 	public const TYPE_DOUBLE = 'double';
 
 	/** @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, true)) {
-            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)
-            );
-        }
-    }
+	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, true)) {
+			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)
+			);
+		}
+	}
 }

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/Converter.php

Indentation +217 added lines, -217 removed lines

@@ -23,27 +23,27 @@ 
  */
 class Converter
 {
-    /** @var array */
-    protected $classes = [];
+	/** @var array */
+	protected $classes = [];
 
-    /** @var array */
-    protected $primitives = [];
+	/** @var array */
+	protected $primitives = [];
 
-    /** @var bool */
-    protected $debug_enabled = false;
+	/** @var bool */
+	protected $debug_enabled = false;
 
-    /**
-     * Converter constructor.
-     *
-     * @throws \RuntimeException
-     */
-    public function __construct()
-    {
-        $this->classes = static::getClassesMapping() ?? [];
-        $this->primitives = static::getPrimitivesMapping() ?? [];
+	/**
+	 * Converter constructor.
+	 *
+	 * @throws \RuntimeException
+	 */
+	public function __construct()
+	{
+		$this->classes = static::getClassesMapping() ?? [];
+		$this->primitives = static::getPrimitivesMapping() ?? [];
 
-	    $this->debug_enabled = Config::get(ResponseBuilder::CONF_KEY_CONVERTER_DEBUG_KEY, false);
-    }
+		$this->debug_enabled = Config::get(ResponseBuilder::CONF_KEY_CONVERTER_DEBUG_KEY, false);
+	}
 
 	/**
 	 * Returns "converter/primitives" entry for given primitive object or throws exception if no config found.
@@ -56,116 +56,116 @@ 
 	 *
 	 * @throws \InvalidArgumentException
 	 */
-    protected function getPrimitiveMappingConfigOrThrow($data): array
-    {
-	    $result = null;
-
-	    $type = \gettype($data);
-	    $result = $this->primitives[ $type ] ?? null;
-	    if ($result === null) {
-		    throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" primitive.', $type));
-	    }
-
-	    if ($this->debug_enabled) {
-		    Log::debug(__CLASS__ . ": Converting primitive type of '{$type}' to data node '{$result[ResponseBuilder::KEY_KEY]}'.");
-	    }
-
-	    return $result;
-    }
-
-    /**
-     * Returns "converter/map" mapping configured for given $data object class or throws exception if not found.
-     * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured.
-     * Throws \InvalidArgumentException if No data conversion mapping configured for given class.
-     *
-     * @param object $data Object to get config for.
-     *
-     * @return array
-     *
-     * @throws \InvalidArgumentException
-     */
-    protected function getClassMappingConfigOrThrow(object $data): array
-    {
-        $result = null;
-        $debug_result = '';
-
-        // check for exact class name match...
-        $cls = \get_class($data);
-        if (\is_string($cls)) {
-	        if (\array_key_exists($cls, $this->classes)) {
-		        $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) {
-			        if ($data instanceof $class_name) {
-				        $result = $this->classes[ $class_name ];
-				        $debug_result = "subclass of {$class_name}";
-				        break;
-			        }
-		        }
-	        }
-        }
-
-        if ($result === null) {
-            throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls));
-        }
-
-        if ($this->debug_enabled) {
+	protected function getPrimitiveMappingConfigOrThrow($data): array
+	{
+		$result = null;
+
+		$type = \gettype($data);
+		$result = $this->primitives[ $type ] ?? null;
+		if ($result === null) {
+			throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" primitive.', $type));
+		}
+
+		if ($this->debug_enabled) {
+			Log::debug(__CLASS__ . ": Converting primitive type of '{$type}' to data node '{$result[ResponseBuilder::KEY_KEY]}'.");
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Returns "converter/map" mapping configured for given $data object class or throws exception if not found.
+	 * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured.
+	 * Throws \InvalidArgumentException if No data conversion mapping configured for given class.
+	 *
+	 * @param object $data Object to get config for.
+	 *
+	 * @return array
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	protected function getClassMappingConfigOrThrow(object $data): array
+	{
+		$result = null;
+		$debug_result = '';
+
+		// check for exact class name match...
+		$cls = \get_class($data);
+		if (\is_string($cls)) {
+			if (\array_key_exists($cls, $this->classes)) {
+				$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) {
+					if ($data instanceof $class_name) {
+						$result = $this->classes[ $class_name ];
+						$debug_result = "subclass of {$class_name}";
+						break;
+					}
+				}
+			}
+		}
+
+		if ($result === null) {
+			throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls));
+		}
+
+		if ($this->debug_enabled) {
 			Log::debug(__CLASS__ . ": Converting {$cls} using {$result[ResponseBuilder::KEY_HANDLER]} because: {$debug_result}.");
-        }
-
-	    return $result;
-    }
-
-    /**
-     * Main entry for data conversion
-     *
-     * @param object|array|null $data
-     *
-     * @return mixed|null
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function convert($data = null): ?array
-    {
-        if ($data === null) {
-            return null;
-        }
-
-        $result = null;
-
-	    Validator::assertIsType('data', $data, [
-		    Validator::TYPE_ARRAY,
-		    Validator::TYPE_BOOL,
-		    Validator::TYPE_DOUBLE,
-		    Validator::TYPE_INTEGER,
-		    Validator::TYPE_STRING,
-		    Validator::TYPE_OBJECT,
-	    ]);
-
-	    if ($result === null && \is_object($data)) {
-		    $cfg = $this->getClassMappingConfigOrThrow($data);
-		    $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
-		    $result = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
-	    }
-
-	    if ($result === null && \is_array($data)) {
-	        $cfg = $this->getPrimitiveMappingConfigOrThrow($data);
-
-	        if ($this->hasNonNumericKeys($data)){
-		        $result = $this->convertArray($data);
-	        } else {
-		        $result = [$cfg[ ResponseBuilder::KEY_KEY ] => $this->convertArray($data)];
-	        }
-        }
-
-	    if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ ResponseBuilder::KEY_KEY ] => $data];
-	    }
-
-	    return $result;
-    }
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Main entry for data conversion
+	 *
+	 * @param object|array|null $data
+	 *
+	 * @return mixed|null
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public function convert($data = null): ?array
+	{
+		if ($data === null) {
+			return null;
+		}
+
+		$result = null;
+
+		Validator::assertIsType('data', $data, [
+			Validator::TYPE_ARRAY,
+			Validator::TYPE_BOOL,
+			Validator::TYPE_DOUBLE,
+			Validator::TYPE_INTEGER,
+			Validator::TYPE_STRING,
+			Validator::TYPE_OBJECT,
+		]);
+
+		if ($result === null && \is_object($data)) {
+			$cfg = $this->getClassMappingConfigOrThrow($data);
+			$worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+			$result = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
+		}
+
+		if ($result === null && \is_array($data)) {
+			$cfg = $this->getPrimitiveMappingConfigOrThrow($data);
+
+			if ($this->hasNonNumericKeys($data)){
+				$result = $this->convertArray($data);
+			} else {
+				$result = [$cfg[ ResponseBuilder::KEY_KEY ] => $this->convertArray($data)];
+			}
+		}
+
+		if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
+			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[ ResponseBuilder::KEY_KEY ] => $data];
+		}
+
+		return $result;
+	}
 
 	/**
 	 * Checks if given array uses custom (non numeric) keys.
@@ -174,97 +174,97 @@ 
 	 *
 	 * @return bool
 	 */
-    protected function hasNonNumericKeys(array $data): bool
-    {
-	    foreach (\array_keys($data) as $key) {
-	    	if (!\is_int($key)) {
-	    		return true;
-		    }
-    	}
-
-	    return false;
-    }
-
-    /**
-     * Recursively walks $data array and converts all known objects if found. Note
-     * $data array is passed by reference so source $data array may be modified.
-     *
-     * @param array $data array to recursively convert known elements of
-     *
-     * @return array
-     *
-     * @throws \RuntimeException
-     */
-    protected function convertArray(array $data): array
-    {
-        // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then
-        // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON
-        // array. But you can't mix these two as the final JSON would not produce predictable results.
-        $string_keys_cnt = 0;
-        $int_keys_cnt = 0;
-        foreach ($data as $key => $val) {
-            if (\is_int($key)) {
-                $int_keys_cnt++;
-            } else {
-                $string_keys_cnt++;
-            }
-
-            if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) {
-                throw new \RuntimeException(
-                    'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
-                    'Arrays with mixed keys are not supported by design.');
-            }
-        }
-
-        foreach ($data as $key => $val) {
-            if (\is_array($val)) {
-                $data[ $key ] = $this->convertArray($val);
-            } elseif (\is_object($val)) {
-                $cfg = $this->getClassMappingConfigOrThrow($val);
-                $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
-                $converted_data = $worker->convert($val, $cfg);
-                $data[ $key ] = $converted_data;
-            }
-        }
-
-        return $data;
-    }
-
-    /**
-     * Reads and validates "converter/map" config mapping
-     *
-     * @return array Classes mapping as specified in configuration or empty array if configuration found
-     *
-     * @throws \RuntimeException if config mapping is technically invalid (i.e. not array etc).
-     */
-    protected static function getClassesMapping(): array
-    {
-        $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER_CLASSES) ?? [];
-
-	    if (!\is_array($classes)) {
-		    throw new \RuntimeException(
-			    \sprintf('CONFIG: "%s" mapping must be an array (%s given)', ResponseBuilder::CONF_KEY_CONVERTER_CLASSES, \gettype($classes)));
-	    }
-
-	    if (!empty($classes)) {
-		    $mandatory_keys = [
-			    ResponseBuilder::KEY_HANDLER,
-			    ResponseBuilder::KEY_KEY,
-		    ];
-		    foreach ($classes as $class_name => $class_config) {
-			    if (!\is_array($class_config)) {
-				    throw new \InvalidArgumentException(sprintf("CONFIG: Config for '{$class_name}' class must be an array (%s given).", \gettype($class_config)));
-			    }
-			    foreach ($mandatory_keys as $key_name) {
-				    if (!\array_key_exists($key_name, $class_config)) {
-					    throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping");
-				    }
-			    }
-		    }
-	    }
-
-        return $classes;
-    }
+	protected function hasNonNumericKeys(array $data): bool
+	{
+		foreach (\array_keys($data) as $key) {
+			if (!\is_int($key)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Recursively walks $data array and converts all known objects if found. Note
+	 * $data array is passed by reference so source $data array may be modified.
+	 *
+	 * @param array $data array to recursively convert known elements of
+	 *
+	 * @return array
+	 *
+	 * @throws \RuntimeException
+	 */
+	protected function convertArray(array $data): array
+	{
+		// This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then
+		// be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON
+		// array. But you can't mix these two as the final JSON would not produce predictable results.
+		$string_keys_cnt = 0;
+		$int_keys_cnt = 0;
+		foreach ($data as $key => $val) {
+			if (\is_int($key)) {
+				$int_keys_cnt++;
+			} else {
+				$string_keys_cnt++;
+			}
+
+			if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) {
+				throw new \RuntimeException(
+					'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
+					'Arrays with mixed keys are not supported by design.');
+			}
+		}
+
+		foreach ($data as $key => $val) {
+			if (\is_array($val)) {
+				$data[ $key ] = $this->convertArray($val);
+			} elseif (\is_object($val)) {
+				$cfg = $this->getClassMappingConfigOrThrow($val);
+				$worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+				$converted_data = $worker->convert($val, $cfg);
+				$data[ $key ] = $converted_data;
+			}
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Reads and validates "converter/map" config mapping
+	 *
+	 * @return array Classes mapping as specified in configuration or empty array if configuration found
+	 *
+	 * @throws \RuntimeException if config mapping is technically invalid (i.e. not array etc).
+	 */
+	protected static function getClassesMapping(): array
+	{
+		$classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER_CLASSES) ?? [];
+
+		if (!\is_array($classes)) {
+			throw new \RuntimeException(
+				\sprintf('CONFIG: "%s" mapping must be an array (%s given)', ResponseBuilder::CONF_KEY_CONVERTER_CLASSES, \gettype($classes)));
+		}
+
+		if (!empty($classes)) {
+			$mandatory_keys = [
+				ResponseBuilder::KEY_HANDLER,
+				ResponseBuilder::KEY_KEY,
+			];
+			foreach ($classes as $class_name => $class_config) {
+				if (!\is_array($class_config)) {
+					throw new \InvalidArgumentException(sprintf("CONFIG: Config for '{$class_name}' class must be an array (%s given).", \gettype($class_config)));
+				}
+				foreach ($mandatory_keys as $key_name) {
+					if (!\array_key_exists($key_name, $class_config)) {
+						throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping");
+					}
+				}
+			}
+		}
+
+		return $classes;
+	}
 
 	/**
 	 * Reads and validates "converter/primitives" config mapping

Spacing +12 added lines, -12 removed lines

@@ -61,7 +61,7 @@ 
 	    $result = null;
 
 	    $type = \gettype($data);
-	    $result = $this->primitives[ $type ] ?? null;
+	    $result = $this->primitives[$type] ?? null;
 	    if ($result === null) {
 		    throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" primitive.', $type));
 	    }
@@ -93,13 +93,13 @@ 
         $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) {
 			        if ($data instanceof $class_name) {
-				        $result = $this->classes[ $class_name ];
+				        $result = $this->classes[$class_name];
 				        $debug_result = "subclass of {$class_name}";
 				        break;
 			        }
@@ -146,22 +146,22 @@ 
 
 	    if ($result === null && \is_object($data)) {
 		    $cfg = $this->getClassMappingConfigOrThrow($data);
-		    $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
-		    $result = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
+		    $worker = new $cfg[ResponseBuilder::KEY_HANDLER]();
+		    $result = [$cfg[ResponseBuilder::KEY_KEY] => $worker->convert($data, $cfg)];
 	    }
 
 	    if ($result === null && \is_array($data)) {
 	        $cfg = $this->getPrimitiveMappingConfigOrThrow($data);
 
-	        if ($this->hasNonNumericKeys($data)){
+	        if ($this->hasNonNumericKeys($data)) {
 		        $result = $this->convertArray($data);
 	        } else {
-		        $result = [$cfg[ ResponseBuilder::KEY_KEY ] => $this->convertArray($data)];
+		        $result = [$cfg[ResponseBuilder::KEY_KEY] => $this->convertArray($data)];
 	        }
         }
 
-	    if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ ResponseBuilder::KEY_KEY ] => $data];
+	    if (\is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
+		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ResponseBuilder::KEY_KEY] => $data];
 	    }
 
 	    return $result;
@@ -218,12 +218,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[ ResponseBuilder::KEY_HANDLER ]();
+                $worker = new $cfg[ResponseBuilder::KEY_HANDLER]();
                 $converted_data = $worker->convert($val, $cfg);
-                $data[ $key ] = $converted_data;
+                $data[$key] = $converted_data;
             }
         }