Разработка:sync/mcategories
| Плагин | |
| Название | mcategories |
| Тип | sync |
Работа с категориями moodle. Плагин позволяет синхронизировать подразделения с категориями Moodle. Предоставляется возможность синхронизации двух независимых веток категорий Moodle независимо друг от друга. Все методы обработки работают через библиотеку ama (modlib/ama).
Содержание
События
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
Перехватываемые события
| Тип плагина | Код плагина | Код события | Идентификтаор | Доп. данные | Пояснение |
|---|---|---|---|---|---|
| storage | departments | insert | идентификатор подразделения | Событие добавления подразделения | |
| storage | departments | update | идентификатор подразделения | Событие обновления подразделения |
Конфиги
Список конфигов плагина.
- (bool)syncenable1 - отвечает за включение автоматической синхронизации создаваемых дочерних подразделений с категориями курсов
- (bool)syncenable2 - сихнронизация второй ветки подразделений
- (int)mdlcategoryid1 - должна хранить в себе идентификатор категории курсов moodle, связанной с редактируемым подразделением
- (int)mdlcategoryid2 - идентификатор категории второй ветки
TODO
Список TODO задач плагина.
- update_department_mdlcategory_tree => $departmentid - синхронизация ветки подразделений, начиная от переданного идентификатора, с веткой категорий Moodle.
API
get_category($id)
Получить объект категории Moodle по его id
Аргументы:
- int $id - id категории в moodle
Возвращаемые значения:
- object|bool - объект категории или false
get_courses($id, $options = [])
Получить курсы Moodle в переданной категории
Аргументы:
- int $id - id категории в moodle
- array $options - дополнительные опции
Возвращаемые значения:
- array - массив курсов
get_courses_count($id, $options = [])
Получить количество курсов в категории
Аргументы:
- int $id - id категории в moodle
- array $options - дополнительные опции
Возвращаемые значения:
- int - количество курсов в категории
create($categoryobj)
Создание категории в Moodle
Аргументы:
- stdClass $categoryobj - простой объект с базовыми полями категории
Возвращаемые значения:
- bool int - идентификатора созданной категории
update(stdClass $categoryobj)
Обновление категории в Moodle
Аргументы:
- stdClass $categoryobj - простой объект с полями категории
Возвращаемые значения:
- bool int | false - идентификатора обновленной категории в случае удачного обновления или false в остальных случаях
delete(stdClass $categoryobj)
Удаление категории в Moodle
Аргументы:
- stdClass $categoryobj - простой объект с полями категории
Возвращаемые значения:
- bool int | false - идентификатора обновленной категории в случае удачного удаления или false в остальных случаях
