Tableau associatif PHP : paires clé valeur

Un tableau associatif range chaque valeur sous une clé que vous choisissez, écrite key => value : $user = ['name' => 'Ada', 'age' => 36];. Lisez une valeur avec $user['name'], et ajoutez-en ou modifiez-en une en affectant sa clé : $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);

Dans d'autres langages, la même structure s'appelle un dictionnaire, une map ou un hash. En PHP, c'est un tableau ordinaire dont les clés sont des chaînes au lieu de 0, 1, 2.

Ajouter, modifier et supprimer des paires

Affecter une clé qui n'existe pas l'ajoute à la fin. Affecter une clé qui existe remplace sa valeur et garde sa position. unset() supprime une paire.

<?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() n'aide pas ici : elle ne peut ajouter que des valeurs à clés numériques. Pour ajouter plusieurs paires à la fois, utilisez array_merge($stock, $more), où les nouvelles valeurs l'emportent, ou $stock + $more, où les clés existantes gardent leur valeur ; la page array_merge compare les deux.

Parcourir les clés et les valeurs

foreach ($array as $key => $value) parcourt les paires dans l'ordre où elles ont été ajoutées. Omettez $key => quand vous n'avez besoin que des valeurs.

<?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";
}

Obtenir toutes les clés ou toutes les valeurs

array_keys() renvoie les clés sous forme de liste simple et array_values() renvoie les valeurs, toutes deux réindexées depuis 0. Donnez un second argument à array_keys() et elle ne renvoie que les clés qui contiennent cette valeur, ce qui permet de trouver toutes les clés d'une valeur.

<?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'

Pour une seule clé, array_search() renvoie la première correspondance, ou false s'il n'y en a pas. La page array_search explique pourquoi il faut comparer ce résultat avec !== false.

Vérifier si une clé existe

isset($arr['key']) est la vérification habituelle et la plus rapide, mais elle renvoie false quand la clé existe et contient null. array_key_exists('key', $arr) renvoie true dans ce cas. Pour lire avec une valeur de repli, l'opérateur ?? fait les deux à la fois.

<?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";

Trier par clé ou par valeur

ksort() trie par clé et asort() par valeur, toutes deux en gardant chaque clé attachée à sa valeur. krsort() et arsort() trient dans l'ordre inverse. N'utilisez pas sort() sur un tableau associatif : elle jette les clés et renumérote depuis 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);

Toutes ces fonctions trient sur place et renvoient true, donc $sorted = ksort($arr) vous donne true, pas un tableau. Les ordres personnalisés utilisent uasort() et uksort().

Inverser, compter et convertir en JSON

Quelques lignes reviennent sans cesse avec des données clé valeur : array_flip() échange clés et valeurs, array_count_values() compte combien de fois chaque valeur apparaît, et json_encode() transforme le tableau en objet 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";

Erreur fréquente : lire une clé qui n'existe pas

Lire une clé manquante renvoie null, mais votre PHP affiche aussi un warning :

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

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

Donnez une valeur par défaut à la lecture avec ??, qui n'affiche jamais de warning, ou vérifiez d'abord avec isset() quand le cas manquant a besoin de sa propre branche.

<?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";
}

Dans une chaîne entre guillemets doubles, entourez la lecture d'accolades, "{$user['email']}". Sans elles, PHP n'accepte que la forme sans guillemets "$user[email]", facile à mal écrire.