Урок - Создание модуля в Drupal 6

Главная » Курсы » Курс Drupal 6, Разработка модулей. » Урок - Создание модуля в Drupal 6

Обучающий онлайн курс
Drupal 6, Разработка модулей.

Лицензия: Копирование запрещено.

Создание модуля

Первое, что нужно выбрать это название модуля. Для условности будем называть наш модуль ramech, хотя вы можете выбрать любое название.

Желательно выбирать название из одного слова - это позволит легче использовать название модуля в названиях функций. Чтобы избежать одинакового названия в модулях - используйте свой личный префикс. Например: ddforum, s3forum.

Начнем.

  1. Переходим в директорию ./sites/all/modules/ (путь указан относительно корня сайта)
  2. Создаем директорию ramech (./sites/all/modules/ramech) - в этой директории будем хранить скрипты и дополнительные файлы нашего модуля.
  3. Переходим в директорию ramech (./sites/all/modules/ramech).
  4. Создаем файл описания модуля *.info. В нашем примере это файл ramech.info (./sites/all/modules/ramech/ramech.info). Файлы модулей *.info являются текстовыми файлами - хранят основную информацию о модуле (название, описание, версия, ...).

    Добавьте в файл следующее содержимое:

    ; $Id:  $
    name = Ramech
    description = Simple module
    package = Ramech group
    core = 6.x
    version = 6.x-1.0
    Все файлы необходимо сохранять, в кодировке UTF-8 без BOM, желательно применять unix-овый формат конца строки.

    Давайте рассмотрим подробнее описаниея модуля:

    • ; $Id: $ - закомментированная строка, используется СVS сервером сайта drupal.org для автоматической идентификации вашего проекта, если вы решите его добавить на сайт drupal.org. Для нас пока не имеет важного значения.
    • name = Ramech - таким обрахом указываем название модуля. Название модуля отображается на странице "Модули/Modules" (admin/build/modules).
    • description = Simple module - указываем описание модуля, отображается на странице "Модули/Modules" (admin/build/modules). Желательно использовать латиницу.
    • package = Ramech group - Группа в которую будет помещен модуль на странице "Модули/Modules" (admin/build/modules).
    • core = 6.x - Версия Drupal для которой разработан модуль. Для версии Drupal 6 указываем "6.x"
    • version = 6.x-1.0 - Версия модуля. Наша "внутрення" версия модуля.
    Этих шагов достаточно, чтобы Drupal 6 опознал наш модуль. Зайдите на страницу "Модули/Modules" (admin/build/modules) и найдите созданный модуль в списке модулей.
  5. Пока наш модуль ничего не делает - переходим к созданию основного файла модуля - файла *.module, для нашего примера это файл ramech.module. Создайте файл ramech.module в директории модуля (./sites/all/modules/ramech/ramech.module). Файлы модуля *.module по сути являются PHP-файлами.

    Добавьте в файл следующее содержимое:

    <?php
    // $Id$
    /**
     * @file
     * Тестовый модуль
     *
     * Тестовый модуль для обучения.
     */

    Теперь подробности...

    • // $Id$ - закомментированная строка, используется СVS сервером сайта drupal.org для автоматической идентификации вашего модуля(проекта), если вы решите добавить модуль на сайт drupal.org.
    • /** .. */ - это специальный вид комментария. Текст расположенный в таком комментарии может быть извлечен для составления документаций. Для подробности изучите материалы о генераторах документации phpDocumentor или Doxygen.
    Файл должен быть в кодировке UTF-8 без BOM.
  6. Пора включить наш модуль - заходим на страницу "Модули/Modules" (admin/build/modules), находим наш модуль, отмечаем на против названия модулья чекбокс и сохраняем (кнопка в внизу страницы).
Мы рассмотрели минимальный набор действий для регистрации модуля в вашем сайте основаном на Drupal 6. Далее мы углубимся и будем рассматривать более подробно из каждых частей.

Дополнительные файлы модулей

Следующие файлы не обязательны, но рекомендуются для использования.
  1. README.txt (название заглавными буквами), в котором должно быть описание модуля и его функционала. Рекомендуется создавать описание на русском и английском языке.
  2. CHANGELOG.txt - описание изменений в разработке.
  3. LICENSE.txt - лицензия вашего модуля.
  4. COPYRIGHT.txt - авторские права.
  5. INSTALL.txt - описание установки, если требуются дополнительные шаги.
  6. TODO.txt - описание задач для изменений.