تعليقات PHP، تضمين/تضمين_مرة، تتطلب/تطلب_مرة واحدة

⚡ ملخص ذكي

تُعدّ التعليقات، وعبارات include و include_once و require و require_once أدوات أساسية في لغة PHP لتوثيق التعليمات البرمجية وإعادة استخدام الملفات. يشرح هذا الدليل كيفية عمل التعليقات أحادية السطر ومتعددة الأسطر، وكيف تتشارك عبارات تضمين الملفات الأربعة في العناوين والقوائم والإعدادات عبر صفحات متعددة.

  • 📝 لماذا التعليق؟ تسجل التعليقات ما يفعله الكود حتى تتمكن أنت والمطورون الآخرون من فهمه لاحقًا؛ حاول أن تجعل عدد أسطر التعليقات حوالي ثلاثة أسطر لكل عشرة أسطر من الكود.
  • ✏️ صيغة التعليق: تبدأ التعليقات ذات السطر الواحد بـ // وتنتهي عند فاصل السطر، بينما تقع التعليقات متعددة الأسطر بين /* و */.
  • 📄 تضمين البيان: تقوم الدالتان include و include_once بسحب ملف آخر إلى البرنامج النصي الحالي، وهما مثاليتان للرؤوس المشتركة وقوائم التنقل.
  • 🔒 بيان المتطلبات: تعمل وظيفة require و require_once مثل وظيفة include ولكنها توقف البرنامج النصي عند الفشل، وهو ما يناسب الملفات الأساسية مثل تكوين قاعدة البيانات.
  • 🔁 المتغيرات _ذات مرة واحدة: تقوم الدالتان include_once و require_once بتجاوز ملف تم تحميله بالفعل، مما يمنع التصريحات المكررة وأخطاء إعادة التعريف.
  • 🇧🇷 تضمين مقابل اشتراط: يُصدر الأمر include تحذيراً فقط ويستمر في حالة وجود ملف مفقود، بينما يُصدر الأمر require خطأً فادحاً ويوقف التنفيذ.
  • 🤖 مساعدة الذكاء الاصطناعي: يمكن لأدوات الذكاء الاصطناعي إنشاء تعليقات PHPDoc، وتقديم المشورة بشأن متى يكون تضمين الملف أو طلبه هو الخيار الأكثر أمانًا.

التعليقات في لغة PHP، وعبارات التضمين والطلب

لماذا استخدام التعليقات؟

  • إذا لم تعمل على الكود المصدري لفترة من الوقت، فمن السهل أن تنسى وظيفته. لذا، فإن إضافة التعليقات إلى الكود المصدري تساعدك على تذكر وظيفته.
  • يعد التعليق على كود المصدر أمرًا مهمًا أيضًا عندما يتعين على العديد من المطورين العمل في نفس المشروع. يمكن للمطورين الآخرين فهم التغييرات التي أجراها أحد المطورين بسهولة بمجرد قراءة التعليقات.
  • كأفضل ممارسة، يجب أن يكون لديك 3 أسطر من التعليقات لكل 10 أسطر من التعليمات البرمجية.

تعليقات PHP

  • تساعدنا التعليقات على فهم الكود
  • التعليقات هي تفسيرات ندرجها في كود المصدر الخاص بنا. هذه التعليقات هي لفهم الإنسان.
  • تبدأ التعليقات المكونة من سطر واحد بشرطتين مائلتين للأمام // وتنتهي في نفس السطر.
  • تعليقات PHP
  • تبدأ تعليقات الأسطر المتعددة بشرطة مائلة للأمام متبوعة بالعلامة النجمية /* وتنتهي بعلامة النجمة متبوعة بالشرطة المائلة للأمام */.
  • تعليقات PHP

يوضح الرسم البياني أدناه ملف PHP يحتوي على تعليقات متعددة الأسطر وتعليقات من سطر واحد.

مثال PHP

مثال تعليقات PHP

PHP تضمين وPHP Include_once

تُستخدم عبارة "include" في لغة PHP لإدراج ملفات أخرى في ملف PHP.

يوجد نوعان منه، include و include_once. يتجاهل مترجم PHP النوع include_once إذا كان الملف المراد تضمينه قد تم تضمينه بالفعل.

تحتوي عبارة التضمين على بناء الجملة التالي

<?php
include 'file_name';
?>

تحتوي عبارة include_once على بناء الجملة التالي

<?php
include_once 'file_name';
?>

هنا،

  • "include/include_once" هو البيان الذي يتضمن الملف
  • "'file_name'" هو اسم الملف المراد تضمينه.

مثال: تضمين / تضمين مرة واحدة

لنفترض أنك تقوم بتطويرping موقع إلكتروني يحتوي على قائمة تنقل واحدة في جميع صفحاته.

يمكنك إنشاء رأس مشترك، ثم تضمينه في كل صفحة باستخدام عبارة التضمين. دعونا نرى كيف يمكن القيام بذلك.

  • سنقوم بإنشاء ملفين باسم
  • header.php، وindex.php

فيما يلي رمز header.php على

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

ستعرض الصفحة الرئيسية أعلاه روابط التنقل.

PHP يتطلب و PHP require_once

تحتوي عبارة "الطلب" على شكلين مختلفين، "يتطلب" و"يتطلب_مرة".

تُستخدم عبارة require/require_once لتضمين ملف.

يتم تجاهل require_once إذا تمت إضافة الملف المطلوب بالفعل بواسطة أي من عبارات التضمين الأربعة.

يحتوي على بناء الجملة التالي

<?php
require 'file_name';
?>
<?php
require_once 'file_name';
?>

هنا،

  • "require/require_once" هو البيان الذي يتضمن الملف
  • "'file_name'" هو اسم الملف المراد تضمينه.

مثال: يتطلب

لنفترض أننا نقوم بتطويرping تطبيق يعتمد على قاعدة بيانات.

يمكننا إنشاء ملف تكوين يمكننا تضمينه في جميع الصفحات التي تتصل بقاعدة البيانات باستخدام بيان الطلب. التكوين.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

لنلقِ نظرة الآن على نموذج التعليمات البرمجية الذي يتطلب ملف التكوين. Pages_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP تشمل مقابل تتطلب

يظهر أدناه الفرق بين include و require.

تضمن تطلب
يصدر تحذيرًا عند حدوث خطأ يُصدر خطأً فادحاً
يستمر تنفيذ البرنامج النصي عند حدوث خطأ يتوقف تنفيذ البرنامج النصي عند حدوث خطأ.

بشكل عام، يوصى باستخدام عبارة التضمين بحيث عند حدوث خطأ، يستمر تنفيذ البرنامج النصي في عرض عنوان البريد الإلكتروني لمدير الموقع أو صفحة اتصل بنا.

يجب استخدام العبارة المطلوبة إذا كان البرنامج النصي بأكمله لا يمكن تشغيله بدون الملف المطلوب.

يمكن استخدام عبارات "include" و "require" في أي سطر في شفرة المصدر حيث تريد أن تظهر الشفرة.

تعليقات توثيق PHP (PHPDoc)

إلى جانب التعليقات أحادية ومتعددة الأسطر، يستخدم مطورو PHP تعليقات PHPDoc لتوثيق الدوال والفئات. تبدأ كتلة PHPDoc بـ /** وتستخدم وسومًا مثل @param و@return التي تقرأها بيئات التطوير المتكاملة (IDEs) لعرض التلميحات والإكمال التلقائي.

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

لا يُغيّر PHPDoc طريقة عمل الكود، ولكنه يُوضّح الغرض من كل دالة ويُمكّن الأدوات من إنشاء توثيق واجهة برمجة التطبيقات (API) تلقائيًا. يُساعد إضافته إلى الملفات المشتركة، مثل ملفات الإعدادات والمساعدات المذكورة أعلاه، في الحفاظ على سهولة صيانة قاعدة الكود المتنامية.

الأسئلة الشائعة

كلاهما يقوم بتحميل الملف مرة واحدة فقط، حتى لو تم استدعاؤه مرة أخرى. الفرق يكمن في معالجة الأخطاء: يُصدر include_once تحذيرًا ويسمح للبرنامج النصي بالاستمرار، بينما يُصدر require_once خطأً فادحًا ويوقف التنفيذ إذا كان الملف مفقودًا.

يُسمح بذلك فقط في حال تفعيل خيار allow_url_include في ملف php.ini، وهو مُعطّل افتراضيًا لأسباب أمنية. يُعدّ تضمين الملفات البعيدة أمرًا محفوفًا بالمخاطر، إذ يُمكن للمهاجم حقن شيفرة برمجية، لذا يُفضّل بشدة استخدام مسارات الملفات المحلية.

لا، يقوم المفسر على الخادم بإزالة تعليقات PHP، لذا فهي لا تصل إلى المتصفح ولا تظهر في مصدر الصفحة. وبالتالي، فإن تأثيرها على الأداء يكاد يكون معدوماً.

نعم. عند إعطاء دالة، يمكن للذكاء الاصطناعي إنشاء كتلة PHPDoc مع ملخص بالإضافة إلى علامات @param و @return. Revراجع الأوصاف بحيث تتطابق مع نيتك، لأن الذكاء الاصطناعي يستنتج المعنى من الأسماء والرموز.

نعم. يمكن للذكاء الاصطناعي مراجعة كل إضافة والتوصية بضرورة تضمين الملفات الأساسية، مثل ملفات التكوين، وتضمين الملفات الاختيارية، مثل الشريط الجانبي الإضافي، مع شرح سلوك الفشل لكل منها.

تلخيص هذه التدوينة بـ: