MarcinOrlowski / laravel-api-response-builder

src/Converter.php

Indentation +206 added lines, -206 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,196 +56,196 @@ 
 	 *
 	 * @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);
-
-		    $result = $this->convertArray($data);
-	        if (!Util::isArrayWithNonNumericKeys($data)){
-		        $result = [$cfg[ RB::KEY_KEY ] => $result];
-	        }
-        }
-
-	    if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-		    $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data];
-	    }
-
-	    return $result;
-    }
-
-    /**
-     * 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;
-    }
+		}
+
+		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);
+
+			$result = $this->convertArray($data);
+			if (!Util::isArrayWithNonNumericKeys($data)){
+				$result = [$cfg[ RB::KEY_KEY ] => $result];
+			}
+		}
+
+		if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
+			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data];
+		}
+
+		return $result;
+	}
+
+	/**
+	 * 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

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,21 +146,21 @@ 
 
 	    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);
 
 		    $result = $this->convertArray($data);
-	        if (!Util::isArrayWithNonNumericKeys($data)){
-		        $result = [$cfg[ RB::KEY_KEY ] => $result];
+	        if (!Util::isArrayWithNonNumericKeys($data)) {
+		        $result = [$cfg[RB::KEY_KEY] => $result];
 	        }
         }
 
-	    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;
@@ -199,12 +199,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;
             }
         }
 

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;
+		});
+	}
 
 	/**
 	 * Checks if given array uses custom (non numeric) keys.