MarcinOrlowski / laravel-api-response-builder

src/ResponseBuilder.php

Indentation +330 added lines, -330 removed lines

@@ -25,337 +25,337 @@
 class ResponseBuilder extends ResponseBuilderBase
 {
 
-    /** @var bool */
-    protected $success = false;
-
-    /** @var int */
-    protected $api_code;
-
-    /** @var int|null */
-    protected $http_code = null;
-
-    /** @var mixed */
-    protected $data = null;
-
-    /** @var string */
-    protected $message = null;
-
-    /** @var array */
-    protected $placeholders = [];
-
-    /** @var int|null */
-    protected $json_opts = null;
-
-    /** @var array */
-    protected $debug_data = [];
-
-    /** @var array */
-    protected $http_headers = [];
-
-    // -----------------------------------------------------------------------------------------------------------
-
-    /**
-     * Private constructor. Use asSuccess() and asError() static methods to obtain instance of Builder.
-     *
-     * @param bool $success
-     * @param int  $api_code
-     */
-    protected function __construct(bool $success, int $api_code)
-    {
-        $this->success = $success;
-        $this->api_code = $api_code;
-    }
-
-    // -----------------------------------------------------------------------------------------------------------
-
-    /**
-     * Returns success
-     *
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_OK.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     */
-    public static function success($data = null, $api_code = null, array $placeholders = null,
-                                   int $http_code = null, int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asSuccess($api_code)
-            ->withData($data)
-            ->withPlaceholders($placeholders)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
-
-    /**
-     * Builds error Response object. Supports optional arguments passed to Lang::get() if associated error
-     * message uses placeholders as well as return data payload
-     *
-     * @param integer           $api_code      Your API code to be returned with the response object.
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_ERROR.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     */
-    public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
-                                 int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withPlaceholders($placeholders)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/** @var bool */
+	protected $success = false;
+
+	/** @var int */
+	protected $api_code;
+
+	/** @var int|null */
+	protected $http_code = null;
+
+	/** @var mixed */
+	protected $data = null;
+
+	/** @var string */
+	protected $message = null;
+
+	/** @var array */
+	protected $placeholders = [];
+
+	/** @var int|null */
+	protected $json_opts = null;
+
+	/** @var array */
+	protected $debug_data = [];
+
+	/** @var array */
+	protected $http_headers = [];
+
+	// -----------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Private constructor. Use asSuccess() and asError() static methods to obtain instance of Builder.
+	 *
+	 * @param bool $success
+	 * @param int  $api_code
+	 */
+	protected function __construct(bool $success, int $api_code)
+	{
+		$this->success = $success;
+		$this->api_code = $api_code;
+	}
+
+	// -----------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Returns success
+	 *
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_OK.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 */
+	public static function success($data = null, $api_code = null, array $placeholders = null,
+								   int $http_code = null, int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asSuccess($api_code)
+			->withData($data)
+			->withPlaceholders($placeholders)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->build();
+	}
+
+	/**
+	 * Builds error Response object. Supports optional arguments passed to Lang::get() if associated error
+	 * message uses placeholders as well as return data payload
+	 *
+	 * @param integer           $api_code      Your API code to be returned with the response object.
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_ERROR.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 */
+	public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
+								 int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withPlaceholders($placeholders)
+			->withData($data)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
 // -----------------------------------------------------------------------------------------------------------
 
-    public static function asSuccess(int $api_code = null): self
-    {
-        return new self(true, $api_code ?? BaseApiCodes::OK());
-    }
-
-    public static function asError(int $api_code): self
-    {
-        $code_ok = BaseApiCodes::OK();
-        if ($api_code !== $code_ok) {
-            Validator::assertIsIntRange('api_code', $api_code, BaseApiCodes::getMinCode(), BaseApiCodes::getMaxCode());
-        }
-        if ($api_code === $code_ok) {
-            throw new \InvalidArgumentException(
-                "Error response cannot use api_code of value {$code_ok} which is reserved for OK");
-        }
-
-        return new self(false, $api_code);
-    }
-
-    public function withHttpCode(int $http_code = null): self
-    {
-        Validator::assertIsType('http_code', $http_code, [Validator::TYPE_INTEGER,
-                                                          Validator::TYPE_NULL]);
-        $this->http_code = $http_code;
-
-        return $this;
-    }
-
-    public function withData($data = null): self
-    {
-        Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
-                                                Validator::TYPE_OBJECT,
-                                                Validator::TYPE_NULL]);
-        $this->data = $data;
-
-        return $this;
-    }
-
-    public function withJsonOptions(int $json_opts = null): self
-    {
-        Validator::assertIsType('json_opts', $json_opts, [Validator::TYPE_INTEGER,
-                                                          Validator::TYPE_NULL]);
-        $this->json_opts = $json_opts;
-
-        return $this;
-    }
-
-    public function withDebugData(array $debug_data = null): self
-    {
-        Validator::assertIsType('$debug_data', $debug_data, [Validator::TYPE_ARRAY,
-                                                             Validator::TYPE_NULL]);
-        $this->debug_data = $debug_data;
-
-        return $this;
-    }
-
-    public function withMessage(string $msg = null): self
-    {
-        Validator::assertIsType('message', $msg, [Validator::TYPE_STRING,
-                                                  Validator::TYPE_NULL]);
-        $this->message = $msg;
-
-        return $this;
-    }
-
-    public function withPlaceholders(array $placeholders = null): self
-    {
-        $this->placeholders = $placeholders;
-
-        return $this;
-    }
-
-    public function withHttpHeaders(array $http_headers = null): self
-    {
-        $this->http_headers = $http_headers ?? [];
-
-        return $this;
-    }
-
-    public function build(): HttpResponse
-    {
-        $api_code = $this->api_code;
-        Validator::assertIsInt('api_code', $api_code);
-
-        $msg_or_api_code = $this->message ?? $api_code;
-        $http_headers = $this->http_headers ?? [];
-
-        if ($this->success) {
-            $api_code = $api_code ?? BaseApiCodes::OK();
-            $http_code = $this->http_code ?? ResponseBuilder::DEFAULT_HTTP_CODE_OK;
-
-            Validator::assertOkHttpCode($http_code);
-
-            $result = $this->make($this->success, $api_code, $msg_or_api_code, $this->data, $http_code,
-                $this->placeholders, $http_headers, $this->json_opts);
-        } else {
-            $http_code = $this->http_code ?? ResponseBuilder::DEFAULT_HTTP_CODE_ERROR;
-
-            Validator::assertErrorHttpCode($http_code);
-
-            $result = $this->make(false, $api_code, $msg_or_api_code, $this->data, $http_code, $this->placeholders,
-                $this->http_headers, $this->json_opts, $this->debug_data);
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * @param boolean           $success         @true if response reports successful operation, @false otherwise.
-     * @param integer           $api_code        Your API code to be returned with the response object.
-     * @param string|integer    $msg_or_api_code message string or valid API code to get message for
-     * @param object|array|null $data            optional additional data to be included in response object
-     * @param integer|null      $http_code       HTTP code for the HttpResponse or @null for either DEFAULT_HTTP_CODE_OK
-     *                                           or DEFAULT_HTTP_CODE_ERROR depending on the $success.
-     * @param array|null        $placeholders    Placeholders passed to Lang::get() for message placeholders
-     *                                           substitution or @null if none.
-     * @param array|null        $http_headers    Optional HTTP headers to be returned in the response.
-     * @param integer|null      $json_opts       See http://php.net/manual/en/function.json-encode.php for supported
-     *                                           options or pass @null to use value from your config (or defaults).
-     * @param array|null        $debug_data      Optional debug data array to be added to returned JSON.
-     *
-     * @return HttpResponse
-     *
-     * @throws \InvalidArgumentException If $api_code is neither a string nor valid integer code.
-     * @throws \InvalidArgumentException if $data is an object of class that is not configured in "classes" mapping.
-     *
-     * @noinspection MoreThanThreeArgumentsInspection
-     */
-    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
-    {
-        $http_headers = $http_headers ?? [];
-        $http_code = $http_code ?? ($success ? ResponseBuilder::DEFAULT_HTTP_CODE_OK : ResponseBuilder::DEFAULT_HTTP_CODE_ERROR);
-        $json_opts = $json_opts ?? Config::get(ResponseBuilder::CONF_KEY_ENCODING_OPTIONS, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
-
-        Validator::assertIsInt('encoding_options', $json_opts);
-
-        Validator::assertIsInt('api_code', $api_code);
-        if (!BaseApiCodes::isCodeValid($api_code)) {
-            Validator::assertIsIntRange('api_code', $api_code, BaseApiCodes::getMinCode(), BaseApiCodes::getMaxCode());
-        }
-
-        return Response::json(
-            $this->buildResponse($success, $api_code, $msg_or_api_code, $placeholders, $data, $debug_data),
-            $http_code, $http_headers, $json_opts);
-    }
-
-    /**
-     * Creates standardised API response array. This is final method called in the whole pipeline before we
-     * return final JSON back to client. If you want to manipulate your response, this is the place to do that.
-     * If you set APP_DEBUG to true, 'code_hex' field will be additionally added to reported JSON for easier
-     * manual debugging.
-     *
-     * @param boolean           $success         @true if response reports successful operation, @false otherwise.
-     * @param integer           $api_code        Your API code to be returned with the response object.
-     * @param string|integer    $msg_or_api_code Message string or valid API code to get message for.
-     * @param array|null        $placeholders    Placeholders passed to Lang::get() for message placeholders
-     *                                           substitution or @null if none.
-     * @param object|array|null $data            API response data if any
-     * @param array|null        $debug_data      optional debug data array to be added to returned JSON.
-     *
-     * @return array response ready to be encoded as json and sent back to client
-     *
-     * @throws \RuntimeException in case of missing or invalid "classes" mapping configuration
-     */
-    protected function buildResponse(bool $success, int $api_code,
-                                     $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);
-        if ($data !== null && !is_object($data)) {
-            // ensure we get object in final JSON structure in data node
-            $data = (object)$data;
-        }
-
-        // get human readable message for API code or use message string (if given instead of API code)
-        if (is_int($msg_or_api_code)) {
-            $message = $this->getMessageForApiCode($success, $msg_or_api_code, $placeholders);
-        } else {
-            Validator::assertIsString('message', $msg_or_api_code);
-            $message = $msg_or_api_code;
-        }
-
-        /** @noinspection PhpUndefinedClassInspection */
-        $response = [
-            ResponseBuilder::KEY_SUCCESS => $success,
-            ResponseBuilder::KEY_CODE    => $api_code,
-            ResponseBuilder::KEY_LOCALE  => \App::getLocale(),
-            ResponseBuilder::KEY_MESSAGE => $message,
-            ResponseBuilder::KEY_DATA    => $data,
-        ];
-
-        if ($debug_data !== null) {
-            $debug_key = Config::get(ResponseBuilder::CONF_KEY_DEBUG_DEBUG_KEY, ResponseBuilder::KEY_DEBUG);
-            $response[ $debug_key ] = $debug_data;
-        }
-
-        return $response;
-    }
-
-    /**
-     * If $msg_or_api_code is integer value, returns human readable message associated with that code (with
-     * fallback to built-in default string if no api code mapping is set. If $msg_or_api_code is a string,
-     * returns it unaltered.
-     *
-     * @param boolean    $success      @true if response reports successful operation, @false otherwise.
-     * @param integer    $api_code     Your API code to be returned with the response object.
-     * @param array|null $placeholders Placeholders passed to Lang::get() for message placeholders
-     *                                 substitution or @null if none.
-     *
-     * @return string
-     */
-    protected function getMessageForApiCode(bool $success, int $api_code, array $placeholders = null): string
-    {
-        // We got integer value here not a message string, so we need to check if we have the mapping for
-        // this string already configured.
-        $key = BaseApiCodes::getCodeMessageKey($api_code);
-        if ($key === null) {
-            // nope, let's get the default one instead, based of
-            $fallback_code = $success ? BaseApiCodes::OK() : BaseApiCodes::NO_ERROR_MESSAGE();
-            $key = BaseApiCodes::getCodeMessageKey($fallback_code);
-        }
-
-        $placeholders = $placeholders ?? [];
-        if (!array_key_exists('api_code', $placeholders)) {
-            $placeholders['api_code'] = $api_code;
-        }
-
-        return \Lang::get($key, $placeholders);
-    }
+	public static function asSuccess(int $api_code = null): self
+	{
+		return new self(true, $api_code ?? BaseApiCodes::OK());
+	}
+
+	public static function asError(int $api_code): self
+	{
+		$code_ok = BaseApiCodes::OK();
+		if ($api_code !== $code_ok) {
+			Validator::assertIsIntRange('api_code', $api_code, BaseApiCodes::getMinCode(), BaseApiCodes::getMaxCode());
+		}
+		if ($api_code === $code_ok) {
+			throw new \InvalidArgumentException(
+				"Error response cannot use api_code of value {$code_ok} which is reserved for OK");
+		}
+
+		return new self(false, $api_code);
+	}
+
+	public function withHttpCode(int $http_code = null): self
+	{
+		Validator::assertIsType('http_code', $http_code, [Validator::TYPE_INTEGER,
+														  Validator::TYPE_NULL]);
+		$this->http_code = $http_code;
+
+		return $this;
+	}
+
+	public function withData($data = null): self
+	{
+		Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
+												Validator::TYPE_OBJECT,
+												Validator::TYPE_NULL]);
+		$this->data = $data;
+
+		return $this;
+	}
+
+	public function withJsonOptions(int $json_opts = null): self
+	{
+		Validator::assertIsType('json_opts', $json_opts, [Validator::TYPE_INTEGER,
+														  Validator::TYPE_NULL]);
+		$this->json_opts = $json_opts;
+
+		return $this;
+	}
+
+	public function withDebugData(array $debug_data = null): self
+	{
+		Validator::assertIsType('$debug_data', $debug_data, [Validator::TYPE_ARRAY,
+															 Validator::TYPE_NULL]);
+		$this->debug_data = $debug_data;
+
+		return $this;
+	}
+
+	public function withMessage(string $msg = null): self
+	{
+		Validator::assertIsType('message', $msg, [Validator::TYPE_STRING,
+												  Validator::TYPE_NULL]);
+		$this->message = $msg;
+
+		return $this;
+	}
+
+	public function withPlaceholders(array $placeholders = null): self
+	{
+		$this->placeholders = $placeholders;
+
+		return $this;
+	}
+
+	public function withHttpHeaders(array $http_headers = null): self
+	{
+		$this->http_headers = $http_headers ?? [];
+
+		return $this;
+	}
+
+	public function build(): HttpResponse
+	{
+		$api_code = $this->api_code;
+		Validator::assertIsInt('api_code', $api_code);
+
+		$msg_or_api_code = $this->message ?? $api_code;
+		$http_headers = $this->http_headers ?? [];
+
+		if ($this->success) {
+			$api_code = $api_code ?? BaseApiCodes::OK();
+			$http_code = $this->http_code ?? ResponseBuilder::DEFAULT_HTTP_CODE_OK;
+
+			Validator::assertOkHttpCode($http_code);
+
+			$result = $this->make($this->success, $api_code, $msg_or_api_code, $this->data, $http_code,
+				$this->placeholders, $http_headers, $this->json_opts);
+		} else {
+			$http_code = $this->http_code ?? ResponseBuilder::DEFAULT_HTTP_CODE_ERROR;
+
+			Validator::assertErrorHttpCode($http_code);
+
+			$result = $this->make(false, $api_code, $msg_or_api_code, $this->data, $http_code, $this->placeholders,
+				$this->http_headers, $this->json_opts, $this->debug_data);
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * @param boolean           $success         @true if response reports successful operation, @false otherwise.
+	 * @param integer           $api_code        Your API code to be returned with the response object.
+	 * @param string|integer    $msg_or_api_code message string or valid API code to get message for
+	 * @param object|array|null $data            optional additional data to be included in response object
+	 * @param integer|null      $http_code       HTTP code for the HttpResponse or @null for either DEFAULT_HTTP_CODE_OK
+	 *                                           or DEFAULT_HTTP_CODE_ERROR depending on the $success.
+	 * @param array|null        $placeholders    Placeholders passed to Lang::get() for message placeholders
+	 *                                           substitution or @null if none.
+	 * @param array|null        $http_headers    Optional HTTP headers to be returned in the response.
+	 * @param integer|null      $json_opts       See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                           options or pass @null to use value from your config (or defaults).
+	 * @param array|null        $debug_data      Optional debug data array to be added to returned JSON.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @throws \InvalidArgumentException If $api_code is neither a string nor valid integer code.
+	 * @throws \InvalidArgumentException if $data is an object of class that is not configured in "classes" mapping.
+	 *
+	 * @noinspection MoreThanThreeArgumentsInspection
+	 */
+	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
+	{
+		$http_headers = $http_headers ?? [];
+		$http_code = $http_code ?? ($success ? ResponseBuilder::DEFAULT_HTTP_CODE_OK : ResponseBuilder::DEFAULT_HTTP_CODE_ERROR);
+		$json_opts = $json_opts ?? Config::get(ResponseBuilder::CONF_KEY_ENCODING_OPTIONS, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
+
+		Validator::assertIsInt('encoding_options', $json_opts);
+
+		Validator::assertIsInt('api_code', $api_code);
+		if (!BaseApiCodes::isCodeValid($api_code)) {
+			Validator::assertIsIntRange('api_code', $api_code, BaseApiCodes::getMinCode(), BaseApiCodes::getMaxCode());
+		}
+
+		return Response::json(
+			$this->buildResponse($success, $api_code, $msg_or_api_code, $placeholders, $data, $debug_data),
+			$http_code, $http_headers, $json_opts);
+	}
+
+	/**
+	 * Creates standardised API response array. This is final method called in the whole pipeline before we
+	 * return final JSON back to client. If you want to manipulate your response, this is the place to do that.
+	 * If you set APP_DEBUG to true, 'code_hex' field will be additionally added to reported JSON for easier
+	 * manual debugging.
+	 *
+	 * @param boolean           $success         @true if response reports successful operation, @false otherwise.
+	 * @param integer           $api_code        Your API code to be returned with the response object.
+	 * @param string|integer    $msg_or_api_code Message string or valid API code to get message for.
+	 * @param array|null        $placeholders    Placeholders passed to Lang::get() for message placeholders
+	 *                                           substitution or @null if none.
+	 * @param object|array|null $data            API response data if any
+	 * @param array|null        $debug_data      optional debug data array to be added to returned JSON.
+	 *
+	 * @return array response ready to be encoded as json and sent back to client
+	 *
+	 * @throws \RuntimeException in case of missing or invalid "classes" mapping configuration
+	 */
+	protected function buildResponse(bool $success, int $api_code,
+									 $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);
+		if ($data !== null && !is_object($data)) {
+			// ensure we get object in final JSON structure in data node
+			$data = (object)$data;
+		}
+
+		// get human readable message for API code or use message string (if given instead of API code)
+		if (is_int($msg_or_api_code)) {
+			$message = $this->getMessageForApiCode($success, $msg_or_api_code, $placeholders);
+		} else {
+			Validator::assertIsString('message', $msg_or_api_code);
+			$message = $msg_or_api_code;
+		}
+
+		/** @noinspection PhpUndefinedClassInspection */
+		$response = [
+			ResponseBuilder::KEY_SUCCESS => $success,
+			ResponseBuilder::KEY_CODE    => $api_code,
+			ResponseBuilder::KEY_LOCALE  => \App::getLocale(),
+			ResponseBuilder::KEY_MESSAGE => $message,
+			ResponseBuilder::KEY_DATA    => $data,
+		];
+
+		if ($debug_data !== null) {
+			$debug_key = Config::get(ResponseBuilder::CONF_KEY_DEBUG_DEBUG_KEY, ResponseBuilder::KEY_DEBUG);
+			$response[ $debug_key ] = $debug_data;
+		}
+
+		return $response;
+	}
+
+	/**
+	 * If $msg_or_api_code is integer value, returns human readable message associated with that code (with
+	 * fallback to built-in default string if no api code mapping is set. If $msg_or_api_code is a string,
+	 * returns it unaltered.
+	 *
+	 * @param boolean    $success      @true if response reports successful operation, @false otherwise.
+	 * @param integer    $api_code     Your API code to be returned with the response object.
+	 * @param array|null $placeholders Placeholders passed to Lang::get() for message placeholders
+	 *                                 substitution or @null if none.
+	 *
+	 * @return string
+	 */
+	protected function getMessageForApiCode(bool $success, int $api_code, array $placeholders = null): string
+	{
+		// We got integer value here not a message string, so we need to check if we have the mapping for
+		// this string already configured.
+		$key = BaseApiCodes::getCodeMessageKey($api_code);
+		if ($key === null) {
+			// nope, let's get the default one instead, based of
+			$fallback_code = $success ? BaseApiCodes::OK() : BaseApiCodes::NO_ERROR_MESSAGE();
+			$key = BaseApiCodes::getCodeMessageKey($fallback_code);
+		}
+
+		$placeholders = $placeholders ?? [];
+		if (!array_key_exists('api_code', $placeholders)) {
+			$placeholders['api_code'] = $api_code;
+		}
+
+		return \Lang::get($key, $placeholders);
+	}
 }

src/ExceptionHandlerHelper.php

Indentation +222 added lines, -222 removed lines

@@ -27,227 +27,227 @@
  */
 class ExceptionHandlerHelper
 {
-    /**
-     * Render an exception into valid API response.
-     *
-     * @param \Illuminate\Http\Request $request Request object
-     * @param \Exception               $ex      Exception
-     *
-     * @return HttpResponse
-     */
-    public static function render(/** @scrutinizer ignore-unused */ $request, Exception $ex): HttpResponse
-    {
-        $result = null;
-        $cfg = static::getExceptionHandlerConfig()['map'];
-
-        if ($ex instanceof HttpException) {
-            // Check if we have any exception configuration for this particular HTTP status code.
-            // This confing entry is guaranted to exist (at least 'default'). Enforced by tests.
-            $http_code = $ex->getStatusCode();
-            $ex_cfg = $cfg[ HttpException::class ][ $http_code ] ?? null;
-            $ex_cfg = $ex_cfg ?? $cfg[ HttpException::class ]['default'];
-            $result = self::processException($ex, $ex_cfg, $http_code);
-        } elseif ($ex instanceof ValidationException) {
-            // This entry is guaranted to exist. Enforced by tests.
-            $http_code = HttpResponse::HTTP_UNPROCESSABLE_ENTITY;
-            $result = self::processException($ex, $cfg[ HttpException::class ][ $http_code ], $http_code);
-        }
-
-        if ($result === null) {
-            // This entry is guaranted to exist. Enforced by tests.
-            $result = self::processException($ex, $cfg['default'], HttpResponse::HTTP_INTERNAL_SERVER_ERROR);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Handles given exception and produces valid HTTP response object.
-     *
-     * @param \Exception $ex                 Exception to be handled.
-     * @param array      $ex_cfg             ExceptionHandler's config excerpt related to $ex exception type.
-     * @param int        $fallback_http_code HTTP code to be assigned to produced $ex related response in
-     *                                       case configuration array lacks own `http_code` value.
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
-     */
-    protected static function processException(\Exception $ex, array $ex_cfg, int $fallback_http_code)
-    {
-        $api_code = $ex_cfg['api_code'];
-        $http_code = $ex_cfg['http_code'] ?? $fallback_http_code;
-        $msg_key = $ex_cfg['msg_key'] ?? null;
-        $msg_enforce = $ex_cfg['msg_enforce'] ?? false;
-
-        // No message key, let's get exception message and if there's nothing useful, fallback to built-in one.
-        $msg = $ex->getMessage();
-        $placeholders = [
-            'api_code' => $api_code,
-            'message'  => ($msg !== '') ? $msg : '???',
-        ];
-
-        // shall we enforce error message?
-        if ($msg_enforce) {
-            // yes, please.
-            if ($msg_key === null) {
-                // there's no msg_key configured for this exact code, so let's obtain our default message
-                $msg = ($msg_key === null) ? static::getErrorMessageForException($ex, $http_code, $placeholders)
-                    : Lang::get($msg_key, $placeholders);
-            }
-        } else {
-            // nothing enforced, handling pipeline: ex_message -> user_defined_msg -> http_ex -> default
-            if ($msg === '') {
-                $msg = ($msg_key === null) ? static::getErrorMessageForException($ex, $http_code, $placeholders)
-                    : Lang::get($msg_key, $placeholders);
-            }
-        }
-
-        // Lets' try to build the error response with what we have now
-        return static::error($ex, $api_code, $http_code, $msg);
-    }
-
-    /**
-     * Returns error message for given exception. If exception message is empty, then falls back to
-     * `default` handler either for HttpException (if $ex is instance of it), or generic `default`
-     * config.
-     *
-     * @param \Exception $ex
-     * @param int        $http_code
-     * @param array      $placeholders
-     *
-     * @return string
-     */
-    protected static function getErrorMessageForException(\Exception $ex, int $http_code, array $placeholders): string
-    {
-        // exception message is uselss, lets go deeper
-        if ($ex instanceof HttpException) {
-            $error_message = Lang::get("response-builder::builder.http_{$http_code}", $placeholders);
-        } else {
-            // Still got nothing? Fall back to built-in generic message for this type of exception.
-            $key = BaseApiCodes::getCodeMessageKey(($ex instanceof HttpException)
-                ? BaseApiCodes::EX_HTTP_EXCEPTION() : BaseApiCodes::NO_ERROR_MESSAGE());
-            $error_message = Lang::get($key, $placeholders);
-        }
-
-        return $error_message;
-    }
-
-    /**
-     * Convert an authentication exception into an unauthenticated response.
-     *
-     * @param \Illuminate\Http\Request                 $request
-     * @param \Illuminate\Auth\AuthenticationException $exception
-     *
-     * @return HttpResponse
-     */
-    protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
-                                                                         AuthException $exception): HttpResponse
-    {
-        // This entry is guaranted to exist. Enforced by tests.
-        $http_code = HttpResponse::HTTP_UNAUTHORIZED;
-        $cfg = static::getExceptionHandlerConfig()['map'][ HttpException::class ][ $http_code ];
-
-        return static::processException($exception, $cfg, $http_code);
-    }
-
-    /**
-     * Process single error and produce valid API response.
-     *
-     * @param Exception $ex Exception to be handled.
-     * @param integer   $api_code
-     * @param integer   $http_code
-     *
-     * @return HttpResponse
-     */
-    protected static function error(Exception $ex,
-                                    int $api_code, int $http_code = null, string $error_message): HttpResponse
-    {
-        $ex_http_code = ($ex instanceof HttpException) ? $ex->getStatusCode() : $ex->getCode();
-        $http_code = $http_code ?? $ex_http_code;
-
-        // Check if we now have valid HTTP error code for this case or need to make one up.
-        // We cannot throw any exception if codes are invalid because we are in Exception Handler already.
-        if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
-            // Not a valid code, let's try to get the exception status.
-            $http_code = $ex_http_code;
-        }
-        // Can it be considered a valid HTTP error code?
-        if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
-            // We now handle uncaught exception, so we cannot throw another one if there's
-            // something wrong with the configuration, so we try to recover and use built-in
-            // codes instead.
-            // FIXME: We should log this event as (warning or error?)
-            $http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR;
-        }
-
-        // If we have trace data debugging enabled, let's gather some debug info and add to the response.
-        $debug_data = null;
-        if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, false)) {
-            $debug_data = [
-                Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_KEY, ResponseBuilder::KEY_TRACE) => [
-                    ResponseBuilder::KEY_CLASS => get_class($ex),
-                    ResponseBuilder::KEY_FILE  => $ex->getFile(),
-                    ResponseBuilder::KEY_LINE  => $ex->getLine(),
-                ],
-            ];
-        }
-
-        // If this is ValidationException, add all the messages from MessageBag to the data node.
-        $data = null;
-        if ($ex instanceof ValidationException) {
-            /** @var ValidationException $ex */
-            $data = [ResponseBuilder::KEY_MESSAGES => $ex->validator->errors()->messages()];
-        }
-
-        return ResponseBuilder::asError($api_code)
-            ->withMessage($error_message)
-            ->withHttpCode($http_code)
-            ->withData($data)
-            ->withDebugData($debug_data)
-            ->build();
-    }
-
-    /**
-     * Returns default (built-in) exception handler config array.
-     *
-     * @return array
-     */
-    protected static function getExceptionHandlerDefaultConfig(): array
-    {
-        return [
-            'map' => [
-                HttpException::class => [
-                    // used by unauthenticated() to obtain api and http code for the exception
-                    HttpResponse::HTTP_UNAUTHORIZED         => [
-                        'api_code' => BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(),
-                    ],
-                    // Required by ValidationException handler
-                    HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [
-                        'api_code' => BaseApiCodes::EX_VALIDATION_EXCEPTION(),
-                    ],
-                    // default handler is mandatory. `default` entry MUST have both `api_code` and `http_code` set.
-                    'default'                               => [
-                        'api_code'  => BaseApiCodes::EX_HTTP_EXCEPTION(),
-                        'http_code' => HttpResponse::HTTP_BAD_REQUEST,
-                    ],
-                ],
-                // default handler is mandatory. `default` entry MUST have both `api_code` and `http_code` set.
-                'default'            => [
-                    'api_code'  => BaseApiCodes::EX_UNCAUGHT_EXCEPTION(),
-                    'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
-                ],
-            ],
-        ];
-    }
-
-    /**
-     * Returns ExceptionHandlerHelper configration array with user configuration merged into built-in defaults.
-     *
-     * @return array
-     */
-    protected static function getExceptionHandlerConfig(): array
-    {
-        return Util::mergeConfig(static::getExceptionHandlerDefaultConfig(),
-            \Config::get(ResponseBuilder::CONF_KEY_EXCEPTION_HANDLER, []));
-    }
+	/**
+	 * Render an exception into valid API response.
+	 *
+	 * @param \Illuminate\Http\Request $request Request object
+	 * @param \Exception               $ex      Exception
+	 *
+	 * @return HttpResponse
+	 */
+	public static function render(/** @scrutinizer ignore-unused */ $request, Exception $ex): HttpResponse
+	{
+		$result = null;
+		$cfg = static::getExceptionHandlerConfig()['map'];
+
+		if ($ex instanceof HttpException) {
+			// Check if we have any exception configuration for this particular HTTP status code.
+			// This confing entry is guaranted to exist (at least 'default'). Enforced by tests.
+			$http_code = $ex->getStatusCode();
+			$ex_cfg = $cfg[ HttpException::class ][ $http_code ] ?? null;
+			$ex_cfg = $ex_cfg ?? $cfg[ HttpException::class ]['default'];
+			$result = self::processException($ex, $ex_cfg, $http_code);
+		} elseif ($ex instanceof ValidationException) {
+			// This entry is guaranted to exist. Enforced by tests.
+			$http_code = HttpResponse::HTTP_UNPROCESSABLE_ENTITY;
+			$result = self::processException($ex, $cfg[ HttpException::class ][ $http_code ], $http_code);
+		}
+
+		if ($result === null) {
+			// This entry is guaranted to exist. Enforced by tests.
+			$result = self::processException($ex, $cfg['default'], HttpResponse::HTTP_INTERNAL_SERVER_ERROR);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Handles given exception and produces valid HTTP response object.
+	 *
+	 * @param \Exception $ex                 Exception to be handled.
+	 * @param array      $ex_cfg             ExceptionHandler's config excerpt related to $ex exception type.
+	 * @param int        $fallback_http_code HTTP code to be assigned to produced $ex related response in
+	 *                                       case configuration array lacks own `http_code` value.
+	 *
+	 * @return \Symfony\Component\HttpFoundation\Response
+	 */
+	protected static function processException(\Exception $ex, array $ex_cfg, int $fallback_http_code)
+	{
+		$api_code = $ex_cfg['api_code'];
+		$http_code = $ex_cfg['http_code'] ?? $fallback_http_code;
+		$msg_key = $ex_cfg['msg_key'] ?? null;
+		$msg_enforce = $ex_cfg['msg_enforce'] ?? false;
+
+		// No message key, let's get exception message and if there's nothing useful, fallback to built-in one.
+		$msg = $ex->getMessage();
+		$placeholders = [
+			'api_code' => $api_code,
+			'message'  => ($msg !== '') ? $msg : '???',
+		];
+
+		// shall we enforce error message?
+		if ($msg_enforce) {
+			// yes, please.
+			if ($msg_key === null) {
+				// there's no msg_key configured for this exact code, so let's obtain our default message
+				$msg = ($msg_key === null) ? static::getErrorMessageForException($ex, $http_code, $placeholders)
+					: Lang::get($msg_key, $placeholders);
+			}
+		} else {
+			// nothing enforced, handling pipeline: ex_message -> user_defined_msg -> http_ex -> default
+			if ($msg === '') {
+				$msg = ($msg_key === null) ? static::getErrorMessageForException($ex, $http_code, $placeholders)
+					: Lang::get($msg_key, $placeholders);
+			}
+		}
+
+		// Lets' try to build the error response with what we have now
+		return static::error($ex, $api_code, $http_code, $msg);
+	}
+
+	/**
+	 * Returns error message for given exception. If exception message is empty, then falls back to
+	 * `default` handler either for HttpException (if $ex is instance of it), or generic `default`
+	 * config.
+	 *
+	 * @param \Exception $ex
+	 * @param int        $http_code
+	 * @param array      $placeholders
+	 *
+	 * @return string
+	 */
+	protected static function getErrorMessageForException(\Exception $ex, int $http_code, array $placeholders): string
+	{
+		// exception message is uselss, lets go deeper
+		if ($ex instanceof HttpException) {
+			$error_message = Lang::get("response-builder::builder.http_{$http_code}", $placeholders);
+		} else {
+			// Still got nothing? Fall back to built-in generic message for this type of exception.
+			$key = BaseApiCodes::getCodeMessageKey(($ex instanceof HttpException)
+				? BaseApiCodes::EX_HTTP_EXCEPTION() : BaseApiCodes::NO_ERROR_MESSAGE());
+			$error_message = Lang::get($key, $placeholders);
+		}
+
+		return $error_message;
+	}
+
+	/**
+	 * Convert an authentication exception into an unauthenticated response.
+	 *
+	 * @param \Illuminate\Http\Request                 $request
+	 * @param \Illuminate\Auth\AuthenticationException $exception
+	 *
+	 * @return HttpResponse
+	 */
+	protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
+																		 AuthException $exception): HttpResponse
+	{
+		// This entry is guaranted to exist. Enforced by tests.
+		$http_code = HttpResponse::HTTP_UNAUTHORIZED;
+		$cfg = static::getExceptionHandlerConfig()['map'][ HttpException::class ][ $http_code ];
+
+		return static::processException($exception, $cfg, $http_code);
+	}
+
+	/**
+	 * Process single error and produce valid API response.
+	 *
+	 * @param Exception $ex Exception to be handled.
+	 * @param integer   $api_code
+	 * @param integer   $http_code
+	 *
+	 * @return HttpResponse
+	 */
+	protected static function error(Exception $ex,
+									int $api_code, int $http_code = null, string $error_message): HttpResponse
+	{
+		$ex_http_code = ($ex instanceof HttpException) ? $ex->getStatusCode() : $ex->getCode();
+		$http_code = $http_code ?? $ex_http_code;
+
+		// Check if we now have valid HTTP error code for this case or need to make one up.
+		// We cannot throw any exception if codes are invalid because we are in Exception Handler already.
+		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
+			// Not a valid code, let's try to get the exception status.
+			$http_code = $ex_http_code;
+		}
+		// Can it be considered a valid HTTP error code?
+		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
+			// We now handle uncaught exception, so we cannot throw another one if there's
+			// something wrong with the configuration, so we try to recover and use built-in
+			// codes instead.
+			// FIXME: We should log this event as (warning or error?)
+			$http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR;
+		}
+
+		// If we have trace data debugging enabled, let's gather some debug info and add to the response.
+		$debug_data = null;
+		if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, false)) {
+			$debug_data = [
+				Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_KEY, ResponseBuilder::KEY_TRACE) => [
+					ResponseBuilder::KEY_CLASS => get_class($ex),
+					ResponseBuilder::KEY_FILE  => $ex->getFile(),
+					ResponseBuilder::KEY_LINE  => $ex->getLine(),
+				],
+			];
+		}
+
+		// If this is ValidationException, add all the messages from MessageBag to the data node.
+		$data = null;
+		if ($ex instanceof ValidationException) {
+			/** @var ValidationException $ex */
+			$data = [ResponseBuilder::KEY_MESSAGES => $ex->validator->errors()->messages()];
+		}
+
+		return ResponseBuilder::asError($api_code)
+			->withMessage($error_message)
+			->withHttpCode($http_code)
+			->withData($data)
+			->withDebugData($debug_data)
+			->build();
+	}
+
+	/**
+	 * Returns default (built-in) exception handler config array.
+	 *
+	 * @return array
+	 */
+	protected static function getExceptionHandlerDefaultConfig(): array
+	{
+		return [
+			'map' => [
+				HttpException::class => [
+					// used by unauthenticated() to obtain api and http code for the exception
+					HttpResponse::HTTP_UNAUTHORIZED         => [
+						'api_code' => BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(),
+					],
+					// Required by ValidationException handler
+					HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [
+						'api_code' => BaseApiCodes::EX_VALIDATION_EXCEPTION(),
+					],
+					// default handler is mandatory. `default` entry MUST have both `api_code` and `http_code` set.
+					'default'                               => [
+						'api_code'  => BaseApiCodes::EX_HTTP_EXCEPTION(),
+						'http_code' => HttpResponse::HTTP_BAD_REQUEST,
+					],
+				],
+				// default handler is mandatory. `default` entry MUST have both `api_code` and `http_code` set.
+				'default'            => [
+					'api_code'  => BaseApiCodes::EX_UNCAUGHT_EXCEPTION(),
+					'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
+				],
+			],
+		];
+	}
+
+	/**
+	 * Returns ExceptionHandlerHelper configration array with user configuration merged into built-in defaults.
+	 *
+	 * @return array
+	 */
+	protected static function getExceptionHandlerConfig(): array
+	{
+		return Util::mergeConfig(static::getExceptionHandlerDefaultConfig(),
+			\Config::get(ResponseBuilder::CONF_KEY_EXCEPTION_HANDLER, []));
+	}
 
 }

Spacing +4 added lines, -4 removed lines

@@ -44,13 +44,13 @@ 
             // Check if we have any exception configuration for this particular HTTP status code.
             // This confing entry is guaranted to exist (at least 'default'). Enforced by tests.
             $http_code = $ex->getStatusCode();
-            $ex_cfg = $cfg[ HttpException::class ][ $http_code ] ?? null;
-            $ex_cfg = $ex_cfg ?? $cfg[ HttpException::class ]['default'];
+            $ex_cfg = $cfg[HttpException::class][$http_code] ?? null;
+            $ex_cfg = $ex_cfg ?? $cfg[HttpException::class]['default'];
             $result = self::processException($ex, $ex_cfg, $http_code);
         } elseif ($ex instanceof ValidationException) {
             // This entry is guaranted to exist. Enforced by tests.
             $http_code = HttpResponse::HTTP_UNPROCESSABLE_ENTITY;
-            $result = self::processException($ex, $cfg[ HttpException::class ][ $http_code ], $http_code);
+            $result = self::processException($ex, $cfg[HttpException::class][$http_code], $http_code);
         }
 
         if ($result === null) {
@@ -144,7 +144,7 @@ 
     {
         // This entry is guaranted to exist. Enforced by tests.
         $http_code = HttpResponse::HTTP_UNAUTHORIZED;
-        $cfg = static::getExceptionHandlerConfig()['map'][ HttpException::class ][ $http_code ];
+        $cfg = static::getExceptionHandlerConfig()['map'][HttpException::class][$http_code];
 
         return static::processException($exception, $cfg, $http_code);
     }

src/BaseApiCodes.php

Indentation +189 added lines, -189 removed lines

@@ -21,194 +21,194 @@
  */
 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 [
-            /** @scrutinizer ignore-deprecated */
-            self::OK()                          => 'response-builder::builder.ok',
-            /** @scrutinizer ignore-deprecated */
-            self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
-            /** @scrutinizer ignore-deprecated */
-            self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
-            /** @scrutinizer ignore-deprecated */
-            self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
-            /** @scrutinizer ignore-deprecated */
-            self::EX_HTTP_NOT_FOUND()           => sprintf($tpl, HttpResponse::HTTP_NOT_FOUND),
-            /** @scrutinizer ignore-deprecated */
-            self::EX_HTTP_SERVICE_UNAVAILABLE() => sprintf($tpl, HttpResponse::HTTP_SERVICE_UNAVAILABLE),
-            /** @scrutinizer ignore-deprecated */
-            self::EX_AUTHENTICATION_EXCEPTION() => sprintf($tpl, HttpResponse::HTTP_UNAUTHORIZED),
-            /** @scrutinizer ignore-deprecated */
-            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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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
-     *
-     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
-     */
-    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 [
+			/** @scrutinizer ignore-deprecated */
+			self::OK()                          => 'response-builder::builder.ok',
+			/** @scrutinizer ignore-deprecated */
+			self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
+			/** @scrutinizer ignore-deprecated */
+			self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
+			/** @scrutinizer ignore-deprecated */
+			self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
+			/** @scrutinizer ignore-deprecated */
+			self::EX_HTTP_NOT_FOUND()           => sprintf($tpl, HttpResponse::HTTP_NOT_FOUND),
+			/** @scrutinizer ignore-deprecated */
+			self::EX_HTTP_SERVICE_UNAVAILABLE() => sprintf($tpl, HttpResponse::HTTP_SERVICE_UNAVAILABLE),
+			/** @scrutinizer ignore-deprecated */
+			self::EX_AUTHENTICATION_EXCEPTION() => sprintf($tpl, HttpResponse::HTTP_UNAUTHORIZED),
+			/** @scrutinizer ignore-deprecated */
+			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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	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
+	 *
+	 * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
+	 */
+	public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
+	}
 
 }