neon\core\helpers\Arr

Complexity

Total Complexity

75

Size/Duplication

Total Lines	542
Duplicated Lines	0 %

Test Coverage

Coverage

81.12%

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	accessible()	0	3	2
A	getRequired()	0	6	3
A	collapse()	0	15	4
A	prepend()	0	9	2
A	wrap()	0	3	2
A	isAssoc()	0	5	1
B	forget()	0	34	7
A	only()	0	3	1
A	flatten()	0	13	4
A	dot()	0	13	4
A	pluck()	0	23	6
A	defaults()	0	5	2
A	query()	0	3	1
A	first()	0	19	6
A	pull()	0	7	1
A	exists()	0	7	2
A	last()	0	7	3
A	except()	0	5	1
A	replaceKeys()	0	9	3
A	where()	0	3	1
A	set()	0	24	5
A	get()	0	3	1
A	groupBy()	0	3	1
C	getData()	0	30	12

<?php
/**
 * @link http://www.newicon.net/neon
 * @copyright Copyright (c) 15/09/2016 Newicon Ltd
 * @license http://www.newicon.net/neon/license/
 */

namespace neon\core\helpers;

use neon\core\interfaces\IArrayable;
use yii\base\DynamicModel;
use yii\base\InvalidConfigException;
use \yii\helpers\ArrayHelper as YiiArrayHelper;
use \ArrayAccess;

class Arr extends YiiArrayHelper
{
	/**
	 * Determine whether the given value is array accessible.
	 *
	 * @param  mixed $value
	 * @return bool
	 */
	public static function accessible($value)
	{
		return is_array($value) || $value instanceof ArrayAccess;
	}

	/**
	 * Specify defaults for an array - if the keys don't exist in $array it 
	 * creates them with the corresponding value in the defaults array.
	 * The defaults array supports nesting by specifying dot notation keys
	 * 
	 * For eg:
	 * ```php
	 * $arr = [
	 *     'msg' => 'My message',
	 *     'other' => 'stuff',
	 * ];
	 * Arr::defaults($arr, [
	 *     'msg' => 'Default hi message',
	 *     'on' => false,
	 *     'some.nested' => 'default'
	 * ])
	 * // =>
	 * [
	 *     'msg' => 'My message',
	 *     'other' => 'stuff',
	 *     'on' => false,
	 *     'some' => [
	 *         'nested' => 'default'
	 *     ]
	 * ]
	 * ```
	 * @param array $array - the array to ensure the defaults exist in
	 */
	public static function defaults($array, $defaults)
	{
		foreach($defaults as $key => $default)
			Arr::set($array, $key, Arr::get($array, $key, $default));
		return $array;
	}

	/**
	 * Flatten a multi-dimensional associative array with dots.
	 *
	 * @param  array $array
	 * @param  string $prepend
	 * @return array
	 */
	public static function dot($array, $prepend = '')
	{
		$results = [];

		foreach ($array as $key => $value) {
			if (is_array($value) && !empty($value)) {
				$results = array_merge($results, static::dot($value, $prepend . $key . '.'));
			} else {
				$results[$prepend . $key] = $value;
			}
		}

		return $results;
	}

	/**
	 * Get all of the given array except for a specified array of items.
	 *
	 * @param  array $array
	 * @param  array|string $keys
	 * @return array
	 */
	public static function except($array, $keys)
	{
		Arr::forget($array, $keys);

		return $array;
	}

	/**
	 * Determine if the given key exists in the provided array.
	 *
	 * @param  \ArrayAccess|array $array
	 * @param  string|int $key
	 * @return bool
	 */
	public static function exists($array, $key)
	{
		if ($array instanceof ArrayAccess) {
			return $array->offsetExists($key);
		}

		return array_key_exists($key, $array);
	}

	/**
	 * Return the first element in an array passing a given truth test.
	 *
	 * ```php
	 * $array = [100, 200, 300];
	 * $value = Arr::first($array, function ($value, $key) {
	 *     return $value >= 150;
	 * });
	 * // returns: 200
	 * ```
	 *
	 * @param  array $array
	 * @param  callable|null $callback Where the first paramter
	 *         is an array items value and second parameter its key.
	 * @param  mixed $default
	 * @return mixed
	 */
	public static function first($array, callable $callback = null, $default = null)
	{
		if (is_null($callback)) {
			if (empty($array)) {
				return value($default);
			}

			foreach ($array as $item) {
				return $item;
			}
		}

		foreach ($array as $key => $value) {
			if (call_user_func($callback, $value, $key)) {

It seems like $callback can also be of type null; however, parameter $callback of call_user_func() does only seem to accept callable, maybe add an additional type check?

				return $value;
			}
		}

		return value($default);
	}

	/**
	 * Return the last element in an array passing a given truth test.
	 *
	 * @param  array $array
	 * @param  callable|null $callback
	 * @param  mixed $default
	 * @return mixed
	 */
	public static function last($array, callable $callback = null, $default = null)
	{
		if (is_null($callback)) {
			return empty($array) ? value($default) : end($array);
		}

		return static::first(array_reverse($array, true), $callback, $default);
	}

	/**
	 * Flatten a multi-dimensional array into a single level.
	 *
	 * @param  array $array
	 * @param  int $depth
	 * @return array
	 */
	public static function flatten($array, $depth = INF)
	{
		return array_reduce($array, function ($result, $item) use ($depth) {
			$item = $item instanceof Collection ? $item->all() : $item;

			if (!is_array($item)) {
				return array_merge($result, [$item]);
			} elseif ($depth === 1) {
				return array_merge($result, array_values($item));
			} else {
				return array_merge($result, static::flatten($item, $depth - 1));

$depth - 1 of type double is incompatible with the type integer expected by parameter $depth of neon\core\helpers\Arr::flatten().

			}
		}, []);
	}

	/**
	 * Remove one or many array items from a given array using "dot" notation.
	 *
	 * @param  array $array
	 * @param  array|string $keys
	 * @return void
	 */
	public static function forget(&$array, $keys)
	{
		$original = &$array;

		$keys = (array)$keys;

		if (count($keys) === 0) {
			return;
		}

		foreach ($keys as $key) {
			// if the exact key exists in the top-level, remove it
			if (static::exists($array, $key)) {
				unset($array[$key]);

				continue;
			}

			$parts = explode('.', $key);

			// clean up before each pass
			$array = &$original;

			while (count($parts) > 1) {
				$part = array_shift($parts);

				if (isset($array[$part]) && is_array($array[$part])) {
					$array = &$array[$part];
				} else {
					continue 2;
				}
			}

			unset($array[array_shift($parts)]);
		}
	}

	/**
	 * Push an item onto the beginning of an array.
	 *
	 * @param  array $array
	 * @param  mixed $value
	 * @param  mixed $key
	 * @return array
	 */
	public static function prepend($array, $value, $key = null)
	{
		if (is_null($key)) {
			array_unshift($array, $value);
		} else {
			$array = [$key => $value] + $array;
		}

		return $array;
	}

	/**
	 * Get a value from the array, and remove it.
	 *
	 * @param  array $array
	 * @param  string $key can use dot notation
	 * @param  mixed $default
	 * @return mixed
	 */
	public static function pull(&$array, $key, $default = null)
	{
		$value = static::get($array, $key, $default);

		static::forget($array, $key);

		return $value;
	}

	/**
	 * Get an item from an array using "dot" or array or string notation.
	 *
	 * @param  \ArrayAccess|array $array
	 * @param  string|\Closure|array $key
	 * @param  mixed $default
	 * @return mixed
	 */
	public static function get($array, $key, $default = null)
	{
		return self::getValue($array, $key, value($default));
	}

	/**
	 * Get property from an array - throws an exception if it does not exist
	 *
	 * @param \ArrayAccess|array $array
	 * @param string $key - key in the array
	 * @param string message - the error message to use if the key does not exist

The type neon\core\helpers\message was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @throws \InvalidArgumentException if the property $key does not exist in the array
	 * @return mixed
	 */
	public static function getRequired($array, $key, $message=null)
	{
		if (!array_key_exists($key, $array)) {
			throw new \InvalidArgumentException($message ?: "You must define a '$key' property.");
		}
		return static::get($array, $key);
	}

	/**
	 * Get an item from an array or object using "dot" notation.
	 * It also works with Collection objects and allows for limited wildcard useage in dot notation
	 * for e.g. 'my.deep.nested.*';
	 *
	 * @param  mixed $target
	 * @param  string|array $key
	 * @param  mixed $default
	 * @return mixed
	 */
	public static function getData($target, $key, $default = null)
	{
		if (is_null($key)) {

The condition is_null($key) is always false.

			return $target;
		}

		$key = is_array($key) ? $key : explode('.', $key);

		while (!is_null($segment = array_shift($key))) {
			if ($segment === '*') {
				if ($target instanceof Collection) {
					$target = $target->all();
				} elseif (!is_array($target)) {
					return value($default);
				}

				$result = Arr::pluck($target, $key);

				return in_array('*', $key) ? Arr::collapse($result) : $result;
			}

			if (Arr::accessible($target) && Arr::exists($target, $segment)) {
				$target = $target[$segment];
			} elseif (is_object($target) && isset($target->{$segment})) {
				$target = $target->{$segment};
			} else {
				return value($default);
			}
		}
		return $target;
	}

	/**
	 * Set an array item to a given value using "dot" notation.
	 *
	 * If no key is given to the method, the entire array will be replaced.
	 *
	 * @param  array $array
	 * @param  string $key
	 * @param  mixed $value
	 * @return array
	 */
	public static function set(&$array, $key, $value)
	{
		if (is_null($key)) {

The condition is_null($key) is always false.

			return $array = $value;
		}

		$keys = explode('.', $key);

		while (count($keys) > 1) {
			$key = array_shift($keys);

			// If the key doesn't exist at this depth, we will just create an empty array
			// to hold the next value, allowing us to create the arrays to hold final
			// values at the correct depth. Then we'll keep digging into the array.
			if (!isset($array[$key]) || !is_array($array[$key])) {
				$array[$key] = [];
			}

			$array = &$array[$key];
		}

		$array[array_shift($keys)] = $value;

		return $array;
	}

	/**
	 * Filter the array using the given callback.
	 *
	 * ```php
	 * $array = [100, '200', 300, '400', 500];
	 *
	 * $array = Arr::where($array, function ($value, $key) {
	 *     return is_string($value);
	 * });
	 *
	 * // [1 => 200, 3 => 400]
	 * ```
	 *
	 * @param  array $array
	 * @param  callable $callback the callable format should be function ($value, $key) {}
	 *
	 * @return array
	 */
	public static function where($array, callable $callback)
	{
		return array_filter($array, $callback, ARRAY_FILTER_USE_BOTH);
	}

	/**
	 * Group an associative array by a field or using a callback.
	 *
	 * @param  callable|string $groupBy
	 * @param  bool $preserveKeys
	 * @return array
	 */
	public static function groupBy($array, $groupBy, $preserveKeys = false)
	{
		return (new Collection($array))->groupBy($groupBy, $preserveKeys)->toArray();
	}

	/**
	 * Determines if an array is associative.
	 *
	 * An array is "associative" if it doesn't have sequential numerical keys beginning with zero.
	 *
	 * @param  array $array
	 * @return bool
	 */
	public static function isAssoc(array $array)
	{
		$keys = array_keys($array);

		return array_keys($keys) !== $keys;
	}

	/**
	 * Get a subset of the items from the given array.
	 *
	 * @param  array $array
	 * @param  array|string $keys
	 * @return array
	 */
	public static function only($array, $keys)
	{
		return array_intersect_key($array, array_flip((array)$keys));
	}

	/**
	 * Pluck an array of values from an array.
	 * Inspired by Laravels Pluck method
	 *
	 * example usage:
	 *
	 * ```php
	 * $array = [
	 *     ['user' => ['id' => 1, 'name' => 'Steve']],
	 *     ['user' => ['id' => 2, 'name' => 'Bob']]
	 * ]
	 *
	 * Arr::pluck($array, 'user.name')
	 *
	 * // Returns: ['Steve', 'Bob'];
	 * ```
	 *
	 * You may also specify how you wish the resulting list to be keyed:
	 *
	 * ```php
	 * $array = Arr::pluck($array, 'user.name', 'user.id');
	 *
	 * // Returns: [1 => 'Steve', 2 => 'Bob'];
	 * ```
	 *
	 * @param  array $array
	 * @param  string|array $value
	 * @param  string|array|null $key
	 * @return array
	 */
	public static function pluck($array, $value, $key = null)
	{
		$results = [];

		$value = is_string($value) ? explode('.', $value) : $value;
		$key = is_null($key) || is_array($key) ? $key : explode('.', $key);

		foreach ($array as $item) {
			$itemValue = Arr::getData($item, $value);

			// If the key is "null", we will just append the value to the array and keep
			// looping. Otherwise we will key the array using the value of the key we
			// received from the developer. Then we'll return the final array form.
			if (is_null($key)) {
				$results[] = $itemValue;
			} else {
				$itemKey = Arr::getData($item, $key);

				$results[$itemKey] = $itemValue;
			}
		}

		return $results;
	}

	/**
	 * If the given value is not an array, wrap it in one.
	 *
	 * @param  mixed $value
	 * @return array
	 */
	public static function wrap($value)
	{
		return !is_array($value) ? [$value] : $value;
	}

	/**
	 * Convert the array into a query string.
	 *
	 * @param  array  $array
	 * @return string
	 */
	public static function query($array)
	{
		return http_build_query($array, null, '&', PHP_QUERY_RFC3986);

null of type null is incompatible with the type string expected by parameter $numeric_prefix of http_build_query().

	}

	/**
	 * Collapse an array of arrays into a single array.
	 *
	 * @param  array $array
	 * @return array
	 */
	public static function collapse($array)
	{
		$results = [];

		foreach ($array as $values) {
			if ($values instanceof Collection) {
				$values = $values->all();
			} elseif (!is_array($values)) {
				continue;
			}

			$results = array_merge($results, $values);
		}

		return $results;
	}

	/**
	 * Replace keys in an array with a differnt name
	 * @param array $array
	 * @param $replace ['findKey' => 'replacekey']

The doc comment ['findKey' at position 0 could not be parsed: Unknown type name '[' at position 0 in ['findKey'.

	 * @return array
	 */
	public static function replaceKeys($array, $replace)
	{
		foreach ($replace as $find => $rep) {
			if (isset($array[$find])) {
				$array[$rep] = $array[$find];
				unset($array[$find]);
			}
		}
		return $array;
	}
}