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

من موسوعة حسوب
< PHP

(PHP 4, PHP 5, PHP 7)

تتحقَّق الدالة is_dir()‎ إن كان مسار الملف أو المجلَّد المُمرَّر إليها مجلَّدًا أم لا.

الوصف

bool is_dir ( string $filename )

تتحقَّق هذه الدالة فيما إذا كان الملف filename هو مجلَّد.

المعاملات

filename

مسار الملف المراد التحقُّق منه. إن كان المعامل filename مسارًا نسبيًّا، فسيُتحقَّق منه نسبةً إلى مجلَّد العمل الحالي. إن كان المعامل filename وصلةً رمزيَّة أو صلبة، فسيُستبين المسار الذي تُشير إليه تلك الوصلة حينئذٍ ويُتحقَّق منه. إن كان الوضع الآمن أو  الخيار open_basedir مفعَّلًا، فستُطبَّق قيود إضافيَّة.

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

تُعاد القيمة TRUE إن كان الملف filename موجودًا ونوعه مجلَّد، أو تُعاد القيمة FALSE خلاف ذلك أو عند وجود خطأ.

أمثلة

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

<?php
var_dump(is_dir('a_file.txt'));
var_dump(is_dir('bogus_dir/abc'));

var_dump(is_dir('..')); //المجلد السابق للمجلد الحالي
?>

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

bool(false)
bool(false)
bool(true)

الأخطاء والاستثناءات

سيُصدر تحذير من المستوى E_WARNING عند فشل العمليَّة.

ملاحظات

  • ستُخزَّن نتيجة هذه الدالة. راجع الدالة clearstatcache()‎ للمزيد من التفاصيل.
  • يمكن أن تُستعمل هذه الدالة بدءًا من إصدار PHP 5.0.0 مع بعض بروتوكلات الروابط (URL wrappers).

انظر أيضًا

  • الدالة chdir()‎: تغيِّر مجلَّد PHP الحالي إلى مجلَّد آخر معطى.
  • الدالة dir()‎: تعيد نسخةً (instance) من الصنف Directory.
  • الدالة opendir()‎: تفتح مجلَّدًا محدَّدًا.
  • الدالة is_link()‎: تتحقَّق إن كان الملف وصلة رمزية.
  • الدالة is_file()‎: تتحقَّق إن كان الملف هو ملفٌّ عاديٌّ.

مصادر