helpers\BaseArrayHelper map()

map() public static method

Builds a map (key-value pairs) from a multidimensional array or an array of objects.

The $from and $to parameters specify the key names or property names to set up the map. Optionally, one can further group the map according to a grouping field $group.

For example,

$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',
//     ],
// ]
public static array map ( $array, $from, $to, $group = null )
$array array
$from string|Closure
$to string|Closure
$group string|Closure
doc_Yii
2016-10-30 17:04:28
Comments
Leave a Comment

Please login to continue.