array_key_exists() ב-PHP: בדיקה אם מפתח קיים במערך

array_key_exists('key', $array) מחזירה true אם למערך יש את המפתח הזה ו-false אם אין. שימו לב לסדר: המפתח בא ראשון, המערך שני. היא מחזירה true גם כשהערך שנשמר תחת המפתח הוא null, וזה הדבר היחיד ש-isset() לא עושה.

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

var_dump(array_key_exists('email', $user));
var_dump(array_key_exists('address', $user));
var_dump(array_key_exists('phone', $user));   // key is there, value is null

$list = ['a', 'b', 'c'];
var_dump(array_key_exists(2, $list));         // integer keys too

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

array_key_exists מול isset

שתיהן בודקות מפתח. הן חלוקות רק כשהערך הוא null: isset() מתייחסת לערך null כ"לא מוגדר", array_key_exists() מדווחת על מה שבאמת נמצא במערך.

<?php
$form = ['name' => 'Ada', 'nickname' => null, 'age' => 0, 'bio' => ''];

foreach (['name', 'nickname', 'age', 'bio', 'missing'] as $key) {
    printf(
        "%-9s isset: %-5s  array_key_exists: %s\n",
        $key,
        var_export(isset($form[$key]), true),
        var_export(array_key_exists($key, $form), true)
    );
}

0 ו-'' נחשבים מוגדרים אצל שתיהן; רק null מפריד ביניהן. מה שאתם רוצים תלוי במה ש-null אומר בנתונים שלכם:

• השתמשו ב-isset() כש-null אומר "אין ערך". זה המקרה הנפוץ, זה מבנה שפה (מעט מהיר יותר), והוא מקבל נתיבים מקוננים ומשתנים לא מוגדרים בלי אזהרה.
• השתמשו ב-array_key_exists() כש-null הוא ערך אמיתי שצריך להבדיל ממפתח חסר: שדה JSON שנשלח כ-null, עמודת מסד נתונים שהיא NULL, אפשרות שהוגדרה במפורש כ-null כדי לנקות אותה.

עמוד isset מכסה את השימושים האחרים שלה, כולל בדיקה של כמה משתנים בבת אחת.

הבחנה בין null לבין חסר במטען JSON

מקרה טיפוסי שבו רק array_key_exists() נותנת את התשובה הנכונה: API שמעדכן רשומה מ-JSON. שדה שנשלח כ-null אומר "נקה אותו", שדה שלא נשלח אומר "אל תיגע בו". isset() רואה את שניהם כאותו דבר.

<?php
$record = ['name' => 'Ada', 'phone' => '555-0100', 'city' => 'London'];
$patch  = json_decode('{"phone": null, "city": "Paris"}', true);

foreach (['name', 'phone', 'city'] as $field) {
    if (array_key_exists($field, $patch)) {
        $record[$field] = $patch[$field];   // includes setting null
    }
}

var_dump($record);

עם isset($patch[$field]) מספר הטלפון היה נשאר, כי ה-null היה נראה כמו שדה חסר.

key_exists() היא אותה פונקציה

key_exists() היא כינוי של array_key_exists(), שנשמר מימי PHP המוקדמים. אותם ארגומנטים, אותה תוצאה. העדיפו את השם המלא, שאותו קוראים מצפים לראות.

<?php
$config = ['debug' => false];

var_dump(key_exists('debug', $config));
var_dump(array_key_exists('debug', $config));
var_dump(key_exists('cache', $config));

טיפוסי מפתחות: "1" ו-1 הם אותו מפתח

מפתחות מערך הם מספרים שלמים או מחרוזות, ומחרוזת שהיא מספר שלם עשרוני פשוט נשמרת כמספר שלם. לכן array_key_exists('1', $arr) מוצאת את המפתח 1, וגם להפך. מחרוזת כמו '01' נשארת מחרוזת והיא מפתח אחר.

<?php
$byId = [1 => 'Ada', 2 => 'Linus', '07' => 'Grace'];

var_dump(array_key_exists('1', $byId));    // "1" is the int key 1
var_dump(array_key_exists(7, $byId));      // 7 is not "07"
var_dump(array_key_exists('07', $byId));

בדיקת מפתחות מקוננים וכמה מפתחות

array_key_exists() מסתכלת על רמה אחת. לנתיב מקונן שבו null לא משנה, isset($a['x']['y']) בודקת כל רמה בבת אחת. לנתיב שבו הוא כן משנה, פונקציית עזר קצרה עוברת על הרמות. כדי לבדוק שכמה מפתחות קיימים כולם, השוו מול array_diff_key().

<?php
function hasPath(array $data, array $path): bool
{
    foreach ($path as $key) {
        if (!is_array($data) || !array_key_exists($key, $data)) {
            return false;
        }
        $data = $data[$key];
    }
    return true;
}

$order = ['customer' => ['address' => ['city' => 'Lyon', 'zip' => null]]];

var_dump(isset($order['customer']['address']['zip']));          // null: false
var_dump(hasPath($order, ['customer', 'address', 'zip']));       // present: true
var_dump(hasPath($order, ['customer', 'phone']));

$required = ['name', 'email', 'password'];
$input = ['name' => 'Ada', 'email' => 'ada@example.com'];
$missing = array_keys(array_diff_key(array_flip($required), $input));
print_r($missing);

array_flip($required) הופכת את רשימת השמות למפתחות כדי ש-array_diff_key() תוכל להשוות אותם למפתחות של הקלט; מה שנשאר הוא רשימת השדות החסרים, מוכנה להודעת שגיאה.

אובייקטים צריכים property_exists

גרסאות PHP ישנות קיבלו אובייקט ב-array_key_exists(). PHP 8 זורקת במקום זאת TypeError. לאובייקטים, property_exists() בודקת מאפיין מוצהר או דינמי (גם כזה שמוגדר כ-null), ו-isset($obj->prop) עובדת כמו isset() על מערכים.

<?php
class User
{
    public ?string $phone = null;
    public string $name = 'Ada';
}

$u = new User();

var_dump(property_exists($u, 'phone'));   // declared, value null
var_dump(isset($u->phone));
var_dump(property_exists($u, 'email'));

$asArray = get_object_vars($u);
var_dump(array_key_exists('name', $asArray));

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