Модуль

Модуль — это самодостаточная программная единица, состоящая из моделей, представлений, контроллеров и иных компонентов. Во многом модуль схож с приложением. Основное различие заключается в том, что модуль не может использоваться сам по себе — только в составе приложения. Пользователи могут обращаться к контроллерам внутри модуля абсолютно так же, как и в случае работы с обычными контроллерами приложения.

Модули могут быть полезными в нескольких ситуациях. Если приложение очень объёмное, мы можем разделить его на несколько модулей, разрабатываемых и поддерживаемых по отдельности. Кроме того, некоторый часто используемый функционал, например, управление пользователями, комментариями и пр., может разрабатываться как модули, чтобы впоследствии можно было с лёгкостью воспользоваться им вновь.

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

Модуль организован как директория, имя которой выступает в качестве уникального идентификатора модуля. Структура директории модуля похожа на структуру базовой директории приложения. Ниже представлена типовая структура директории модуля с именем forum:




В корневой директории модуля должен находиться класс модуля, наследующий CWebModule. Имя класса определяется, используя выражение
ucfirst($id).'Module', где $id соответствует идентификатору модуля (или названию директории модуля). Класс модуля выполняет роль
центрального хранилища информации, совместно используемой компонентами модуля. Например, мы можем использовать
CWebModule::params для хранения параметров модуля, а также CWebModule::components для совместного использования
компонентов приложения на уровне модуля.





Подсказка: Для создания базового каркаса модуля можно воспользоваться
  генератором модулей, входящим в состав Gii.





Использование модуля



Для использования модуля необходимо поместить папку модуля в директорию modules
базовой директории приложения. Далее необходимо объявить
идентификатор модуля в свойстве приложения modules. Например, чтобы воспользоваться модулем forum,
приведённым выше, можно использовать следующую конфигурацию приложения:






Кроме того, модулю можно задать начальные значения свойств. Порядок использования такой же, как и с компонентами
приложения. Например, модуль forum может иметь в своём классе свойство с именем
postPerPage, которое может быть установлено в конфигурации приложения
следующим образом:






К экземпляру модуля можно обращаться посредством свойства module активного в настоящий момент контроллера. Через экземпляр
модуля можно получить доступ к совместно используемой информации на уровне модуля. Например, для того чтобы обратиться к упомянутому выше свойству
postPerPage, мы можем воспользоваться следующим выражением:






Обратиться к действию контроллера в модуле можно, используя маршрут moduleID/controllerID/actionID.
Например, предположим, что всё тот же модуль forum имеет контроллер с именем PostController. Тогда мы можем использовать
маршрут forum/post/create для того, чтобы обратиться к действию create этого контроллера.
Адрес URL, соответствующий этому маршруту, будет таким: http://www.example.com/index.php?r=forum/post/create.





Подсказка: Если контроллер находится в подпапке папки controllers, мы также можем использовать формат
  маршрута, приведенный выше. Например, предположим, что контроллер PostController находится в
  папке forum/controllers/admin, тогда мы можем обратиться к действию create через forum/admin/post/create.





Вложенные модули



Модули могут быть вложенными друг в друга сколько угодно раз,
т.е. один модуль может содержать в себе другой, который
содержит в себе ещё один. Первый мы будем называть модуль-родитель,
второй — модуль-потомок.
Модули-потомки должны быть описаны в свойстве modules
модуля-родителя точно так же, как мы описываем модули в файле конфигурации
приложения.



Для обращения к действию контроллера в дочернем модуле используется
маршрут parentModuleID/childModuleID/controllerID/actionID.