MarcinOrlowski\ResponseBuilder\Util

Complexity

Total Complexity

9

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	mergeConfig()	0	23	5
A	sortArrayByPri()	0	7	1
A	isArrayWithNonNumericKeys()	0	9	3

<?php
declare(strict_types=1);

namespace MarcinOrlowski\ResponseBuilder;

/**
 * Laravel API Response Builder
 *
 * @package   MarcinOrlowski\ResponseBuilder
 *
 * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
 * @copyright 2016-2021 Marcin Orlowski
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 */

use MarcinOrlowski\ResponseBuilder\Exceptions as Ex;

/**
 * Commonly used utility functions
 */
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 Ex\IncompatibleTypeException(
						"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;
			}
		}

		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;

			return $pri_b <=> $pri_a;
		});
	}

	/**
	 * Checks if given array uses custom (non numeric) keys.
	 *
	 * @param array $data
	 *
	 * @return bool
	 */
	public static function isArrayWithNonNumericKeys(array $data): bool
	{
		foreach (\array_keys($data) as $key) {
			if (!\is_int($key)) {
				return true;
			}
		}

		return false;
	}

}