array_column
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
array_column — Повертає масив із значень одного стовпця вхідного масиву
Опис
array_column(array $array, int|string|null $column_key, int|string|null $index_key = null): array
Функцияarray_column() повертає значення одного стовпця масиву (array), обозначенного ключомcolumn_key. Щоб проіндексувати значення масиву, що повертається, значеннями стовпця index_key вхідного масиву, задають необов'язковий параметр index_key
Список параметрів
array
Багатомірний масив або масив об'єктів, з якого витягуватиметься стовпець значень. Якщо заданий масив об'єктів, то можна вибирати будь-які його загальнодоступні характеристики. Щоб отримати закриті або захищені властивості, у класі потрібно реалізувати два магічні методи. __get() і __isset()
column_key
Ключ шпальти, значення якого потрібно повернути. Дозволено передавати як цілий ключ стовпця, так і рядкову назву ключа асоціативного масиву або властивості об'єкта, значення якого потрібно отримати. У параметр також дозволено передавати значення null для повернення повних масивів або об'єктів (це буде корисно за умови одночасної передачі параметра index_key, щоб переіндексувати масив).
index_key
Стовпець, значення якого будуть ключами або індексами масива, що повертається. Дозволено вказувати як цілий ключ стовпця, так і рядкову назву ключа. Значення наводиться як завжди для ключів масиву (проте, до PHP 8.0.0 об'єкти, що підтримують перетворення до рядка, були також дозволені).
Значення, що повертаються
Повертає масив із значень одного стовпця чи властивості об'єкта вхідного масиву.
список змін
| Версия | Опис |
|---|---|
| 8.0.0 | Об'єкти в стовпцях, позначені параметром index_key, більше не будуть перетворені на рядок і замість цього викидатимуть виняток TypeError |
Приклади
Приклад #1 Отримаємо стовпець із іменами з набору записів
Результат виконання наведеного прикладу:
Array
(
[0] => John
[1] => Sally
[2] => Jane
[3] => Peter
)
Приклад #2 Отримаємо стовпець прізвищ з набору записів, проіндексувавши їх значення стовпця «id»
Результат виконання наведеного прикладу:
Array
(
[2135] => Doe
[3245] => Smith
[5342] => Jones
[5623] => Doe
)
Приклад #3 Отримаємо стовпець імен користувачів із загальнодоступної властивості «username» об'єкта
Результат виконання наведеного прикладу:
Array
(
[0] => user 1
[1] => user 2
[2] => user 3
)
Приклад #4 Отримаємо стовпець імен користувачів з приватної властивості об'єкта «name», визначивши магічний метод __get()
Результат виконання наведеного прикладу:
Array
(
[0] => Fred
[1] => Jane
[2] => John
)
Якщо в об'єкті не буде методу __isset(), то повернеться порожній масив.