PHP array_search(): trovare la chiave di un valore

array_search($value, $array) restituisce la chiave del primo elemento uguale a $value, oppure false se nessun elemento corrisponde. Dato che una chiave trovata può essere 0, verifica il risultato con !== false, come in if (($key = array_search('pear', $fruits)) !== false).

<?php
$fruits = ['apple', 'pear', 'plum'];

$key = array_search('pear', $fruits);
var_dump($key);

$key = array_search('kiwi', $fruits);
var_dump($key);

$prices = ['apple' => 1.20, 'pear' => 0.90];
echo array_search(0.90, $prices), "\n";   // works with string keys too

Se ti serve solo un sì o un no, in_array() lo dice direttamente. array_search() serve quando devi sapere dove si trova il valore, per esempio per modificarlo o rimuoverlo.

La trappola 0 vs false

Il bug più comune con array_search(): il valore è il primo elemento, la sua chiave è 0, e if ($key) tratta 0 come falso. Il codice dice "non trovato" per un valore che è proprio lì. Confronta con !== false, che corrisponde solo a un vero false.

<?php
$queue = ['Ada', 'Linus', 'Grace'];

if (array_search('Ada', $queue)) {
    echo "Wrong check: found\n";
} else {
    echo "Wrong check: not found\n";      // this runs, key is 0
}

$key = array_search('Ada', $queue);
if ($key !== false) {
    echo "Right check: found at $key\n";
}

!= false ha lo stesso bug di if ($key), perché 0 == false è true. Solo l'operatore stretto li distingue.

Ricerca stretta

Come in_array(), array_search() confronta con == a meno che tu non passi true come terzo argomento. La modalità debole permette a una stringa di trovare un numero e a null di trovare 0, il che restituisce una chiave inattesa.

<?php
$ids = [10, 20, 30];
var_dump(array_search('20', $ids));         // loose: "20" == 20
var_dump(array_search('20', $ids, true));   // strict: no match

$stock = ['apples' => 5, 'pears' => 0];
var_dump(array_search(null, $stock));       // null == 0: finds 'pears'
var_dump(array_search(null, $stock, true));

Trovare tutte le chiavi con un valore

array_search() si ferma alla prima corrispondenza. array_keys($array, $value) restituisce ogni chiave corrispondente come array; aggiungi true per un confronto stretto. Un risultato vuoto significa nessuna corrispondenza, quindi non c'è confusione tra 0 e false.

<?php
$seats = ['A1' => 'free', 'A2' => 'taken', 'A3' => 'free', 'A4' => 'taken'];

echo array_search('free', $seats), "\n";          // first only
print_r(array_keys($seats, 'free', true));       // all of them

$colors = ['red', 'blue', 'red', 'green', 'red'];
echo implode(', ', array_keys($colors, 'red')), "\n";

Cercare in un array multidimensionale con array_column

array_search() non guarda dentro gli array annidati. Per una lista di righe, estrai con array_column() il campo che stai cercando; le posizioni in quella lista corrispondono ai numeri di riga, quindi il risultato è l'indice della riga.

<?php
$users = [
    ['id' => 101, 'name' => 'Ada',   'email' => 'ada@example.com'],
    ['id' => 102, 'name' => 'Linus', 'email' => 'linus@example.com'],
    ['id' => 103, 'name' => 'Grace', 'email' => 'grace@example.com'],
];

$i = array_search('linus@example.com', array_column($users, 'email'), true);
if ($i !== false) {
    echo "Found {$users[$i]['name']} with id {$users[$i]['id']}\n";
}

// When rows are looked up often, index them once by the field instead
$byEmail = array_column($users, null, 'email');
echo $byEmail['grace@example.com']['id'], "\n";

array_column() rinumera il suo output da 0, quindi tutto torna solo quando le righe sono numerate 0, 1, 2 senza buchi. Dopo unset() o array_filter() la numerazione ha dei buchi; esegui prima array_values() sulle righe oppure usa la ricerca per chiave delle ultime due righe. array_column() approfondisce la forma con la chiave indice.

Ricerca case-insensitive

array_search() confronta le stringhe esattamente. Converti in minuscolo entrambi i lati per ignorare maiuscole e minuscole. array_map() mantiene le chiavi, quindi la chiave che ottieni è quella dell'array originale.

<?php
$tags = ['first' => 'PHP', 'second' => 'Laravel', 'third' => 'MySQL'];

var_dump(array_search('mysql', $tags, true));

$lower = array_map('strtolower', $tags);
$key = array_search(strtolower('mysql'), $lower, true);
var_dump($key);
echo $tags[$key], "\n";

Cercare e poi sostituire o rimuovere

Il motivo abituale per cercare è agire sull'elemento trovato. Con la chiave in mano, assegna per modificarlo o usa unset() per rimuoverlo, e proteggiti sempre prima con !== false: unset($arr[false]) rimuove in silenzio l'elemento con chiave 0.

<?php
$todo = ['buy milk', 'call Ada', 'write report'];

$key = array_search('call Ada', $todo, true);
if ($key !== false) {
    $todo[$key] = 'call Ada (done)';
}

$key = array_search('buy milk', $todo, true);
if ($key !== false) {
    unset($todo[$key]);
}

$todo = array_values($todo);   // renumber after unset
print_r($todo);