MarcinOrlowski / laravel-api-response-builder

src/ResponseBuilder.php

Indentation +12 added lines, -12 removed lines

@@ -85,7 +85,7 @@ 
 	 * @return HttpResponse
 	 */
 	public static function success($data = null, $api_code = null, array $placeholders = null,
-	                               int $http_code = null, int $json_opts = null): HttpResponse
+								   int $http_code = null, int $json_opts = null): HttpResponse
 	{
 		return static::asSuccess($api_code)
 			->withData($data)
@@ -113,7 +113,7 @@ 
 	 * @return HttpResponse
 	 */
 	public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
-	                             int $json_opts = null): HttpResponse
+								 int $json_opts = null): HttpResponse
 	{
 		return static::asError($api_code)
 			->withPlaceholders($placeholders)
@@ -162,7 +162,7 @@ 
 	public function withHttpCode(int $http_code = null): self
 	{
 		Validator::assertIsType('http_code', $http_code, [Type::INTEGER,
-		                                                  Type::NULL]);
+														  Type::NULL]);
 		$this->http_code = $http_code;
 
 		return $this;
@@ -176,8 +176,8 @@ 
 	public function withData($data = null): self
 	{
 		Validator::assertIsType('data', $data, [Type::ARRAY,
-		                                        Type::OBJECT,
-		                                        Type::NULL]);
+												Type::OBJECT,
+												Type::NULL]);
 		$this->data = $data;
 
 		return $this;
@@ -191,7 +191,7 @@ 
 	public function withJsonOptions(int $json_opts = null): self
 	{
 		Validator::assertIsType('json_opts', $json_opts, [Type::INTEGER,
-		                                                  Type::NULL]);
+														  Type::NULL]);
 		$this->json_opts = $json_opts;
 
 		return $this;
@@ -205,7 +205,7 @@ 
 	public function withDebugData(array $debug_data = null): self
 	{
 		Validator::assertIsType('$debug_data', $debug_data, [Type::ARRAY,
-		                                                     Type::NULL]);
+															 Type::NULL]);
 		$this->debug_data = $debug_data;
 
 		return $this;
@@ -219,7 +219,7 @@ 
 	public function withMessage(string $msg = null): self
 	{
 		Validator::assertIsType('message', $msg, [Type::STRING,
-		                                          Type::NULL]);
+												  Type::NULL]);
 		$this->message = $msg;
 
 		return $this;
@@ -306,8 +306,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function make(bool $success, int $api_code, $msg_or_api_code, $data = null,
-	                        int $http_code = null, array $placeholders = null, array $http_headers = null,
-	                        int $json_opts = null, array $debug_data = null): HttpResponse
+							int $http_code = null, array $placeholders = null, array $http_headers = null,
+							int $json_opts = null, array $debug_data = null): HttpResponse
 	{
 		$http_headers = $http_headers ?? [];
 		$http_code = $http_code ?? ($success ? RB::DEFAULT_HTTP_CODE_OK : RB::DEFAULT_HTTP_CODE_ERROR);
@@ -346,8 +346,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function buildResponse(bool $success, int $api_code,
-	                                 $msg_or_api_code, array $placeholders = null,
-	                                 $data = null, array $debug_data = null): array
+									 $msg_or_api_code, array $placeholders = null,
+									 $data = null, array $debug_data = null): array
 	{
 		// ensure $data is either @null, array or object of class with configured mapping.
 		$data = (new Converter())->convert($data);

Spacing +1 added lines, -1 removed lines

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

src/ResponseBuilderServiceProvider.php

Indentation +44 added lines, -44 removed lines

@@ -25,56 +25,56 @@
 
 class ResponseBuilderServiceProvider extends ServiceProvider
 {
-    protected $config_files = [
-        'response_builder.php',
-    ];
+	protected $config_files = [
+		'response_builder.php',
+	];
 
-    /**
-     * Register bindings in the container.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        foreach ($this->config_files as $file) {
-            $this->mergeConfigFrom(__DIR__ . "/../config/{$file}", RB::CONF_CONFIG);
-        }
-    }
+	/**
+	 * Register bindings in the container.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		foreach ($this->config_files as $file) {
+			$this->mergeConfigFrom(__DIR__ . "/../config/{$file}", RB::CONF_CONFIG);
+		}
+	}
 
-    /**
-     * 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');
 
-        foreach ($this->config_files as $file) {
-            $this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
-        }
-    }
+		foreach ($this->config_files as $file) {
+			$this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
+		}
+	}
 
-    /**
-     * 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);
 
-        if (\array_key_exists('converter', $merged_config)) {
-            Util::sortArrayByPri($merged_config['converter']);
-        }
+		if (\array_key_exists('converter', $merged_config)) {
+			Util::sortArrayByPri($merged_config['converter']);
+		}
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }

src/Converter.php

Spacing +12 added lines, -12 removed lines

@@ -61,7 +61,7 @@ 
 	    $result = null;
 
 	    $type = \gettype($data);
-	    $result = $this->primitives[ $type ] ?? null;
+	    $result = $this->primitives[$type] ?? null;
 	    if ($result === null) {
 		    throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" primitive.', $type));
 	    }
@@ -93,13 +93,13 @@ 
         $cls = \get_class($data);
         if (\is_string($cls)) {
 	        if (\array_key_exists($cls, $this->classes)) {
-		        $result = $this->classes[ $cls ];
+		        $result = $this->classes[$cls];
 		        $debug_result = 'exact config match';
 	        } else {
 		        // no exact match, then lets try with `instanceof`
 		        foreach (\array_keys($this->classes) as $class_name) {
 			        if ($data instanceof $class_name) {
-				        $result = $this->classes[ $class_name ];
+				        $result = $this->classes[$class_name];
 				        $debug_result = "subclass of {$class_name}";
 				        break;
 			        }
@@ -146,22 +146,22 @@ 
 
 	    if ($result === null && \is_object($data)) {
 		    $cfg = $this->getClassMappingConfigOrThrow($data);
-		    $worker = new $cfg[ RB::KEY_HANDLER ]();
-		    $result = [$cfg[ RB::KEY_KEY ] => $worker->convert($data, $cfg)];
+		    $worker = new $cfg[RB::KEY_HANDLER]();
+		    $result = [$cfg[RB::KEY_KEY] => $worker->convert($data, $cfg)];
 	    }
 
 	    if ($result === null && \is_array($data)) {
 	        $cfg = $this->getPrimitiveMappingConfigOrThrow($data);
 
-	        if ($this->hasNonNumericKeys($data)){
+	        if ($this->hasNonNumericKeys($data)) {
 		        $result = $this->convertArray($data);
 	        } else {
-		        $result = [$cfg[ RB::KEY_KEY ] => $this->convertArray($data)];
+		        $result = [$cfg[RB::KEY_KEY] => $this->convertArray($data)];
 	        }
         }
 
-	    if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data];
+	    if (\is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
+		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[RB::KEY_KEY] => $data];
 	    }
 
 	    return $result;
@@ -218,12 +218,12 @@ 
 
         foreach ($data as $key => $val) {
             if (\is_array($val)) {
-                $data[ $key ] = $this->convertArray($val);
+                $data[$key] = $this->convertArray($val);
             } elseif (\is_object($val)) {
                 $cfg = $this->getClassMappingConfigOrThrow($val);
-                $worker = new $cfg[ RB::KEY_HANDLER ]();
+                $worker = new $cfg[RB::KEY_HANDLER]();
                 $converted_data = $worker->convert($val, $cfg);
-                $data[ $key ] = $converted_data;
+                $data[$key] = $converted_data;
             }
         }
 

Indentation +217 added lines, -217 removed lines

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

src/Validator.php

Indentation +150 added lines, -150 removed lines

@@ -17,165 +17,165 @@
  */
 class Validator
 {
-    /**
-     * Checks if given $val is of type boolean
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsBool(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::BOOLEAN]);
-    }
+	/**
+	 * Checks if given $val is of type boolean
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsBool(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [Type::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  $value Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsInt(string $key, $value): void
-    {
-        self::assertIsType($key, $value, [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  $value Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsInt(string $key, $value): void
+	{
+		self::assertIsType($key, $value, [Type::INTEGER]);
+	}
 
-    /**
-     * Checks if given $val is of type array
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsArray(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::ARRAY]);
-    }
+	/**
+	 * Checks if given $val is of type array
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsArray(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [Type::ARRAY]);
+	}
 
-    /**
-     * Checks if given $val is an object
-     *
-     * @param string $var_name Name of the key to be used if exception is thrown.
-     * @param mixed  $value    Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsObject(string $var_name, $value): void
-    {
-        self::assertIsType($var_name, $value, [Type::OBJECT]);
-    }
+	/**
+	 * Checks if given $val is an object
+	 *
+	 * @param string $var_name Name of the key to be used if exception is thrown.
+	 * @param mixed  $value    Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsObject(string $var_name, $value): void
+	{
+		self::assertIsType($var_name, $value, [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  $value Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsString(string $name, $value): void
-    {
-        self::assertIsType($name, $value, [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  $value Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsString(string $name, $value): void
+	{
+		self::assertIsType($name, $value, [Type::STRING]);
+	}
 
-    /**
-     * @param string $var_name Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $value    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 $var_name, $value, int $min, int $max): void
-    {
-        self::assertIsInt($var_name, $value);
+	/**
+	 * @param string $var_name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $value    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 $var_name, $value, int $min, int $max): void
+	{
+		self::assertIsInt($var_name, $value);
 
-        if ($min > $max) {
-            throw new \RuntimeException(
-                \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name));
-        }
+		if ($min > $max) {
+			throw new \RuntimeException(
+				\sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name));
+		}
 
-        if (($min > $value) || ($value > $max)) {
-            throw new \InvalidArgumentException(
-                \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max));
-        }
-    }
+		if (($min > $value) || ($value > $max)) {
+			throw new \InvalidArgumentException(
+				\sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max));
+		}
+	}
 
-    /**
-     * Checks if $item (of name $key) is of type that is include in $allowed_types.
-     *
-     * @param string $var_name      Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $value         Variable to be asserted.
-     * @param array  $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER]
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsType(string $var_name, $value, array $allowed_types): void
-    {
-        $type = \gettype($value);
-        if (!\in_array($type, $allowed_types, true)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be one of allowed types: %s (%s given)',
-                    $var_name, implode(', ', $allowed_types), \gettype($value))
-            );
-        }
-    }
+	/**
+	 * Checks if $item (of name $key) is of type that is include in $allowed_types.
+	 *
+	 * @param string $var_name      Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $value         Variable to be asserted.
+	 * @param array  $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER]
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsType(string $var_name, $value, array $allowed_types): void
+	{
+		$type = \gettype($value);
+		if (!\in_array($type, $allowed_types, true)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be one of allowed types: %s (%s given)',
+					$var_name, implode(', ', $allowed_types), \gettype($value))
+			);
+		}
+	}
 
-    /**
-     * 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,
-            RB::ERROR_HTTP_CODE_MIN, RB::ERROR_HTTP_CODE_MAX);
-    }
+	/**
+	 * 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,
+			RB::ERROR_HTTP_CODE_MIN, RB::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 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 (that is value coming from variable, which name is passed in $label) is instance of $cls class.
-     *
-     * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message.
-     * @param object $obj      Object to check instance of
-     * @param string $cls      Target class we want to check $obj agains.
-     */
-    public static function assertInstanceOf(string $var_name, object $obj, string $cls): void
-    {
-        if (!($obj instanceof $cls)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be instance of "%s".', $var_name, $cls)
-            );
-        }
-    }
+	/**
+	 * Ensures $obj (that is value coming from variable, which name is passed in $label) is instance of $cls class.
+	 *
+	 * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message.
+	 * @param object $obj      Object to check instance of
+	 * @param string $cls      Target class we want to check $obj agains.
+	 */
+	public static function assertInstanceOf(string $var_name, object $obj, string $cls): void
+	{
+		if (!($obj instanceof $cls)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be instance of "%s".', $var_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(object $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(object $obj, array $config): array;
 }

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