الدالة opendir()‎ في PHP

(PHP 4, PHP 5, PHP 7)

تفتح الدالة opendir()‎ مجلَّدًا محدَّدًا.

الوصف

resource opendir ( string $path [, resource $context ] )

تفتح هذه الدالة المجلَّد ذي المسار path ثمَّ تعيد مقبضًا له يمكن أن يُستعمل لاحقًا مع الدالة closedir()‎ والدالة readdir()‎ والدالة rewinddir()‎.

المعاملات

path

مسار المجلَّد المُراد فتحه.

context

راجع قسم المجرى (stream) للمزيد من الشرح عن المعامل context.

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

يُعاد مورد مقبض المجلَّد عند نجاح العمليَّة، أو القيمة FALSE عند فشلها.

إن كان المسار path خطأً ولا يشير إلى مجلَّد أو كان المجلدَّ موجودًا ولكن لا يمكن فتحه لقيود في أذوناته أو كان هنالك خطأ في نظام الملفات، فستُعاد القيمة FALSE وسيُصدر خطأ من المستوى E_WARNING. يمكنك إخفاء ظهور هذا الخطأ بإضافة المعامل @ إلى بداية اسم الدالة.

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

الإصدار	الوصف
5.0.0	أًصبح المعامل path يدعم البروتوكول ftp://‎ في عناوين URL.
4.3.0	يمكن الآن للمعامل path أن يكون أيَّ عنوان URL يدعم تضمين المجلَّد إلَّا أنَّ البروتوكول file://‎ يدعم ذلك فقط في PHP 4.

أمثلة

المثال 1: استعمال الدالة opendir()‎

<?php
$dir = "/etc/php5/";

// فتح المجلَّد لقراءة محتواه
if (is_dir($dir)) {
    if ($dh = opendir($dir)) {
        while (($file = readdir($dh)) !== false) {
            echo "filename: $file : filetype: " . filetype($dir . $file) . "\n";
        }
        closedir($dh);
    }
}
?>

سيُظهر المثال السابق نتيجة شبيهة بالتالي:

filename: . : filetype: dir
filename: .. : filetype: dir
filename: apache : filetype: dir
filename: cgi : filetype: dir
filename: cli : filetype: dir

انظر أيضًا

• الدالة is_dir()‎: تتحقَّق إن كان المسار المُمرَّر إليها مجلَّدًا.
• الدالة readdir()‎: تقرأ عنصرًا واحدًا من محتويات المجلَّد وتعيده.
• الدالة dir()‎: تعيد نسخةً (instance) من الصنف Directory.

مصادر

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