array_search() ב-PHP: מציאת המפתח של ערך

array_search($value, $array) מחזירה את המפתח של האיבר הראשון ששווה ל-$value, או false אם שום איבר לא מתאים. כיוון שמפתח שנמצא יכול להיות 0, בדקו את התוצאה עם !== false, כמו ב-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

אם אתם צריכים רק כן או לא, in_array() אומרת את זה ישירות. array_search() נועדה למקרים שבהם צריך לדעת איפה הערך יושב, למשל כדי לשנות או להסיר אותו.

המלכודת של 0 מול false

הבאג הנפוץ ביותר עם array_search(): הערך הוא האיבר הראשון, המפתח שלו הוא 0, ו-if ($key) מתייחס ל-0 כשקר. הקוד אומר "לא נמצא" על ערך שנמצא ממש שם. השוו עם !== false, שמתאים רק ל-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 יש אותו באג כמו ל-if ($key), כי 0 == false הוא true. רק האופרטור המחמיר מבדיל ביניהם.

חיפוש מחמיר

כמו in_array(), גם array_search() משווה עם == אלא אם מעבירים true כארגומנט השלישי. מצב רופף מאפשר למחרוזת למצוא מספר ול-null למצוא 0, וזה מחזיר מפתח שלא ציפיתם לו.

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

מציאת כל המפתחות עם ערך מסוים

array_search() עוצרת בהתאמה הראשונה. array_keys($array, $value) מחזירה כל מפתח מתאים כמערך; הוסיפו true להשוואה מחמירה. תוצאה ריקה אומרת שאין התאמה, ולכן אין בלבול בין 0 ל-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";

חיפוש במערך רב ממדי עם array_column

array_search() לא מסתכלת בתוך מערכים מקוננים. ברשימת שורות, חלצו את השדה שאתם מחפשים עם array_column(); המיקומים ברשימה הזו תואמים למספרי השורות, ולכן התוצאה היא האינדקס של השורה.

<?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() ממספרת את הפלט שלה מחדש מ-0, ולכן זה מסתדר רק כשהשורות ממוספרות 0, 1, 2 בלי פערים. אחרי unset() או array_filter() יש פערים במספור; הריצו קודם array_values() על השורות או השתמשו בחיפוש לפי מפתח שבשתי השורות האחרונות. ב-array_column() יש עוד על הצורה עם מפתח אינדקס.

חיפוש בלי תלות באותיות גדולות וקטנות

array_search() משווה מחרוזות בדיוק. המירו את שני הצדדים לאותיות קטנות כדי להתעלם מרישיות. array_map() שומרת על המפתחות, ולכן המפתח שמקבלים בחזרה הוא המפתח במערך המקורי.

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

חיפוש והחלפה או הסרה

הסיבה הרגילה לחפש היא לפעול על האיבר שנמצא. כשהמפתח ביד, הציבו כדי לשנות אותו או unset() כדי להסיר אותו, ותמיד הגנו קודם עם !== false: unset($arr[false]) מסירה בשקט את האיבר עם המפתח 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);