MarcinOrlowski / laravel-api-response-builder

src/ApiCodesHelpers.php

Indentation +120 added lines, -120 removed lines

@@ -21,125 +21,125 @@
  */
 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
-     */
-    public static function getCodeForInternalOffset(int $internal_code): int
-    {
-        $min = static::RESERVED_MIN_API_CODE_OFFSET;
-        $max = static::RESERVED_MAX_API_CODE_OFFSET;
-        Validator::assertIsIntRange('internal_code', $internal_code, $min, $max);
-
-        return ($internal_code === 0) ? 0 : $internal_code + static::getMinCode();
-    }
+	/**
+	 * Returns lowest allowed error code for this module
+	 *
+	 * @return integer
+	 *
+	 * @throws \RuntimeException Throws exception if no min_code set up
+	 */
+	public static function getMinCode(): int
+	{
+		$key = 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
+	 */
+	public static function getCodeForInternalOffset(int $internal_code): int
+	{
+		$min = static::RESERVED_MIN_API_CODE_OFFSET;
+		$max = static::RESERVED_MAX_API_CODE_OFFSET;
+		Validator::assertIsIntRange('internal_code', $internal_code, $min, $max);
+
+		return ($internal_code === 0) ? 0 : $internal_code + static::getMinCode();
+	}
 
 }

src/Converters/ToArrayConverter.php

Indentation +14 added lines, -14 removed lines

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

src/Converters/ArrayableConverter.php

Indentation +14 added lines, -14 removed lines

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

src/ExceptionHandlerHelper.php

Indentation +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 	 * @return \Symfony\Component\HttpFoundation\Response
 	 */
 	protected static function processException(\Exception $ex, array $ex_cfg,
-	                                           int $fallback_http_code = HttpResponse::HTTP_INTERNAL_SERVER_ERROR)
+											   int $fallback_http_code = HttpResponse::HTTP_INTERNAL_SERVER_ERROR)
 	{
 		$api_code = $ex_cfg['api_code'];
 		$http_code = $ex_cfg['http_code'] ?? $fallback_http_code;
@@ -142,7 +142,7 @@ 
 	 * @return HttpResponse
 	 */
 	protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
-	                                                                     AuthException $exception): HttpResponse
+																		 AuthException $exception): HttpResponse
 	{
 		$cfg = self::getExceptionHandlerConfig();
 
@@ -163,7 +163,7 @@ 
 	 * @return HttpResponse
 	 */
 	protected static function error(Exception $ex,
-	                                int $api_code, int $http_code = null, string $error_message): HttpResponse
+									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;

src/Util.php

Indentation +50 added lines, -50 removed lines

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

config/response_builder.php

Indentation +73 added lines, -73 removed lines

@@ -12,78 +12,78 @@ 
  */
 
 return [
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Code range settings
     |-----------------------------------------------------------------------------------------------------------
     */
-    'min_code'          => 100,
-    'max_code'          => 1024,
+	'min_code'          => 100,
+	'max_code'          => 1024,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Error code to message mapping
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'map'               => [
-        // YOUR_API_CODE => '<MESSAGE_KEY>',
-    ],
+	'map'               => [
+		// YOUR_API_CODE => '<MESSAGE_KEY>',
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Response Builder data converter
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'converter'         => [
-        \Illuminate\Database\Eloquent\Model::class          => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-            // 'key'     => 'item',
-            'pri'     => 0,
-        ],
-        \Illuminate\Support\Collection::class               => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-            // 'key'     => 'item',
-            'pri'     => 0,
-        ],
-        \Illuminate\Database\Eloquent\Collection::class     => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-            // 'key'     => 'item',
-            'pri'     => 0,
-        ],
-        \Illuminate\Http\Resources\Json\JsonResource::class => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-            // 'key'     => 'item',
-            'pri'     => 0,
-        ],
+	'converter'         => [
+		\Illuminate\Database\Eloquent\Model::class          => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+			// 'key'     => 'item',
+			'pri'     => 0,
+		],
+		\Illuminate\Support\Collection::class               => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+			// 'key'     => 'item',
+			'pri'     => 0,
+		],
+		\Illuminate\Database\Eloquent\Collection::class     => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+			// 'key'     => 'item',
+			'pri'     => 0,
+		],
+		\Illuminate\Http\Resources\Json\JsonResource::class => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+			// 'key'     => 'item',
+			'pri'     => 0,
+		],
 
-        /*
+		/*
         |-----------------------------------------------------------------------------------------------------------
         | Generic converters should have lower pri to allow dedicated ones to kick in first when class matches
         |-----------------------------------------------------------------------------------------------------------
         */
-        \JsonSerializable::class                            => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
-            // 'key'     => 'item',
-            'pri'     => -10,
-        ],
-        \Illuminate\Contracts\Support\Arrayable::class      => [
-            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
-            // 'key'     => 'item',
-            'pri'     => -10,
-        ],
+		\JsonSerializable::class                            => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
+			// 'key'     => 'item',
+			'pri'     => -10,
+		],
+		\Illuminate\Contracts\Support\Arrayable::class      => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+			// 'key'     => 'item',
+			'pri'     => -10,
+		],
 
-    ],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Exception handler error codes
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'exception_handler' => [
-	    /*
+	'exception_handler' => [
+		/*
 	     * The following keys are supported for each handler specified.
 	     *   `handler`
 	     *   `pri`
@@ -103,17 +103,17 @@ 
 		 *                  message ($ex->getMessage()).
 		 */
 
-    	Illuminate\Validation\ValidationException::class => [
-		    'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
-		    'pri'     => -100,
-		    'config' => [
-		    	],
-	    ],
+		Illuminate\Validation\ValidationException::class => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
+			'pri'     => -100,
+			'config' => [
+				],
+		],
 
 		\Symfony\Component\HttpKernel\Exception\HttpException::class => [
-	        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-	        'pri'     => -100,
-	        'config'  => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+			'pri'     => -100,
+			'config'  => [
 //		        HttpException::class => [
 //			        // used by unauthenticated() to obtain api and http code for the exception
 //			        HttpResponse::HTTP_UNAUTHORIZED         => [
@@ -129,41 +129,41 @@ 
 //				        'http_code' => HttpResponse::HTTP_BAD_REQUEST,
 //			        ],
 //		        ],
-	        ],
+			],
 //	        // This is final exception handler. If ex is not dealt with yet this is its last stop.
-	        // default handler is mandatory and MUST have both `api_code` and `http_code` set.
+			// default handler is mandatory and MUST have both `api_code` and `http_code` set.
 
-	        'default' => [
-		        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-		        'pri'     => -127,
-		        'config'  => [
+			'default' => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+				'pri'     => -127,
+				'config'  => [
 //			        'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION,
 //			        'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
-		        ],
-	        ],
-	    ],
-    ],
+				],
+			],
+		],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | data-to-json encoding options
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
+	'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Debug config
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'debug'             => [
-        'debug_key'         => 'debug',
-        'exception_handler' => [
-            'trace_key'     => 'trace',
-            'trace_enabled' => env('APP_DEBUG', false),
-        ],
-    ],
+	'debug'             => [
+		'debug_key'         => 'debug',
+		'exception_handler' => [
+			'trace_key'     => 'trace',
+			'trace_enabled' => env('APP_DEBUG', false),
+		],
+	],
 
 ];