This is used when restoring course logs where it is required that we map the objectid to it's new value in the new course.
Does nothing in the base class except display a debugging message warning the user that the event does not contain the required functionality to map this information. For events that do not store an objectid this won't be called, so no debugging message will be displayed.
Example of usage:
return array('db' => 'assign_submissions', 'restore' => 'submission');
If the objectid can not be mapped during restore set the value to core\event\base::NOT_MAPPED, example -
return array('db' => 'some_table', 'restore' => core\event\base::NOT_MAPPED);
Note - it isn't necessary to specify the 'db' and 'restore' values in this case, so you can also use -
return core\event\base::NOT_MAPPED;
The 'db' key refers to the database table and the 'restore' key refers to the name of the restore element the objectid is associated with. In many cases these will be the same.
- Return values
-
| string | the name of the restore mapping the objectid links to |
Reimplemented in mod_workshop\event\submission_viewed, mod_workshop\event\submission_updated, mod_workshop\event\submission_reassessed, mod_workshop\event\submission_deleted, mod_workshop\event\submission_created, mod_workshop\event\submission_assessed, mod_workshop\event\phase_switched, mod_workshop\event\course_module_viewed, mod_workshop\event\assessment_reevaluated, mod_workshop\event\assessment_evaluated, mod_workshop\event\assessable_uploaded, mod_wiki\event\page_viewed, mod_wiki\event\page_version_viewed, mod_wiki\event\page_version_restored, mod_wiki\event\page_version_deleted, mod_wiki\event\page_updated, mod_wiki\event\page_map_viewed, mod_wiki\event\page_locks_deleted, mod_wiki\event\page_history_viewed, mod_wiki\event\page_diff_viewed, mod_wiki\event\page_deleted, mod_wiki\event\page_created, mod_wiki\event\course_module_viewed, mod_wiki\event\comments_viewed, mod_url\event\course_module_viewed, mod_survey\event\report_viewed, mod_survey\event\report_downloaded, mod_survey\event\course_module_viewed, mod_scorm\event\sco_launched, mod_scorm\event\course_module_viewed, mod_resource\event\course_module_viewed, mod_quiz\event\user_override_updated, mod_quiz\event\user_override_deleted, mod_quiz\event\user_override_created, mod_quiz\event\question_manually_graded, mod_quiz\event\group_override_updated, mod_quiz\event\group_override_deleted, mod_quiz\event\group_override_created, mod_quiz\event\course_module_viewed, mod_quiz\event\attempt_viewed, mod_quiz\event\attempt_summary_viewed, mod_quiz\event\attempt_submitted, mod_quiz\event\attempt_started, mod_quiz\event\attempt_reviewed, mod_quiz\event\attempt_regraded, mod_quiz\event\attempt_preview_started, mod_quiz\event\attempt_deleted, mod_quiz\event\attempt_becameoverdue, mod_quiz\event\attempt_abandoned, mod_page\event\course_module_viewed, mod_lti\event\course_module_viewed, mod_lesson\event\user_override_updated, mod_lesson\event\user_override_deleted, mod_lesson\event\user_override_created, mod_lesson\event\question_viewed, mod_lesson\event\question_answered, mod_lesson\event\page_updated, mod_lesson\event\page_moved, mod_lesson\event\page_deleted, mod_lesson\event\page_created, mod_lesson\event\lesson_started, mod_lesson\event\lesson_resumed, mod_lesson\event\lesson_restarted, mod_lesson\event\lesson_ended, mod_lesson\event\highscores_viewed, mod_lesson\event\highscore_added, mod_lesson\event\group_override_updated, mod_lesson\event\group_override_deleted, mod_lesson\event\group_override_created, mod_lesson\event\essay_attempt_viewed, mod_lesson\event\essay_assessed, mod_lesson\event\course_module_viewed, mod_lesson\event\content_page_viewed, mod_imscp\event\course_module_viewed, mod_glossary\event\entry_viewed, mod_glossary\event\entry_updated, mod_glossary\event\entry_disapproved, mod_glossary\event\entry_deleted, mod_glossary\event\entry_created, mod_glossary\event\entry_approved, mod_glossary\event\course_module_viewed, mod_glossary\event\category_updated, mod_glossary\event\category_deleted, mod_glossary\event\category_created, mod_forum\event\subscription_deleted, mod_forum\event\subscription_created, mod_forum\event\post_updated, mod_forum\event\post_deleted, mod_forum\event\post_created, mod_forum\event\discussion_viewed, mod_forum\event\discussion_updated, mod_forum\event\discussion_unpinned, mod_forum\event\discussion_subscription_deleted, mod_forum\event\discussion_subscription_created, mod_forum\event\discussion_pinned, mod_forum\event\discussion_moved, mod_forum\event\discussion_deleted, mod_forum\event\discussion_created, mod_forum\event\course_module_viewed, mod_forum\event\assessable_uploaded, mod_folder\event\folder_updated, mod_folder\event\course_module_viewed, mod_feedback\event\response_submitted, mod_feedback\event\response_deleted, mod_feedback\event\course_module_viewed, mod_data\event\record_updated, mod_data\event\record_deleted, mod_data\event\record_created, mod_data\event\field_updated, mod_data\event\field_deleted, mod_data\event\field_created, mod_data\event\course_module_viewed, mod_choice\event\report_viewed, mod_choice\event\report_downloaded, mod_choice\event\course_module_viewed, mod_choice\event\answer_updated, mod_choice\event\answer_submitted, mod_choice\event\answer_deleted, mod_choice\event\answer_created, mod_chat\event\sessions_viewed, mod_chat\event\message_sent, mod_chat\event\course_module_viewed, booktool_print\event\chapter_printed, booktool_print\event\book_printed, booktool_exportimscp\event\book_exported, mod_book\event\course_module_viewed, mod_book\event\chapter_viewed, mod_book\event\chapter_updated, mod_book\event\chapter_deleted, mod_book\event\chapter_created, assignsubmission_onlinetext\event\submission_updated, assignsubmission_onlinetext\event\submission_created, assignsubmission_onlinetext\event\assessable_uploaded, assignsubmission_file\event\submission_updated, assignsubmission_file\event\submission_created, assignsubmission_file\event\assessable_uploaded, mod_assign\event\workflow_state_updated, mod_assign\event\user_override_updated, mod_assign\event\user_override_deleted, mod_assign\event\user_override_created, mod_assign\event\submission_viewed, mod_assign\event\submission_unlocked, mod_assign\event\submission_status_updated, mod_assign\event\submission_locked, mod_assign\event\submission_graded, mod_assign\event\submission_duplicated, mod_assign\event\statement_accepted, mod_assign\event\marker_updated, mod_assign\event\identities_revealed, mod_assign\event\group_override_updated, mod_assign\event\group_override_deleted, mod_assign\event\group_override_created, mod_assign\event\feedback_viewed, mod_assign\event\extension_granted, mod_assign\event\course_module_viewed, mod_assign\event\assessable_submitted, mod_assign\event\all_submissions_downloaded, core\event\webservice_token_sent, core\event\webservice_token_created, core\event\webservice_service_user_removed, core\event\webservice_service_user_added, core\event\webservice_service_updated, core\event\webservice_service_deleted, core\event\webservice_service_created, core\event\user_updated, core\event\user_profile_viewed, core\event\user_loggedout, core\event\user_loggedinas, core\event\user_loggedin, core\event\user_list_viewed, core\event\user_info_field_updated, core\event\user_info_field_deleted, core\event\user_info_field_created, core\event\user_info_category_updated, core\event\user_info_category_deleted, core\event\user_info_category_created, core\event\user_graded, core\event\user_enrolment_updated, core\event\user_enrolment_deleted, core\event\user_enrolment_created, core\event\user_deleted, core\event\user_created, core\event\tag_updated, core\event\tag_unflagged, core\event\tag_removed, core\event\tag_flagged, core\event\tag_deleted, core\event\tag_created, core\event\tag_added, core\event\scale_updated, core\event\scale_deleted, core\event\scale_created, core\event\role_unassigned, core\event\role_deleted, core\event\role_capabilities_updated, core\event\role_assigned, core\event\questions_imported, core\event\questions_exported, core\event\question_moved, core\event\question_category_base, core\event\question_base, core\event\prediction_action_started, core\event\notification_viewed, core\event\notification_sent, core\event\note_updated, core\event\note_deleted, core\event\note_created, core\event\mnet_access_control_updated, core\event\mnet_access_control_created, core\event\message_viewed, core\event\message_user_unblocked, core\event\message_user_blocked, core\event\message_sent, core\event\message_deleted, core\event\message_contact_unblocked, core\event\message_contact_removed, core\event\message_contact_blocked, core\event\message_contact_added, core\event\grouping_updated, core\event\grouping_group_unassigned, core\event\grouping_group_assigned, core\event\grouping_deleted, core\event\grouping_created, core\event\group_updated, core\event\group_message_sent, core\event\group_member_removed, core\event\group_member_added, core\event\group_deleted, core\event\group_created, core\event\grade_letter_updated, core\event\grade_letter_deleted, core\event\grade_letter_created, core\event\grade_deleted, core\event\enrol_instance_updated, core\event\enrol_instance_deleted, core\event\enrol_instance_created, core\event\course_updated, core\event\course_section_updated, core\event\course_section_created, core\event\course_restored, core\event\course_module_updated, core\event\course_module_deleted, core\event\course_module_created, core\event\course_module_completion_updated, core\event\course_deleted, core\event\course_created, core\event\course_content_deleted, core\event\course_completed, core\event\course_category_viewed, core\event\course_category_updated, core\event\course_category_deleted, core\event\course_category_created, core\event\course_backup_created, core\event\config_log_created, core\event\completion_defaults_updated, core\event\competency_viewed, core\event\competency_user_evidence_updated, core\event\competency_user_evidence_deleted, core\event\competency_user_evidence_created, core\event\competency_user_competency_viewed_in_plan, core\event\competency_user_competency_viewed_in_course, core\event\competency_user_competency_viewed, core\event\competency_user_competency_review_stopped, core\event\competency_user_competency_review_started, core\event\competency_user_competency_review_requested, core\event\competency_user_competency_review_request_cancelled, core\event\competency_user_competency_rated_in_plan, core\event\competency_user_competency_rated_in_course, core\event\competency_user_competency_rated, core\event\competency_user_competency_plan_viewed, core\event\competency_updated, core\event\competency_template_viewed, core\event\competency_template_updated, core\event\competency_template_deleted, core\event\competency_template_created, core\event\competency_plan_viewed, core\event\competency_plan_updated, core\event\competency_plan_unlinked, core\event\competency_plan_unapproved, core\event\competency_plan_review_stopped, core\event\competency_plan_review_started, core\event\competency_plan_review_requested, core\event\competency_plan_review_request_cancelled, core\event\competency_plan_reopened, core\event\competency_plan_deleted, core\event\competency_plan_created, core\event\competency_plan_completed, core\event\competency_plan_approved, core\event\competency_framework_viewed, core\event\competency_framework_updated, core\event\competency_framework_deleted, core\event\competency_framework_created, core\event\competency_evidence_created, core\event\competency_deleted, core\event\competency_created, core\event\comment_deleted, core\event\comment_created, core\event\cohort_updated, core\event\cohort_member_removed, core\event\cohort_member_added, core\event\cohort_deleted, core\event\cohort_created, core\event\calendar_subscription_updated, core\event\calendar_subscription_deleted, core\event\calendar_subscription_created, core\event\calendar_event_updated, core\event\calendar_event_deleted, core\event\calendar_event_created, core\event\blog_external_viewed, core\event\blog_external_updated, core\event\blog_external_removed, core\event\blog_external_added, core\event\blog_entry_updated, core\event\blog_entry_deleted, core\event\blog_entry_created, core\event\blog_association_deleted, core\event\blog_association_created, core\event\badge_updated, core\event\badge_revoked, core\event\badge_enabled, core\event\badge_duplicated, core\event\badge_disabled, core\event\badge_deleted, core\event\badge_criteria_updated, core\event\badge_criteria_deleted, core\event\badge_criteria_created, core\event\badge_created, core\event\badge_awarded, core\event\badge_archived, tool_usertours\event\tour_started, tool_usertours\event\tour_reset, tool_usertours\event\tour_ended, tool_usertours\event\step_shown, tool_policy\event\acceptance_base, tool_monitor\event\subscription_deleted, tool_monitor\event\subscription_created, tool_monitor\event\rule_updated, tool_monitor\event\rule_deleted, and tool_monitor\event\rule_created.
1.8.20