From cc6a8bc792de6dbb1e8604b9f280dbcef52e79a6 Mon Sep 17 00:00:00 2001 From: Mark Nelson Date: Sat, 10 May 2014 16:07:56 -0700 Subject: [PATCH] MDL-45445 events: added '(optional)' to event params where applicable --- lib/classes/event/blog_entries_viewed.php | 16 ++++++++-------- lib/classes/event/course_created.php | 2 +- lib/classes/event/course_deleted.php | 4 ++-- lib/classes/event/course_updated.php | 4 ++-- lib/classes/event/note_created.php | 2 +- lib/classes/event/note_deleted.php | 2 +- lib/classes/event/note_updated.php | 2 +- lib/classes/event/role_assigned.php | 2 +- lib/classes/event/role_deleted.php | 4 ++-- lib/classes/event/role_unassigned.php | 2 +- lib/classes/event/user_graded.php | 4 ++-- lib/classes/event/user_list_viewed.php | 4 ++-- lib/classes/event/user_loggedout.php | 2 +- lib/classes/event/user_profile_viewed.php | 6 +++--- lib/classes/event/webservice_service_created.php | 2 +- .../classes/event/assessable_uploaded.php | 2 +- mod/choice/classes/event/answer_submitted.php | 2 +- mod/choice/classes/event/answer_updated.php | 2 +- mod/glossary/classes/event/entry_created.php | 2 +- mod/glossary/classes/event/entry_deleted.php | 2 +- mod/glossary/classes/event/entry_updated.php | 2 +- mod/quiz/classes/event/attempt_abandoned.php | 2 +- mod/quiz/classes/event/attempt_becameoverdue.php | 2 +- mod/quiz/classes/event/attempt_submitted.php | 2 +- mod/scorm/classes/event/sco_launched.php | 2 +- mod/wiki/classes/event/page_locks_deleted.php | 2 +- mod/wiki/classes/event/page_updated.php | 2 +- .../classes/event/submission_assessed.php | 2 +- .../classes/event/submission_created.php | 2 +- .../classes/event/submission_reassessed.php | 4 ++-- .../classes/event/submission_updated.php | 2 +- mod/workshop/classes/event/submission_viewed.php | 2 +- 32 files changed, 47 insertions(+), 47 deletions(-) diff --git a/lib/classes/event/blog_entries_viewed.php b/lib/classes/event/blog_entries_viewed.php index b94303f67cb..632b892fcdb 100644 --- a/lib/classes/event/blog_entries_viewed.php +++ b/lib/classes/event/blog_entries_viewed.php @@ -30,14 +30,14 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - int entryid: id of the entry. - * - int tagid: id of the tag. - * - int userid: id of the user. - * - int modid: id of the mod. - * - int groupid: id of the group. - * - int courseid: id of associated course. - * - string search: the string used to search. - * - int fromstart: the time to search from. + * - int entryid: (optional) id of the entry. + * - int tagid: (optional) id of the tag. + * - int userid: (optional) id of the user. + * - int modid: (optional) id of the mod. + * - int groupid: (optional) id of the group. + * - int courseid: (optional) id of associated course. + * - string search: (optional) the string used to search. + * - int fromstart: (optional) the time to search from. * } * * @package core diff --git a/lib/classes/event/course_created.php b/lib/classes/event/course_created.php index 0836ccb10fa..699dcc15785 100644 --- a/lib/classes/event/course_created.php +++ b/lib/classes/event/course_created.php @@ -32,8 +32,8 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string shortname: shortname of course. * - string fullname: fullname of course. + * - string shortname: (optional) shortname of course. * } * * @package core diff --git a/lib/classes/event/course_deleted.php b/lib/classes/event/course_deleted.php index d89aa1966f1..19641ffef42 100644 --- a/lib/classes/event/course_deleted.php +++ b/lib/classes/event/course_deleted.php @@ -32,9 +32,9 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string shortname: shortname of course. * - string fullname: fullname of course. - * - string idnumber: id number of course. + * - string shortname: (optional) shortname of course. + * - string idnumber: (optional) id number of course. * } * * @package core diff --git a/lib/classes/event/course_updated.php b/lib/classes/event/course_updated.php index e7053b298d0..a49e9c2852e 100644 --- a/lib/classes/event/course_updated.php +++ b/lib/classes/event/course_updated.php @@ -32,8 +32,8 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string shortname: shortname of course. - * - string fullname: fullname of course. + * - string shortname: (optional) shortname of course. + * - string fullname: (optional) fullname of course. * } * * @package core diff --git a/lib/classes/event/note_created.php b/lib/classes/event/note_created.php index dc303f46d6f..e6720eb8353 100644 --- a/lib/classes/event/note_created.php +++ b/lib/classes/event/note_created.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string publishstate: the publish state. + * - string publishstate: (optional) the publish state. * } * * @package core diff --git a/lib/classes/event/note_deleted.php b/lib/classes/event/note_deleted.php index 6f446051f26..0e127cad45f 100644 --- a/lib/classes/event/note_deleted.php +++ b/lib/classes/event/note_deleted.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string publishstate: the publish state. + * - string publishstate: (optional) the publish state. * } * * @package core diff --git a/lib/classes/event/note_updated.php b/lib/classes/event/note_updated.php index 08b4dcd7b10..816816b6fcb 100644 --- a/lib/classes/event/note_updated.php +++ b/lib/classes/event/note_updated.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string publishstate: the publish state. + * - string publishstate: (optional) the publish state. * } * * @package core diff --git a/lib/classes/event/role_assigned.php b/lib/classes/event/role_assigned.php index 6722959d9bf..78682dad9e8 100644 --- a/lib/classes/event/role_assigned.php +++ b/lib/classes/event/role_assigned.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * * - int id: role assigned id. * - string component: name of component. - * - int itemid: id of the item. + * - int itemid: (optional) id of the item. * } * * @package core diff --git a/lib/classes/event/role_deleted.php b/lib/classes/event/role_deleted.php index f80003de35f..9b5a2e2bd0f 100644 --- a/lib/classes/event/role_deleted.php +++ b/lib/classes/event/role_deleted.php @@ -33,8 +33,8 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - string shortname: shortname of role. - * - string description: role description. - * - string archetype: role type. + * - string description: (optional) role description. + * - string archetype: (optional) role type. * } * * @package core diff --git a/lib/classes/event/role_unassigned.php b/lib/classes/event/role_unassigned.php index 79928c31cac..bb788c2186d 100644 --- a/lib/classes/event/role_unassigned.php +++ b/lib/classes/event/role_unassigned.php @@ -35,7 +35,7 @@ defined('MOODLE_INTERNAL') || die(); * * - int id: role assigned id. * - string component: name of component. - * - int itemid: id of item. + * - int itemid: (optional) id of item. * } * * @package core diff --git a/lib/classes/event/user_graded.php b/lib/classes/event/user_graded.php index 9af099f4194..479b4ddd36c 100644 --- a/lib/classes/event/user_graded.php +++ b/lib/classes/event/user_graded.php @@ -36,8 +36,8 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about the event. * * - int itemid: grade item id. - * - bool overridden: Is this grade override? - * - float finalgrade: the final grade value. + * - bool overridden: (optional) Is this grade override? + * - float finalgrade: (optional) the final grade value. * } * * @package core diff --git a/lib/classes/event/user_list_viewed.php b/lib/classes/event/user_list_viewed.php index 09bfc9a0178..002fbfe2084 100644 --- a/lib/classes/event/user_list_viewed.php +++ b/lib/classes/event/user_list_viewed.php @@ -32,8 +32,8 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string courseshortname: the short name of course. - * - string coursefullname: the full name of course. + * - string courseshortname: (optional) the short name of course. + * - string coursefullname: (optional) the full name of course. * } * * @package core diff --git a/lib/classes/event/user_loggedout.php b/lib/classes/event/user_loggedout.php index e64d8724cfe..7131a5a38f7 100644 --- a/lib/classes/event/user_loggedout.php +++ b/lib/classes/event/user_loggedout.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string sessionid: session id. + * - string sessionid: (optional) session id. * } * * @package core diff --git a/lib/classes/event/user_profile_viewed.php b/lib/classes/event/user_profile_viewed.php index 277aa97cf85..d2541955606 100644 --- a/lib/classes/event/user_profile_viewed.php +++ b/lib/classes/event/user_profile_viewed.php @@ -32,9 +32,9 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - int courseid: id of course. - * - string courseshortname: shortname of course. - * - string coursefullname: fullname of course. + * - int courseid: (optional) id of course. + * - string courseshortname: (optional) shortname of course. + * - string coursefullname: (optional) fullname of course. * } * * @package core diff --git a/lib/classes/event/webservice_service_created.php b/lib/classes/event/webservice_service_created.php index c844c8aff89..6a64a6ee1c0 100644 --- a/lib/classes/event/webservice_service_created.php +++ b/lib/classes/event/webservice_service_created.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string sessionid: session id. + * - string sessionid: (optional) session id. * } * * @package core diff --git a/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php b/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php index 6a9989601c4..c22efa6f3a2 100644 --- a/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php +++ b/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php @@ -32,7 +32,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string format: content format. + * - string format: (optional) content format. * } * * @package assignsubmission_onlinetext diff --git a/mod/choice/classes/event/answer_submitted.php b/mod/choice/classes/event/answer_submitted.php index a1b19354bbb..c3ce232cd04 100644 --- a/mod/choice/classes/event/answer_submitted.php +++ b/mod/choice/classes/event/answer_submitted.php @@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int choiceid: id of choice. - * - int optionid: id of option. + * - int optionid: (optional) id of option. * } * * @package mod_choice diff --git a/mod/choice/classes/event/answer_updated.php b/mod/choice/classes/event/answer_updated.php index 39183229c82..e13bd903378 100644 --- a/mod/choice/classes/event/answer_updated.php +++ b/mod/choice/classes/event/answer_updated.php @@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int choiceid: id of choice. - * - int optionid: id of option. + * - int optionid: (optional) id of option. * } * * @package mod_choice diff --git a/mod/glossary/classes/event/entry_created.php b/mod/glossary/classes/event/entry_created.php index a09b577897e..e1a760b9119 100644 --- a/mod/glossary/classes/event/entry_created.php +++ b/mod/glossary/classes/event/entry_created.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string concept: the concept of created entry. + * - string concept: (optional) the concept of created entry. * } * * @package mod_glossary diff --git a/mod/glossary/classes/event/entry_deleted.php b/mod/glossary/classes/event/entry_deleted.php index e3a17999a79..76ba944f082 100644 --- a/mod/glossary/classes/event/entry_deleted.php +++ b/mod/glossary/classes/event/entry_deleted.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string concept: the concept of deleted entry. + * - string concept: (optional) the concept of deleted entry. * - string mode: (optional) view mode user was in before deleting entry. * - int|string hook: (optional) hook parameter in the previous view mode. * } diff --git a/mod/glossary/classes/event/entry_updated.php b/mod/glossary/classes/event/entry_updated.php index 312c2ae3979..2e02eeb068b 100644 --- a/mod/glossary/classes/event/entry_updated.php +++ b/mod/glossary/classes/event/entry_updated.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string concept: the concept of updated entry (after update). + * - string concept: (optional) the concept of updated entry (after update). * } * * @package mod_glossary diff --git a/mod/quiz/classes/event/attempt_abandoned.php b/mod/quiz/classes/event/attempt_abandoned.php index 6da45e0a292..6cf65708c33 100644 --- a/mod/quiz/classes/event/attempt_abandoned.php +++ b/mod/quiz/classes/event/attempt_abandoned.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int submitterid: id of submitter (null when trigged by CLI script). - * - int quizid: id of the quiz. + * - int quizid: (optional) id of the quiz. * } * * @package mod_quiz diff --git a/mod/quiz/classes/event/attempt_becameoverdue.php b/mod/quiz/classes/event/attempt_becameoverdue.php index 9b039bb6941..4d32d296fc5 100644 --- a/mod/quiz/classes/event/attempt_becameoverdue.php +++ b/mod/quiz/classes/event/attempt_becameoverdue.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int submitterid: id of submitter (null when trigged by CLI script). - * - int quizid: the id of the quiz. + * - int quizid: (optional) the id of the quiz. * } * * @package mod_quiz diff --git a/mod/quiz/classes/event/attempt_submitted.php b/mod/quiz/classes/event/attempt_submitted.php index 1177abe91c9..5bae3181d80 100644 --- a/mod/quiz/classes/event/attempt_submitted.php +++ b/mod/quiz/classes/event/attempt_submitted.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int submitterid: id of submitter (null when trigged by CLI script). - * - int quizid: the id of the quiz. + * - int quizid: (optional) the id of the quiz. * } * * @package mod_quiz diff --git a/mod/scorm/classes/event/sco_launched.php b/mod/scorm/classes/event/sco_launched.php index 30e68f75cb1..ec43916c46b 100644 --- a/mod/scorm/classes/event/sco_launched.php +++ b/mod/scorm/classes/event/sco_launched.php @@ -32,7 +32,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event properties. * * - string loadedcontent: A reference to the content loaded. - * - int instanceid: Instance id of the scorm activity. + * - int instanceid: (optional) Instance id of the scorm activity. * } * * @package mod_scorm diff --git a/mod/wiki/classes/event/page_locks_deleted.php b/mod/wiki/classes/event/page_locks_deleted.php index 8d322c975f8..d3c6c5c1beb 100644 --- a/mod/wiki/classes/event/page_locks_deleted.php +++ b/mod/wiki/classes/event/page_locks_deleted.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - int section: section id. + * - int section: (optional) section id. * } * * @package mod_wiki diff --git a/mod/wiki/classes/event/page_updated.php b/mod/wiki/classes/event/page_updated.php index 770de81f4f6..7bda98e76a2 100644 --- a/mod/wiki/classes/event/page_updated.php +++ b/mod/wiki/classes/event/page_updated.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string newcontent: updated content. + * - string newcontent: (optional) updated content. * } * * @package mod_wiki diff --git a/mod/workshop/classes/event/submission_assessed.php b/mod/workshop/classes/event/submission_assessed.php index c4740e41fa7..04c5623d606 100644 --- a/mod/workshop/classes/event/submission_assessed.php +++ b/mod/workshop/classes/event/submission_assessed.php @@ -31,8 +31,8 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * - int workshopid: Workshop ID. * - int submissionid: Submission ID. + * - int workshopid: (optional) Workshop ID. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_created.php b/mod/workshop/classes/event/submission_created.php index 2b9c85f751f..d17f05f9392 100644 --- a/mod/workshop/classes/event/submission_created.php +++ b/mod/workshop/classes/event/submission_created.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * - string submissiontitle: Submission title. + * - string submissiontitle: (optional) Submission title. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_reassessed.php b/mod/workshop/classes/event/submission_reassessed.php index 9cdd6ce9356..a4a79ee1396 100644 --- a/mod/workshop/classes/event/submission_reassessed.php +++ b/mod/workshop/classes/event/submission_reassessed.php @@ -31,9 +31,9 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * - int workshopid: Workshop ID. * - int submissionid: Submission ID. - * - float grade: Assessment grade. + * - int workshopid: (optional) Workshop ID. + * - float grade: (optional) Assessment grade. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_updated.php b/mod/workshop/classes/event/submission_updated.php index 90e5c67a859..f45741529df 100644 --- a/mod/workshop/classes/event/submission_updated.php +++ b/mod/workshop/classes/event/submission_updated.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * - string submissiontitle: Submission title. + * - string submissiontitle: (optional) Submission title. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_viewed.php b/mod/workshop/classes/event/submission_viewed.php index 9bf80941ed8..a4985688096 100644 --- a/mod/workshop/classes/event/submission_viewed.php +++ b/mod/workshop/classes/event/submission_viewed.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * - int workshopid: workshop ID. + * - int workshopid: (optional) workshop ID. * } * * @package mod_workshop