MarcinOrlowski / laravel-api-response-builder

src/Validator.php

Indentation +179 added lines, -179 removed lines

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

src/Contracts/ConverterContract.php

Indentation +10 added lines, -10 removed lines

@@ -15,14 +15,14 @@
  */
 interface ConverterContract
 {
-    /**
-     * Returns array representation of the object.
-     *
-     * @param object $obj    Object to be converted
-     * @param array  $config Converter config array to be used for this object (based on exact class
-     *                       name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert($obj, array $config): array;
+	/**
+	 * Returns array representation of the object.
+	 *
+	 * @param object $obj    Object to be converted
+	 * @param array  $config Converter config array to be used for this object (based on exact class
+	 *                       name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert($obj, array $config): array;
 }

src/Converter.php

Indentation +173 added lines, -173 removed lines

@@ -22,177 +22,177 @@
  */
 class Converter
 {
-    /**
-     * @var array
-     */
-    protected $classes = [];
-
-    /**
-     * Converter constructor.
-     *
-     * @throws \RuntimeException
-     */
-    public function __construct()
-    {
-        $this->classes = static::getClassesMapping() ?? [];
-    }
-
-    /**
-     * Returns local copy of configuration mapping for the classes.
-     *
-     * @return array
-     */
-    public function getClasses(): array
-    {
-        return $this->classes;
-    }
-
-    /**
-     * Checks if we have "classes" mapping configured for $data object class.
-     * Returns @true if there's valid config for this class.
-     * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured.
-     * Throws \InvalidArgumentException if No data conversion mapping configured for given class.
-     *
-     * @param object $data Object to check mapping for.
-     *
-     * @return array
-     *
-     * @throws \InvalidArgumentException
-     */
-    protected function getClassMappingConfigOrThrow(object $data): array
-    {
-        $result = null;
-
-        // check for exact class name match...
-        $cls = get_class($data);
-        if (array_key_exists($cls, $this->classes)) {
-            $result = $this->classes[ $cls ];
-        } else {
-            // no exact match, then lets try with `instanceof`
-            foreach (array_keys($this->getClasses()) as $class_name) {
-                if ($data instanceof $class_name) {
-                    $result = $this->classes[ $class_name ];
-                    break;
-                }
-            }
-        }
-
-        if ($result === null) {
-            throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls));
-        }
-
-        return $result;
-    }
-
-    /**
-     * We need to prepare source data
-     *
-     * @param object|array|null $data
-     *
-     * @return array|null
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function convert($data = null): ?array
-    {
-        if ($data === null) {
-            return null;
-        }
-
-        Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
-                                                Validator::TYPE_OBJECT]);
-
-        if (is_object($data)) {
-            $cfg = $this->getClassMappingConfigOrThrow($data);
-            $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
-            if (array_key_exists(ResponseBuilder::KEY_KEY, $cfg)) {
-                $data = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
-            } else {
-                $data = $worker->convert($data, $cfg);
-            }
-        } else {
-            $data = $this->convertArray($data);
-        }
-
-        return $data;
-    }
-
-    /**
-     * Recursively walks $data array and converts all known objects if found. Note
-     * $data array is passed by reference so source $data array may be modified.
-     *
-     * @param array $data array to recursively convert known elements of
-     *
-     * @return array
-     *
-     * @throws \RuntimeException
-     */
-    protected function convertArray(array $data): array
-    {
-        // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then
-        // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON
-        // array. But you can't mix these two as the final JSON would not produce predictable results.
-        $string_keys_cnt = 0;
-        $int_keys_cnt = 0;
-        foreach ($data as $key => $val) {
-            if (is_int($key)) {
-                $int_keys_cnt++;
-            } else {
-                $string_keys_cnt++;
-            }
-
-            if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) {
-                throw new \RuntimeException(
-                    'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
-                    'Arrays with mixed keys are not supported by design.');
-            }
-        }
-
-        foreach ($data as $key => $val) {
-            if (is_array($val)) {
-                $data[ $key ] = $this->convertArray($val);
-            } elseif (is_object($val)) {
-                $cfg = $this->getClassMappingConfigOrThrow($val);
-                $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
-                $converted_data = $worker->convert($val, $cfg);
-                $data[ $key ] = $converted_data;
-            }
-        }
-
-        return $data;
-    }
-
-    /**
-     * Reads and validates "classes" config mapping
-     *
-     * @return array Classes mapping as specified in configuration or empty array if configuration found
-     *
-     * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc).
-     */
-    protected static function getClassesMapping(): array
-    {
-        $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER);
-
-        if ($classes !== null) {
-            if (!is_array($classes)) {
-                throw new \RuntimeException(
-                    sprintf('CONFIG: "classes" mapping must be an array (%s given)', gettype($classes)));
-            }
-
-            $mandatory_keys = [
-                ResponseBuilder::KEY_HANDLER,
-            ];
-            foreach ($classes as $class_name => $class_config) {
-                foreach ($mandatory_keys as $key_name) {
-                    if (!array_key_exists($key_name, $class_config)) {
-                        throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping");
-                    }
-                }
-            }
-        } else {
-            $classes = [];
-        }
-
-        return $classes;
-    }
+	/**
+	 * @var array
+	 */
+	protected $classes = [];
+
+	/**
+	 * Converter constructor.
+	 *
+	 * @throws \RuntimeException
+	 */
+	public function __construct()
+	{
+		$this->classes = static::getClassesMapping() ?? [];
+	}
+
+	/**
+	 * Returns local copy of configuration mapping for the classes.
+	 *
+	 * @return array
+	 */
+	public function getClasses(): array
+	{
+		return $this->classes;
+	}
+
+	/**
+	 * Checks if we have "classes" mapping configured for $data object class.
+	 * Returns @true if there's valid config for this class.
+	 * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured.
+	 * Throws \InvalidArgumentException if No data conversion mapping configured for given class.
+	 *
+	 * @param object $data Object to check mapping for.
+	 *
+	 * @return array
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	protected function getClassMappingConfigOrThrow(object $data): array
+	{
+		$result = null;
+
+		// check for exact class name match...
+		$cls = get_class($data);
+		if (array_key_exists($cls, $this->classes)) {
+			$result = $this->classes[ $cls ];
+		} else {
+			// no exact match, then lets try with `instanceof`
+			foreach (array_keys($this->getClasses()) as $class_name) {
+				if ($data instanceof $class_name) {
+					$result = $this->classes[ $class_name ];
+					break;
+				}
+			}
+		}
+
+		if ($result === null) {
+			throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls));
+		}
+
+		return $result;
+	}
+
+	/**
+	 * We need to prepare source data
+	 *
+	 * @param object|array|null $data
+	 *
+	 * @return array|null
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public function convert($data = null): ?array
+	{
+		if ($data === null) {
+			return null;
+		}
+
+		Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
+												Validator::TYPE_OBJECT]);
+
+		if (is_object($data)) {
+			$cfg = $this->getClassMappingConfigOrThrow($data);
+			$worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+			if (array_key_exists(ResponseBuilder::KEY_KEY, $cfg)) {
+				$data = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
+			} else {
+				$data = $worker->convert($data, $cfg);
+			}
+		} else {
+			$data = $this->convertArray($data);
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Recursively walks $data array and converts all known objects if found. Note
+	 * $data array is passed by reference so source $data array may be modified.
+	 *
+	 * @param array $data array to recursively convert known elements of
+	 *
+	 * @return array
+	 *
+	 * @throws \RuntimeException
+	 */
+	protected function convertArray(array $data): array
+	{
+		// This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then
+		// be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON
+		// array. But you can't mix these two as the final JSON would not produce predictable results.
+		$string_keys_cnt = 0;
+		$int_keys_cnt = 0;
+		foreach ($data as $key => $val) {
+			if (is_int($key)) {
+				$int_keys_cnt++;
+			} else {
+				$string_keys_cnt++;
+			}
+
+			if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) {
+				throw new \RuntimeException(
+					'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
+					'Arrays with mixed keys are not supported by design.');
+			}
+		}
+
+		foreach ($data as $key => $val) {
+			if (is_array($val)) {
+				$data[ $key ] = $this->convertArray($val);
+			} elseif (is_object($val)) {
+				$cfg = $this->getClassMappingConfigOrThrow($val);
+				$worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+				$converted_data = $worker->convert($val, $cfg);
+				$data[ $key ] = $converted_data;
+			}
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Reads and validates "classes" config mapping
+	 *
+	 * @return array Classes mapping as specified in configuration or empty array if configuration found
+	 *
+	 * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc).
+	 */
+	protected static function getClassesMapping(): array
+	{
+		$classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER);
+
+		if ($classes !== null) {
+			if (!is_array($classes)) {
+				throw new \RuntimeException(
+					sprintf('CONFIG: "classes" mapping must be an array (%s given)', gettype($classes)));
+			}
+
+			$mandatory_keys = [
+				ResponseBuilder::KEY_HANDLER,
+			];
+			foreach ($classes as $class_name => $class_config) {
+				foreach ($mandatory_keys as $key_name) {
+					if (!array_key_exists($key_name, $class_config)) {
+						throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping");
+					}
+				}
+			}
+		} else {
+			$classes = [];
+		}
+
+		return $classes;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -66,12 +66,12 @@ 
         // check for exact class name match...
         $cls = get_class($data);
         if (array_key_exists($cls, $this->classes)) {
-            $result = $this->classes[ $cls ];
+            $result = $this->classes[$cls];
         } else {
             // no exact match, then lets try with `instanceof`
             foreach (array_keys($this->getClasses()) as $class_name) {
                 if ($data instanceof $class_name) {
-                    $result = $this->classes[ $class_name ];
+                    $result = $this->classes[$class_name];
                     break;
                 }
             }
@@ -104,9 +104,9 @@ 
 
         if (is_object($data)) {
             $cfg = $this->getClassMappingConfigOrThrow($data);
-            $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+            $worker = new $cfg[ResponseBuilder::KEY_HANDLER]();
             if (array_key_exists(ResponseBuilder::KEY_KEY, $cfg)) {
-                $data = [$cfg[ ResponseBuilder::KEY_KEY ] => $worker->convert($data, $cfg)];
+                $data = [$cfg[ResponseBuilder::KEY_KEY] => $worker->convert($data, $cfg)];
             } else {
                 $data = $worker->convert($data, $cfg);
             }
@@ -150,12 +150,12 @@ 
 
         foreach ($data as $key => $val) {
             if (is_array($val)) {
-                $data[ $key ] = $this->convertArray($val);
+                $data[$key] = $this->convertArray($val);
             } elseif (is_object($val)) {
                 $cfg = $this->getClassMappingConfigOrThrow($val);
-                $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ]();
+                $worker = new $cfg[ResponseBuilder::KEY_HANDLER]();
                 $converted_data = $worker->convert($val, $cfg);
-                $data[ $key ] = $converted_data;
+                $data[$key] = $converted_data;
             }
         }
 

src/Converters/ToArrayConverter.php

Indentation +14 added lines, -14 removed lines

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

src/Converters/JsonSerializableConverter.php

Indentation +14 added lines, -14 removed lines

@@ -19,19 +19,19 @@
 
 class JsonSerializableConverter implements ConverterContract
 {
-    /**
-     * Returns array representation of the object implementing \JsonSerializable interface.
-     *
-     * @param \JsonSerializable $obj    Object to be converted
-     * @param array             $config Converter config array to be used for this object (based on exact class
-     *                                  name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array
-    {
-        Validator::assertInstanceOf('obj', $obj, \JsonSerializable::class);
+	/**
+	 * Returns array representation of the object implementing \JsonSerializable interface.
+	 *
+	 * @param \JsonSerializable $obj    Object to be converted
+	 * @param array             $config Converter config array to be used for this object (based on exact class
+	 *                                  name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array
+	{
+		Validator::assertInstanceOf('obj', $obj, \JsonSerializable::class);
 
-        return ['val' => json_decode($obj->jsonSerialize(), true)];
-    }
+		return ['val' => json_decode($obj->jsonSerialize(), true)];
+	}
 }

config/response_builder.php

Indentation +80 added lines, -80 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,
+		],
 
-        /*
+		/*
         |-----------------------------------------------------------------------------------------------------------
         | Converters for generic classes should use lower priority to allow dedicated converters to be used.
         |-----------------------------------------------------------------------------------------------------------
         */
-        \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 options can be used for each entry specified:
          * `api_code`   : (int) mandatory api_code to be used for given exception
          * `http_code`  : (int) optional HTTP code. If not specified, exception's HTTP status code will be used.
@@ -96,8 +96,8 @@ 
          *                `msg_key` is set, or message referenced by `msg_key` completely ignoring exception
          *                message ($ex->getMessage()).
          */
-        'map' => [
-            /*
+		'map' => [
+			/*
              * HTTP Exceptions
              * ---------------
              * Configure how you want Http Exception to be handled based on its Http status code.
@@ -105,51 +105,51 @@ 
              * Additionally, you can specify `http_code` to be any valid 400-599 HTTP status code, otherwise
              * code set in the exception will be used.
              */
-            //            HttpException::class => [
-            //                // used by unauthenticated() to obtain api and http code for the exception
-            //                HttpResponse::HTTP_UNAUTHORIZED         => [
-            //                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNATHORIZED_EXCEPTION,
-            //                ],
-            //                // Required by ValidationException handler
-            //                HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [
-            //                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION,
-            //                ],
-            //                // default handler is mandatory and MUST have both `api_code` and `http_code` set.
-            //                'default'                               => [
-            //                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_GENERIC_HTTP_EXCEPTION,
-            //                    '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'            => [
-            //                'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION,
-            //                'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
-            //            ],
-            //        ],
-        ],
-    ],
+			//            HttpException::class => [
+			//                // used by unauthenticated() to obtain api and http code for the exception
+			//                HttpResponse::HTTP_UNAUTHORIZED         => [
+			//                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNATHORIZED_EXCEPTION,
+			//                ],
+			//                // Required by ValidationException handler
+			//                HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [
+			//                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION,
+			//                ],
+			//                // default handler is mandatory and MUST have both `api_code` and `http_code` set.
+			//                'default'                               => [
+			//                    'api_code'  => ApiCodes::YOUR_API_CODE_FOR_GENERIC_HTTP_EXCEPTION,
+			//                    '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'            => [
+			//                '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),
+		],
+	],
 
 ];