Первый вопрос, который я задаю себе при новой задаче на разработку: к какому типу относится будущий плагин. От ответа зависит всё остальное: где лежит код, какие файлы обязательны, будет ли плагин копироваться вместе с курсом и как ядро будет его вызывать. Ошибка здесь стоит дорого, потому что тип входит в имя компонента, а значит в названия таблиц и прав. Исправить это позже можно только созданием нового плагина и переносом данных. Подробнее о том, как под такие задачи строится разработка плагинов Moodle, написано на отдельной странице. Здесь только выбор типа.
Как ядро делит плагины
Moodle знает несколько десятков типов плагинов, у каждого свой каталог и свой контракт с ядром. Список лежит в документации на moodledev.io, а на своём сайте его покажет страница «Обзор плагинов» в администрировании. На практике в проектах по СДО встречается меньше десятка. Остальные нужны или самому ядру, или узким задачам вроде редакторов, фильтров текста и вопросов банка.
Выбор помогает сделать один вопрос: в какое место интерфейса или процесса ядро должно вас вызывать? Если «никуда, я хочу свою страницу и свои данные», это local. Если «в курсе, как элемент», это mod. Если «при входе пользователя», auth. Если «при записи на курс», enrol. Остальное следует из этого.
Сводная таблица: задача, тип, пример
| Задача | Тип | Каталог | Пример из практики |
|---|---|---|---|
| Своя страница, настройки, веб-сервис, интеграция, служебные таблицы | local | local/имя | Электронная зачётная книжка, автоотчисление по окончании обучения |
| Новый элемент курса: добавляется в тему, оценивается, завершается | mod | mod/имя | Тесты, задания, SCORM |
| Виджет на странице: курс, главная, панель | block | blocks/имя | Блок ближайших дедлайнов |
| Способ входа через внешнюю систему | auth | auth/имя | LDAP, OAuth, вход через Госуслуги |
| Способ записи на курс | enrol | enrol/имя | Запись по оплате, по договору, из 1С |
| Отчёт со своим доступом и фильтрами | report | report/имя | Отчёт о прохождении курса |
| Административный инструмент без привязки к курсам | tool | admin/tool/имя | Массовая загрузка, служебные утилиты |
| Платёжный шлюз | paygw | payment/gateway/имя | EduKassa и другие провайдеры платежей |
| Внешний вид сайта | theme | theme/имя | Дочерняя тема на базе Boost |
| Новое отображение курса | format | course/format/имя | Формат «Плитки» |
| Тип вопроса в банке вопросов | qtype | question/type/имя | Вопрос с особой проверкой ответа |
| Обработка текста при выводе | filter | filter/имя | Подстановка терминов и формул |
| Канал доставки уведомлений | message | message/output/имя | Отправка в мессенджер |
Таблица неполная, но закрывает большую часть реальных запросов. Дальше о тех типах, где чаще всего ошибаются.
local: универсальный, но не мусорная корзина
Local-плагин, как и любой другой, получает все базовые возможности: свои таблицы, права, настройки, страницы, плановые задачи, события, веб-сервисы, строки языка. Чего у него нет, так это жизненного цикла элемента курса. Поэтому local хорош для всего, что относится ко всему сайту или к пользователям: кабинет, зачётка, отчёты, интеграция с 1С, синхронизация.
Зачётная книжка у меня сделана именно так. Она читает журнал оценок разных курсов, складывает записи в свои таблицы и показывает студенту и методисту собственные страницы. Курсовой «элемент зачётки» там не нужен, ведь запись принадлежит студенту, а не конкретному курсу. Подробнее о самой зачётке на странице электронной зачётной книжки.
Опасность local в том, что в него можно положить что угодно, и через два года плагин превращается в склад несвязанных функций. Один local-плагин на одну функциональную область. Если внутри уже живут отчёты, синхронизация и кабинет, это три плагина.
mod: когда сущность живёт внутри курса
Модуль нужен, если пользователь добавляет его в курс кнопкой «Добавить элемент или ресурс», у каждого экземпляра свои настройки, а результат попадает в журнал оценок и условия завершения. Вместе с этим вы берёте на себя обязательства: резервное копирование и восстановление, импорт, права на уровне модуля, события просмотра, поддержку мобильного приложения. Писать mod ради одной страницы с отчётом неразумно: объём работы в разы больше, чем в local, а выгоды никакой.
Простое правило: если вам нужно, чтобы копия курса переносила вместе с собой этот объект, то это mod. Если объект общий для сайта, то это не он.
block: виджет, а не приложение
Блок это компактный фрагмент на странице. Он хорош для списка ближайших событий, ссылки на кабинет, счётчика. Но блок живёт на странице, которую пользователь мог не открыть или откуда его могли убрать. Если логика критична (например, учёт или проверка документов), делайте её в local, а блок оставьте тонкой витриной, которая показывает данные и ведёт на страницу плагина. Подробнее об этом разделении писала в статье про блоки и личный кабинет.
auth и enrol: точки, где сидит безопасность
Auth отвечает за то, кого система пускает и как. Это самый чувствительный тип: ошибка в нём даёт доступ чужим людям. Если нужно просто войти через готового провайдера (OAuth 2, LDAP, SAML), сначала проверьте, нет ли уже поддерживаемого плагина. Писать свой auth имеет смысл, когда внешняя система нестандартная. Об этом подробнее в разделе SSO для Moodle.
Enrol решает, кто и как попадает в курс, и это не то же самое, что вход. Классический повод для своего enrol: запись по подтверждённой оплате, по приказу о зачислении, из выгрузки 1С. Тут часто путают enrol и разовую загрузку студентов скриптом. Если запись нужно делать один раз по CSV, плагин не нужен. Если система должна непрерывно поддерживать состав курса по внешнему источнику, нужен именно он или синхронизация через когорты, о чём я писала в материале про интеграцию Moodle с 1С.
report, tool и local: где живёт отчёт
Это самая частая развилка в моей практике. Отчёт можно положить в report/, в admin/tool/ или в local/. Различия такие:
| Тип | Когда выбирать |
|---|---|
| report | Отчёт показывается на уровне курса или сайта в стандартном меню «Отчёты», подчиняется правам отчётов |
| tool | Служебный инструмент для администратора, не связанный с обучением напрямую |
| local | Отчёт нужен как часть большого решения: свои таблицы, кабинет, выгрузки, пользовательские роли |
Если отчёт должен считаться по регламенту организации, с PDF и Excel, и его видят разные роли, я чаще выбираю local или report и обязательно закладываю отдельные права. Подробности по выгрузкам в отчётах для ДПО.
Типичные ошибки выбора
- Делают mod ради страницы. Получают лишние обязательства по резервным копиям и тестам.
- Кладут критичную логику в block. После смены компоновки страницы она пропадает из интерфейса.
- Меняют тип после старта. Таблицы и права приходится переименовывать миграцией.
- Пишут свой enrol, когда хватило бы когорт и скрипта синхронизации.
- Складывают всё в один local. Через год никто не помнит, что от чего зависит.
Подплагины: плагины внутри плагинов
Часть плагинов разрешает расширять себя собственными плагинами. У задания (mod_assign) есть подтипы для способов сдачи и обратной связи, у теста свои правила доступа и отчёты, у рабочих тетрадей и форумов свои. Описание подтипов лежит в каталоге db: в старых версиях это файл subplugins.php, в новых subplugins.json. Если вам нужно добавить способ сдачи работ, вы не пишете новый mod, а делаете подплагин задания: получите интерфейс и права от родителя бесплатно. Это экономит недели работы, поэтому перед выбором типа проверьте, нет ли у нужного модуля такой точки расширения. Список подтипов смотрите в описании модуля на moodledev.io.
Одна задача — несколько плагинов
В реальных проектах задача редко укладывается в один тип. Типичные сочетания из моей практики:
| Задача заказчика | Из чего собирается |
|---|---|
| Кабинет слушателя с загрузкой документов и проверкой методистом | local-плагин с таблицами, страницами и правами; при желании блок со ссылкой на кабинет на главной |
| Платный доступ к курсу | Платёжный шлюз (paygw) для приёма денег и способ записи (enrol), который открывает курс после оплаты; их связывает платёжная подсистема ядра |
| Автоматическое отчисление по окончании обучения | local-плагин с плановой задачей и настройками |
| Отчёт для руководителей в Excel и PDF | local или report, плюс классы выгрузки; права отдельной ролью |
| Вход из внешнего кабинета | auth-плагин или готовый OAuth и небольшой local для сопоставления учётных записей |
Каждый плагин отвечает за свою часть, а связываются они через события, права и публичные методы классов. Такой набор проще сопровождать: при обновлении Moodle ломается обычно что-то одно, и это видно сразу.
Сначала проверьте каталог
Прежде чем выбирать тип и писать код, посмотрите каталог плагинов moodle.org. Нужный плагин часто уже существует. Смотрите на три вещи: заявлена ли поддержка вашей версии Moodle, когда обновлялся плагин в последний раз и есть ли открытые проблемы в трекере. Заброшенный плагин с поддержкой только старых веток это будущий технический долг: он заблокирует обновление системы. Как оценивать такие находки в уже работающей СДО, я описываю в аудите; ориентиры по работам приведены на странице стоимости.
Как принять решение за пять минут
Ответьте на четыре вопроса. Нужен ли объект внутри курса и в его копии? Если да, mod. Нужно ли вмешаться в вход или запись? Тогда auth или enrol. Нужен ли просто виджет на странице? Block. Во всех остальных случаях local. Если ответ получается «и то, и другое», то это два плагина, которые общаются через события или API, а не один раздутый.
Если сомневаетесь, опишите задачу в нескольких предложениях и пришлите. Я предложу тип и объём работ на странице доработки Moodle, ориентиры по цене собраны на странице стоимости.
Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.