PHP/dir

(PHP 4, PHP 5, PHP 7)

تعيد الدالة dir()‎ نسخةً (instance) من الصنف Directory.

الوصف

Directory dir ( string $directory [, resource $context ] )

تملك هذه الدالة آلية شبه كائنيَّة التوجه لقراءة المجلَّد. سيُفتح المجلد directory المعطى.

المعاملات

directory

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

context

ملاحظة: أُضيف دعم المحتوى منذ إصدار PHP 5.0.0. راجع قسم المجرى (stream) للمزيد من الشرح عن المحتوى (context).

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

تُعاد نسخةٌ من الصنف Directory عند نجاح العمليَّة، أو القيمة NULL إن كان هنالك خطأ في أحد المعاملين المُمرَّرين أو كلاهما، أو القيمة FALSE إن حصل خطأ آخر.

أمثلة

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

انتبه رجاءً إلى الطريقة المستعملة للتأكُّد من القيمة التي يعيدها التابع Directory::read()‎ في الشيفرة التالية. سنتحقَّق إن كانت تلك القيمة مطابقة للقيمة FALSE (مساوية لها ومن ذات نوعها؛ راجع صفحة عوامل المقارنة للمزيد من المعلومات)؛ سيؤدِّي وجود عنصر في المجلَّد يعادل اسمه القيمة FALSE إلى الخروج من حلقة التكرار (مثل وجود مجلّد اسمه "0").

<?php
$d = dir("/etc/php5");
echo "Handle: " . $d->handle . "\n";
echo "Path: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
   echo $entry."\n";
}
$d->close();
?>

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

Handle: Resource id #2
Path: /etc/php5
.
..
apache
cgi
cli

ملاحظات

• يعتمد ترتيب محتويات المجلَّد المعادة باستعمال التابع read على النظام المستعمل.

مصادر

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