PHP array_key_exists(): 배열 키 존재 확인

array_key_exists('key', $array)는 배열에 그 키가 있으면 true, 없으면 false를 반환합니다. 순서에 주의하세요. 키가 먼저, 배열이 두 번째입니다. 키 아래 저장된 값이 null이어도 true를 반환하며, 이것이 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이 무엇을 뜻하는지에 달려 있습니다.

• null이 "값 없음"을 뜻한다면 isset()을 쓰세요. 흔한 경우이고, 언어 구조라서(조금 더 빠름) 중첩 경로와 정의되지 않은 변수도 경고 없이 받습니다.
• null이 없는 키와 구별해야 하는 진짜 값이라면 array_key_exists()를 쓰세요. null로 보낸 JSON 필드, NULL인 데이터베이스 컬럼, 지우려고 일부러 null로 설정한 옵션 같은 경우입니다.

여러 변수를 한 번에 확인하는 것을 포함한 다른 용도는 isset 페이지에서 다룹니다.

JSON 페이로드에서 null과 누락 구별하기

array_key_exists()만 올바른 답을 주는 대표적인 경우입니다. JSON으로 레코드를 수정하는 API에서 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()는 초기 PHP부터 남아 있는 array_key_exists()의 별칭입니다. 인수도 결과도 같습니다. 읽는 사람이 예상하는 전체 이름을 쓰세요.

<?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은 같은 키

배열 키는 정수나 문자열이며, 평범한 10진 정수인 문자열은 정수로 저장됩니다. 그래서 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를 던집니다. 객체에는 선언된 속성이나 동적 속성(값이 null이어도)을 확인하는 property_exists()를 쓰고, 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()는 객체의 접근 가능한 속성을 배열로 바꾸며, 그다음에는 배열 함수를 쓸 수 있습니다.