Class yii\helpers\ArrayHelper
| 继承 | yii\helpers\ArrayHelper » yii\helpers\BaseArrayHelper |
|---|---|
| 可用版本自 | 2.0 |
| 源码 | https://github.com/yiichina/yii2/blob/api/framework/helpers/ArrayHelper.php |
ArrayHelper 提供了可以在应用程序中使用的额外的数组功能。
有关 ArrayHelper 更多的细节和使用信息，可以参阅 关于数组助手类的指南。
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| filter() | 根据指定的规则筛选数组。 | yii\helpers\BaseArrayHelper |
| getColumn() | 返回数组中指定列的值。 传入的数组类型可以是多维数组或者对象数组。 | yii\helpers\BaseArrayHelper |
| getValue() | 检索具有给定键或属性名的数组元素或对象属性的值。 如果这个数组中不存在键，将返回默认值。 从对象中获取值时不使用。 | yii\helpers\BaseArrayHelper |
| htmlDecode() | 将 HTML 实体解码为字符串数组中的相应字符。 只有数组值将被默认解码。 如果数组是一个值，此方法还将递归的进行解码。 只有字符串值才会被解码。 | yii\helpers\BaseArrayHelper |
| htmlEncode() | 将字符串数组中的特殊字符编码为 HTML 实体。 默认情况下只对数组值进行编码。 如果数组是一个值，此方法还将递归的进行编码。 只有字符串值才会被编码。 | yii\helpers\BaseArrayHelper |
| index() | 根据指定的键对数组进行索引和/或分组。 输入的应该是多维数组或对象数组。 | yii\helpers\BaseArrayHelper |
| isAssociative() | 返回一个值，该值指示给定数组是否是关联数组。 | yii\helpers\BaseArrayHelper |
| isIn() | 检查是否为数组或 Traversable 包含一个元素。 | yii\helpers\BaseArrayHelper |
| isIndexed() | 返回一个值，该值指示给定数组是否是索引数组。 | yii\helpers\BaseArrayHelper |
| isSubset() | 检测是否为一个数组或者 Traversable 是另一个数组的子集还是 Traversable。 | yii\helpers\BaseArrayHelper |
| isTraversable() | 检查变量是数组还是 Traversable。 | yii\helpers\BaseArrayHelper |
| keyExists() | 检查给定数组是否包含指定键。
此方法通过支持不区分大小写键的比较增强了 array_key_exists()
函数。 |
yii\helpers\BaseArrayHelper |
| map() | 从多维数组当中或者对象数组（key-value pairs）构建一个映射。
那个 $from 和 $to 参数指定的键名或者属性名来设置映射。
可选，可以根据 $group 变量对映射键值对进一步分组。 |
yii\helpers\BaseArrayHelper |
| merge() | 递归合并 2 个及以上的数组。 如果每个数组元素有相同的字符串键值对， 后者将会覆盖前者（不同于 array_merge_recursive）。 如果两个数组都有数组类型的元素并且具有相同的键， 那么将进行递归合并。 对于整型键类型元素，后面数组中的元素将 会被追加到前面的数组中去。 你能够使用 yii\helpers\UnsetArrayValue 对象从之前的数组中设置值或者 yii\helpers\ReplaceArrayValue 强制替换原先的值来替代递归数组合并。 | yii\helpers\BaseArrayHelper |
| multisort() | 按一个或多个键对对象数组或者数组（具有相同结构）进行排序。 | yii\helpers\BaseArrayHelper |
| remove() | 从数组中移除元素并返回值。 如果数组中不存在键，则默认值将被返回。 | yii\helpers\BaseArrayHelper |
| removeValue() | 从数组中移除对应的值并返回移除的项。 | yii\helpers\BaseArrayHelper |
| setValue() | 在指定键的路径上将值写入关联数组。 如果没有这样的关键路径，它将通过递归创建。 如果键存在，就会被覆盖。 | yii\helpers\BaseArrayHelper |
| toArray() | 将对象或者对象数组转换成数组。 | yii\helpers\BaseArrayHelper |