الدالة basename() في PHP
(PHP 4 >= 4.0.3, PHP 5, PHP 7)
تعيد الدالة basename() اسم الملف أو المجلَّد الأساسي (basename) بعد تمرير مساره إليها.
الوصف
string basename ( string $path [, string $suffix ] )
تعيد هذه الدالة اسم الملف أو المجلد للسلسلة النصيَّة path التي تمثِّل مسار ذلك الملف أو المجلَّد؛ بعبارة أخرى، تستخلص هذه الدالة اسم العنصر الأساسي من مساره المُعطى.
ملاحظة: تُعامِل الدالة basename() السلسلة النصيَّة الممرَّرة إليها بكلِّ بساطةٍ إذ لا تميِّز حقيقةً نوع نظام الملفات المستعمل أو بعض عناصر المسار مثل "..".
تنبيه: تأخذ الدالة basename() المحليَّة (locale) بالحسبان، لذا إن أردت الحصول على الاسم الأساسي الصحيح من مسارات ذات محارف متعدِّدة البايتات (multibyte character paths)، فيجب أن تتطابق المحليَّة وذلك عبر ضبطها باستعمال الدالة setlocale().
المعاملات
path
المسار الذي ستُجرى عليه العمليَّة.
يُستعمَل الخط المائل (/) والخط المائل الخلفي (\) كمحارف فصل (أي تفصل بين أسماء المجلدات) ضمن المسار في بيئة ويندوز. أمَّا في البيئات الأخرى كأنظمة يونكس، فيُستعمَل الخط المائل (/).
suffix
إن انتهى اسم العنصر بلاحقة (suffix) معيَّنة، فإنَّ تحديد هذه اللاحقة سيُؤدي إلى إزالتها من الاسم المُعاد.
القيم المعادة
يُعاد الاسم الأساسي للعنصر ذي المسار path المعطى.
أمثلة
المثال 1: استعمال الدالة basename()
<?php
echo "1) ".basename("/etc/sudoers.d", ".d").PHP_EOL;
echo "2) ".basename("/etc/sudoers.d").PHP_EOL;
echo "3) ".basename("/etc/passwd").PHP_EOL;
echo "4) ".basename("/etc/").PHP_EOL;
echo "5) ".basename(".").PHP_EOL;
echo "6) ".basename("/");
?>
سيُظهر المثال السابق النتيجة التالية:
1) sudoers
2) sudoers.d
3) passwd
4) etc
5) .
6)
انظر أيضًا
- الدالة
dirname(): تعيد مسار المجلد الأب. - الدالة
pathinfo(): تعيد معلومات حول مسار ما.