PHP/array search

(PHP 4 >= 4.0.5, PHP 5, PHP 7)

تبحث الدالة array_search()‎ في المصفوفة عن قيمة محددة وتعيد مفتاح أول عنصر يحمل هذه القيمة إذا نجح.

الوصف

mixed array_search ( mixed $needle , array $haystack [, bool $strict = FALSE ] )

تبحث الدالة array_search()‎ في المصفوفة haystack عن القيمة needle.

المعاملات

needle

القيمة التي نبحث عنها.

ملاحظة:إذا كانت needle سلسلةً نصيةً (string)، فستكون المقارنة بطريقة حساسة لحالة الأحرف.

haystack

المصفوفة المراد البحث فيها.

strict

إذا ضُبِطَ المعامل الثالث strict إلى القيمة TRUE فستبحث الدالة array_search()‎ عن عناصر متطابقة في المصفوفة haystack. الأمر الذي يعني أنه سيؤدي أيضًا إلى إجراء مقارنة صارمة للنوع للقيمة needle في المصفوفة haystack، ويجب أن تكون الكائنات متماثلة.

القيم المعادة

تعيد هذه الدالة مفتاح العنصر الي يحمل القيمة needle إذا عُثِرَ عليه في المصفوفة، أو تعيد FALSE خلاف ذلك.

إذا عُثِرَ على needle في haystack أكثر من مرة، فسيُعاد مفتاح أول عنصر مطابق. وتُستخدم الدالة array_keys()‎ بدلاً من ذلك مع المعامل search_value الاختياري لإسترجاع المفاتيح لجميع القيم المطابقة.

تحذير: قد تُعيد هذه الدالة القيمة المنطقية FALSE، ولكن قد تُعيد أيضًا قيمة غير منطقية تُقيّم بنفس القيمة FALSE. يرجى قراءة قسم القيم المنطقية Booleans لمزيد من المعلومات. يستخدم العامل === لاختبار القيمة المعادة من هذه الدالة.

سجل التغييرات

الإصدار	الوصف
5.3.0	كما هو الحال مع جميع دوال PHP الداخلية اعتبارًا من الإصدار 5.3.0، تعيد الدالة array_search()‎ القيمة NULL إذا مُرِّرَت معاملات غير صالحة لها.

أمثلة

المثال 1: مثال على الدالة array_search()‎

<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array);   // $key = 1;
?>

انظر أيضًا

• الدالة array_keys()‎: إعادة كافة مفاتيح أو مجموعة فرعية من مفاتيح المصفوفة.
• الدالة array_values​​()‎: إعادة كافة قيم عناصر المصفوفة.
• الدالة array_key_exists()‎: التحقق من وجود مفتاح أو مؤشر معين في المصفوفة.
• الدالة in_array()‎: التحقق من وجود قيمة ما في مصفوفة.

مصادر

• صفحة الدالة array_search في توثيق PHP الرسمي.