Разработка:sync/courseenrolment

Материал из DOF
Перейти к: навигация, поиск
Плагин
Название courseenrolments
Тип sync


Синхронизация подписок на учебные потоки с подписками на курсы Moodle.

  • Подписка на курс Moodle (вызывается из рабочего процесса cpassed при переводе объекта cpassed в статус "active", в случае, если для ученика существует пользователь Moodle, а для дисциплины задан курс Moodle). При этом, если для потока задана группа moodle, она тоже передается и при подписке происходит включение в эту группу.
  • Отписка от курса Moodle (вызывается из рабочего процесса cpassed при выводе подписки из статуса active).

Подписка, отписка и включение в группу происходит с использованием плагина modlibs/ama (modlib('ama')->course($mcourse)->role()->enrol(), modlib('ama')->course($mcourse)->role()->unenrol(), modlib('ama')->course($mcourse)->group($mgroup)->add_member($muser),

API

enrol_to_course()

Записывает пользователя на курс.

  • возвращаемое значение: (bool)
    • true если пользователя удалось подписать
    • false если произошла ошибка
  • $mdlcourseid - id курса в Moodle на который подписывается пользователь
  • $mdluserid - id пользователя в moodle
  • $mdlgroupid[optional] - id группы, в которую будет записан пользователь или null, если пользователь не будет записан в группу
  • @param int $mdlroleid[optional] - id роли прльзователя в курсе (из таблицы moodle). Роль по умолчанию - ученик.
  • @param int $timeend[optional] - время окончания обучения на курсе в формете unixtime (при наступлении этой даты пользователь булет отписан с курса)
  • @param bool $hidden[optional] - записать пользователя в скрытом режиме (он не будет отображаться в списке пользователей для учеников и учителей курса)

unenrol_from_course()

Отписывает пользователя из курса

  • возвращаемое значение: (bool)
    • true если пользователя удалось отписать
    • false если произошла ошибка
  • $mdlcourseid - id курса в Moodle с которого отписывается пользователь
  • $mdluserid - id пользователя в moodle

add_to_group()

Записывает пользователя в группу moodle

  • возвращаемое значение: (bool)
  • $mdlcourseid - id курса в Moodle в котором находится группа
  • $mdlgroupid - id группы в курсе, куда будет записываться пользователь
  • $mdluserid - id пользователя в moodle