Перейти к содержимому
M
Все статьи
Разработка 8 мин чтения

Формат курса как плагин: как сделать своё отображение курса и не сломать «Плитки»

Формат курса Moodle как плагин: класс format_имя, настройки, рендер, шаблоны и поведение при обновлении. Опыт исправления формата «Плитки» на Moodle 5.2.

Формат курса Moodle как плагин: класс format_имя, настройки, рендер, шаблоны и поведение при обновлении. Опыт исправления формата «Плитки» на Moodle 5.2.

Формат курса определяет, как выглядит и ведёт себя страница курса: список тем, сетка плиток, вкладки, пошаговое прохождение. Сделать свой формат можно, но это плагин из тех, которые чаще всего ломаются при обновлении Moodle. Причина не в сложности формата, а в том, что именно страница курса в версиях 4.x и 5.x менялась сильнее остальных. Ниже о том, как формат устроен, и о том, что я исправляла, когда обновляла СДО учебного центра до 5.2.

Что делает формат курса

Формат отвечает на несколько вопросов, которые Moodle задаёт курсу. Есть ли в нём разделы и как они называются. Какой адрес у страницы раздела. Какие настройки есть у курса и у раздела. Можно ли перетаскивать элементы. Как показывать содержимое. Для разработчика это класс в lib.php плюс набор классов и шаблонов для вывода. Если вы только выбираете готовый формат, начните со страницы про настройку Moodle. Эта статья для тех, кто пишет формат или чинит чужой.

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

Файл или каталогНазначение
course/format/имя/version.phpКомпонент format_имя, версия, совместимость
lib.phpКласс format_имя: поведение формата и описание его настроек
classes/output/Классы вывода: переопределяют части страницы курса
templates/Шаблоны Mustache для своих блоков вывода
renderer.phpСтарый способ вывода; в новых версиях основной вывод идёт через классы вывода
amd/src/JavaScript формата, например сворачивание или переходы
styles.css или SCSSОформление формата
lang/Строки интерфейса и названия настроек
classes/privacy/provider.phpСведения для экспорта и удаления данных; у формата без личных данных объявляется отсутствие хранения

Класс формата

До версии 4.0 базовый класс назывался format_base и находился в course/format/lib.php. Начиная с 4.0 базовый класс — core_courseformat\base, и новые форматы наследуют его. Ниже минимальный набор того, что переопределяют на практике.

use core_courseformat\base as format_base;

class format_cards extends format_base {

    public function uses_sections() {
        return true;
    }

    public function supports_components() {
        return true;
    }

    public function course_format_options($foreditform = false) {
        static $options = null;
        if ($options === null) {
            $options = [
                'cardsperrow' => [
                    'default' => 3,
                    'type' => PARAM_INT,
                ],
            ];
        }
        return $options;
    }
}

Метод uses_sections сообщает, что у курса есть разделы, а course_format_options описывает свои параметры курса. Moodle сам сохраняет их в таблицу параметров формата и подставляет значения по умолчанию. Для показа параметров в форме настройки курса в массив добавляют описание элемента формы, и это уже зависит от вашей версии.

Метод supports_components относится к новой схеме 4.x: он говорит ядру, что формат согласен работать с компонентами курсового редактора, то есть с индексом курса и перемещением элементов без перезагрузки страницы. Формат без этой поддержки продолжает работать, но редактирование в нём возвращается к устаревшему поведению.

Вывод: переопределять мало, а не всё

Типичная ошибка при написании формата — скопировать целиком вывод одного из штатных форматов и менять его по месту. Через год ядро меняет шаблоны, ваша копия остаётся прежней, и редактор начинает вести себя странно. Я иду другим путём. Беру классы вывода ядра и переопределяю только тот элемент, который отличается: например, как показан раздел в сетке. Шаблоны, отвечающие за кнопки редактирования и атрибуты для JavaScript редактора, остаются штатными. Ядру нужны определённые атрибуты у элементов, чтобы перетаскивание и скрытие работали, и если шаблон их потерял, редактор молча перестаёт работать на этом блоке.

Что случилось с форматом «Плитки» при обновлении

В рабочей СДО центра дополнительного образования курсы были построены на формате «Плитки» (плагин format_tiles): тема раскрывается плиткой, внутри лежат материалы. Я обновляла систему с 4.3 до 5.2 через 4.5 LTS, и формат пришлось привести в порядок. Общий порядок обновления описан на странице про обновление Moodle, а здесь только то, что относилось к формату.

  • Сначала я выяснила, есть ли у плагина версия для каждого шага. Для каждого шага версию плагина приходится подбирать и проверять отдельно, одна и та же сборка подходит не всегда.
  • Затем проверила курс в режиме редактирования, а не только в просмотре. Именно редактирование ломается первым: на тестовой копии кнопки перемещения и скрытия могут не работать, хотя курс отображается.
  • Потом сравнила стили. В 5.0 тема перешла на новую версию Bootstrap, и все самописные стили плиток, завязанные на старые классы, нужно было проверить.
  • Отдельно прошла по курсам, где в плитках использовались вложенные элементы. В 5.0 у ядра появились подразделы, и это новый способ вложенности, которого в старом формате не было.

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

Что ломается чаще всего

СимптомВероятная причинаЧто делать
Курс виден, но редактировать нельзяФормат не согласован с курсовым редактором 4.x или 5.xВернуть штатные шаблоны элементов, включить поддержку компонентов
Пропали настройки формата в форме курсаИзменился способ описания параметровСверить метод описания параметров с документацией версии
Стили «поехали» после перехода на 5.xУстаревшие классы Bootstrap и атрибутыЗаменить атрибуты и классы на новые, пересобрать стили
Ссылки на разделы ведут на пустую страницуНеверный адрес страницы разделаПроверить метод, возвращающий адрес раздела
JavaScript формата не срабатываетНе собраны AMD-модули или неверные путиСобрать модули и очистить кэш, см. статью про AMD
Ошибка при обновлении плагинаНесовместимая версия в version.phpУказать реальную совместимость и проверить на тестовой копии

Когда писать свой формат, а когда нет

Настройки формата и обновление

Параметры формата, которые вы объявляете в course_format_options, хранятся в базе отдельно от курса. Если в новой версии плагина параметр переименован, у существующих курсов старое значение теряется, и курс получает значение по умолчанию. Для формата, которым пользуются сотни курсов, это ощутимо: вчера плитки шли по три в ряд, сегодня по умолчанию. Поэтому переименование параметра сопровождают шагом обновления в db/upgrade.php, который переносит значения, а не оставляют на удачу.

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

Порядок проверки формата после обновления Moodle

  1. Подготовьте копию сайта с реальными курсами, включая самые старые и самые сложные.
  2. Откройте курс в режиме просмотра под студентом, потом под преподавателем.
  3. Включите режим редактирования и пройдите весь набор действий: переместить раздел, скрыть элемент, добавить элемент, дублировать, удалить, перетащить элемент в другой раздел.
  4. Откройте курс на телефоне. Плиточные форматы чаще всего ломаются на узких экранах.
  5. Проверьте резервное копирование и восстановление курса с этим форматом: параметры формата должны вернуться.
  6. Посмотрите журнал ошибок сервера во время прохождения. Предупреждения о замененных функциях часто проявляются раньше, чем что-то ломается.

Этот перечень я прохожу на копии до обновления рабочей системы. Он занимает заметно меньше времени, чем разбор жалоб преподавателей после.

Что решить до начала работы

Перед тем как садиться за код формата, я прошу заказчика ответить на три вопроса. Какие именно действия нужны преподавателю на странице курса, кроме просмотра. Сколько курсов уже живёт на текущем формате и придётся ли их переносить. Кто будет сопровождать формат после выхода следующей версии Moodle. Ответы часто меняют задачу: выясняется, что нужна не новая страница курса, а два параметра штатного формата и немного стилей. Тогда формат не пишется вовсе, а заказчик не получает плагин, который придётся чинить при каждом обновлении.

Свой формат оправдан, если страница курса должна работать иначе: другой порядок показа, другая навигация, обязательные настройки курса. Если нужно лишь поправить внешний вид штатного формата, достаточно темы. Если нужна готовая плиточная сетка, берите существующий плагин и ведите его обновления, а не пишите заново. И заранее решите, кто будет сопровождать формат при выходе новых версий Moodle: это работа не на один раз. Для расчёта сопровождения посмотрите страницу технической поддержки Moodle.

Нужна помощь с Moodle?

Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.