README

FyreArray 是一个免费的、开源的用于 PHP 的数组操作库。

目录

• 安装
• 方法

安装

使用 Composer

composer require fyre/array

在 PHP 中

use Fyre\Utility\Arr;

方法

Chunk

将数组分割成块。

• $array 是输入数组。
• $size 是表示每个块大小的数字。
• $preserveKeys 是一个布尔值，指示是否保留数组键，默认为 false。

$chunk = Arr::chunk($array, $size, $preserveKeys);

Collapse

递归地将元素替换到第一个数组中。

• $array 是输入数组。

此方法的所有参数都将替换到第一个数组中。

$collapsed = Arr::collapse($array, ...$replacements);

Column

从输入数组中返回单个列的值。

• $array 是输入数组。
• $key 是要拉取值的列。

$column = Arr::column($array, $key);

Combine

通过使用一个数组作为键，另一个数组作为其值来创建一个数组。

• $keys 是包含键的数组。
• $values 是包含值的数组。

$combined = Arr::combine($keys, $values);

Count

计算数组中的所有元素。

• $array 是输入数组。
• $mode 是表示计数模式的整数，默认为 Arr::COUNT_NORMAL。

$count = Arr::count($array, $mode);

Difference

查找第一个数组中不存在于其他任何数组中的值。

• $array 是输入数组。

提供的任何其他参数将用于测试第一个数组中的值。

$diff = Arr::diff($array, ...$arrays);

Divide

将数组分割成键和值。

• $array 是输入数组。

$divided = Arr::divide($array);

Dot

使用 "点" 表示法将多维数组展平。

• $array 是输入数组。
• $prefix 是表示键前缀的字符串，默认为 null。

$dot = Arr::dot($array, $prefix);

Except

返回不带指定键/值对的数组。

• $array 是输入数组。
• $keys 是包含要删除的键的数组。

$except = Arr::except($array, $keys);

Fill

用值填充数组。

• $amount 是表示要插入的元素数量的数字。
• $value 是要插入的值。

$filled = Arr::fill($amount, $value);

Filter

使用回调函数过滤数组元素。

• $array 是输入数组。
• $callback 是要使用的回调函数。
• $mode 是一个表示将发送到回调的参数的数字，默认为 Arr::FILTER_BOTH。

如果省略 $callback，则此函数将过滤数组中的空元素。

$filtered = Arr::filter($array, $callback);

Find

查找数组中满足回调的第一个值。

• $array 是输入数组。
• $callback 是要使用的回调函数。
• $default 是要返回的默认值，默认为 null。

$find = Arr::find($array, $callback, $default);

Find Last

查找数组中满足回调的最后一个值。

• $array 是输入数组。
• $callback 是要使用的回调函数。
• $default 是要返回的默认值。

$findLast = Arr::findLast($array, $callback, $default);

Flatten

将多维数组展平到单层。

• $array 是输入数组。
• $maxDepth 是表示要展平的最大深度的数字，默认为 1。

$flattened = Arr::flatten($array, $maxDepth);

Forget Dot

使用 "点" 表示法删除键/值对。

• $array 是输入数组。
• $key 是要删除的键。

$forgetDot = Arr::forgetDot($array, $key);

Get Dot

使用 "点" 表示法检索值。

• $array 是输入数组。
• $key 是要查找的键。
• $defaultValue 是要返回的默认值，默认为 null。

$getDot = Arr::getDot($array, $key, $defaultValue);

Has Dot

使用 "点" 表示法检查给定元素是否存在于数组中。

• $array 是输入数组。
• $key 是要检查的键。

$hasDot = Arr::hasDot($array, $key);

Has Key

检查给定的键是否存在于数组中。

• $array 是输入数组。
• $key 是要检查的键。

$hasKey = Arr::hasKey($array, $key);

Includes

检查给定的值是否存在于数组中。

• $array 是输入数组。
• $value 是要检查的值。

$includes = Arr::includes($array, $value);

Index

使用给定的键值索引多维数组。

• $array 是输入数组。
• $key 是要拉取键值的列。

$index = Arr::index($array, $key);

Index Of

在数组中搜索给定值并返回第一个键。

• $array 是输入数组。
• $value 是要搜索的值。
• $strict 是一个布尔值，表示是否执行严格搜索，默认为 false。

$indexOf = Arr::indexOf($array, $value, $strict);

交集

查找第一个数组中存在于所有其他数组中的值。

• $array 是输入数组。

所有提供的附加参数都将用于测试交集。

$intersect = Arr::intersect($array, ...$arrays);

判断数组

确定值是否为数组。

• $value 是要测试的值。

$isArray = Arr::isArray($value);

判断列表

确定数组是否有从 0 开始的连续键。

• $array 是要测试的数组。

$isList = Arr::isList($array);

连接

使用指定的分隔符连接数组元素。

• $array 是输入数组。
• $separator 是表示连接的分隔符字符串，默认为 ","

$joined = Arr::join($array, $separator);

键

返回数组的所有键。

• $array 是输入数组。

$keys = Arr::keys($array);

最后索引

搜索数组中的给定值并返回最后一个键。

• $array 是输入数组。
• $value 是要搜索的值。
• $strict 是一个布尔值，表示是否执行严格搜索，默认为 false。

$lastIndexOf = Arr::lastIndexOf($array, $value, $strict);

映射

将回调函数应用于数组的元素。

• $array 是输入数组。
• $callback 是要使用的回调函数。

$map = Arr::map($array, $callback);

合并

合并一个或多个数组。

• $array 是输入数组。

所有提供的附加参数将合并到第一个数组中。

$merged = Arr::merge($array, ...$arrays);

仅

返回包含指定键/值对的数组。

• $array 是输入数组。
• $keys 是包含要包含的键的数组。

$only = Arr::only($array, $keys);

填充

使用值填充数组到指定长度。

• $array 是输入数组。
• $size 是表示新数组大小的数字。
• $value 是要填充的值。

$padded = Arr::pad($array, $size, $value);

点选取

使用“点”表示法选取值列表。

• $arrays 是输入数组。
• $key 是要查找的键。

$values = Arr::pluckDot($arrays, $key);

弹出

弹出数组的最后一个元素。

• $array 是输入数组。

$pop = Arr::pop($array);

推送

将一个或多个元素推送到数组的末尾。

• $array 是输入数组。

所有提供的附加参数将被推送到数组中。

$newCount = Arr::push($array, ...$values);

随机值

从数组中返回一个随机值。

• $array 是输入数组。

$randomValue = Arr::randomValue($array);

范围

创建包含一系列元素的数组。

• $start 是表示序列的第一个值的数字。
• $end 是表示序列中结束值的数字。
• $step 是表示序列中值之间增量的数字，默认为 1。

$range = Arr::range($start, $end, $step);

减少

使用回调函数迭代地将数组减少到单个值。

• $array 是输入数组。
• $callback 是要使用的回调函数。
• $initial 是要使用的初始值，默认为 null。

$reduced = Arr::reduce($array, $callback, $initial);

反转

返回逆序排列的数组。

• $array 是输入数组。

$reversed = Arr::reverse($array);

点设置

使用“点”表示法设置值。

• $array 是输入数组。
• $key 是键。
• $value 是要设置的值。
• $overwrite 是一个布尔值，表示是否将先前值覆盖，默认为 true。

$setDot = Arr::setDot($array, $key, $value, $overwrite);

移位

将元素从数组开头移除。

• $array 是输入数组。

$shift = Arr::shift($array);

洗牌

洗牌数组。

• $array 是输入数组。

$shuffled = Arr::shuffle($array);

切片

提取数组的切片。

• $array 是输入数组。
• $offset 是表示起始偏移量的数字。
• $length 是表示切片长度的数字。
• $preserveKeys 决定是否保留数组键，默认为 false。

$slice = Arr::slice($array, $offset, $length, $preserveKeys);

排序

排序数组。

• $array 是输入数组。
• $sort 是表示排序标志或比较 闭包 的数字，默认为 Arr::SORT_NATURAL。

$sorted = Arr::sort($array, $sort);

切片

移除数组的一部分并用其他内容替换。

• $array 是输入数组。
• $offset 是表示起始偏移量的数字。
• $length 是表示切片长度的数字。
• $replacement 是要插入数组的元素。

$spliced = Arr::splice($array, $offset, $length, $replacement);

唯一

从数组中删除重复值。

• $array 是输入数组。

$unique = Arr::unique($array);

前置

将一个或多个元素添加到数组的开头。

• $array 是输入数组。

所有提供的附加参数将被添加到数组开头。

$newCount = Arr::unshift($array, ...$values);

值

返回数组的所有值。

• $array 是输入数组。

$values = Arr::values($array);

包装

从任何值创建一个数组。

• $value是要包装的值。

$wrapped = Arr::wrap($value);