MDL-45445 events: added '(optional)' to event params where applicable
authorMark Nelson <markn@moodle.com>
Sat, 10 May 2014 23:07:56 +0000 (16:07 -0700)
committerMark Nelson <markn@moodle.com>
Fri, 13 Jun 2014 03:46:58 +0000 (20:46 -0700)
32 files changed:
lib/classes/event/blog_entries_viewed.php
lib/classes/event/course_created.php
lib/classes/event/course_deleted.php
lib/classes/event/course_updated.php
lib/classes/event/note_created.php
lib/classes/event/note_deleted.php
lib/classes/event/note_updated.php
lib/classes/event/role_assigned.php
lib/classes/event/role_deleted.php
lib/classes/event/role_unassigned.php
lib/classes/event/user_graded.php
lib/classes/event/user_list_viewed.php
lib/classes/event/user_loggedout.php
lib/classes/event/user_profile_viewed.php
lib/classes/event/webservice_service_created.php
mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php
mod/choice/classes/event/answer_submitted.php
mod/choice/classes/event/answer_updated.php
mod/glossary/classes/event/entry_created.php
mod/glossary/classes/event/entry_deleted.php
mod/glossary/classes/event/entry_updated.php
mod/quiz/classes/event/attempt_abandoned.php
mod/quiz/classes/event/attempt_becameoverdue.php
mod/quiz/classes/event/attempt_submitted.php
mod/scorm/classes/event/sco_launched.php
mod/wiki/classes/event/page_locks_deleted.php
mod/wiki/classes/event/page_updated.php
mod/workshop/classes/event/submission_assessed.php
mod/workshop/classes/event/submission_created.php
mod/workshop/classes/event/submission_reassessed.php
mod/workshop/classes/event/submission_updated.php
mod/workshop/classes/event/submission_viewed.php

index b94303f..632b892 100644 (file)
@@ -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
index 0836ccb..699dcc1 100644 (file)
@@ -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
index d89aa19..19641ff 100644 (file)
@@ -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
index e7053b2..a49e9c2 100644 (file)
@@ -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
index dc303f4..e6720eb 100644 (file)
@@ -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
index 6f44605..0e127ca 100644 (file)
@@ -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
index 08b4dcd..816816b 100644 (file)
@@ -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
index 6722959..78682da 100644 (file)
@@ -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
index f80003d..9b5a2e2 100644 (file)
@@ -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
index 79928c3..bb788c2 100644 (file)
@@ -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
index 9af099f..479b4dd 100644 (file)
@@ -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
index 09bfc9a..002fbfe 100644 (file)
@@ -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
index e64d872..7131a5a 100644 (file)
@@ -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
index 277aa97..d254195 100644 (file)
@@ -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
index c844c8a..6a64a6e 100644 (file)
@@ -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
index c186471..aae666b 100644 (file)
@@ -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
index 3ef4025..905c17a 100644 (file)
@@ -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
index cad67ef..a5b04cd 100644 (file)
@@ -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
index 4942c88..98387f8 100644 (file)
@@ -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
index 1cef820..f116600 100644 (file)
@@ -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.
  * }
index 9554c99..ea831fd 100644 (file)
@@ -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
index 02e5ac3..08e5607 100644 (file)
@@ -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
index 412ec19..5318048 100644 (file)
@@ -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
index 5de691e..b64a967 100644 (file)
@@ -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
index d3acb1c..62c0de8 100644 (file)
@@ -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
index 6295699..991c8e4 100644 (file)
@@ -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
index f6491bb..ab792b4 100644 (file)
@@ -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
index 57ccf64..94dda70 100644 (file)
@@ -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
index 97564c5..928eb56 100644 (file)
@@ -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
index c66a8fc..30b5967 100644 (file)
@@ -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
index 8275ded..cb727fb 100644 (file)
@@ -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
index ffe6013..eac6cae 100644 (file)
@@ -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