Drupal: Вынос служебных функций модуля в отдельный класс

26.12.2013

В друпале негласно принято держать служебные функции модуля в файле modulename.module и добавлять именам функций префикс _, например _node_types_build(). Некоторые модули выносят функции в .inc файл и перед вызовом дёргают module_load_include(). Мне всегда не нравился такой подход, куда приятней хранить все системные функции в отдельном статическом классе. Приятным бонусом является автозагрузка классов, т.е. не надо вручную инклудить файл.

Реализация для Drupal 7

1. Создаём в папке модуля файл modulename_helper.inc.

2. Реализуем в созданном файле класс modulename_helper с набором статических функций:

class modulename_helper {
  public static function my_function() {
    // ...
  }
  public static function my_other_function() {
    // ...
  }
}

3. Добавляем в .info файл модуля строчку:

files[] = modulename_helper.inc

4. Сбрасываем кэш.

5. В любом месте кода пользуемся функциями modulename_helper::my_function() и modulename_helper::my_other_function().

Реализация для Drupal 8+

1. Создаём файл ModulenameHelper.php в папке src вашего модуля (т.е. modules/modulename/src/ModulenameHelper.php относительно корня друпала).

2. Реализуем в созданном файле класс ModulenameHelper с набором статических функций:

namespace Drupal\modulename;

class ModulenameHelper {
  public static function myFunction() {
    // ...
  }
  public static function myOtherFunction() {
    // ...
  }
}

3. Сбрасываем кэш.

4. В любом месте кода пользуемся функциями ModulenameHelper::myFunction() и ModulenameHelper::myOtherFunction(). Перед использованием не забываем добавить в начало файла строчку use Drupal\modulename\ModulenameHelper;

Так же в Drupal 8 можно хранить служебные функции в приватных методах контроллеров, форм, плагинов и т.д., таким образом отдельный класс-хелпер возможно и не понадобится.

Написанное актуально для

Drupal 7, Drupal 8+

Drupal → Вынос служебных функций модуля в отдельный класс

Реализация для Drupal 7

Реализация для Drupal 8+

Комментарии

Добавить комментарий