blocks:courserecycle:technicalguide
Table des matières
Course Recycle block (course recycling): Technical guide
Permissions
- Addinstance: Allows adding the block to courses
- View: See this block - non-editing teacher by default
- Admin: Manage the block options (course status) teachers by default
Web services
The Course recycling block web services currently only concern the GUILess mode.
- block_course_recycle_get_archivables(): Retrieves the current list of courses to archive on the source platform. It is invoked from an archive platform.
Parameters
No parameters
- block_course_recycle_update_course_status($courseidfield, $courseid, $status, $postactions): It is invoked by the archive platform on the source platform to report the end of a course archiving process and update the source's recycling information.
Parameters
- courseidfield: Indicates the reference field for identifying the course (id, idnumber or shortname)
- courseid: Gives the course identifier according to the previous field.
- status: Indicates the new status of the course. (In the current implementation, the archive platform returns a “Done” or “Failed” status if an error occurred when retrieving the archived course).
- postactions: Returns the original status before archiving so the source platform can determine the additional actions to run after archiving.
Scheduled tasks
GUI mode tasks (Recycling cycle control)
- task_show: Runs once per management period to enable the display of the choice selector.
- task_lock: Runs once per recycling period to lock the recycling choices.
- task_recycle: Runs once per recycling period to perform the recycling actions.
- task_reset: Runs once at the start of the recycling period to hide the choice selectors
GUILess mode tasks
The GUILess mode tasks do not run on all platforms. Some are meant for the “source” platform that is archived, while others only run on the archive platform.
Source tasks
- discover_finished_courses_task: Examines the courses of the platform and detects the courses considered finished. Incidentally, this task examines the mail reminders to send to ask teachers to decide on the destination of their courses.
Archive tasks
- pull_and_archive_courses_task: Retrieves the list of courses to archive and proceeds with the archiving.
Credits
- Valéry Frémaux - Development and tests
- Florence Labord - Documentation and tests
Index du composant- Back to plugins index - Back to catalogue index
blocks/courserecycle/technicalguide.txt · Dernière modification : de 127.0.0.1
