أسلوب الترميز

أسلوب الترميز
مقدمة أساسية لأسلوب ترميز Osclass
أسلوب الترميز
يستند هذا الدليل الصغير جزئيًا إلى دليل أسلوب الترميز الخاص بـ Zend Framework: http://framework.zend.com/manual/1.12/en/coding-standard.coding-style.html

ترسيم كود PHP
يجب دائمًا تحديد كود PHP بعلامات PHP القياسية كاملة النموذج:

?>

المتغيرات
يجب أن تتبع المتغيرات الترميز المجري (https://en.wikipedia.org/wiki/Hungarian_notation) ، وهذا يعني أنها يجب أن تبدأ بحرف يشير إلى نوع المتغير ، على سبيل المثال i للعدد الصحيح ، و a للمصفوفات ، و o للكائنات ، s للسلاسل ... أيضًا ، يجب أن يكون كل حرف أول من الكلمة كبيرًا.

$iThisIsAnInteger = 42;
$sSomeText = 'This is some text';
$aVariable = array(1, 2, 3, 4 , 5);
...

ملاحظة: يجب أن تتبع أسماء أعمدة SQL تدوينًا مشابهًا ، ولكن يجب أن يتبع الحرف الأول شرطة سفلية. يتم فصل الكلمات بشرطة سفلية ، وكلها بأحرف صغيرة. إذا كان العمود هو مفتاح أساسي ، فيجب أن يسبقه "pk_" إذا كان مفتاحًا خارجيًا بـ "fk_"

i_integer_variable
s_some_text
dt_registration_date
pk_i_id // this is a primary key
fk_i_category_id // this is a foreign key
...

الطبقات
إعلان الفصل
يجب دائمًا كتابة الدعامة على السطر الموجود أسفل اسم الفئة.
يجب أن تحتوي كل فئة على كتلة توثيق تتوافق مع معيار PHPDocumentor. فيما يلي مثال على إعلان صنف مقبول:

/**
* Documentation Block Here
*/
class Foo
{
/**
* Documentation Block Here
*/
public function bar()
{
// all contents of function
// must be indented four spaces
}
}

بيانات التحكم
إذا / آخر / السيف
يجب أن تحتوي عبارات التحكم المبنية على بنيات if و elseif على مسافة واحدة قبل قوس الفتح للشروط ومسافة واحدة بعد قوس الإغلاق.
تم كتابة قوس الافتتاح على نفس السطر مثل العبارة الشرطية.
يتم دائمًا كتابة قوس الإغلاق على سطر خاص به. يجب وضع مسافة بادئة لأي محتوى داخل الأقواس باستخدام أربع مسافات.

if ($a != 2) {
$a = 2;
} else {
$a = 7;
}

if ($a != 2) {
$a = 2;
} elseif ($a == 3) {
$a = 4;
} else {
$a = 7;
}

مطلوب دائمًا وضع الأقواس.
العبارات التالية إذا كانت غير صحيحة

if($a != 2)
$a = 2;

يحول
يجب أن تحتوي عبارات التحكم المكتوبة بعبارة "switch" على مسافة واحدة قبل قوس فتح العبارة الشرطية وبعد قوس الإغلاق.
يجب وضع مسافة بادئة لجميع المحتويات داخل عبارة "switch" باستخدام أربع مسافات. يجب وضع مسافة بادئة للمحتوى الموجود أسفل كل عبارة "حالة" باستخدام أربع مسافات إضافية.

switch ($numPeople) {
case 1:
break;

case 2:
break;

default:
break;
}

يجب عدم حذف الإعداد الافتراضي للبناء من تعليمة التبديل.
تنسيق الوثائق
يجب أن تكون جميع كتل التوثيق ("docblocks") متوافقة مع تنسيق phpDocumentor. إن وصف تنسيق phpDocumentor خارج نطاق هذا المستند. لمزيد من المعلومات ، قم بزيارة: »http://phpdoc.org/
معلومات اكثر
يستند هذا الدليل الصغير جزئيًا إلى دليل أسلوب الترميز الخاص بـ Zend Framework: http://framework.zend.com/manual/1.12/en/coding-standard.coding-style.html