MarcinOrlowski / laravel-api-response-builder

src/lang/en/builder.php

Indentation +11 added lines, -11 removed lines

@@ -10,19 +10,19 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Error #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Error #:api_code',
 
-    // can be used by Exception Handler (if enabled)
-    'uncaught_exception'       => 'Uncaught exception :message',
-    // we talking API call here, hence we have http_not_found
-    'http_not_found'           => 'Item not found',
-    'http_exception'           => 'HTTP exception :message',
-    'http_service_unavailable' => 'Service maintenance in progress',
+	// can be used by Exception Handler (if enabled)
+	'uncaught_exception'       => 'Uncaught exception :message',
+	// we talking API call here, hence we have http_not_found
+	'http_not_found'           => 'Item not found',
+	'http_exception'           => 'HTTP exception :message',
+	'http_service_unavailable' => 'Service maintenance in progress',
 
-    // Exception Handler (added in 3.3.0)
-    'authentication_exception' => 'Not authorized to access',
-    'validation_exception'     => 'Invalid data',
+	// Exception Handler (added in 3.3.0)
+	'authentication_exception' => 'Not authorized to access',
+	'validation_exception'     => 'Invalid data',
 
 ];
 

src/lang/pl/builder.php

Indentation +11 added lines, -11 removed lines

@@ -10,18 +10,18 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Błąd #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Błąd #:api_code',
 
-    // can be used by Exception Handler (if enabled)
-    'uncaught_exception'       => 'Nieprzechwycony wyjątek :message',
-    // we talking API call here, hence we have http_not_found
-    'http_not_found'           => 'Element nie znaleziony',
-    'http_exception'           => 'Wyjątek HTTP :message',
-    'http_service_unavailable' => 'Trwa przerwa serwisowa',
+	// can be used by Exception Handler (if enabled)
+	'uncaught_exception'       => 'Nieprzechwycony wyjątek :message',
+	// we talking API call here, hence we have http_not_found
+	'http_not_found'           => 'Element nie znaleziony',
+	'http_exception'           => 'Wyjątek HTTP :message',
+	'http_service_unavailable' => 'Trwa przerwa serwisowa',
 
-    // Exception Handler (added in 3.3.0)
-    'authentication_exception' => 'Brak autoryzacji dostępu',
-    'validation_exception'     => 'Nieprawidłowe dane',
+	// Exception Handler (added in 3.3.0)
+	'authentication_exception' => 'Brak autoryzacji dostępu',
+	'validation_exception'     => 'Nieprawidłowe dane',
 
 ];

src/BaseApiCodes.php

Indentation +168 added lines, -168 removed lines

@@ -19,173 +19,173 @@
  */
 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
-    {
-        /**
-         * @var array built-in codes mapping
-         */
-        return [
-            self::OK()                          => 'response-builder::builder.ok',
-            self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
-            self::EX_HTTP_NOT_FOUND()           => 'response-builder::builder.http_not_found',
-            self::EX_HTTP_SERVICE_UNAVAILABLE() => 'response-builder::builder.http_service_unavailable',
-            self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
-            self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
-            self::EX_AUTHENTICATION_EXCEPTION() => 'response-builder::builder.authentication_exception',
-            self::EX_VALIDATION_EXCEPTION()     => 'response-builder::builder.validation_exception',
-        ];
-    }
-
-    /**
-     * Returns API code for internal code OK
-     *
-     * @return int valid API code in current range
-     */
-    public static function OK(): int
-    {
-        return static::getCodeForInternalOffset(static::OK_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code NO_ERROR_MESSAGE
-     *
-     * @return int valid API code in current range
-     */
-    public static function NO_ERROR_MESSAGE(): int
-    {
-        return static::getCodeForInternalOffset(static::NO_ERROR_MESSAGE_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_HTTP_NOT_FOUND
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_HTTP_NOT_FOUND(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_NOT_FOUND_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_HTTP_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_HTTP_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_UNCAUGHT_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_AUTHENTICATION_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_VALIDATION_EXCEPTION
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_VALIDATION_EXCEPTION(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_VALIDATION_EXCEPTION_OFFSET);
-    }
-
-    /**
-     * Returns API code for internal code EX_HTTP_SERVICE_UNAVAILABLE
-     *
-     * @return int valid API code in current range
-     */
-    public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
-    {
-        return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
-    }
+	use ApiCodesHelpers;
+
+	/**
+	 * protected code range - lowest code for reserved range.
+	 *
+	 * @var int
+	 */
+	public const RESERVED_MIN_API_CODE_OFFSET = 0;
+
+	/**
+	 * protected code range - highest code for reserved range
+	 *
+	 * @var int
+	 */
+	public const RESERVED_MAX_API_CODE_OFFSET = 19;
+
+	/**
+	 * built-in codes: OK
+	 *
+	 * @var int
+	 */
+	protected const OK_OFFSET = 0;
+	/**
+	 * built-in code for fallback message mapping
+	 *
+	 * @var int
+	 */
+	protected const NO_ERROR_MESSAGE_OFFSET = 1;
+	/**
+	 * built-in error code for HTTP_NOT_FOUND exception
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_NOT_FOUND_OFFSET = 10;
+	/**
+	 * built-in error code for HTTP_SERVICE_UNAVAILABLE exception
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_SERVICE_UNAVAILABLE_OFFSET = 11;
+	/**
+	 * built-in error code for HTTP_EXCEPTION
+	 *
+	 * @var int
+	 */
+	protected const EX_HTTP_EXCEPTION_OFFSET = 12;
+	/**
+	 * built-in error code for UNCAUGHT_EXCEPTION
+	 *
+	 * @var int
+	 */
+	protected const EX_UNCAUGHT_EXCEPTION_OFFSET = 13;
+
+	/**
+	 * built-in error code for \Illuminate\Auth\AuthenticationException
+	 *
+	 * @var int
+	 */
+	protected const EX_AUTHENTICATION_EXCEPTION_OFFSET = 14;
+
+	/**
+	 * built-in error code for \Illuminate\Auth\AuthenticationException
+	 *
+	 * @var int
+	 */
+	protected const EX_VALIDATION_EXCEPTION_OFFSET = 15;
+
+	/**
+	 * Returns base code mapping array
+	 *
+	 * @return array
+	 */
+	protected static function getBaseMap(): array
+	{
+		/**
+		 * @var array built-in codes mapping
+		 */
+		return [
+			self::OK()                          => 'response-builder::builder.ok',
+			self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
+			self::EX_HTTP_NOT_FOUND()           => 'response-builder::builder.http_not_found',
+			self::EX_HTTP_SERVICE_UNAVAILABLE() => 'response-builder::builder.http_service_unavailable',
+			self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
+			self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
+			self::EX_AUTHENTICATION_EXCEPTION() => 'response-builder::builder.authentication_exception',
+			self::EX_VALIDATION_EXCEPTION()     => 'response-builder::builder.validation_exception',
+		];
+	}
+
+	/**
+	 * Returns API code for internal code OK
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function OK(): int
+	{
+		return static::getCodeForInternalOffset(static::OK_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code NO_ERROR_MESSAGE
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function NO_ERROR_MESSAGE(): int
+	{
+		return static::getCodeForInternalOffset(static::NO_ERROR_MESSAGE_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_HTTP_NOT_FOUND
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_HTTP_NOT_FOUND(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_NOT_FOUND_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_HTTP_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_HTTP_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_UNCAUGHT_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_AUTHENTICATION_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_VALIDATION_EXCEPTION
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_VALIDATION_EXCEPTION(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_VALIDATION_EXCEPTION_OFFSET);
+	}
+
+	/**
+	 * Returns API code for internal code EX_HTTP_SERVICE_UNAVAILABLE
+	 *
+	 * @return int valid API code in current range
+	 */
+	public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
+	{
+		return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
+	}
 
 }

src/Validator.php

Indentation +76 added lines, -76 removed lines

@@ -15,88 +15,88 @@
  */
 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';
 
-    /**
-     * 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 assertInt(string $key, $var): void
-    {
-        self::assertType($key, $var, [self::TYPE_INTEGER]);
-    }
+	/**
+	 * Checks if given $val is of type integer
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertInt(string $key, $var): void
+	{
+		self::assertType($key, $var, [self::TYPE_INTEGER]);
+	}
 
-    /**
-     * 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 assertString(string $name, $var): void
-    {
-        self::assertType($name, $var, [self::TYPE_STRING]);
-    }
+	/**
+	 * Checks if given $val is of type string
+	 *
+	 * @param string $name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var  Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertString(string $name, $var): void
+	{
+		self::assertType($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 assertIntRange(string $name, $var, int $min, int $max): void
-    {
-        self::assertInt($name, $var);
+	/**
+	 * @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 assertIntRange(string $name, $var, int $min, int $max): void
+	{
+		self::assertInt($name, $var);
 
-        if ($min > $max) {
-            throw new \RuntimeException(
-                sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name));
-        }
+		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));
-        }
-    }
+		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 assertType(string $name, $var, array $allowed_types): void
-    {
-        $type = gettype($var);
-        if (!in_array($type, $allowed_types)) {
-            $msg = sprintf('"%s" must be one of allowed types: %s (%s given)', $name, implode(', ', $allowed_types), gettype($var));
-            throw new \InvalidArgumentException($msg);
-        }
-    }
+	/**
+	 * 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 assertType(string $name, $var, array $allowed_types): void
+	{
+		$type = gettype($var);
+		if (!in_array($type, $allowed_types)) {
+			$msg = sprintf('"%s" must be one of allowed types: %s (%s given)', $name, implode(', ', $allowed_types), gettype($var));
+			throw new \InvalidArgumentException($msg);
+		}
+	}
 }

src/ApiCodesHelpers.php

Indentation +123 added lines, -123 removed lines

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

src/ExceptionHandlerHelper.php

Indentation +159 added lines, -159 removed lines

@@ -27,165 +27,165 @@
  */
 class ExceptionHandlerHelper
 {
-    /**
-     * Exception types
-     */
-    public const TYPE_HTTP_NOT_FOUND_KEY           = 'http_not_found';
-    public const TYPE_HTTP_SERVICE_UNAVAILABLE_KEY = 'http_service_unavailable';
-    public const TYPE_HTTP_UNAUTHORIZED_KEY        = 'authentication_exception';
-    public const TYPE_HTTP_EXCEPTION_KEY           = 'http_exception';
-    public const TYPE_VALIDATION_EXCEPTION_KEY     = 'validation_exception';
-    public const TYPE_UNCAUGHT_EXCEPTION_KEY       = 'uncaught_exception';
-    public const TYPE_AUTHENTICATION_EXCEPTION_KEY = 'authentication_exception';
-
-    /**
-     * Render an exception into valid API response.
-     *
-     * @param \Illuminate\Http\Request $request   Request object
-     * @param \Exception               $exception Exception
-     *
-     * @return HttpResponse
-     */
-    public static function render(/** @scrutinizer ignore-unused */ $request, Exception $exception): HttpResponse
-    {
-        $result = null;
-
-        if ($exception instanceof HttpException) {
-            switch ($exception->getStatusCode()) {
-                case HttpResponse::HTTP_NOT_FOUND:
-                    $result = static::error($exception, static::TYPE_HTTP_NOT_FOUND_KEY,
-                        BaseApiCodes::EX_HTTP_NOT_FOUND(), HttpResponse::HTTP_NOT_FOUND);
-                    break;
-
-                case HttpResponse::HTTP_SERVICE_UNAVAILABLE:
-                    $result = static::error($exception, static::TYPE_HTTP_SERVICE_UNAVAILABLE_KEY,
-                        BaseApiCodes::EX_HTTP_SERVICE_UNAVAILABLE(), HttpResponse::HTTP_SERVICE_UNAVAILABLE);
-                    break;
-
-                case HttpResponse::HTTP_UNAUTHORIZED:
-                    $result = static::error($exception, static::TYPE_HTTP_UNAUTHORIZED_KEY,
-                        BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(), HttpResponse::HTTP_UNAUTHORIZED);
-                    break;
-
-                default:
-                    $result = static::error($exception, static::TYPE_HTTP_EXCEPTION_KEY,
-                        BaseApiCodes::EX_HTTP_EXCEPTION(), HttpResponse::HTTP_BAD_REQUEST);
-                    break;
-            }
-        } elseif ($exception instanceof ValidationException) {
-            $result = static::error($exception, static::TYPE_VALIDATION_EXCEPTION_KEY,
-                BaseApiCodes::EX_VALIDATION_EXCEPTION(), HttpResponse::HTTP_BAD_REQUEST);
-        }
-
-        if ($result === null) {
-            $result = static::error($exception, static::TYPE_UNCAUGHT_EXCEPTION_KEY,
-                BaseApiCodes::EX_UNCAUGHT_EXCEPTION(), HttpResponse::HTTP_INTERNAL_SERVER_ERROR);
-        }
-
-        return $result;
-    }
-
-    /**
-     * 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,
-                                                                         AuthenticationException $exception): HttpResponse
-    {
-        return static::error($exception, 'authentication_exception', BaseApiCodes::EX_AUTHENTICATION_EXCEPTION());
-    }
-
-    /**
-     * Process singe error and produce valid API response
-     *
-     * @param Exception $exception            Exception to be processed
-     * @param string    $exception_config_key Category of the exception
-     * @param integer   $fallback_api_code    API code to return
-     * @param integer   $fallback_http_code   HTTP code to return
-     *
-     * @return HttpResponse
-     */
-    protected static function error(Exception $exception, $exception_config_key, $fallback_api_code,
-                                    $fallback_http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR): HttpResponse
-    {
-        // common prefix for config key
-        $base_key = sprintf('%s.exception', ResponseBuilder::CONF_EXCEPTION_HANDLER_KEY);
-
-        // get API and HTTP codes from exception handler config or use fallback values if no such
-        // config fields are set.
-        $api_code = Config::get("{$base_key}.{$exception_config_key}.code", $fallback_api_code);
-        $http_code = Config::get("{$base_key}.{$exception_config_key}.http_code", $fallback_http_code);
-
-        // check if we now have valid HTTP error code for this case or need to make one up.
-        if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
-            // no code, let's try to get the exception status
-            $http_code = ($exception instanceof \Symfony\Component\HttpKernel\Exception\HttpException)
-                ? $exception->getStatusCode()
-                : $exception->getCode();
-        }
-
-        // can it be considered valid HTTP error code?
-        if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
-            $http_code = $fallback_http_code;
-        }
-
-        // let's figure out what event we are handling now
-        $known_codes = [
-            self::TYPE_HTTP_NOT_FOUND_KEY           => BaseApiCodes::EX_HTTP_NOT_FOUND(),
-            self::TYPE_HTTP_SERVICE_UNAVAILABLE_KEY => BaseApiCodes::EX_HTTP_SERVICE_UNAVAILABLE(),
-            self::TYPE_UNCAUGHT_EXCEPTION_KEY       => BaseApiCodes::EX_UNCAUGHT_EXCEPTION(),
-            self::TYPE_AUTHENTICATION_EXCEPTION_KEY => BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(),
-            self::TYPE_VALIDATION_EXCEPTION_KEY     => BaseApiCodes::EX_VALIDATION_EXCEPTION(),
-            self::TYPE_HTTP_EXCEPTION_KEY           => BaseApiCodes::EX_HTTP_EXCEPTION(),
-        ];
-        $base_api_code = BaseApiCodes::NO_ERROR_MESSAGE();
-        foreach ($known_codes as $item_config_key => $item_api_code) {
-            if ($api_code === Config::get("{$base_key}.{$item_config_key}.code", $item_api_code)) {
-                $base_api_code = $api_code;
-                break;
-            }
-        }
-
-        /** @var array|null $data Optional payload to return */
-        $data = null;
-        if ($api_code === Config::get("{$base_key}.validation_exception.code", BaseApiCodes::EX_VALIDATION_EXCEPTION())) {
-            /** @var ValidationException $exception */
-            $data = [ResponseBuilder::KEY_MESSAGES => $exception->validator->errors()->messages()];
-        }
-
-        $key = BaseApiCodes::getCodeMessageKey($api_code) ?? BaseApiCodes::getCodeMessageKey($base_api_code);
-
-        // let's build error error_message
-        $error_message = $exception->getMessage();
-
-        // if we do not have any error_message in the hand yet, we need to fall back to built-in string configured
-        // for this particular exception.
-        if ($error_message === '') {
-            $error_message = Lang::get($key, [
-                'api_code' => $api_code,
+	/**
+	 * Exception types
+	 */
+	public const TYPE_HTTP_NOT_FOUND_KEY           = 'http_not_found';
+	public const TYPE_HTTP_SERVICE_UNAVAILABLE_KEY = 'http_service_unavailable';
+	public const TYPE_HTTP_UNAUTHORIZED_KEY        = 'authentication_exception';
+	public const TYPE_HTTP_EXCEPTION_KEY           = 'http_exception';
+	public const TYPE_VALIDATION_EXCEPTION_KEY     = 'validation_exception';
+	public const TYPE_UNCAUGHT_EXCEPTION_KEY       = 'uncaught_exception';
+	public const TYPE_AUTHENTICATION_EXCEPTION_KEY = 'authentication_exception';
+
+	/**
+	 * Render an exception into valid API response.
+	 *
+	 * @param \Illuminate\Http\Request $request   Request object
+	 * @param \Exception               $exception Exception
+	 *
+	 * @return HttpResponse
+	 */
+	public static function render(/** @scrutinizer ignore-unused */ $request, Exception $exception): HttpResponse
+	{
+		$result = null;
+
+		if ($exception instanceof HttpException) {
+			switch ($exception->getStatusCode()) {
+				case HttpResponse::HTTP_NOT_FOUND:
+					$result = static::error($exception, static::TYPE_HTTP_NOT_FOUND_KEY,
+						BaseApiCodes::EX_HTTP_NOT_FOUND(), HttpResponse::HTTP_NOT_FOUND);
+					break;
+
+				case HttpResponse::HTTP_SERVICE_UNAVAILABLE:
+					$result = static::error($exception, static::TYPE_HTTP_SERVICE_UNAVAILABLE_KEY,
+						BaseApiCodes::EX_HTTP_SERVICE_UNAVAILABLE(), HttpResponse::HTTP_SERVICE_UNAVAILABLE);
+					break;
+
+				case HttpResponse::HTTP_UNAUTHORIZED:
+					$result = static::error($exception, static::TYPE_HTTP_UNAUTHORIZED_KEY,
+						BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(), HttpResponse::HTTP_UNAUTHORIZED);
+					break;
+
+				default:
+					$result = static::error($exception, static::TYPE_HTTP_EXCEPTION_KEY,
+						BaseApiCodes::EX_HTTP_EXCEPTION(), HttpResponse::HTTP_BAD_REQUEST);
+					break;
+			}
+		} elseif ($exception instanceof ValidationException) {
+			$result = static::error($exception, static::TYPE_VALIDATION_EXCEPTION_KEY,
+				BaseApiCodes::EX_VALIDATION_EXCEPTION(), HttpResponse::HTTP_BAD_REQUEST);
+		}
+
+		if ($result === null) {
+			$result = static::error($exception, static::TYPE_UNCAUGHT_EXCEPTION_KEY,
+				BaseApiCodes::EX_UNCAUGHT_EXCEPTION(), HttpResponse::HTTP_INTERNAL_SERVER_ERROR);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * 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,
+																		 AuthenticationException $exception): HttpResponse
+	{
+		return static::error($exception, 'authentication_exception', BaseApiCodes::EX_AUTHENTICATION_EXCEPTION());
+	}
+
+	/**
+	 * Process singe error and produce valid API response
+	 *
+	 * @param Exception $exception            Exception to be processed
+	 * @param string    $exception_config_key Category of the exception
+	 * @param integer   $fallback_api_code    API code to return
+	 * @param integer   $fallback_http_code   HTTP code to return
+	 *
+	 * @return HttpResponse
+	 */
+	protected static function error(Exception $exception, $exception_config_key, $fallback_api_code,
+									$fallback_http_code = ResponseBuilder::DEFAULT_HTTP_CODE_ERROR): HttpResponse
+	{
+		// common prefix for config key
+		$base_key = sprintf('%s.exception', ResponseBuilder::CONF_EXCEPTION_HANDLER_KEY);
+
+		// get API and HTTP codes from exception handler config or use fallback values if no such
+		// config fields are set.
+		$api_code = Config::get("{$base_key}.{$exception_config_key}.code", $fallback_api_code);
+		$http_code = Config::get("{$base_key}.{$exception_config_key}.http_code", $fallback_http_code);
+
+		// check if we now have valid HTTP error code for this case or need to make one up.
+		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
+			// no code, let's try to get the exception status
+			$http_code = ($exception instanceof \Symfony\Component\HttpKernel\Exception\HttpException)
+				? $exception->getStatusCode()
+				: $exception->getCode();
+		}
+
+		// can it be considered valid HTTP error code?
+		if ($http_code < ResponseBuilder::ERROR_HTTP_CODE_MIN) {
+			$http_code = $fallback_http_code;
+		}
+
+		// let's figure out what event we are handling now
+		$known_codes = [
+			self::TYPE_HTTP_NOT_FOUND_KEY           => BaseApiCodes::EX_HTTP_NOT_FOUND(),
+			self::TYPE_HTTP_SERVICE_UNAVAILABLE_KEY => BaseApiCodes::EX_HTTP_SERVICE_UNAVAILABLE(),
+			self::TYPE_UNCAUGHT_EXCEPTION_KEY       => BaseApiCodes::EX_UNCAUGHT_EXCEPTION(),
+			self::TYPE_AUTHENTICATION_EXCEPTION_KEY => BaseApiCodes::EX_AUTHENTICATION_EXCEPTION(),
+			self::TYPE_VALIDATION_EXCEPTION_KEY     => BaseApiCodes::EX_VALIDATION_EXCEPTION(),
+			self::TYPE_HTTP_EXCEPTION_KEY           => BaseApiCodes::EX_HTTP_EXCEPTION(),
+		];
+		$base_api_code = BaseApiCodes::NO_ERROR_MESSAGE();
+		foreach ($known_codes as $item_config_key => $item_api_code) {
+			if ($api_code === Config::get("{$base_key}.{$item_config_key}.code", $item_api_code)) {
+				$base_api_code = $api_code;
+				break;
+			}
+		}
+
+		/** @var array|null $data Optional payload to return */
+		$data = null;
+		if ($api_code === Config::get("{$base_key}.validation_exception.code", BaseApiCodes::EX_VALIDATION_EXCEPTION())) {
+			/** @var ValidationException $exception */
+			$data = [ResponseBuilder::KEY_MESSAGES => $exception->validator->errors()->messages()];
+		}
+
+		$key = BaseApiCodes::getCodeMessageKey($api_code) ?? BaseApiCodes::getCodeMessageKey($base_api_code);
+
+		// let's build error error_message
+		$error_message = $exception->getMessage();
+
+		// if we do not have any error_message in the hand yet, we need to fall back to built-in string configured
+		// for this particular exception.
+		if ($error_message === '') {
+			$error_message = Lang::get($key, [
+				'api_code' => $api_code,
 				'message'  => '???',
-            ]);
-        }
-
-        // if we have trace data debugging enabled, let's gather some debug
-        // info and add to the response.
-        $trace_data = null;
-        if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, false)) {
-            $trace_data = [
-                Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_KEY, ResponseBuilder::KEY_TRACE) => [
-                    ResponseBuilder::KEY_CLASS => get_class($exception),
-                    ResponseBuilder::KEY_FILE  => $exception->getFile(),
-                    ResponseBuilder::KEY_LINE  => $exception->getLine(),
-                ],
-            ];
-        }
-
-        return ResponseBuilder::errorWithMessageAndDataAndDebug($api_code, $error_message, $data,
-            $http_code, null, $trace_data);
-    }
+			]);
+		}
+
+		// if we have trace data debugging enabled, let's gather some debug
+		// info and add to the response.
+		$trace_data = null;
+		if (Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_ENABLED, false)) {
+			$trace_data = [
+				Config::get(ResponseBuilder::CONF_KEY_DEBUG_EX_TRACE_KEY, ResponseBuilder::KEY_TRACE) => [
+					ResponseBuilder::KEY_CLASS => get_class($exception),
+					ResponseBuilder::KEY_FILE  => $exception->getFile(),
+					ResponseBuilder::KEY_LINE  => $exception->getLine(),
+				],
+			];
+		}
+
+		return ResponseBuilder::errorWithMessageAndDataAndDebug($api_code, $error_message, $data,
+			$http_code, null, $trace_data);
+	}
 
 }

config/response_builder.php

Indentation +44 added lines, -44 removed lines

@@ -12,69 +12,69 @@ 
  */
 
 return [
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Code range settings
     |-----------------------------------------------------------------------------------------------------------
     */
-    'min_code'          => 100,
-    'max_code'          => 1024,
+	'min_code'          => 100,
+	'max_code'          => 1024,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Error code to message mapping
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'map'               => [
+	'map'               => [
 
-    ],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Response Builder classes
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'classes'           => [
-        \Illuminate\Database\Eloquent\Model::class          => [
-            'key'    => 'item',
-            'method' => 'toArray',
-            'pri'    => 0,
-        ],
-        \Illuminate\Support\Collection::class               => [
-            'key'    => 'items',
-            'method' => 'toArray',
-            'pri'    => -1,
-        ],
-        \Illuminate\Database\Eloquent\Collection::class     => [
-            'key'    => 'items',
-            'method' => 'toArray',
-            'pri'    => 0,
-        ],
-        \Illuminate\Http\Resources\Json\JsonResource::class => [
-            'key'    => 'item',
-            'method' => 'toArray',
-            'pri'    => 0,
-        ],
-    ],
+	'classes'           => [
+		\Illuminate\Database\Eloquent\Model::class          => [
+			'key'    => 'item',
+			'method' => 'toArray',
+			'pri'    => 0,
+		],
+		\Illuminate\Support\Collection::class               => [
+			'key'    => 'items',
+			'method' => 'toArray',
+			'pri'    => -1,
+		],
+		\Illuminate\Database\Eloquent\Collection::class     => [
+			'key'    => 'items',
+			'method' => 'toArray',
+			'pri'    => 0,
+		],
+		\Illuminate\Http\Resources\Json\JsonResource::class => [
+			'key'    => 'item',
+			'method' => 'toArray',
+			'pri'    => 0,
+		],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | 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,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Exception handler error codes
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'exception_handler' => [
-        'exception' => [
+	'exception_handler' => [
+		'exception' => [
 //			'http_not_found' => [
 //				'code'      => \App\ApiCodes::HTTP_NOT_FOUND(),
 //				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST,
@@ -99,21 +99,21 @@ 
 //				'code'      => \App\ApiCodes::VALIDATION_EXCEPTION(),
 //				'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_UNPROCESSABLE_ENTITY,
 //			],
-        ],
-    ],
+		],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | 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),
+		],
+	],
 
 ];

src/ResponseBuilderServiceProvider.php

Indentation +47 added lines, -47 removed lines

@@ -25,60 +25,60 @@
 
 class ResponseBuilderServiceProvider extends ServiceProvider
 {
-    /**
-     * Register bindings in the container.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        $this->mergeConfigFrom(
-            __DIR__ . '/../config/response_builder.php', 'response_builder'
-        );
-    }
+	/**
+	 * Register bindings in the container.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		$this->mergeConfigFrom(
+			__DIR__ . '/../config/response_builder.php', 'response_builder'
+		);
+	}
 
-    /**
-     * Sets up package resources
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
+	/**
+	 * Sets up package resources
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
 
-        $source = __DIR__ . '/../config/response_builder.php';
-        $this->publishes([
-            $source => config_path('response_builder.php'),
-        ]);
-    }
+		$source = __DIR__ . '/../config/response_builder.php';
+		$this->publishes([
+			$source => config_path('response_builder.php'),
+		]);
+	}
 
-    /**
-     * Merge the given configuration with the existing configuration.
-     *
-     * @param string $path
-     * @param string $key
-     *
-     * @return void
-     */
-    protected function mergeConfigFrom($path, $key)
-    {
-        $defaults = require $path;
-        $config = $this->app['config']->get($key, []);
+	/**
+	 * Merge the given configuration with the existing configuration.
+	 *
+	 * @param string $path
+	 * @param string $key
+	 *
+	 * @return void
+	 */
+	protected function mergeConfigFrom($path, $key)
+	{
+		$defaults = require $path;
+		$config = $this->app['config']->get($key, []);
 
-        $merged_config = Util::mergeConfig($defaults, $config);
+		$merged_config = Util::mergeConfig($defaults, $config);
 
-        // we now need to sort 'classes' node by priority
-        uasort($merged_config['classes'], function($a, $b) {
-            $pri_a = $a['pri'] ?? 0;
-            $pri_b = $b['pri'] ?? 0;
+		// we now need to sort 'classes' node by priority
+		uasort($merged_config['classes'], function($a, $b) {
+			$pri_a = $a['pri'] ?? 0;
+			$pri_b = $b['pri'] ?? 0;
 
-            return $pri_b <=> $pri_a;
-        });
+			return $pri_b <=> $pri_a;
+		});
 
-        print_r($merged_config);
-        die();
+		print_r($merged_config);
+		die();
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }

src/Util.php

Indentation +36 added lines, -36 removed lines

@@ -15,43 +15,43 @@
  */
 final class Util
 {
-    /**
-     * Merges the configs together and takes multi-dimensional arrays into account.
-     * Support for multi-dimensional config array. Built-in config merge only supports flat arrays.
-     * Throws \RuntimeException if arrays stucture causes type conflics (i.e. you want to merge
-     * array with int).
-     *
-     * @param array $original Array to merge other array into. Usually default values to overwrite.
-     * @param array $merging  Array with items to be merged into $original, overriding (primitives) or merging
-     *                        (arrays) entries in destination array.
-     *
-     * @return array
-     *
-     * @throws \RuntimeException
-     */
-    public static function mergeConfig(array $original, array $merging): array
-    {
-        $array = $original;
-        foreach ($merging as $m_key => $m_val) {
-            if (array_key_exists($m_key, $original)) {
-                $orig_type = gettype($original[ $m_key ]);
-                $m_type = gettype($m_val);
-                if ($orig_type !== $m_type) {
-                    throw new \RuntimeException(
-                        "Incompatible types. Cannot merge {$m_type} into {$orig_type} (key '{$m_key}').");
-                }
+	/**
+	 * Merges the configs together and takes multi-dimensional arrays into account.
+	 * Support for multi-dimensional config array. Built-in config merge only supports flat arrays.
+	 * Throws \RuntimeException if arrays stucture causes type conflics (i.e. you want to merge
+	 * array with int).
+	 *
+	 * @param array $original Array to merge other array into. Usually default values to overwrite.
+	 * @param array $merging  Array with items to be merged into $original, overriding (primitives) or merging
+	 *                        (arrays) entries in destination array.
+	 *
+	 * @return array
+	 *
+	 * @throws \RuntimeException
+	 */
+	public static function mergeConfig(array $original, array $merging): array
+	{
+		$array = $original;
+		foreach ($merging as $m_key => $m_val) {
+			if (array_key_exists($m_key, $original)) {
+				$orig_type = gettype($original[ $m_key ]);
+				$m_type = gettype($m_val);
+				if ($orig_type !== $m_type) {
+					throw new \RuntimeException(
+						"Incompatible types. Cannot merge {$m_type} into {$orig_type} (key '{$m_key}').");
+				}
 
-                if (is_array($merging[ $m_key ])) {
-                    $array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
-                } else {
-                    $array[ $m_key ] = $m_val;
-                }
-            } else {
-                $array[ $m_key ] = $m_val;
-            }
-        }
+				if (is_array($merging[ $m_key ])) {
+					$array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
+				} else {
+					$array[ $m_key ] = $m_val;
+				}
+			} else {
+				$array[ $m_key ] = $m_val;
+			}
+		}
 
-        return $array;
-    }
+		return $array;
+	}
 
 }