<?php
namespace BitApps\WPKit\Helpers;
/*
* This helper class is used to help with array manipulation.
* Taken from Laravel framework. illuminate/collections package.
*
* @link https://github.com/laravel/framework/tree/master/src/Illuminate/Collections
* Docs @link https://laravel.com/docs/9.x/helpers#arrays-and-objects-method-list
*/
use ArrayAccess;
use Closure;
use InvalidArgumentException;
class Arr
{
/**
* 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;
}
/**
* Add an element to an array using "dot" notation if it doesn't exist.
*
* @param array $array
* @param string $key
* @param mixed $value
*
* @return array
*/
public static function add($array, $key, $value)
{
if (\is_null(static::get($array, $key))) {
static::set($array, $key, $value);
}
return $array;
}
/**
* Collapse an array of arrays into a single array.
*
* @param iterable $array
*
* @return array
*/
public static function collapse($array)
{
$results = [];
foreach ($array as $values) {
if (!\is_array($values)) {
continue;
}
$results[] = $values;
}
return array_merge([], ...$results);
}
/**
* Cross join the given arrays, returning all possible permutations.
*
* @param iterable ...$arrays
*
* @return array
*/
public static function crossJoin(...$arrays)
{
$results = [[]];
foreach ($arrays as $index => $array) {
$append = [];
foreach ($results as $product) {
foreach ($array as $item) {
$product[$index] = $item;
$append[] = $product;
}
}
$results = $append;
}
return $results;
}
/**
* Divide an array into two arrays. One with keys and the other with values.
*
* @param array $array
*
* @return array
*/
public static function divide($array)
{
return [array_keys($array), array_values($array)];
}
/**
* Flatten a multi-dimensional associative array with dots.
*
* @param iterable $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 keys.
*
* @param array $array
* @param array|string $keys
*
* @return array
*/
public static function except($array, $keys)
{
static::forget($array, $keys);
return $array;
}
/**
* Determine if the given key exists in the provided array.
*
* @param array|ArrayAccess $array
* @param int|string $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.
*
* @param iterable $array
* @param mixed $default
*
* @return mixed
*/
public static function first($array, callable $callback = null, $default = null)
{
if (\is_null($callback)) {
if (empty($array)) {
return self::value($default);
}
foreach ($array as $item) {
return $item;
}
}
foreach ($array as $key => $value) {
if ($callback($value, $key)) {
return $value;
}
}
return self::value($default);
}
/**
* Return the last element in an array passing a given truth test.
*
* @param array $array
* @param mixed $default
*
* @return mixed
*/
public static function last($array, callable $callback = null, $default = null)
{
if (\is_null($callback)) {
return empty($array) ? self::value($default) : end($array);
}
return static::first(array_reverse($array, true), $callback, $default);
}
/**
* Flatten a multi-dimensional array into a single level.
*
* @param iterable $array
* @param int $depth
*
* @return array
*/
public static function flatten($array, $depth = INF)
{
$result = [];
foreach ($array as $item) {
if (!\is_array($item)) {
$result[] = $item;
} else {
$values = $depth === 1 ? array_values($item) : static::flatten($item, $depth - 1);
foreach ($values as $value) {
$result[] = $value;
}
}
}
return $result;
}
/**
* Remove one or many array items from a given array using "dot" notation.
*
* @param array $array
* @param array|string $keys
*/
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)]);
}
}
/**
* Get an item from an array using "dot" notation.
*
* @param array|ArrayAccess $array
* @param null|int|string $key
* @param mixed $default
*
* @return mixed
*/
public static function get($array, $key, $default = null)
{
if (!static::accessible($array)) {
return self::value($default);
}
if (\is_null($key)) {
return $array;
}
if (static::exists($array, $key)) {
return $array[$key];
}
if (strpos($key, '.') === false) {
return isset($array[$key]) ? $array[$key] : self::value($default);
}
foreach (explode('.', $key) as $segment) {
if (static::accessible($array) && static::exists($array, $segment)) {
$array = $array[$segment];
} else {
return self::value($default);
}
}
return $array;
}
/**
* Check if an item or items exist in an array using "dot" notation.
*
* @param array|ArrayAccess $array
* @param array|string $keys
*
* @return bool
*/
public static function has($array, $keys)
{
$keys = (array) $keys;
if (!$array || $keys === []) {
return false;
}
foreach ($keys as $key) {
$subKeyArray = $array;
if (static::exists($array, $key)) {
continue;
}
foreach (explode('.', $key) as $segment) {
if (static::accessible($subKeyArray) && static::exists($subKeyArray, $segment)) {
$subKeyArray = $subKeyArray[$segment];
} else {
return false;
}
}
}
return true;
}
/**
* Determine if any of the keys exist in an array using "dot" notation.
*
* @param array|ArrayAccess $array
* @param array|string $keys
*
* @return bool
*/
public static function hasAny($array, $keys)
{
if (\is_null($keys)) {
return false;
}
$keys = (array) $keys;
if (!$array) {
return false;
}
if ($keys === []) {
return false;
}
foreach ($keys as $key) {
if (static::has($array, $key)) {
return true;
}
}
return false;
}
/**
* Determines if an array is associative.
*
* An array is "associative" if it doesn't have sequential numerical keys beginning with zero.
*
* @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.
*
* @param iterable $array
* @param null|array|int|string $value
* @param null|array|string $key
*
* @return array
*/
public static function pluck($array, $value, $key = null)
{
$results = [];
$keyValue = static::explodePluckParameters($value, $key);
$value = $keyValue[0];
$key = $keyValue[1];
foreach ($array as $item) {
$itemValue = self::dataGet($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 = self::dataGet($item, $key);
if (\is_object($itemKey) && method_exists($itemKey, '__toString')) {
$itemKey = (string) $itemKey;
}
$results[$itemKey] = $itemValue;
}
}
return $results;
}
/**
* 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 (\func_num_args() == 2) {
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
* @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;
}
/**
* Convert the array into a query string.
*
* @param array $array
*
* @return string
*/
public static function query($array)
{
return http_build_query($array, '', '&', PHP_QUERY_RFC3986);
}
/**
* Get one or a specified number of random values from an array.
*
* @param array $array
* @param null|int $number
* @param bool|false $preserveKeys
*
* @throws InvalidArgumentException
*
* @return mixed
*/
public static function random($array, $number = null, $preserveKeys = false)
{
$requested = \is_null($number) ? 1 : $number;
$count = \count($array);
if ($requested > $count) {
throw new InvalidArgumentException("You requested {$requested} items, but there are only {$count} items available.");
}
if (\is_null($number)) {
return $array[array_rand($array)];
}
if ((int) $number === 0) {
return [];
}
$keys = array_rand($array, $number);
$results = [];
if ($preserveKeys) {
foreach ((array) $keys as $key) {
$results[$key] = $array[$key];
}
} else {
foreach ((array) $keys as $key) {
$results[] = $array[$key];
}
}
return $results;
}
/**
* 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 null|string $key
* @param mixed $value
*
* @return array
*/
public static function set(&$array, $key, $value)
{
if (\is_null($key)) {
return $array = $value;
}
$keys = explode('.', $key);
foreach ($keys as $i => $key) {
if (\count($keys) === 1) {
break;
}
unset($keys[$i]);
// 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;
}
/**
* Shuffle the given array and return the result.
*
* @param array $array
* @param null|int $seed
*
* @return array
*/
public static function shuffle($array, $seed = null)
{
if (\is_null($seed)) {
shuffle($array);
} else {
mt_srand($seed);
shuffle($array);
mt_srand();
}
return $array;
}
/**
* Sort the array using asort.
*
* @param array $array
* @param int $options
* @param bool $descending
*
* @return array
*/
public static function sort($array, $options = SORT_REGULAR, $descending = false)
{
$descending ? arsort($array, $options) : asort($array, $options);
return $array;
}
/**
* Recursively sort an array by keys and values.
*
* @param array $array
* @param int $options
* @param bool $descending
*
* @return array
*/
public static function sortRecursive($array, $options = SORT_REGULAR, $descending = false)
{
foreach ($array as &$value) {
if (\is_array($value)) {
$value = static::sortRecursive($value, $options, $descending);
}
}
if (static::isAssoc($array)) {
$descending ? krsort($array, $options) : ksort($array, $options);
} else {
$descending ? rsort($array, $options) : sort($array, $options);
}
return $array;
}
/**
* Conditionally compile classes from an array into a CSS class list.
*
* @param array $array
*
* @return string
*/
public static function toCssClasses($array)
{
$classList = static::wrap($array);
$classes = [];
foreach ($classList as $class => $constraint) {
if (is_numeric($class)) {
$classes[] = $constraint;
} elseif ($constraint) {
$classes[] = $class;
}
}
return implode(' ', $classes);
}
/**
* Filter the array using the given callback.
*
* @param array $array
*
* @return array
*/
public static function where($array, callable $callback)
{
return array_filter($array, $callback, ARRAY_FILTER_USE_BOTH);
}
/**
* If the given value is not an array and not null, wrap it in one.
*
* @param mixed $value
*
* @return array
*/
public static function wrap($value)
{
if (\is_null($value)) {
return [];
}
return \is_array($value) ? $value : [$value];
}
/**
* Return the default value of the given value.
*
* @param mixed $value
*
* @return mixed
*/
public static function value($value, ...$args)
{
return $value instanceof Closure ? $value(...$args) : $value;
}
/**
* Get an item from an array or object using "dot" notation.
*
* @param mixed $target
* @param string|array|int|null $key
* @param mixed $default
*
* @return mixed
*/
public static function dataGet($target, $key, $default = null)
{
if (\is_null($key)) {
return $target;
}
$key = \is_array($key) ? $key : explode('.', $key);
foreach ($key as $i => $segment) {
unset($key[$i]);
if (\is_null($segment)) {
return $target;
}
if ($segment === '*') {
if (!\is_array($target)) {
return self::value($default);
}
$result = [];
foreach ($target as $item) {
$result[] = self::dataGet($item, $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 self::value($default);
}
}
return $target;
}
/**
* Explode the "value" and "key" arguments passed to "pluck".
*
* @param array|string $value
* @param null|array|string $key
*
* @return array
*/
protected static function explodePluckParameters($value, $key)
{
$value = \is_string($value) ? explode('.', $value) : $value;
$key = \is_null($key) || \is_array($key) ? $key : explode('.', $key);
return [$value, $key];
}
}