Разработка:sync/mcourses — различия между версиями
DShtolin (обсуждение | вклад) м |
DShtolin (обсуждение | вклад) (→API) |
||
| Строка 8: | Строка 8: | ||
== 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 | ||
=События= | =События= | ||
Версия 10:47, 14 декабря 2017
| Плагин | |
| Название | mcourses |
| Тип | sync |
Работа с курсами moodle
Содержание
- 1 API
- 1.1 get_course($id)
- 1.2 get_course_link($id)
- 1.3 course_exists_quiet($id)
- 1.4 create_backup($courseid, $backupoptions = [], $fileoptions = [])
- 1.5 restore_backup($courseid, $restoreoptions = [], $fileoptions = [], $courseoptions = [])
- 1.6 backup_exists($courseid, $fileoptions = [])
- 1.7 create_course(stdClass $courseobj)
- 2 События
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
События
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
Перехватываемые события
| Тип плагина | Код плагина | Код события | Идентификтаор | Доп. данные | Пояснение |
|---|---|---|---|---|---|
| storage | programmitems | coursedata_verification_requested | идентификатор курса | массив с данными:
|
Запрошено согласование мастер-курса |
| storage | programmitems | coursedata_accepted | идентификатор курса | массив с данными:
|
Мастер-курс одобрен |
| storage | programmitems | coursedata_declined | идентификатор курса | массив с данными:
|
Мастер-курс отклонен |
