Class yii\helpers\BaseArrayHelper

根据指定的规则筛选数组。

比如：

$array = [
    'A' => [1, 2],
    'B' => [
        'C' => 1,
        'D' => 2,
    ],
    'E' => 1,
];

$result = \yii\helpers\ArrayHelper::filter($array, ['A']);
// $result will be:
// [
//     'A' => [1, 2],
// ]

$result = \yii\helpers\ArrayHelper::filter($array, ['A', 'B.C']);
// $result will be:
// [
//     'A' => [1, 2],
//     'B' => ['C' => 1],
// ]

$result = \yii\helpers\ArrayHelper::filter($array, ['B', '!B.C']);
// $result will be:
// [
//     'B' => ['D' => 2],
// ]

返回数组中指定列的值。 传入的数组类型可以是多维数组或者对象数组。

比如，

$array = [
    ['id' => '123', 'data' => 'abc'],
    ['id' => '345', 'data' => 'def'],
];
$result = ArrayHelper::getColumn($array, 'id');
// the result is: ['123', '345']

// using anonymous function
$result = ArrayHelper::getColumn($array, function ($element) {
    return $element['id'];
});

检索具有给定键或属性名的数组元素或对象属性的值。 如果这个数组中不存在键，将返回默认值。 从对象中获取值时不使用。

数组中的键可以指定圆点来检索子数组中的值或者对象中包含的属性。 特别是，如果键是 x.y.z， 然后返回的值中像这样 $array['x']['y']['z'] 或者 $array->x->y->z（如果 $array 是一个对象）。 如果 $array['x'] 或者 $array->x 既不是数组也不是对象，将返回默认值。 注意如果数组已经有元素 x.y.z，然后它的值将被返回来替代遍历子数组。 因此最好要做指定键值对的数组 像这样 ['x', 'y', 'z']。

以下是一些用法示例,

// working with array
$username = \yii\helpers\ArrayHelper::getValue($_POST, 'username');
// working with object
$username = \yii\helpers\ArrayHelper::getValue($user, 'username');
// working with anonymous function
$fullName = \yii\helpers\ArrayHelper::getValue($user, function ($user, $defaultValue) {
    return $user->firstName . ' ' . $user->lastName;
});
// using dot format to retrieve the property of embedded object
$street = \yii\helpers\ArrayHelper::getValue($users, 'address.street');
// using an array of keys to retrieve the value
$value = \yii\helpers\ArrayHelper::getValue($versions, ['1.0', 'date']);

将 HTML 实体解码为字符串数组中的相应字符。 只有数组值将被默认解码。 如果数组是一个值，此方法还将递归的进行解码。 只有字符串值才会被解码。

参见 http://www.php.net/manual/en/function.htmlspecialchars-decode.php.

将字符串数组中的特殊字符编码为 HTML 实体。 默认情况下只对数组值进行编码。 如果数组是一个值，此方法还将递归的进行编码。 只有字符串值才会被编码。

参见 http://www.php.net/manual/en/function.htmlspecialchars.php.

根据指定的键对数组进行索引和/或分组。 输入的应该是多维数组或对象数组。

这个 $key 可以是子数组的键名，对象的属性名， 或匿名函数返回的值将被用作键。

$groups 是数组中的键， 用于根据指定的键将输入数组分组为一个或多个子数组。

如果 $key 被指定为 null 或者与该键对应的元素的值除未指定的 $groups 外为 null 那么该元素将被丢弃。

比如：

$array = [
    ['id' => '123', 'data' => 'abc', 'device' => 'laptop'],
    ['id' => '345', 'data' => 'def', 'device' => 'tablet'],
    ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone'],
];
$result = ArrayHelper::index($array, 'id');

结果会生成一个关联数组，这个键就是 id 属性的值

[
    '123' => ['id' => '123', 'data' => 'abc', 'device' => 'laptop'],
    '345' => ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone']
    // The second element of an original array is overwritten by the last element because of the same id
]

匿名函数也可以用作于分组数组当中。

$result = ArrayHelper::index($array, function ($element) {
    return $element['id'];
});

id 将作为第三个参数传入到 $array 并按 id 进行分组：

$result = ArrayHelper::index($array, null, 'id');

结果将生成多维数组并按 id 进行一维分组， 二维按索引 device 进行分组并生成 data 索引三维数组：

[
    '123' => [
        ['id' => '123', 'data' => 'abc', 'device' => 'laptop']
    ],
    '345' => [ // all elements with this index are present in the result array
        ['id' => '345', 'data' => 'def', 'device' => 'tablet'],
        ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone'],
    ]
]

通过键进行分组的数组中也可以使用匿名函数：

$result = ArrayHelper::index($array, 'data', [function ($element) {
    return $element['id'];
}, 'device']);

结果将返回一个多维数组一维按 id 分组， 二维按索引 device 分组并且三维按索引 data 进行分组：

[
    '123' => [
        'laptop' => [
            'abc' => ['id' => '123', 'data' => 'abc', 'device' => 'laptop']
        ]
    ],
    '345' => [
        'tablet' => [
            'def' => ['id' => '345', 'data' => 'def', 'device' => 'tablet']
        ],
        'smartphone' => [
            'hgi' => ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone']
        ]
    ]
]

返回一个值，该值指示给定数组是否是关联数组。

如果数组的键都是字符串，那么数组就是关联的。如果 $allStrings 设置为假， 如果数组的键中至少有一个是字符串，那么该数组将被视为关联数组。

注意，空数组不会被认为是关联的。

检查是否为数组或 Traversable 包含一个元素。

这个方法与 PHP 函数 in_array() 相同 但它还适用于实现 Traversable 接口。

参见 http://php.net/manual/en/function.in-array.php.

返回一个值，该值指示给定数组是否是索引数组。

如果一个数组的所有键都是整数，那么该数组是索引数组。如果变量 $consecutive 设置为真， 那么数组键必须是从 0 开始的连续序列。

注意，空数组将被认为是索引的。

检测是否为一个数组或者 Traversable 是另一个数组的子集还是 Traversable。

这个方法将返回 true，如果 $needles 所有的元素都包含在 $haystack。 如果至少缺少一个元素的话，将被返回 false。

检查变量是数组还是 Traversable。

该方法与 PHP 函数 is_array() 相同， 但是，它还可以用于实现 Traversable 接口。

参见 http://php.net/manual/en/function.is-array.php.

检查给定数组是否包含指定键。 此方法通过支持不区分大小写键的比较增强了 array_key_exists() 函数。

从多维数组当中或者对象数组（key-value pairs）构建一个映射。 那个 $from 和 $to 参数指定的键名或者属性名来设置映射。 可选，可以根据 $group 变量对映射键值对进一步分组。

比如，

$array = [
    ['id' => '123', 'name' => 'aaa', 'class' => 'x'],
    ['id' => '124', 'name' => 'bbb', 'class' => 'x'],
    ['id' => '345', 'name' => 'ccc', 'class' => 'y'],
];

$result = ArrayHelper::map($array, 'id', 'name');
// the result is:
// [
//     '123' => 'aaa',
//     '124' => 'bbb',
//     '345' => 'ccc',
// ]

$result = ArrayHelper::map($array, 'id', 'name', 'class');
// the result is:
// [
//     'x' => [
//         '123' => 'aaa',
//         '124' => 'bbb',
//     ],
//     'y' => [
//         '345' => 'ccc',
//     ],
// ]

递归合并 2 个及以上的数组。 如果每个数组元素有相同的字符串键值对， 后者将会覆盖前者（不同于 array_merge_recursive）。 如果两个数组都有数组类型的元素并且具有相同的键， 那么将进行递归合并。 对于整型键类型元素，后面数组中的元素将 会被追加到前面的数组中去。 你能够使用 yii\helpers\UnsetArrayValue 对象从之前的数组中设置值或者 yii\helpers\ReplaceArrayValue 强制替换原先的值来替代递归数组合并。

按一个或多个键对对象数组或者数组（具有相同结构）进行排序。

从数组中移除元素并返回值。 如果数组中不存在键，则默认值将被返回。

用法示例，

// $array = ['type' => 'A', 'options' => [1, 2]];
// working with array
$type = \yii\helpers\ArrayHelper::remove($array, 'type');
// $array content
// $array = ['options' => [1, 2]];

从数组中移除对应的值并返回移除的项。

比如，

$array = ['Bob' => 'Dylan', 'Michael' => 'Jackson', 'Mick' => 'Jagger', 'Janet' => 'Jackson'];
$removed = \yii\helpers\ArrayHelper::removeValue($array, 'Jackson');
// result:
// $array = ['Bob' => 'Dylan', 'Mick' => 'Jagger'];
// $removed = ['Michael' => 'Jackson', 'Janet' => 'Jackson'];

在指定键的路径上将值写入关联数组。 如果没有这样的关键路径，它将通过递归创建。 如果键存在，就会被覆盖。

 $array = [
     'key' => [
         'in' => [
             'val1',
             'key' => 'val'
         ]
     ]
 ];

ArrayHelper::setValue($array, 'key.in.0', ['arr' => 'val']); 的结果如下：

 [
     'key' => [
         'in' => [
             ['arr' => 'val'],
             'key' => 'val'
         ]
     ]
 ]

这个 ArrayHelper::setValue($array, 'key.in', ['arr' => 'val']); 或者 ArrayHelper::setValue($array, ['key', 'in'], ['arr' => 'val']); 生成的结果集如下：

 [
     'key' => [
         'in' => [
             'arr' => 'val'
         ]
     ]
 ]

将对象或者对象数组转换成数组。