in_array() ב-PHP: בדיקה אם ערך נמצא במערך

in_array($needle, $haystack) מחזירה true אם הערך נמצא איפשהו במערך ו-false אם לא. העבירו true כארגומנט השלישי, in_array($needle, $haystack, true), כדי לדרוש גם אותו טיפוס; בצורה המחמירה הזו כדאי להשתמש כברירת מחדל.

<?php
$roles = ['admin', 'editor', 'viewer'];

var_dump(in_array('editor', $roles));
var_dump(in_array('owner', $roles));

if (in_array('admin', $roles, true)) {
    echo "Show the admin menu\n";
}

in_array() מסתכלת רק על ערכים. כדי לבדוק אם מפתח קיים, השתמשו ב-array_key_exists() או ב-isset().

הפרמטר המחמיר

בלי הארגומנט השלישי, in_array() משווה עם ==, שממיר טיפוסים לפני ההשוואה. עם true, היא משווה עם ===: גם הערך וגם הטיפוס חייבים להתאים. ההבדל מופיע ברגע שהמערך מערבב מספרים ומחרוזות, וזה נפוץ בנתונים מטפסים, מכתובות URL ומקובצי CSV.

<?php
$ids = [1, 2, 3];

var_dump(in_array('2', $ids));          // loose: "2" == 2
var_dump(in_array('2', $ids, true));    // strict: string is not int

$flags = [0, 'off'];
var_dump(in_array(null, $flags));       // null == 0
var_dump(in_array(null, $flags, true));

var_dump(in_array(true, ['yes']));      // 'yes' is truthy, so == true
var_dump(in_array('1e1', ['10']));      // both numeric: 10 == 10

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

כלל אחד השתנה ב-PHP 8: מחרוזת לא מספרית כבר לא שווה ל-0, ולכן in_array('abc', [0]) הוא false היום אבל היה true ב-PHP 7. קוד שנכתב ל-PHP 7 הסתמך על זה לפעמים, וזו עוד סיבה להעביר true ולא להיות תלויים בכללי ההמרה. עמוד אופרטורי ההשוואה מסביר אותם במלואם.

in_array בלי תלות באותיות גדולות וקטנות

in_array() משווה מחרוזות בדיוק, ולכן 'PHP' ו-'php' שונים. המירו גם את המחט וגם את המערך לאותיות קטנות לפני הבדיקה. mb_strtolower() מטפלת גם באותיות עם סימנים דיאקריטיים ובאותיות שאינן לטיניות.

<?php
$allowed = ['jpg', 'PNG', 'Gif'];
$ext = 'png';

var_dump(in_array($ext, $allowed, true));

$lower = array_map('strtolower', $allowed);
var_dump(in_array(strtolower($ext), $lower, true));

$cities = ['München', 'Zürich'];
var_dump(in_array('ZÜRICH', $cities, true));
var_dump(in_array(mb_strtolower('ZÜRICH'), array_map('mb_strtolower', $cities), true));

בדיקת כמה ערכים בבת אחת

in_array() מקבלת מחט אחת. לכמה מחטים, השוו את המערכים כקבוצות: array_diff() מחזירה את המחטים שחסרות, כך שתוצאה ריקה אומרת שכולן קיימות, ו-array_intersect() מחזירה את המחטים שנמצאו.

<?php
$skills = ['php', 'sql', 'git', 'docker'];

$required = ['php', 'git'];
$hasAll = array_diff($required, $skills) === [];
var_dump($hasAll);

$wanted = ['rust', 'sql'];
$hasAny = array_intersect($wanted, $skills) !== [];
var_dump($hasAny);

print_r(array_diff(['php', 'go'], $skills));   // what is missing

array_diff() ו-array_intersect() משוות ערכים כמחרוזות, ולכן 1 ו-'1' נחשבים שם שווים.

in_array על מערך רב ממדי

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

<?php
$users = [
    ['id' => 1, 'email' => 'ada@example.com'],
    ['id' => 2, 'email' => 'linus@example.com'],
];

var_dump(in_array('ada@example.com', $users, true));    // compares whole rows

$emails = array_column($users, 'email');
var_dump(in_array('ada@example.com', $emails, true));

var_dump(in_array(['id' => 2, 'email' => 'linus@example.com'], $users, true));

השורה האחרונה מראה שהמחט יכולה להיות בעצמה מערך: היא מתאימה לשורה זהה, עם אותם מפתחות, ערכים וסדר.

in_array מול array_search מול isset

שלושתן עונות על "האם זה שם?", אבל הן מחזירות דברים שונים ורצות במהירויות שונות:

השתמשו ב-array_search() כשאתם צריכים לדעת איפה הערך נמצא. כשאתם בודקים הרבה ערכים מול אותה רשימה גדולה, הפכו את הרשימה פעם אחת כך שהערכים שלה יהפכו למפתחות, והשתמשו ב-isset().

<?php
$banned = [];
for ($i = 0; $i < 100000; $i++) {
    $banned[] = "user$i";
}
$checks = ['user99999', 'guest', 'user5'];

$start = hrtime(true);
for ($n = 0; $n < 200; $n++) {
    foreach ($checks as $name) {
        in_array($name, $banned, true);
    }
}
printf("in_array: %.1f ms\n", (hrtime(true) - $start) / 1e6);

$set = array_flip($banned);        // values become keys, done once
$start = hrtime(true);
for ($n = 0; $n < 200; $n++) {
    foreach ($checks as $name) {
        isset($set[$name]);
    }
}
printf("isset:    %.1f ms\n", (hrtime(true) - $start) / 1e6);

var_dump(isset($set['user5']), isset($set['guest']));

הזמנים משתנים מהרצה להרצה, אבל הפער לא: החיפוש עם isset() נשאר קבוע בעוד in_array() גדלה עם גודל הרשימה. array_flip() עובדת רק עם ערכי מחרוזת ומספר שלם, וכפילויות מתמזגות למפתח אחד, וזה לא משנה לבדיקת חברות.