Joomla! 框架 3.x API » \Joomla\Utilities\ArrayHelper

私有构造函数，防止实例化此类

__construct() :

自	1.0

响应

混合

向数组数组或对象添加一列

addColumn(mixed||string|int array, mixed||string|int column,  colName,  keyCol = null) : mixed||string|int

静态

自	1.5.0
参见	https://php.ac.cn/manual/en/language.types.array.php

参数

数组: array<string|int, mixed>源数组
列: array<string|int, mixed>用作新列的数组
colName: string新列的索引或新对象属性的名称
keyCol: string用于与新列映射的列索引或对象属性名称

响应

array<string|int, mixed>向源数组添加新列后的数组

将对象或数组映射到数组的实用函数

arrayFromObject( item,  recurse,  regex) : mixed||string|int

静态

自	1.0

参数

项目: mixed源对象或数组
递归: bool在多级对象中递归时为真
正则表达式: string用于匹配字段名的可选正则表达式

响应

array<string|int, mixed>

改进的 array_search，允许在关联数组中对字符串值进行部分匹配。

arraySearch( needle, mixed||string|int haystack,  caseSensitive = true) :

静态

自	1.0

参数

针: string要在数组中搜索的文本。
干草堆: array<string|int, mixed>要搜索以查找 $needle 的关联数组。
区分大小写: bool如果要区分大小写搜索，则为真，否则为假。

响应

mixed如果找到，则返回匹配的数组 $key，否则返回 false。

多维数组安全唯一性测试

arrayUnique(mixed||string|int array) : mixed||string|int

静态

参见	https://php.ac.cn/manual/en/function.array-unique.php
自	1.0

参数

数组: array<string|int, mixed>要使唯一的数组。

响应

array<string|int, mixed>

从数组数组或对象中删除一列

dropColumn(mixed||string|int array,  colName) : mixed||string|int

静态

自	1.5.0
参见	https://php.ac.cn/manual/en/language.types.array.php

参数

数组: array<string|int, mixed>源数组
colName: string要删除的列索引或对象属性名称

响应

array<string|int, mixed>源数组中的值列

将数据递归转换为一维数组的方法。

flatten(array|object array,  separator = '.',  prefix = '') : mixed||string|int

静态

自	1.3.0

参数

数组: array<string|int, mixed>|object要转换的数组或对象。
分隔符: string键分隔符。
前缀: string最后一级键前缀。

响应

array<string|int, mixed>

将对象映射到数组的实用函数

fromObject( source,  recurse = true,  regex = null) : mixed||string|int

静态

自	1.0

参数

来源: object源对象
递归: bool在多级对象中递归时为真
正则表达式: string用于匹配字段名的可选正则表达式

响应

array<string|int, mixed>

从数组数组或对象中提取一列

getColumn(mixed||string|int array,  valueCol,  keyCol = null) : mixed||string|int

静态

自

1.0

参见

https://php.ac.cn/manual/en/language.types.array.php

https://php.ac.cn/manual/en/function.array-column.php

参数

数组: array<string|int, mixed>源数组
valueCol: string用作值的列索引或对象属性名称。它也可以是 NULL 以返回完整的数组或对象（这与 $keyCol 一起使用很有用，可以重新索引数组）。
keyCol: string用作键的列索引或对象属性名称

响应

array<string|int, mixed>源数组中的值列

实用程序函数，用于从命名数组返回一个值或指定一个默认值

getValue(array|\ArrayAccess array,  name,  default = null,  type = '') :

静态

自	1.0
抛出	`InvalidArgumentException`

参数

数组: array<string|int, mixed>|ArrayAccess实现 ArrayAccess 的命名数组或对象
姓名: string要搜索的键（这可以是数组索引或点分隔键序列，如在注册表中）
默认: mixed如果未找到键，则要给出的默认值
类型: string变量的返回类型（INT、FLOAT、STRING、WORD、BOOLEAN、ARRAY）

响应

混合

接受数组的关联数组并使用数组值作为键反转数组键到值。

invert(mixed||string|int array) : mixed||string|int

静态

示例：$input = array( 'New' => array('1000', '1500', '1750'), 'Used' => array('3000', '4000', '5000', '6000') ); $output = ArrayHelper::invert($input);

输出将等于：$output = array( '1000' => 'New', '1500' => 'New', '1750' => 'New', '3000' => 'Used', '4000' => 'Used', '5000' => 'Used', '6000' => 'Used' );

自	1.0

参数

数组: array<string|int, mixed>源数组。

响应

array<string|int, mixed>

确定数组是否为关联数组的方法。

isAssociative(mixed||string|int array) :

静态

自	1.0

参数

数组: array<string|int, mixed>要测试的数组。

响应

布尔

递归合并数组。

mergeRecursive(mixed||string|int args) : mixed||string|int

静态

自	2.0.0
抛出	`InvalidArgumentException`

参数

参数: array<string|int, mixed>要合并的数组列表。

响应

array<string|int, mixed>合并后的数组。

对数组进行枢纽操作以创建标量、数组或对象数组的反向查找。

pivot(mixed||string|int source,  key = null) : mixed||string|int

静态

自	1.0

参数

来源: array<string|int, mixed>源数组。
钥匙: string当源数组的元素是对象或数组时，要旋转的键。

响应

array<string|int, mixed>以键的值或对象或数组的单个键为中心旋转的数组数组。

对对象数组进行排序的实用函数

sortObjects(mixed||string|int a,  k,  direction = 1,  caseSensitive = true,  locale = false) : mixed||string|int

静态

自	1.0

参数

一个: array<string|int, mixed>对象数组
ķ: mixed要排序的键（字符串）或键数组
方向: mixed方向（整数）或方向数组，用于指定排序方向 [1 = 升序] [-1 = 降序]
区分大小写: mixed布尔值或布尔值数组，以允许区分大小写或不区分大小写排序
区域设置: mixed布尔值或布尔值数组，以允许使用区域设置语言或不使用区域设置语言进行排序

响应

array<string|int, mixed>

将数组转换为整数值的函数

toInteger(mixed||string|int array, int|array default = null) : mixed||string|int

静态

自	1.0

参数

数组: array<string|int, mixed>要转换的源数组
默认: int|array<string|int, mixed>如果 $array 不是数组，则要分配的默认值

响应

array<string|int, mixed>

将数组映射到 stdClass 对象的实用函数。

toObject(mixed||string|int array,  class = 'stdClass',  recursive = true) :

静态

自	1.0

参数

数组: array<string|int, mixed>要映射的数组。
类: string要创建的类的名称
递归: bool还转换主数组内的任何数组

响应

对象

将数组映射到字符串的实用函数。

toString(mixed||string|int array,  innerGlue = '=',  outerGlue = ' ',  keepOuterKey = false) :

静态

自	1.0

参数

数组: array<string|int, mixed>要映射的数组。
innerGlue: string键和值之间的粘合剂（可选，默认为 '='）。
outerGlue: string数组元素之间的粘合剂（可选，默认为 ' '）。
keepOuterKey: bool如果要保留最终键，则为真。

响应

字符串