php 101 توزيع شيفرات PHP على عدة ملفات

سنشرح في هذا الدرس كيف نوزِّع شيفرات على عدِّة ملفات وكيف نُضمِّن شيفرات من ملفات أخرى. توفِّر PHP أربع دوال لتضمين الشيفرات من الملفات الأخرى:

• include
• include_once
• require
• require_once

الدالة include

تُستعمَل include لتضمين الملفات الخارجية إلى الملف الحالي، حيث تنسخ النص من الملف الخارجي وتلصقه مكان وجودها، وإن حدثت أيّة أخطاء فستتجاوز هذه الدالة عملية تضمين الملف وسيُستكمَل التنفيذ مع إظهار تحذير (warning) دون إظهار خطأ (error). 

على سبيل المثال، لدي ملفان هما tutorials.php و tutorials2.php في نفس المجلد. 

الملف tutorials2.php:

<?php
/**
* this is another class in file tutorial2.php
*/
class Bird
{

  function __construct()
  {
    echo "class Bird included";
  }
}
?>

الملف tutorials.php:

<?php
include 'tutorial2.php';
// كما يُمكن أن نكتبه على النّحو التّالي include('tutorial2.php');
$obj = new Bird();
?>

الناتج:

class Bird included

الدالة include_once

هذه الدالة شبيهة بالدالة include لكن الاختلاف أنها تُضمِّن الملف مرةً واحدةً فقط؛ مثلًا، إن كان لديك ملفُ آخرٌ يُضمِّن كلا الملفين السابقين باستخدام include فسيُضمَّن الصنف Bird مرتين وسينتج عن ذلك خطأ لأنه لا يُسمَح بإعادة تعريف الصنف مرةً أخرى. وهذا الأمر يحدث كثيرًا في المشاريع أو التطبيقات الكبيرة، لذا يكون البديل هو استخدام include_once التي ستُضمِّن tutorial2.php مرةً واحدةً فقط.

الدالة require

تعمل require كعمل include إلا أنها تعطي خطأً (بدلًا من تحذير) عندما يحدث خطأ في تضمين الملف، ويتوقّف البرنامج عن التّنفيذ.

الدالة require_once

وهي تعمل أيضًا بشكلٍ شبيهٍ بالدالة include_once إلا أنها تعطي خطأً بدلًا من تحذير كما في require، ويتوقّف البرنامج أيضًا.

مسار التضمين

كان لدينا في المثال السابق كلا الملفين في نفس المجلد ثم ضمَّنا الملف tutorial2.php مباشرةً، وهذا ما يدعى "بالمسار النسبي"؛ لكن كيف يمكننا أن نضمِّن ملفًا من مجلدٍ آخر؟ يمكننا تمثيل المسار إلى الملف بطريقتين: 

1.  المسارات النسبية 
2. المسارات المطلقة

المسارات المطلقة

وهي مسار الملف بدءًا من مجلد الجذر؛ الذي يكون في لينكس (وغيره من الأنظمة الشبيهة بِيونكس) كالآتي:

include_once( '/var/www/html/findalltogether/tutorial2.php' );

أما في ويندوز، فسيبدأ المسار المطلق بحرف القرص (مثل C:\www\html\tutorial2.php)، لاحظ أنَّ الشرطة المائلة الخلفية (\) هي التي تستعمل في المسارات في ويندوز.

المسارات النسبية

وهي مسار الملف نسبةً إلى الملف الحالي (أي الملف الذي يجري عملية التضمين)؛ حيث يمكن أن يكون الملف في ثلاثة أماكن نسبية: 

1. أن يكون في نفس مجلد الملف الذي يجري عملية التضمين 
2. أن يكون ضمن مجلد في نفس مجلد الملف الذي يجري عملية التضمين 
3. أن يكون المجلد الأب (parent) أو في مجلدٍ موجودٍ في المجلد الأب 

لنتناول شرح كل حالةٍ على حدة: 

• لقد استعملنا مسبقًا الحالة الأولى، ولقد وضعنا اسم الملف مباشرةً إن كان في نفس المجلد 
• 2. أما في الحالة الثانية، فعلينا أن نضيف اسم المجلد؛ فمثلًا إن كان الملف موجودًا في مجلدٍ باسم folder فسيكون سطر التضمين هو:

‎include('folder/tutorial2.php');‎

أما لو كان هنالك أكثر من مجلد فرعي، فسنحتاج إلى كتابة أسمائها أيضًا:

‎include('first/second/third/tutorial2.php');‎

• 3. في الحالة الأخيرة، سنستعمل "‎../‎" (نقطتين ثم خط مائل) كي ننتقل إلى المجلد السابق؛ وبفرض أنَّ الملف الحالي موجودٌ في ‎/var/www/html/tutorials/include/tutorials.php ونريد تضمين الملف ‎/var/www/html/another/tutorial2.php، فسنستعمل:

‎include('../../another/tutorial2.php');‎

لتضمينه، إذ أنَّ ‎../‎ تعني أننا ننتقل إلى الخلف مجلدًا واحدًا فقط.

مجالات الأسماء

في المشاريع الكبيرة، من الممكن (وهذا يحدث عادةً) أن يكون لدينا دالتان أو صنفان لهما نفس الاسم في مكتبتين أو ملفين مختلفين؛ ونحتاج أحيانًا أن نضمن كلا الملفين في نفس الملف، مما يؤدي إلى حدوث خطأ لأنه لا يجوز أن نعيد تعريف دالة أو صنف أكثر من مرة واحدة؛ لذا جاءت مجالات الأسماء (namespaces) للمساعدة في تجنب تلك التضاربات. مجالات الأسماء كالمجلدات، حيث لا نستطيع أن نضع ملفين بنفس الاسم في نفس المجلد، وبالمثل لا نستطيع تعريف دالتين أو صنفين في نفس مجال الأسماء، لكن نستطيع فعل ذلك في مجال أسماءٍ مختلف. 

لنفترض مثلًا أننا نبرمج نظامًا للتسوق، ولدينا دالتَا عرض مختلفتين، واحدة في ملف car.php كي تُظهِر عربة التسوق والأخرى في checkout.php لتظهر معلومات الدفع؛ ونريد تضمين هاتين الدالتين في ملفٍ سينفِّذ الدالة ‎display()‎ من ملف checkout.php إن ضغط المستخدم على زر "checkout"، وسيستدعي الدالة display()‎ من ملف cart.php فيما عدا ذلك. علينا هاهنا أن نستعمل مجالًا للأسماء، حيث سنُعرِّف كل دالة بمجال أسماءٍ مختلف كي لا تظهر أيّة أخطاء عند تضمين كلا الملفين سويةً. 

ملف checkout.php:

<?php
namespace Checkout;
function display()
{
  // code for display function
  echo "dispay in checkout";
}

?>

ملف cart.php:

<?php
namespace Cart;
function display()
{
  //code of dispay function in cart
  echo "display in cart";
}
?>

ملف tutorials.php:

<?php
// including files in different namespace
require 'checkout.php';
require 'cart.php';

// checking condition
if ( $action == "checkout" ) {
  // calling from checkout namespace
  Checkout\display();
} else {
  // calling from cart namespace
  Cart\display();
}
?>

لاحظ ما يلي في الأمثلة السابقة:

• تُنشَأ مجالات الأسماء بكتابة namespace NamespaceName;‎ بعد وسم ‎<?php
• نستطيع استدعاء الدوال والأصناف من مجالات أسماء معيّنة بكتابة NamespaceName\functionName()‎ و NamespaceName\classname‎ على التوالي وبالترتيب

مجالات الأسماء الفرعية والكلمة المفتاحية use

يمكننا تعريف مجال فرعي كما لو كنا ننشِئ مجلدًا فرعيًا، الشكل العام لتعريفه هو

‎namespace NamespaceName/subNamespaceName/anotherSubNamespace;‎

وطريقة استعمال مجالات الأسماء الفرعية مماثلة تمامًا لاستعمال مجالات الأسماء العادية؛ وعندما يكون المشروع كبيرًا ويحتوي الكثير من مجالات الأسماء الفرعية، فسيصبح من المزعج أن نكتب نفس الاسم مرارًا وتكرارًا، لذا توفِّر لغة PHP الكلمة المحجوزة «use» لهذا الغرض، إذ تُسنِد use اسم مجال الأسماء الفرعي بأكمله إلى اسمٍ ذي كلمةٍ وحيدة.

use longNamespaceName as shortName;

يمكنك بعد ذلك أن تستعمل الاسم القصير لمجال الأسماء بدلًا من كتابة كل الاسم، يدعى الاسم القصير بالاسم البديل (alias).

<?php
require "checkout.php";
// نعرف اسمًا أقصر للاسم الأطول
use Namespace\SubNamespace\FrontEnd\Checkout as NewCheckout;
NewCheckout\display();
? >

التحميل التلقائي للأصناف

العديد من المبرمجين الذين يكتبون برامج كائنية التوجه يُنشئون ملفًا لكل صنف، ومن أكثر الأشياء التي تزعجهم هي كتابة قائمة طويلة من الملفات التي يجب تضمينها في بداية كل ملف. 

لم يعد ذلك ضروريًا في PHP 5، فأصبحت هنالك طريقة لتضيمن الأصناف تلقائيًا عند الحاجة إليها. 

يمكننا استعمال التحميل التلقائي للأصناف عبر الدالةspl_autoload_register()‎، وهذه الدالة مرنة جدًا، وتسمح باستخدام أكثر من محمل تلقائي (autoloader)، هذا مثالٌ عن استخدامها:

<?php
spl_autoload_register(function ($class_name) {
    include $class_name.'.php';
});

$obj  = new MyClass1();
$obj2 = new MyClass2(); 
?>

تقبل دالة spl_autoload_register وسيطًا هو الدالة التي ستضمن ملفات الأصناف، فإما أن تُعرِّف الدالة ثم تمرر اسمها إلى دالة spl_autoload_register، أو أن تعرف دالة مجهولة مباشرةً داخل الدالة spl_autoload_register كما في المثال السابق. مثالٌ عن الحالة الأولى:

<?php
function my_autoloader($class_name) {
        include $class_name.'.php';
}

spl_autoload_register('my_autoloader');
?>

في هذه الحالة ولدى محاولة استخدام صنف غير مُعرّف في نفس الملف مثل: 

$car = new Car; 

سيقوم PHP بمحاولة تحميل الملف Car.php (يبحث في المُجلّد الحالي) وإن وجده يقوم بإنشاء مُتغير جديد من صنف Car.

التحميل التلقائي في Composer

شاع استعمل Composer لإدارة حزم المكتبات البرمجية في PHP، إن أردت الاطلاع على المزيد من المعلومات حوله، فانظر إلى مقالة ما هو Composer ولماذا يجب على كل مطور PHP استخدامه. 

يُنشِئ Composer الملف vendors/autoloader.php الذي يتيح تضمين المكتبات الضرورية لعمل مشروعك تلقائيًا دون الحاجة إلى فعل ذلك يدويًا، وذلك عبر تضمين ذاك الملف في شيفرات PHP:

<?php
require_once "vendors/autoloader.php";

أسهل طريقة هي تحديد كل صنف على حدة، وسنُعرِّف لهذا الغرض مصفوفةً تحتوي على مسارات الملفات التي نريد تحميلها تلقائيًا في ملف composer.json، ربما تستفيد من هذه الطريقة في تضمين الملفات التي تحوي دوال PHP التي لا يمكن تحميلها تلقائيًا:

{
    "autoload": {
        "files": ["src/MyLibrary/functions.php"]
    }
}

أو عبر PSR-4، التي تسمح لك بربط مجالات الأسماء إلى مسارات نسبية (relative paths) لجذر الحزمة، فعند التحميل التلقائي لصنف مثل Foo\\Bar\\Abz، فإن سابقة (prefix) مجال الأسماء Foo\\‎ التي تشير إلى المجلد src/‎ تعني أن آلية التحميل التلقائي ستبحث عن ملف باسم src/Bar/Baz.php وتضمِّنه إن كان موجودًا:

{
    "autoload": {
        "psr-4": {
            "Monolog\\": "src/",
            "Vendor\\Namespace\\": ""
        }
    }
}

ولو أردت أن تبحث عن نفس السابقة في أكثر من مجلد، فعليك تحديد تلك المجلدات في مصفوفة كالآتي:

{
    "autoload": {
        "psr-4": { "Monolog\\": ["src/", "lib/"] }
    }
}

وتستطيع توفير مجلد افتراضي إن لم يُعرَّف مجال الأسماء للصنف الذي يراد تحميله تلقائيًا، وذلك بترك مكان السابقة فارغًا:

{
    "autoload": {
        "psr-4": { "": "src/" }
    }
}

المصادر

• مقال Distribute code in files in PHP لصاحبه Harish Kumar
• توثيق Composer
• صفحات include و require و Autoloading Classes و spl_autoload_register و ‎‎__autoload