Разработка:Стандарт кодирования

Правила оформления кода в проекте «Электронный деканат».

Стиль кодирования

Формат файлов

1. Все файлы с кодом должны иметь расширение .php
2. Все html-шаблоны должны иметь расширение .html
3. Весь текст, включая исходный код, должен быть в кодировке utf-8 с оконачаниями строк в формет Unix
4. Окончания строк в формате Unix (LF - 0x0A)
5. Все php-теги должны быть полными <?php ... ?>. Краткие теки <? ?> не допускаются
6. Все отступы – 4 пробела. Не использовать TAB.
7. Длинна строки в коде не должна быть больше 80 символов. В некоторых случаях допускается 120, если это упростит читаемость кода.
8. Пробелы можно использовать свободно. Не надо бояться растягивать код для улучшения читабельности.

Имена

1. Имена файлов должны состоять только из латинских символов, знака подчеркивания и точки. Имя файла обязательно должно иметь расширение. Рекомендуется использовать для именования файлов слова на английском языке.
2. Имена классов должны состоять из строчных латинских символов и знака подчеркивания. Рекомендуется использовать английские слова разделенных символом подчеркивания. Имя класса в плагине должно начинаться с префикса, соответствующего плагину. Если требуется, имя класса может включать преффикс и суффикс.
3. Имена функций и методов должны состоять из строчных латинских символов и знака подчеркивания. Имя функции в плагине должно начинаться с префикса, соответствующего имени модуля (dof_) и плагину, в котором объявлена (типплагина_кодплагина). Затем идет часть имени, описывающая выполняемое действие. Последняя часть - это существительное, обозначающее сущность, над которой это действие производится либо набор сущностей. Не должно быть пробелов между именем функции и скобками. Это относится и к объявлению функции, и к ее использованию. Параметры всегда должны иметь разумные значения по умолчанию, если это возможно. Пример: modname_get_string($identifier, $pluginname = NULL). Между ключевым словом function и именем функции должен быть только один пробел.
4. Имена параметров функций именуются по тем же правилам, что и переменные. Имя параметра должно быть кратким и информативным для сторонних программистов. Если параметр может быть не задан, используйте по умолчанию значение null, для отличия этой ситуации от передачи параметра false, 0 или если это требуется).
5. Имена переменных - всегда легкие для чтения осмысленные слова английского языка, набранные в нижнем регистре. Несколько слов пишутся слитно. Но они должны быть как можно короче. Используйте имена во множественном числе для массивов объектов. Например: $courseid, $studentsgrades
6. Имена глобальных переменных, должны состоять полностью из заглавных букв. Пример: $CFG
7. Имена констант должны состоять из латинских символов в верхнем регистре и знака подчеркивания. Всегда начинаются с имени модуля (DOF). Если константа объявлена в плагине, она получает дополнительный префикс ТИППЛАГИНА_КОДПЛАГИНА. Слова в названии разделены символом подчеркивания. Пример: SITE_ID
8. true, false и null должны быть набраны в нижнем регистре
9. AND, OR, XOR должны быть набраны в верхнем регистре, не используйте сокращенные синонимы.

Строки

1. Используйте одинарные кавычки, если в строке отсутствуют макроподстановки и эскейп-последовательности, а так же если в строке присутствует много двойных кавычек.
2. При макроподстановках в двойных кавычках заключайте переменные в фигурные скобки.
3. Объединение строк выполняется через оператор "точка" (.)

Массивы

1. Не используйте отрицательных чисел для нумерации массивов (кроме случаев, когда это прямо требуется логикой программы).
2. Индексация массива может начинаться с любого положительного числа, обычно с 0.
3. При объявлении массива через функцию array() ставьте пробел после запятой при перечислении параметров. Длинные объявления можно переносить по строкам. При объявлении ассоциативных массивов помещайте на одну строку одну пару ключ-значение.

Классы

1. Свойства класса должны объявляться до его методов.
2. Фигурная скобка пишется на следующей строчке после объявления имени класса, на одном уровне с ключевым словом class.
3. Объявление любого класса должно быть документировано по стандарту PHPDocumentor
4. Весь код внутри класса должен быть сдвинут на 4 пробела от уровня его объявления.
5. Объявление класса должно быть отделено от остального коду двумя пустыми строками.
6. Свойства класса должны объявляться напрямую при объявлении класса с указанием модификатора доступа (private (доступ извне запрещен), protected (разрешен доступ из наследников) или public)

Функции и методы

1. Объявление функций и методов должно сопровождаться комментарием по стандарту PHPDocumentor
2. Все объявления методов должны содержать модификатор доступа (private (доступ извне запрещен), protected (разрешен доступ из наследников) или public)
3. Фигурная скобка должна располагаться на следующей строке после объявления имени функции или метода на одном с ним уровнем.
4. Тело функции должно быть сдвинуто на 4 пробела влево.
5. Между именем функции и круглой скобкой не должно быть пробела.
6. Если функция не возвращает значений, то true обозначает успех, false - не успех. Если функция возвращает массив, в случае успешного выполнения, но отсутствия элементов в результате, функция должна возвращать пустой массив.

Управляющие конструкции

Ставьте один пробел между скобками и синтаксическими конструкциями. Это не относится к функциям и их параметрам. Пример:

   if ( $a >= max($key) )
   {
   
   ···· $c = $a;
   
   }

Блоки всегда ограничиваются фигурными скобками. При этом используется стиль Олмана:

   if (<cond>)
   {
   ····<body>
   }

Комментарии и документация

1. Комментарии должны быть подробными и содержательными. Объяснять каждое объявление классов, функций и переменных. Каждый цикл и каждая ветвь условия должны быть пояснены содержательным смыслом выполняемых действий, например: "перебираем список товаров", "если пользователь не заполнил поле имя..."
2. Комментарии к функциям и классам оформляются в формате PHPDoc
3. Комментарии в строках должны быть в стиле //. Они должны быть понятными и располагаться над строкой комментируемого кода.
4. Файлы, содержащие PHP-код должны начинаться с комментария, предусмотренного лицензией GNU GPL.

Дата и время

1. Все даты и время в базе данных хранятся в Unix Timestamp по UTC без учета летнего времени и пересчитываются в местное время при отображении.
2. Если определена только дата, то время устанавливается 12:00 по полудню на UTC.

Исключения

1. Рекомендуется использование исключений для сообщения об ошибках.
2. Любые необработанные исключения должны заканчиваться вызовом $DOF->print_error() для вывода сообщения об ошибке.
3. Не используйте исключения для обработки штатных ситуаций, только в ошибочных и аварийных ситуаций.
4. Для вывода исключений можно использовать следующие классы:
   1. dof_exception - базовый класс исключения
   2. dof_exception_coding - ошибка разработчика
   3. dof_exception_db - ошибка обращения к СУБД
   4. dof_exception_file - ошибка работы с файлами

Прочее

1. При копировании объектов используйте PHP5-функцию копирования объектов. В MOODLE есть функция clone(), которая совместима и с PHP4 тоже.
2. Если вы копируете переменную, которая может содержать объект, то используйте функцию MOODLE fullclone().
3. Все переменные перед первым использованием необходимо инициализировать.
4. Имя модуля может включать только строчные латинские буквы и содержать не более 20 символов.
5. Следует избегать использования глобальных переменных.
6. Обращения к объектом Free Dean's Office выполняется через объект $DOF. При объявлении плагина он должен сохранить ссылка на объект $DOF в собственном свойстве dof и во всех собственных методов использовать для обращения $this->dof
7. Не должно быть никакого SQL-кода за пределом справочников (плагинов storage)
8. Кроме плагинов im никакие другие плагины не должны принимать запросы по http. Исключение могут составлять плагины sync, которые могут принимать входящие soap-запросы и т.п. (но и они не должны реализовывать веб-интерфейс). При этом все плагины должны быть безопасны на случай, если злоумышленик попытается обратиться по прямой ссылке к одному из их файлов (следует предотвращать запуск файла по прямой ссылке, если это может нанести урон безопасности).

Исключения из правил

1. При использовании сторонних библиотек возможно отступление от некоторых пунктов. Это связано с экономией времени на переработку оформления библиотеки и сохранением стиля сопутствующего кода. Пример: class SomeCustomClass {function classMethod(){...}}

Структура базы данных

1. Имена таблиц, принадлежащих справочникам, должны начинаться с префикса "block_dof_s_кодсправочника"
2. Имена колонок БД, содержащих ключ по другой колонке в БД Free Dean's Office должны заканчиваться на "id"
3. Имена колонок в БД, содержащих ключ объекта в собственной БД Moodle должны начинаться на "mdl" (но не должны заканчиваться на "id")

Безопасность

1. Все переменные должны содержать только безопасные данные (текстовые строки должны быть обработаны addslashes()). При получении данных через optional_param(), require_param(), dof_modlib_widgets_form (moodleform), а так же через стандартные методы справочников - все данные передаются в уже обработанном виде. При отображении данных на веб-странице и прочих операциях, где строки не должны быть экранированы, программист должен самостоятельно обработать данные stripslashes() непосредственно перед операцией, далее эти данные в программе использоваться не должны, либо их необходимо преобразовать обратно. Во всех остальных случаях, включая задание текстовых констант непосредственно в коде программы, программист обязан позаботится о безопасности данных (addslashes()).

Работа со стандартными библиотеками moodle

Этот раздел будет содержать справку по работе со стандартными пакетами moodle