Разработка:sync/mcourses — различия между версиями

Материал из DOF
Перейти к: навигация, поиск
(Новая страница: «{{Infobox_Plugin | name = mcourses | type = sync }} Работа с курсами moodle == API == === get_course === Получить объект курса mo...»)
 
(→‎CRON)
 
(не показаны 4 промежуточные версии 2 участников)
Строка 4: Строка 4:
 
}}
 
}}
  
−
Работа с курсами moodle
+
Работа с курсами moodle.
 +
Плагин отлавливает события создания/обновления дисциплины/учебного процесса, проверяет флаг создания курса в Moodle и создает, если это необходимо.
 +
 
 +
= Конфиги =
 +
Список конфигов плагина.
 +
 
 +
* (string)mdlcategoryvarname - название переменной конфига в плагине sync/mcategories, куда будут добавляться новый курсы Moodle
 +
* (int)mdlcourseid_template - идентификатор шаблона курса, на основании которого будут создаваться новые курсы в Moodle
 +
 
 +
= CRON =
 +
Задачи, которые выполняются по крону.
 +
 
 +
* Починка неправильно созданных дисциплин (если был параметр создания курса в Moodle, но он не был создан)
 +
* Починка неправильно созданных учебных процессов (если был параметр создания курса в Moodle, но он не был создан)
 +
 
 +
=События=
 +
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
 +
====Перехватываемые события====
 +
{| border="1"
 +
|+ Таблица событий, которые перехватывает этот плагин
 +
! Тип плагина
 +
! Код плагина
 +
! Код события
 +
! Идентификтаор
 +
! Доп. данные
 +
! Пояснение
 +
|-
 +
| storage
 +
| programmitems
 +
| coursedata_verification_requested
 +
| идентификатор курса
 +
| массив с данными:
 +
* initiator - пользователь, запросивший согласование
 +
* course - наименование курса
 +
* discipline - наименование дисциплины
 +
* notificationresult - массив с результатами отправки уведомлений
 +
| Запрошено согласование мастер-курса
 +
|-
 +
| storage
 +
| programmitems
 +
| coursedata_accepted
 +
| идентификатор курса
 +
| массив с данными:
 +
* course - наименование курса
 +
* discipline - наименование дисциплины
 +
* notificationresult - массив с результатами отправки уведомлений
 +
| Мастер-курс одобрен
 +
|-
 +
| storage
 +
| programmitems
 +
| coursedata_declined
 +
| идентификатор курса
 +
| массив с данными:
 +
* course - наименование курса
 +
* discipline - наименование дисциплины
 +
* notificationresult - массив с результатами отправки уведомлений
 +
| Мастер-курс отклонен
 +
|-
 +
| storage
 +
| programmitems
 +
| insert
 +
|
 +
|
 +
| Добавление дисциплины
 +
|-
 +
| storage
 +
| programmitems
 +
| update
 +
|
 +
|
 +
| Обновление дисциплины
 +
|-
 +
| storage
 +
| cstreams
 +
| insert
 +
|
 +
|
 +
| Добавление учебного процесса
 +
|-
 +
| storage
 +
| cstreams
 +
| update
 +
|
 +
|
 +
| Обновление учебного процесса
 +
|}
 +
 
  
 
== API ==
 
== API ==
  
−
=== get_course ===
+
===='''get_course($id)'''====
 
Получить объект курса moodle по его id
 
Получить объект курса moodle по его id
  
−
=== get_course_link ===
+
''Аргументы:''
 +
* int $id - id курса в moodle
 +
''Возвращаемые значения:''
 +
* object|bool - объект курса или false
 +
 
 +
===='''get_course_link($id)'''====
 
Получить ссылку на курс moodle
 
Получить ссылку на курс moodle
  
−
=== course_exists_quiet ===
+
''Аргументы:''
 +
* int $id - id курса в moodle
 +
''Возвращаемые значения:''
 +
* string|bool - строка для ссылки на курс или false если такого курса нет
 +
 
 +
===='''course_exists_quiet($id)'''====
 
Аккуратно проверить существование курса в moodle, не создавая ошибок print_error
 
Аккуратно проверить существование курса в moodle, не создавая ошибок print_error
  
−
=== create_backup ===
+
''Аргументы:''
 +
* int $id - id курса в moodle
 +
''Возвращаемые значения:''
 +
* bool - true, если курс существует; false, если курс не существует
 +
 
 +
===='''create_backup($courseid, $backupoptions = [], $fileoptions = [])'''====
 
Создание резервной копии курса
 
Создание резервной копии курса
  
−
=== restore_backup ===
+
''Аргументы:''
 +
* int $courseid - id курса в moodle
 +
* array $backupoptions
 +
* array $fileoptions
 +
''Возвращаемые значения:''
 +
* boolean
 +
 
 +
===='''restore_backup($courseid, $restoreoptions = [], $fileoptions = [], $courseoptions = [])'''====
 
Восстановление курса из резервной копии
 
Восстановление курса из резервной копии
  
−
=== backup_exists ===
+
''Аргументы:''
 +
* int $courseid - id курса в moodle
 +
* int $courseid
 +
* array $restoreoptions
 +
* array $fileoptions
 +
* array $courseoptions
 +
''Возвращаемые значения:''
 +
* int
 +
 
 +
===='''backup_exists($courseid, $fileoptions = [])'''====
 
Проверка существования резервной копии курса
 
Проверка существования резервной копии курса
  
−
=== create_course ===
+
''Аргументы:''
 +
* int $courseid - id курса в moodle
 +
* array $fileoptions
 +
''Возвращаемые значения:''
 +
* boolean
 +
 
 +
===='''create_course(stdClass $courseobj)'''====
 
Создание курса мудл
 
Создание курса мудл
 +
 +
''Аргументы:''
 +
* stdClass $courseobj
 +
''Возвращаемые значения:''
 +
* int
 +
 +
===='''clone_course($mdlcourseid, stdClass $courseobj)'''====
 +
Создание курса на основе существующего курса в Moodle
 +
 +
''Аргументы:''
 +
* int $mdlcourseid - id курса в moodle
 +
* stdClass $courseobj
 +
 +
''Возвращаемые значения:''
 +
* int | false - идентификатора курса вслучае успеха и false в остальных случаях

Текущая версия на 11:37, 2 марта 2018

Плагин
Название mcourses
Тип sync


Работа с курсами moodle. Плагин отлавливает события создания/обновления дисциплины/учебного процесса, проверяет флаг создания курса в Moodle и создает, если это необходимо.

Конфиги

Список конфигов плагина.

  • (string)mdlcategoryvarname - название переменной конфига в плагине sync/mcategories, куда будут добавляться новый курсы Moodle
  • (int)mdlcourseid_template - идентификатор шаблона курса, на основании которого будут создаваться новые курсы в Moodle

CRON

Задачи, которые выполняются по крону.

  • Починка неправильно созданных дисциплин (если был параметр создания курса в Moodle, но он не был создан)
  • Починка неправильно созданных учебных процессов (если был параметр создания курса в Moodle, но он не был создан)

События

В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.

Перехватываемые события

Таблица событий, которые перехватывает этот плагин
Тип плагина Код плагина Код события Идентификтаор Доп. данные Пояснение
storage programmitems coursedata_verification_requested идентификатор курса массив с данными:
  • initiator - пользователь, запросивший согласование
  • course - наименование курса
  • discipline - наименование дисциплины
  • notificationresult - массив с результатами отправки уведомлений
Запрошено согласование мастер-курса
storage programmitems coursedata_accepted идентификатор курса массив с данными:
  • course - наименование курса
  • discipline - наименование дисциплины
  • notificationresult - массив с результатами отправки уведомлений
Мастер-курс одобрен
storage programmitems coursedata_declined идентификатор курса массив с данными:
  • course - наименование курса
  • discipline - наименование дисциплины
  • notificationresult - массив с результатами отправки уведомлений
Мастер-курс отклонен
storage programmitems insert Добавление дисциплины
storage programmitems update Обновление дисциплины
storage cstreams insert Добавление учебного процесса
storage cstreams update Обновление учебного процесса


API

get_course($id)

Получить объект курса moodle по его id

Аргументы:

  • int $id - id курса в moodle

Возвращаемые значения:

  • object|bool - объект курса или false

get_course_link($id)

Получить ссылку на курс moodle

Аргументы:

  • int $id - id курса в moodle

Возвращаемые значения:

  • string|bool - строка для ссылки на курс или false если такого курса нет

course_exists_quiet($id)

Аккуратно проверить существование курса в moodle, не создавая ошибок print_error

Аргументы:

  • int $id - id курса в moodle

Возвращаемые значения:

  • bool - true, если курс существует; false, если курс не существует

create_backup($courseid, $backupoptions = [], $fileoptions = [])

Создание резервной копии курса

Аргументы:

  • int $courseid - id курса в moodle
  • array $backupoptions
  • array $fileoptions

Возвращаемые значения:

  • boolean

restore_backup($courseid, $restoreoptions = [], $fileoptions = [], $courseoptions = [])

Восстановление курса из резервной копии

Аргументы:

  • int $courseid - id курса в moodle
  • int $courseid
  • array $restoreoptions
  • array $fileoptions
  • array $courseoptions

Возвращаемые значения:

  • int

backup_exists($courseid, $fileoptions = [])

Проверка существования резервной копии курса

Аргументы:

  • int $courseid - id курса в moodle
  • array $fileoptions

Возвращаемые значения:

  • boolean

create_course(stdClass $courseobj)

Создание курса мудл

Аргументы:

  • stdClass $courseobj

Возвращаемые значения:

  • int

clone_course($mdlcourseid, stdClass $courseobj)

Создание курса на основе существующего курса в Moodle

Аргументы:

  • int $mdlcourseid - id курса в moodle
  • stdClass $courseobj

Возвращаемые значения:

  • int | false - идентификатора курса вслучае успеха и false в остальных случаях
Источник — «http://docs.deansoffice.ru/wiki/index.php?title=Разработка:sync/mcourses&oldid=3194»