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

Блок Moodle для личного кабинета: когда достаточно block-плагина, а когда нужен local

Block или local: что выбрать для личного кабинета Moodle. Устройство block-плагина, права, области показа, пример блока и случаи, когда блока мало.

Block или local: что выбрать для личного кабинета Moodle. Устройство block-плагина, права, области показа, пример блока и случаи, когда блока мало.

Для личного кабинета обучающегося существует соблазн писать всё одним плагином. Либо всё складывают в блок и потом удивляются, что блоку негде хранить данные и нельзя дать собственную страницу. Либо всё делают local-плагином и забывают, что показывать готовое можно было дешёвым блоком. Разница между ними простая, и на ней строится выбор. Общий подход к кабинету для центров ДПО я описывала на странице Moodle для ДПО, здесь разбираем техническую сторону.

Что умеет каждый тип

ЗадачаBlockLocal
Показать информацию в области страницыДа, для этого он созданНет собственного места на странице, нужны страницы или хуки
Своя страница с адресомНеудобно, блок живёт внутри страницыДа, обычный файл в каталоге плагина
Собственные таблицы базыМожно, но не принятоДа, привычное место
Обработка событий и плановые задачиМожно, но смешивает ролиДа
Настройка расположения администратором и пользователемДа, блоки двигают и скрываютНет, интерфейса размещения нет
Права на уровне экземпляраДа, у блока есть свой контекстПрава на уровне сайта или курса
Загрузка и проверка файловНеудобноДа, через страницы плагина

Практическое правило: если нужно только показать и ссылаться, хватит блока. Если у функции есть данные, страницы и действия, то это local-плагин, а блок становится его витриной. В кабинете слушателя для учебного центра ДПО я сделала именно так: логика, таблицы и страницы загрузки документов лежат в local-плагине, а то, что должно попадаться на глаза, показывается в области страницы. Загрузка документов с проверкой методистом в блок не помещается.

Устройство блока

Блок лежит в blocks/имя, компонент называется block_имя. Класс — block_имя, он наследует block_base.

defined('MOODLE_INTERNAL') || die();

class block_mycourses_next extends block_base {

    public function init() {
        $this->title = get_string('pluginname', 'block_mycourses_next');
    }

    public function get_content() {
        if ($this->content !== null) {
            return $this->content;
        }
        $this->content = new stdClass();
        $this->content->text = $this->render_list();
        $this->content->footer = '';
        return $this->content;
    }

    public function applicable_formats() {
        return ['my' => true, 'course-view' => false, 'site' => false];
    }

    public function has_config() {
        return false;
    }
}

Метод init вызывается при создании объекта и задаёт заголовок. Метод get_content вызывается при отрисовке страницы, и его результат кэшируют внутри объекта, поэтому в начале стоит проверка на повторный вызов. Область my в applicable_formats — это личная панель; именно она интересна для кабинета.

Права на добавление

Без прав блок не появится в списке «Добавить блок». В db/access.php объявляют два права: block/имя:addinstance для курсов и страниц, block/имя:myaddinstance для личной панели. Для второго контекстом выступает система, а не блок. Забыв одно из них, вы получите блок, который можно добавить в курс, но нельзя на панель. Названия и архетипы смотрите в образце любого штатного блока в каталоге blocks, тут проще скопировать готовое, чем писать по памяти.

Где блок берёт данные

Блок выполняется при каждом открытии страницы. Это определяет всю его архитектуру. Три практических следствия.

  • Не пишите тяжёлых запросов прямо в get_content. Если выборка по студенту занимает заметное время, сохраняйте её результат в кэш Moodle, ключом сделав идентификатор пользователя, и сбрасывайте по событию.
  • Всегда проверяйте права. Блок видит текущего пользователя, но не ограничивает его сам. Данные чужих курсов в блоке без проверки утекут.
  • Выводите разметку через шаблоны Mustache, а не строкой в PHP. Шаблон можно переопределить в теме, строку нельзя.
$renderer = $this->page->get_renderer('block_mycourses_next');
$this->content->text = $renderer->render_from_template(
    'block_mycourses_next/list',
    ['items' => $items]
);

Шаблон лежит в templates/list.mustache и получает массив из контекста. Данные для шаблона готовит отдельный класс в classes, а не метод блока. Так блок остаётся тонким, а подготовка данных покрывается тестами.

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

Возьмём кабинет слушателя курсов повышения квалификации. Что нужно человеку на первом экране: ближайшие занятия, статус документов, незавершённые курсы. Разложим по плагинам.

ЭлементГде реализованПочему
Список текущих курсов и прогрессБлокЧитает готовые данные Moodle, собственных таблиц не нужно
Статус документов (приняты, возвращены)Блок на данных local-плагинаПоказывает сводку, а подробности открываются на странице local
Загрузка документов и проверка методистомLocal-плагинСвоя таблица, права, файловая область, уведомления
Напоминание по срокамLocal-плагин с плановой задачейРаботает независимо от открытых страниц

Если вам нужен кабинет вместо стандартной панели, речь уже не о блоках: меняется страница, на которую попадает пользователь, и это отдельная доработка. Описание того, что я делаю в таких проектах, лежит на странице разработки плагинов.

Чек-лист блока перед выкладкой

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

Типичные ошибки при работе с блоками

СимптомПричинаРешение
Блока нет в списке «Добавить блок»Не объявлено или не выдано право добавленияПроверить db/access.php, обновить версию плагина, очистить кэши
Блок добавляется на курс, но не на панельНет права для личной панели или не включена область myДобавить право myaddinstance и область в applicable_formats
Блок показывает чужие данныеНет проверки текущего пользователя и правВыбирать данные по идентификатору текущего пользователя
Панель открывается медленноТяжёлый запрос в get_contentКэш Moodle или готовые данные от плановой задачи
Содержимое не обновляется после изменения данныхКэш не сбрасывается по событиюПодписаться на событие и очищать ключ пользователя
Блок пуст для студентов, но виден преподавателюПроверка на право, которого у студента нетПроверять то право, которое действительно нужно для просмотра

Кэширование содержимого блока

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

$cache = cache::make('block_mycourses_next', 'userlist');
$items = $cache->get($USER->id);
if ($items === false) {
    $items = \block_mycourses_next\local\data::for_user($USER->id);
    $cache->set($USER->id, $items);
}

Описание кэша лежит в db/caches.php с типом хранения приложения, а названия определений должны совпадать со строками в языковом файле.

Как я делю работу на практике

Когда заказчик просит «личный кабинет», я сначала прошу перечислить, что человек делает в нём каждую неделю, а что видит один раз. То, что он только смотрит, ложится в блоки и занимает мало времени. То, что требует действий, например загрузить документ, подтвердить прочтение, выбрать группу, становится страницами local-плагина. Такая раскладка заодно защищает от переделки: когда заказчик через полгода просит добавить ещё одну сводку, достаточно нового блока, а не правки всего кабинета.

Блок и тёмная сторона личной панели

Отдельно о личной панели. Администратор может закрепить набор блоков для всех пользователей и запретить им менять страницу. Это удобно для кабинета: у каждого слушателя на первом экране одно и то же. Но при такой настройке блок, которого нет в списке закреплённых, пользователь добавить не сможет, даже если право ему выдано. Поэтому после выкладки нового блока проверьте не только добавление под администратором, но и то, как панель выглядит у обычного студента, у которого настройки страницы заблокированы. Ещё один подвох: блоки на панели выводятся для всех ролей, и данные, предназначенные только методистам, нужно скрывать проверкой права в самом блоке, а не размещением в «служебной» области.

Стоит ли делать кабинет блоками или отдельным плагином, зависит от того, сколько в нём действий и данных, а не только просмотра. Опишите, что должен видеть и делать слушатель, и по этому списку я разделю работу на block и local. Связаться можно через страницу программиста Moodle.

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

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