Ассоциативные массивы PHP: пары ключ и значение

Ассоциативный массив хранит каждое значение под ключом, который вы выбираете, в виде key => value: $user = ['name' => 'Ada', 'age' => 36];. Значение читается через $user['name'], а добавить или изменить его можно присваиванием по ключу: $user['email'] = 'ada@example.com';.

<?php
$user = [
    'name' => 'Ada',
    'age'  => 36,
    'city' => 'London',
];

echo $user['name'], "\n";
echo $user['age'], "\n";

$user['email'] = 'ada@example.com';   // add a pair
$user['city']  = 'Paris';             // change a value

print_r($user);

В других языках такую структуру называют словарём, map или хешем. В PHP это обычный массив, ключи которого строки, а не 0, 1, 2.

Добавление, изменение и удаление пар

Присваивание по несуществующему ключу добавляет пару в конец. Присваивание по существующему ключу заменяет значение и сохраняет позицию. unset() удаляет пару.

<?php
$stock = ['apples' => 10, 'pears' => 4];

$stock['plums'] = 7;      // new key: added at the end
$stock['apples'] = 12;    // existing key: value replaced
$stock['pears']--;        // change in place
unset($stock['plums']);   // remove a pair

print_r($stock);

array_push() здесь не поможет: она умеет добавлять только значения с числовыми ключами. Чтобы добавить несколько пар сразу, используйте array_merge($stock, $more), где побеждают новые значения, или $stock + $more, где существующие ключи сохраняют свои значения; на странице про array_merge эти способы сравниваются.

Обход ключей и значений

foreach ($array as $key => $value) проходит пары в порядке добавления. Уберите $key =>, когда нужны только значения.

<?php
$capitals = [
    'France'  => 'Paris',
    'Japan'   => 'Tokyo',
    'Brazil'  => 'Brasília',
];

foreach ($capitals as $country => $capital) {
    echo "The capital of $country is $capital.\n";
}

foreach ($capitals as $capital) {
    echo mb_strtoupper($capital), "\n";
}

Все ключи или все значения

array_keys() возвращает ключи простым списком, а array_values() возвращает значения, оба с новой нумерацией от 0. Если передать array_keys() второй аргумент, она вернёт только ключи с этим значением, так находят все ключи для значения.

<?php
$grades = ['Ada' => 'A', 'Linus' => 'B', 'Grace' => 'A'];

print_r(array_keys($grades));
print_r(array_values($grades));
print_r(array_keys($grades, 'A'));    // keys whose value is 'A'

echo array_search('B', $grades), "\n"; // first key with value 'B'

Для одного ключа array_search() возвращает первое совпадение или false, если его нет. Почему этот результат нужно сравнивать через !== false, объясняется на странице про array_search.

Проверка, есть ли ключ

isset($arr['key']) это обычная и самая быстрая проверка, но она возвращает false, когда ключ существует и хранит null. array_key_exists('key', $arr) в этом случае возвращает true. Для чтения со значением по умолчанию оператор ?? делает и то, и другое сразу.

<?php
$settings = ['theme' => 'dark', 'font' => null];

var_dump(isset($settings['theme']));
var_dump(isset($settings['font']));            // null counts as not set
var_dump(array_key_exists('font', $settings)); // the key is there

$size = $settings['size'] ?? 14;               // default when missing
echo $size, "\n";

Сортировка по ключу или значению

ksort() сортирует по ключу, а asort() по значению, обе оставляют каждый ключ привязанным к его значению. krsort() и arsort() сортируют в обратном порядке. Не используйте sort() для ассоциативного массива: она выбрасывает ключи и нумерует заново с 0.

<?php
$population = ['Tokyo' => 37, 'Delhi' => 32, 'Shanghai' => 29, 'Cairo' => 22];

ksort($population);       // A to Z by city
print_r($population);

arsort($population);      // largest value first
print_r($population);

sort($population);        // keys are lost
print_r($population);

Все эти функции сортируют на месте и возвращают true, поэтому $sorted = ksort($arr) даст true, а не массив. Для своего порядка есть uasort() и uksort().

Перевернуть, посчитать и превратить в JSON

С данными ключ/значение снова и снова встречаются несколько однострочников: array_flip() меняет местами ключи и значения, array_count_values() считает, сколько раз встречается каждое значение, а json_encode() превращает массив в JSON-объект.

<?php
$codes = ['red' => '#f00', 'green' => '#0f0', 'blue' => '#00f'];

print_r(array_flip($codes));           // look up a name by code

$votes = ['yes', 'no', 'yes', 'yes', 'no'];
print_r(array_count_values($votes));   // value => how many times

echo json_encode($codes), "\n";

Частая ошибка: чтение ключа, которого нет

Чтение отсутствующего ключа возвращает null, но ваш PHP ещё и печатает предупреждение:

<?php
$user = ['name' => 'Ada'];
echo $user['phone'];

Warning: Undefined array key "phone" in /var/www/html/index.php on line 3

Задайте значение по умолчанию через ??, который никогда не предупреждает, или сначала проверьте через isset(), когда для отсутствующего ключа нужна отдельная ветка.

<?php
$user = ['name' => 'Ada', 'email' => 'ada@example.com'];

$phone = $user['phone'] ?? 'no phone on file';
echo $phone, "\n";

if (isset($user['email'])) {
    echo "Send mail to {$user['email']}\n";
}

Внутри строки в двойных кавычках оборачивайте обращение в фигурные скобки, "{$user['email']}". Без них PHP принимает только форму без кавычек "$user[email]", в которой легко ошибиться.