الدالة 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);