Класс yii\helpers\BaseArrayHelper

filter() public static method (available since version 2.0.9)

Фильтрация массива по заданным правилам.

Например:

$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],
// ]

getColumn() public static method

Возвращает значения указанного столбца в массиве.

Входной массив должен быть многомерным или массивом объектов.

Например,

$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'];
});

getValue() public static method

Извлекает значение элемента массива или свойства объекта с заданным ключом или именем свойства.

Если ключ не существует в массиве или объекте, возвращается значение по умолчанию.

Ключ может быть указан в формате точки, чтобы получить значение подмассива или свойства вложенного объекта. В частности, если ключ равен 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']);

htmlDecode() public static method

Декодирует HTML-сущности в соответствующие символы в массиве строк.

По умолчанию декодируются только значения массива. Если значение является массивом, этот метод также декодирует его рекурсивно. Декодируются только строковые значения.

См. также http://www.php.net/manual/en/function.htmlspecialchars-decode.php.

htmlEncode() public static method

Кодирует специальные символы в массиве строк в HTML-сущности.

По умолчанию кодируются только значения массива. Если значение является массивом, этот метод также закодирует его рекурсивно. Кодируются только строковые значения.

См. также http://www.php.net/manual/en/function.htmlspecialchars.php.

index() public static method

Индексирует и/или группирует массив по заданному ключу.

Входные данные должны быть либо многомерным массивом, либо массивом объектов.

Ключ может быть либо именем ключа подмассива, либо именем свойства объекта, либо анонимной функцией, которая должна вернуть значение, используемое в качестве ключа.

$groups — массив ключей, используемых для группировки входного массива в один или несколько подмассивов на основе заданных ключей.

Если $key задан как null или значение элемента, соответствующего ключу, равно null в дополнение к $groups не указан, то элемент отбрасывается.

Например:

$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']
        ]
    ]
]

isAssociative() public static method

Возвращает значение, указывающее, является ли заданный массив ассоциативным.

Массив является ассоциативным, если все его ключи являются строками. Если $allStrings ложно, то массив будет считаться ассоциативным, если хотя бы один из его ключей является строкой.

Обратите внимание, что пустой массив НЕ будет считаться ассоциативным.

isIn() public static method (доступно с версии 2.0.7)

Проверяет, содержит ли массив или объект Traversable элемент.

Этот метод делает то же самое, что и функция PHP in_array(), но дополнительно работает с объектами, реализующими интерфейс Traversable.

См. также http://php.net/manual/en/function.in-array.php.

isIndexed() public static method

Возвращает значение, указывающее, является ли данный массив индексированным.

Массив считается индексированным, если все его ключи являются целыми числами. Если $consecutive равно true, то ключи массива должны быть последовательной последовательностью, начиная с 0.

Обратите внимание, что пустой массив будет считаться индексированным.

isSubset() public static method (доступно с версии 2.0.7)

Проверяет, является ли массив или Traversable подмножеством другого массива или Traversable.

Этот метод вернёт true, если все элементы $needles содержатся в $haystack. Если хотя бы один элемент отсутствует, будет возвращено false.

isTraversable() public static method (доступно с версии 2.0.8)

Проверяет, является ли переменная массивом или Traversable.

Этот метод делает то же самое, что и функция PHP is_array(), но дополнительно работает с объектами, реализующими интерфейс Traversable.

См. также http://php.net/manual/en/function.is-array.php.

keyExists() public static method

Проверяет, содержит ли данный массив указанный ключ.

Этот метод расширяет функцию array_key_exists(), поддерживая сравнение ключей без учёта регистра.

map() public static method

Создаёт карту (пары ключ-значение) из многомерного массива или массива объектов.

Параметры $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',
//     ],
// ]

merge() public static method

Рекурсивно объединяет два или более массивов в один.

Если в каждом массиве есть элемент с одинаковым строковым значением ключа, то последний перепишет предыдущий (отличается от array_merge_recursive). Рекурсивное объединение будет проведено, если у обоих массивов есть элемент типа массив и у них одинаковый ключ. Для элементов с целочисленными ключами элементы из последнего массива будут добавлены в первый массив. Можно использовать объект yii\helpers\UnsetArrayValue для удаления значения из предыдущего массива или yii\helpers\ReplaceArrayValue для принудительной замены предыдущего значения вместо рекурсивного объединения.

multisort() public static method

Сортирует массив объектов или массивов (с одинаковой структурой) по одному или нескольким ключам.

remove() public static method

Удаляет элемент из массива и возвращает его значение. Если ключ не существует в массиве, возвращается значение по умолчанию.

Примеры использования,

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

removeValue() public static method (доступен с версии 2.0.11)

Удаляет элементы с совпадающими значениями из массива и возвращает удаленные элементы.

Пример,

$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'];

toArray() public static method

Преобразует объект или массив объектов в массив.

[
    'app\models\Post' => [
        'id',
        'title',
        // the key name in array result => property name
        'createTime' => 'created_at',
        // the key name in array result => anonymous function
        'length' => function ($post) {
            return strlen($post->content);
        },
    ],
]

[
    'id' => 123,
    'title' => 'test',
    'createTime' => '2013-01-01 12:00AM',
    'length' => 301,
]