مُجمّل كود PHP

ماذا يعني التجميل هنا

يغيّر المُجمّل التخطيط فقط. يجب أن يفعل الكود الشيء نفسه قبل التنسيق وبعده. تطبّق هذه الأداة قائمة قصيرة من قواعد التخطيط:

• تنتهي كل فاصلة منقوطة عند سطر.
• يبدأ كل قوس فاتح في سطره الخاص، وكذلك كل قوس مغلق.
• يُزاح الكود داخل الأقواس مستوى واحدًا لكل عمق تداخل.
• تُتبع كل فاصلة بمسافة واحدة.
• تُحذف الأسطر الفارغة في الناتج.

لا تضيف مسافات حول العوامل، ولا تعيد تسمية أي شيء، ولا تعيد ترتيب الكود.

مثال قبل وبعد

الإدخال:

<?php class User{private $name;public function getName(){return $this->name;}}

الناتج مع 4 مسافات:

<?php class User
{
    private $name;
    public function getName()
    {
        return $this->name;
    }
}

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

متى تستخدم أداة أخرى

تتعامل الأداة مع الأقواس والفواصل المنقوطة كأحرف عادية. إنها لا تحلل PHP، لذلك لا تستطيع اتباع دليل أسلوب مشروع أو تقسيم الأسطر الطويلة أو تصحيح المسافات حول العوامل مثل = و+. التعليقات ووثائق heredoc وحلقات for (;;) قد تخرج بشكل خاطئ، لأن الفاصلة المنقوطة داخلها تُعامل كأي فاصلة منقوطة أخرى. لقاعدة كود كاملة، شغّل أداة إصلاح مضبوطة في محرّرك أو في خط البناء، واحتفظ بهذه الصفحة للتنظيفات السريعة لمرة واحدة.

تجميل دالة فيها حلقة

الإدخال المضغوط:

function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

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

اختيار 2 أو 4 مسافات

تُعد 4 مسافات العرض الشائع في كود PHP وأسهلها في القراءة. اختر 2 عندما يكون الكود متداخلًا بعمق أو عندما يكون المكان الذي ستلصق فيه ضيقًا، مثل رسالة محادثة. يغيّر الإعداد الإزاحة فقط، ولا يغيّر أبدًا مواضع كسر الأسطر.

تحقق من النتيجة

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