From 184afb6b7307feec9ba3829f93cdf7791bb0eb09 Mon Sep 17 00:00:00 2001 From: Rajesh Taneja Date: Fri, 3 Jan 2014 15:03:48 +0800 Subject: [PATCH] MDL-43238 events: Added event other information in event php doc block --- lib/classes/event/assessable_uploaded.php | 7 +++++++ .../event/blog_association_created.php | 9 +++++++++ lib/classes/event/blog_entries_viewed.php | 6 ++++++ lib/classes/event/comment_created.php | 6 ++++++ lib/classes/event/comment_deleted.php | 6 ++++++ lib/classes/event/content_viewed.php | 6 ++++++ lib/classes/event/course_category_deleted.php | 8 +++++++- lib/classes/event/course_content_deleted.php | 6 ++++++ lib/classes/event/course_created.php | 7 +++++++ lib/classes/event/course_deleted.php | 8 ++++++++ lib/classes/event/course_module_created.php | 8 ++++++++ lib/classes/event/course_module_deleted.php | 7 +++++++ lib/classes/event/course_module_updated.php | 8 ++++++++ lib/classes/event/course_reset_ended.php | 6 ++++++ lib/classes/event/course_reset_started.php | 6 ++++++ lib/classes/event/course_restored.php | 10 ++++++++++ lib/classes/event/course_section_updated.php | 6 ++++++ lib/classes/event/course_updated.php | 7 +++++++ lib/classes/event/group_member_added.php | 7 +++++++ lib/classes/event/note_created.php | 6 ++++++ lib/classes/event/note_deleted.php | 6 ++++++ lib/classes/event/note_updated.php | 6 ++++++ lib/classes/event/notes_viewed.php | 6 ++++++ lib/classes/event/role_assigned.php | 8 ++++++++ lib/classes/event/role_deleted.php | 8 ++++++++ lib/classes/event/role_unassigned.php | 8 ++++++++ lib/classes/event/user_deleted.php | 10 ++++++++++ lib/classes/event/user_enrolment_created.php | 6 ++++++ lib/classes/event/user_enrolment_deleted.php | 7 +++++++ lib/classes/event/user_enrolment_updated.php | 6 ++++++ lib/classes/event/user_list_viewed.php | 8 ++++++++ lib/classes/event/user_loggedin.php | 6 ++++++ lib/classes/event/user_loggedinas.php | 7 +++++++ lib/classes/event/user_loggedout.php | 6 ++++++ lib/classes/event/user_profile_viewed.php | 8 ++++++++ .../event/webservice_function_called.php | 6 ++++++ lib/classes/event/webservice_login_failed.php | 8 ++++++++ .../event/webservice_service_created.php | 6 ++++++ .../event/webservice_token_created.php | 6 ++++++ .../classes/event/assessable_submitted.php | 6 ++++++ mod/assign/classes/event/marker_updated.php | 6 ++++++ .../event/submission_status_updated.php | 6 ++++++ .../classes/event/workflow_state_updated.php | 6 ++++++ .../classes/event/assessable_uploaded.php | 7 +++++++ .../classes/event/assessable_uploaded.php | 20 +++++++++++++++++++ .../classes/event/assessable_uploaded.php | 8 ++++++++ .../classes/event/assessable_submitted.php | 10 ++++++++++ .../classes/event/assessable_uploaded.php | 8 ++++++++ mod/chat/classes/event/sessions_viewed.php | 7 +++++++ mod/choice/classes/event/answer_submitted.php | 7 +++++++ mod/choice/classes/event/answer_updated.php | 7 +++++++ mod/choice/classes/event/report_viewed.php | 6 ++++++ .../classes/event/course_module_viewed.php | 7 +++++++ .../classes/event/response_deleted.php | 8 ++++++++ .../classes/event/response_submitted.php | 8 ++++++++ .../classes/event/assessable_uploaded.php | 9 +++++++++ .../event/unknown_service_api_called.php | 10 ++++++++++ mod/quiz/classes/event/attempt_abandoned.php | 6 ++++++ .../classes/event/attempt_becameoverdue.php | 6 ++++++ mod/quiz/classes/event/attempt_submitted.php | 6 ++++++ mod/wiki/classes/event/comment_created.php | 6 ++++++ mod/wiki/classes/event/comment_deleted.php | 6 ++++++ mod/wiki/classes/event/page_deleted.php | 6 ++++++ mod/wiki/classes/event/page_diff_viewed.php | 7 +++++++ mod/wiki/classes/event/page_locks_deleted.php | 6 ++++++ mod/wiki/classes/event/page_map_viewed.php | 6 ++++++ mod/wiki/classes/event/page_updated.php | 6 ++++++ .../classes/event/page_version_deleted.php | 6 ++++++ .../classes/event/page_version_restored.php | 6 ++++++ .../classes/event/page_version_viewed.php | 6 ++++++ .../classes/event/assessable_uploaded.php | 7 +++++++ report/log/classes/event/content_viewed.php | 7 +++++++ .../loglive/classes/event/content_viewed.php | 7 +++++++ .../outline/classes/event/content_viewed.php | 7 +++++++ .../classes/event/content_viewed.php | 7 +++++++ report/stats/classes/event/content_viewed.php | 7 +++++++ 76 files changed, 538 insertions(+), 1 deletion(-) diff --git a/lib/classes/event/assessable_uploaded.php b/lib/classes/event/assessable_uploaded.php index 4e4ed8d346e..46aa825a1c5 100644 --- a/lib/classes/event/assessable_uploaded.php +++ b/lib/classes/event/assessable_uploaded.php @@ -36,6 +36,13 @@ defined('MOODLE_INTERNAL') || die(); * * Both events could be triggered in a row, first the uploaded, then the submitted. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content string. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/blog_association_created.php b/lib/classes/event/blog_association_created.php index 5670f52c1f6..0e7da1c9e20 100644 --- a/lib/classes/event/blog_association_created.php +++ b/lib/classes/event/blog_association_created.php @@ -29,6 +29,15 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a new blog entry is associated with a context. * + * @property-read array $other { + * Extra information about event. + * + * @type string associatetype type of blog association, course/coursemodule. + * @type int blogid id of blog. + * @type int associateid id of associate. + * @type string subject blog subject. + * } + * * @package core * @copyright 2013 onwards Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/blog_entries_viewed.php b/lib/classes/event/blog_entries_viewed.php index bf4dbafa066..d0119faaf03 100644 --- a/lib/classes/event/blog_entries_viewed.php +++ b/lib/classes/event/blog_entries_viewed.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when blog entries are viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type int courseid id of associated course. + * } + * * @package core * @copyright 2013 onwards Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/comment_created.php b/lib/classes/event/comment_created.php index abee52e0e93..cebf7c54087 100644 --- a/lib/classes/event/comment_created.php +++ b/lib/classes/event/comment_created.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * This class has to be extended by any event which is triggred while creating new comment. * + * @property-read array $other { + * Extra information about event. + * + * @type int itemid id of item for which comment is added. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/comment_deleted.php b/lib/classes/event/comment_deleted.php index f6a20040c39..69c43c6e76e 100644 --- a/lib/classes/event/comment_deleted.php +++ b/lib/classes/event/comment_deleted.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * This class has to be extended by any event which is triggred while deleting comment. * + * @property-read array $other { + * Extra information about event. + * + * @type int itemid id of item for which comment is deleted. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/content_viewed.php b/lib/classes/event/content_viewed.php index 7492bd124bb..17f032808b2 100644 --- a/lib/classes/event/content_viewed.php +++ b/lib/classes/event/content_viewed.php @@ -39,6 +39,12 @@ defined('MOODLE_INTERNAL') || die(); * $event->trigger(); * where \report_participation\event\content_viewed extends \core\event\content_viewed * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_category_deleted.php b/lib/classes/event/course_category_deleted.php index ff7ecf38369..a856ef134e1 100644 --- a/lib/classes/event/course_category_deleted.php +++ b/lib/classes/event/course_category_deleted.php @@ -19,7 +19,13 @@ namespace core\event; defined('MOODLE_INTERNAL') || die(); /** - * category deleted event. + * Category deleted event. + * + * @property-read array $other { + * Extra information about event. + * + * @type string name category name. + * } * * @package core * @copyright 2013 Mark Nelson diff --git a/lib/classes/event/course_content_deleted.php b/lib/classes/event/course_content_deleted.php index 92fc9a61a37..d5b6624a900 100644 --- a/lib/classes/event/course_content_deleted.php +++ b/lib/classes/event/course_content_deleted.php @@ -21,6 +21,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Course content_deleted event. * + * @property-read array $other { + * Extra information about event. + * + * @type array options list of options which were skipped while deleting course content. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_created.php b/lib/classes/event/course_created.php index deeacb4b678..57eb640570c 100644 --- a/lib/classes/event/course_created.php +++ b/lib/classes/event/course_created.php @@ -21,6 +21,13 @@ defined('MOODLE_INTERNAL') || die(); /** * Course created event. * + * @property-read array $other { + * Extra information about event. + * + * @type string shortname shortname of course. + * @type string fullname fullname of course. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_deleted.php b/lib/classes/event/course_deleted.php index 0f704a77b53..0580e7c5eed 100644 --- a/lib/classes/event/course_deleted.php +++ b/lib/classes/event/course_deleted.php @@ -21,6 +21,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Course deleted event. * + * @property-read array $other { + * Extra information about event. + * + * @type string shortname shortname of course. + * @type string fullname fullname of course. + * @type string idnumber id number of course. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_module_created.php b/lib/classes/event/course_module_created.php index 9ed6fc88c28..2c481a8f64f 100644 --- a/lib/classes/event/course_module_created.php +++ b/lib/classes/event/course_module_created.php @@ -17,6 +17,14 @@ /** * Event to be triggered when a new course module is created. * + * @property-read array $other { + * Extra information about event. + * + * @type string modulename name of module created. + * @type string name title of module. + * @type string instanceid id of module instance. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. diff --git a/lib/classes/event/course_module_deleted.php b/lib/classes/event/course_module_deleted.php index 67a4b020e40..d00a43a140b 100644 --- a/lib/classes/event/course_module_deleted.php +++ b/lib/classes/event/course_module_deleted.php @@ -30,6 +30,13 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a course module is deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type string modulename name of module deleted. + * @type string instanceid id of module instance. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. diff --git a/lib/classes/event/course_module_updated.php b/lib/classes/event/course_module_updated.php index ced42109742..99e61f80a46 100644 --- a/lib/classes/event/course_module_updated.php +++ b/lib/classes/event/course_module_updated.php @@ -30,6 +30,14 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a course module is updated. * + * @property-read array $other { + * Extra information about event. + * + * @type string modulename name of module updated. + * @type string name title of module. + * @type string instanceid id of module instance. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. diff --git a/lib/classes/event/course_reset_ended.php b/lib/classes/event/course_reset_ended.php index 56e10091225..5c8f280b357 100644 --- a/lib/classes/event/course_reset_ended.php +++ b/lib/classes/event/course_reset_ended.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * core course reset ended event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array reset_options all reset options settings including courseid. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_reset_started.php b/lib/classes/event/course_reset_started.php index 8a34a75e073..f28d6de39d4 100644 --- a/lib/classes/event/course_reset_started.php +++ b/lib/classes/event/course_reset_started.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * core course reset started event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array reset_options all reset options settings including courseid. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_restored.php b/lib/classes/event/course_restored.php index 2f8fa4f831f..8e7af36651b 100644 --- a/lib/classes/event/course_restored.php +++ b/lib/classes/event/course_restored.php @@ -21,6 +21,16 @@ defined('MOODLE_INTERNAL') || die(); /** * Course restored event. * + * @property-read array $other { + * Extra information about event. + * + * @type string type restore type, activity, course or section. + * @type int target where restored (new/existing/current/adding/deleting) + * @type int mode execution mode + * @type string opertaion restore + * @type boolean samesite true is restored to same site. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_section_updated.php b/lib/classes/event/course_section_updated.php index 5a7d9e06a65..60760e596b1 100644 --- a/lib/classes/event/course_section_updated.php +++ b/lib/classes/event/course_section_updated.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Course section updated. * + * @property-read array $other { + * Extra information about event. + * + * @type int sectionnum section number. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/course_updated.php b/lib/classes/event/course_updated.php index c037d20b13e..47ab3affda5 100644 --- a/lib/classes/event/course_updated.php +++ b/lib/classes/event/course_updated.php @@ -21,6 +21,13 @@ defined('MOODLE_INTERNAL') || die(); /** * Course updated event. * + * @property-read array $other { + * Extra information about event. + * + * @type string shortname shortname of course. + * @type string fullname fullname of course. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/group_member_added.php b/lib/classes/event/group_member_added.php index df1c2d1f3fc..6855e155712 100644 --- a/lib/classes/event/group_member_added.php +++ b/lib/classes/event/group_member_added.php @@ -28,6 +28,13 @@ defined('MOODLE_INTERNAL') || die(); /** * core_group member added event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string component name of component + * @type int itemid id of item. + * } + * * @package core_group * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/note_created.php b/lib/classes/event/note_created.php index 838ba8c4429..e3ce2abafcb 100644 --- a/lib/classes/event/note_created.php +++ b/lib/classes/event/note_created.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a note is created. * + * @property-read array $other { + * Extra information about event. + * + * @type string publishstate publish state. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/note_deleted.php b/lib/classes/event/note_deleted.php index 45249fe6258..52f9182d9d7 100644 --- a/lib/classes/event/note_deleted.php +++ b/lib/classes/event/note_deleted.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a note is deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type string publishstate publish state + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/note_updated.php b/lib/classes/event/note_updated.php index df3ac78c21c..fb94617c2d8 100644 --- a/lib/classes/event/note_updated.php +++ b/lib/classes/event/note_updated.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a note is updated. * + * @property-read array $other { + * Extra information about event. + * + * @type string publishstate publish state. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/notes_viewed.php b/lib/classes/event/notes_viewed.php index 3680fc45fde..a2981061e4b 100644 --- a/lib/classes/event/notes_viewed.php +++ b/lib/classes/event/notes_viewed.php @@ -31,6 +31,12 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a note is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content hard-coded to notes. + * } + * * @package core * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/role_assigned.php b/lib/classes/event/role_assigned.php index 5213900392f..f22fd163152 100644 --- a/lib/classes/event/role_assigned.php +++ b/lib/classes/event/role_assigned.php @@ -21,6 +21,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Role assigned event. * + * @property-read array $other { + * Extra information about event. + * + * @type int id role assigned id. + * @type string component name of component. + * @type int itemid id of item. + * } + * * @package core * @copyright 2013 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/role_deleted.php b/lib/classes/event/role_deleted.php index d11dab86265..ae150c8f6b6 100644 --- a/lib/classes/event/role_deleted.php +++ b/lib/classes/event/role_deleted.php @@ -21,6 +21,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Role assigned event. * + * @property-read array $other { + * Extra information about event. + * + * @type string shortname shortname of role. + * @type string description role description. + * @type string archetype role type. + * } + * * @package core_event * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/role_unassigned.php b/lib/classes/event/role_unassigned.php index 2e5a9866708..f3d0850a9e7 100644 --- a/lib/classes/event/role_unassigned.php +++ b/lib/classes/event/role_unassigned.php @@ -21,6 +21,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Role unassigned event. * + * @property-read array $other { + * Extra information about event. + * + * @type int id role assigned id. + * @type string component name of component. + * @type int itemid id of item. + * } + * * @package core * @copyright 2013 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_deleted.php b/lib/classes/event/user_deleted.php index e04ee16975f..fdc68c8743d 100644 --- a/lib/classes/event/user_deleted.php +++ b/lib/classes/event/user_deleted.php @@ -28,6 +28,16 @@ defined('MOODLE_INTERNAL') || die(); /** * Event when user profile is deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type string username name of user. + * @type string email user email. + * @type string idnumber user idnumber. + * @type string picture user picture. + * @type int mnethostid mnet host id. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_enrolment_created.php b/lib/classes/event/user_enrolment_created.php index 064ccf5032c..c5e0d0ee863 100644 --- a/lib/classes/event/user_enrolment_created.php +++ b/lib/classes/event/user_enrolment_created.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event when user is enrolled in a course. * + * @property-read array $other { + * Extra information about event. + * + * @type string enrol name of enrolment instance. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_enrolment_deleted.php b/lib/classes/event/user_enrolment_deleted.php index 89923477cfa..4376a2b7efb 100644 --- a/lib/classes/event/user_enrolment_deleted.php +++ b/lib/classes/event/user_enrolment_deleted.php @@ -17,6 +17,13 @@ /** * User enrolment deleted event. * + * @property-read array $other { + * Extra information about event. + * + * @type string enrol name of enrolment instance. + * @type array userenrolment user_enrolment record. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_enrolment_updated.php b/lib/classes/event/user_enrolment_updated.php index 8e53236e3e7..69e71dea9b2 100644 --- a/lib/classes/event/user_enrolment_updated.php +++ b/lib/classes/event/user_enrolment_updated.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event when user enrolment is updated. * + * @property-read array $other { + * Extra information about event. + * + * @type string enrol name of enrolment instance. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_list_viewed.php b/lib/classes/event/user_list_viewed.php index 45aa787c802..fce1f0d8794 100644 --- a/lib/classes/event/user_list_viewed.php +++ b/lib/classes/event/user_list_viewed.php @@ -17,6 +17,14 @@ /** * Defines the user list viewed event. * + * @property-read array $other { + * Extra information about event. + * + * @type int courseid id of course. + * @type string courseshortname short name of course. + * @type string coursefullname full name of course. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_loggedin.php b/lib/classes/event/user_loggedin.php index 9628e311f8e..0bb4e17f936 100644 --- a/lib/classes/event/user_loggedin.php +++ b/lib/classes/event/user_loggedin.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * User login event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string username name of user. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_loggedinas.php b/lib/classes/event/user_loggedinas.php index 50012d8cffb..136307dc3d5 100644 --- a/lib/classes/event/user_loggedinas.php +++ b/lib/classes/event/user_loggedinas.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * User loggedinas event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string originalusername original username. + * @type string loggedinasusername username of logged in as user. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_loggedout.php b/lib/classes/event/user_loggedout.php index 8f2c6aacfdd..d17f0bf1fe9 100644 --- a/lib/classes/event/user_loggedout.php +++ b/lib/classes/event/user_loggedout.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event when user logout. * + * @property-read array $other { + * Extra information about event. + * + * @type string sessionid session id. + * } + * * @package core * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/user_profile_viewed.php b/lib/classes/event/user_profile_viewed.php index af9f22878f6..eefc9bf5e48 100644 --- a/lib/classes/event/user_profile_viewed.php +++ b/lib/classes/event/user_profile_viewed.php @@ -17,6 +17,14 @@ /** * Defines the user profile viewed event. * + * @property-read array $other { + * Extra information about event. + * + * @type int courseid id of course. + * @type string courseshortname short name of course. + * @type string coursefullname fullname of course. + * } + * * @package core * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/webservice_function_called.php b/lib/classes/event/webservice_function_called.php index 99143857fcd..1334784617b 100644 --- a/lib/classes/event/webservice_function_called.php +++ b/lib/classes/event/webservice_function_called.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * core webservice function_called event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string function name of the function. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/webservice_login_failed.php b/lib/classes/event/webservice_login_failed.php index 395e91bca3d..9ababb062ba 100644 --- a/lib/classes/event/webservice_login_failed.php +++ b/lib/classes/event/webservice_login_failed.php @@ -28,6 +28,14 @@ defined('MOODLE_INTERNAL') || die(); /** * core web service login_failed event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string method authentication method. + * @type string reason failure reason. + * @type string tokenid id of token. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/webservice_service_created.php b/lib/classes/event/webservice_service_created.php index 436a23614da..22fd29c4010 100644 --- a/lib/classes/event/webservice_service_created.php +++ b/lib/classes/event/webservice_service_created.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * core webservice service created event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string sessionid session id. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/classes/event/webservice_token_created.php b/lib/classes/event/webservice_token_created.php index 5f18336b64d..d5799e0b1d9 100644 --- a/lib/classes/event/webservice_token_created.php +++ b/lib/classes/event/webservice_token_created.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * core webservice token_created event class. * + * @property-read array $other { + * Extra information about event. + * + * @type bool auto automatically created. + * } + * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/classes/event/assessable_submitted.php b/mod/assign/classes/event/assessable_submitted.php index 7c67ad9373b..5e7d6e8ded1 100644 --- a/mod/assign/classes/event/assessable_submitted.php +++ b/mod/assign/classes/event/assessable_submitted.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_assign assessable submitted event class. * + * @property-read array $other { + * Extra information about event. + * + * @type bool submission_editable is submission editable. + * } + * * @package mod_assign * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/classes/event/marker_updated.php b/mod/assign/classes/event/marker_updated.php index 2596e9b7347..616005d83d9 100644 --- a/mod/assign/classes/event/marker_updated.php +++ b/mod/assign/classes/event/marker_updated.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_assign marker updated event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int markerid userid id of marker. + * } + * * @package mod_assign * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/classes/event/submission_status_updated.php b/mod/assign/classes/event/submission_status_updated.php index 731be58b8ff..32be18b196d 100644 --- a/mod/assign/classes/event/submission_status_updated.php +++ b/mod/assign/classes/event/submission_status_updated.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_assign submission status updated event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string newstatus status of submission. + * } + * * @package mod_assign * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/classes/event/workflow_state_updated.php b/mod/assign/classes/event/workflow_state_updated.php index 00c78124750..6ccdf0d4fd7 100644 --- a/mod/assign/classes/event/workflow_state_updated.php +++ b/mod/assign/classes/event/workflow_state_updated.php @@ -29,6 +29,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_assign workflow state updated event class. * + * @property-read array $other { + * Extra information about event. + * + * @type string newstatus status of submission. + * } + * * @package mod_assign * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/submission/file/classes/event/assessable_uploaded.php b/mod/assign/submission/file/classes/event/assessable_uploaded.php index 0f2ccc7a6ef..b32eb00d9dc 100644 --- a/mod/assign/submission/file/classes/event/assessable_uploaded.php +++ b/mod/assign/submission/file/classes/event/assessable_uploaded.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * assignsubmission_file assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hash. + * @type string content empty string. + * } + * * @package assignsubmission_file * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php b/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php index 179319e71e9..07a6b35df3e 100644 --- a/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php +++ b/mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php @@ -29,6 +29,14 @@ defined('MOODLE_INTERNAL') || die(); /** * assignsubmission_onlinetext assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content string. + * @type string format content format. + * } + * * @package assignsubmission_onlinetext * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later @@ -100,4 +108,16 @@ class assessable_uploaded extends \core\event\assessable_uploaded { $this->data['objecttable'] = 'assign_submission'; } + /** + * Validation that should be shared among child classes. + * + * @throws \coding_exception when validation fails. + * @return void + */ + protected function validate_data() { + parent::validate_data(); + if (!isset($this->other['format']) || !is_string($this->other['format'])) { + throw new \coding_exception('format must be set in $other and must be a string.'); + } + } } diff --git a/mod/assignment/type/online/classes/event/assessable_uploaded.php b/mod/assignment/type/online/classes/event/assessable_uploaded.php index d1659b0e4ed..1a9c8a3cceb 100644 --- a/mod/assignment/type/online/classes/event/assessable_uploaded.php +++ b/mod/assignment/type/online/classes/event/assessable_uploaded.php @@ -29,6 +29,14 @@ defined('MOODLE_INTERNAL') || die(); /** * assignment_online assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content submission text. + * @type string triggeredfrom name of the function from which it is triggred. + * } + * * @package assignment_online * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/assignment/type/upload/classes/event/assessable_submitted.php b/mod/assignment/type/upload/classes/event/assessable_submitted.php index 5a0f2c57752..5318d4affbd 100644 --- a/mod/assignment/type/upload/classes/event/assessable_submitted.php +++ b/mod/assignment/type/upload/classes/event/assessable_submitted.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * assignment_submitted assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int assignmentid assignment id. + * @type bool submission_editable is submission editable. + * } + * * @package assignment_submitted * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later @@ -117,5 +124,8 @@ class assessable_submitted extends \core\event\assessable_submitted { if (!isset($this->other['submission_editable'])) { throw new \coding_exception('Other must contain the key submission_editable.'); } + if (!isset($this->other['assignmentid'])) { + throw new \coding_exception('Other must contain the key assignmentid.'); + } } } diff --git a/mod/assignment/type/upload/classes/event/assessable_uploaded.php b/mod/assignment/type/upload/classes/event/assessable_uploaded.php index 697456b1235..1d3a7761edb 100644 --- a/mod/assignment/type/upload/classes/event/assessable_uploaded.php +++ b/mod/assignment/type/upload/classes/event/assessable_uploaded.php @@ -29,6 +29,14 @@ defined('MOODLE_INTERNAL') || die(); /** * assignment_upload assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content empty string. + * @type int assignmentid assignment id. + * } + * * @package assignment_upload * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/chat/classes/event/sessions_viewed.php b/mod/chat/classes/event/sessions_viewed.php index e18562ba4b4..766ac9a6659 100644 --- a/mod/chat/classes/event/sessions_viewed.php +++ b/mod/chat/classes/event/sessions_viewed.php @@ -28,6 +28,13 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_chat sessions viewed event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int start start of period. + * @type int end end of period. + * } + * * @package mod_chat * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/choice/classes/event/answer_submitted.php b/mod/choice/classes/event/answer_submitted.php index 2b3e673d192..999a96998e4 100644 --- a/mod/choice/classes/event/answer_submitted.php +++ b/mod/choice/classes/event/answer_submitted.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_choice answer submitted event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int choiceid id of choice. + * @type int optionid id of option + * } + * * @package mod_choice * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/choice/classes/event/answer_updated.php b/mod/choice/classes/event/answer_updated.php index be548b7a5d4..eb0a276dac1 100644 --- a/mod/choice/classes/event/answer_updated.php +++ b/mod/choice/classes/event/answer_updated.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_choice answer updated event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int choiceid id of choice. + * @type int optionid id of option + * } + * * @package mod_choice * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/choice/classes/event/report_viewed.php b/mod/choice/classes/event/report_viewed.php index 88299eacb65..acf1394e994 100644 --- a/mod/choice/classes/event/report_viewed.php +++ b/mod/choice/classes/event/report_viewed.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event for when a choice activity report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * } + * * @package mod_choice * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/feedback/classes/event/course_module_viewed.php b/mod/feedback/classes/event/course_module_viewed.php index 637a3ed1991..bbe47c03517 100644 --- a/mod/feedback/classes/event/course_module_viewed.php +++ b/mod/feedback/classes/event/course_module_viewed.php @@ -28,6 +28,13 @@ defined('MOODLE_INTERNAL') || die(); /** * Event for when a feedback activity is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type int anonymous if feedback is anonymous. + * @type int cmid course module id. + * } + * * @package mod_feedback * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/feedback/classes/event/response_deleted.php b/mod/feedback/classes/event/response_deleted.php index 49bee251413..be00b5e80f8 100644 --- a/mod/feedback/classes/event/response_deleted.php +++ b/mod/feedback/classes/event/response_deleted.php @@ -30,6 +30,14 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a feedback response is deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type int anonymous if feedback is anonymous. + * @type int cmid course module id. + * @type int instanceid id of instance. + * } + * * @package mod_feedback * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. diff --git a/mod/feedback/classes/event/response_submitted.php b/mod/feedback/classes/event/response_submitted.php index 74abca974de..600fd2759f7 100644 --- a/mod/feedback/classes/event/response_submitted.php +++ b/mod/feedback/classes/event/response_submitted.php @@ -30,6 +30,14 @@ defined('MOODLE_INTERNAL') || die(); * * Class for event to be triggered when a feedback response is submitted. * + * @property-read array $other { + * Extra information about event. + * + * @type int anonymous if feedback is anonymous. + * @type int cmid course module id. + * @type int instanceid id of instance. + * } + * * @package mod_feedback * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. diff --git a/mod/forum/classes/event/assessable_uploaded.php b/mod/forum/classes/event/assessable_uploaded.php index db25779a266..5cbfd3c9230 100644 --- a/mod/forum/classes/event/assessable_uploaded.php +++ b/mod/forum/classes/event/assessable_uploaded.php @@ -29,6 +29,15 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_forum assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content post discussion message. + * @type int discussionid id of discussion. + * @type string triggeredfrom name of the function from where event is triggred. + * } + * * @package mod_forum * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/lti/classes/event/unknown_service_api_called.php b/mod/lti/classes/event/unknown_service_api_called.php index dad8f78bdb6..9e6dff770f8 100644 --- a/mod/lti/classes/event/unknown_service_api_called.php +++ b/mod/lti/classes/event/unknown_service_api_called.php @@ -28,6 +28,16 @@ defined('MOODLE_INTERNAL') || die(); /** * Event for when something happens with an unknown lti service API call. * + * @property-read array $other { + * Extra information about event. + * + * @type string body raw body. + * @type string messageid id of message. + * @type string messagetype type of message. + * @type string consumerkey key of consumer. + * @type string sharedsecret shared secret key. + * } + * * @package mod_lti * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/quiz/classes/event/attempt_abandoned.php b/mod/quiz/classes/event/attempt_abandoned.php index 5b6f439abdc..eacdd70af7d 100644 --- a/mod/quiz/classes/event/attempt_abandoned.php +++ b/mod/quiz/classes/event/attempt_abandoned.php @@ -27,6 +27,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event for when a quiz attempt is abandoned. * + * @property-read array $other { + * Extra information about event. + * + * @type int submitterid id of submitter. + * } + * * @package mod_quiz * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/quiz/classes/event/attempt_becameoverdue.php b/mod/quiz/classes/event/attempt_becameoverdue.php index e6ca398f09b..ad8a0870a84 100644 --- a/mod/quiz/classes/event/attempt_becameoverdue.php +++ b/mod/quiz/classes/event/attempt_becameoverdue.php @@ -30,6 +30,12 @@ defined('MOODLE_INTERNAL') || die(); * Please note that the name of this event is not following the event naming convention. * Its name should not be used as a reference for other events to be created. * + * @property-read array $other { + * Extra information about event. + * + * @type int submitterid id of submitter. + * } + * * @package mod_quiz * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/quiz/classes/event/attempt_submitted.php b/mod/quiz/classes/event/attempt_submitted.php index 83d54f571f5..476ca3c3ef1 100644 --- a/mod/quiz/classes/event/attempt_submitted.php +++ b/mod/quiz/classes/event/attempt_submitted.php @@ -27,6 +27,12 @@ defined('MOODLE_INTERNAL') || die(); /** * Event for when a quiz attempt is submitted. * + * @property-read array $other { + * Extra information about event. + * + * @type int submitterid id of submitter. + * } + * * @package mod_quiz * @copyright 2013 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/comment_created.php b/mod/wiki/classes/event/comment_created.php index bbc4a583d28..904039afcd9 100644 --- a/mod/wiki/classes/event/comment_created.php +++ b/mod/wiki/classes/event/comment_created.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki comment created event. * + * @property-read array $other { + * Extra information about event. + * + * @type int itemid id of item for which comment is created. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/comment_deleted.php b/mod/wiki/classes/event/comment_deleted.php index 1e3c757e2eb..48ab63782e7 100644 --- a/mod/wiki/classes/event/comment_deleted.php +++ b/mod/wiki/classes/event/comment_deleted.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki comment deleted event. * + * @property-read array $other { + * Extra information about event. + * + * @type int itemid id of item for which comment is deleted. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_deleted.php b/mod/wiki/classes/event/page_deleted.php index 44432e02bbb..b129f3718a5 100644 --- a/mod/wiki/classes/event/page_deleted.php +++ b/mod/wiki/classes/event/page_deleted.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki page deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type int subwikiid id subwiki. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_diff_viewed.php b/mod/wiki/classes/event/page_diff_viewed.php index 487ae03be2d..a1d69a84a23 100644 --- a/mod/wiki/classes/event/page_diff_viewed.php +++ b/mod/wiki/classes/event/page_diff_viewed.php @@ -28,6 +28,13 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki diff viewed event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int comparewith version number to compare with. + * @type int compare version number to compare. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_locks_deleted.php b/mod/wiki/classes/event/page_locks_deleted.php index b7cead27f20..5aee13b82e9 100644 --- a/mod/wiki/classes/event/page_locks_deleted.php +++ b/mod/wiki/classes/event/page_locks_deleted.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki page locks deleted (override locks) * + * @property-read array $other { + * Extra information about event. + * + * @type int section section id. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_map_viewed.php b/mod/wiki/classes/event/page_map_viewed.php index 251b7c2aa6a..8b94fd496b4 100644 --- a/mod/wiki/classes/event/page_map_viewed.php +++ b/mod/wiki/classes/event/page_map_viewed.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki map viewed event class. * + * @property-read array $other { + * Extra information about event. + * + * @type int option map option viewed. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_updated.php b/mod/wiki/classes/event/page_updated.php index 2c9737fdfac..e39aa3438d8 100644 --- a/mod/wiki/classes/event/page_updated.php +++ b/mod/wiki/classes/event/page_updated.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki page updated. * + * @property-read array $other { + * Extra information about event. + * + * @type string newcontent updated content. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_version_deleted.php b/mod/wiki/classes/event/page_version_deleted.php index dc0b6ce4114..622d8e15a45 100644 --- a/mod/wiki/classes/event/page_version_deleted.php +++ b/mod/wiki/classes/event/page_version_deleted.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki page version deleted. * + * @property-read array $other { + * Extra information about event. + * + * @type int pageid id wiki page. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_version_restored.php b/mod/wiki/classes/event/page_version_restored.php index 435e009c284..601c6353f1f 100644 --- a/mod/wiki/classes/event/page_version_restored.php +++ b/mod/wiki/classes/event/page_version_restored.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki version restored event. * + * @property-read array $other { + * Extra information about event. + * + * @type int pageid id wiki page. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/wiki/classes/event/page_version_viewed.php b/mod/wiki/classes/event/page_version_viewed.php index 8239c43f1d9..c641933db80 100644 --- a/mod/wiki/classes/event/page_version_viewed.php +++ b/mod/wiki/classes/event/page_version_viewed.php @@ -28,6 +28,12 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_wiki version viewed event. * + * @property-read array $other { + * Extra information about event. + * + * @type int versionid id page version. + * } + * * @package mod_wiki * @copyright 2013 Rajesh Taneja * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/mod/workshop/classes/event/assessable_uploaded.php b/mod/workshop/classes/event/assessable_uploaded.php index a1c3f53867d..bef08cdc6eb 100644 --- a/mod/workshop/classes/event/assessable_uploaded.php +++ b/mod/workshop/classes/event/assessable_uploaded.php @@ -29,6 +29,13 @@ defined('MOODLE_INTERNAL') || die(); /** * mod_workshop assessable uploaded event class. * + * @property-read array $other { + * Extra information about event. + * + * @type array pathnamehashes uploaded files path name hashes. + * @type string content string. + * } + * * @package mod_workshop * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/report/log/classes/event/content_viewed.php b/report/log/classes/event/content_viewed.php index a5a0510a7cb..b6d677e8a05 100644 --- a/report/log/classes/event/content_viewed.php +++ b/report/log/classes/event/content_viewed.php @@ -26,6 +26,13 @@ namespace report_log\event; /** * Event triggered, when some content in log report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * @type string url (optional) url of report page. + * } + * * @package report_log * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/report/loglive/classes/event/content_viewed.php b/report/loglive/classes/event/content_viewed.php index 10383225dbd..8dea5b2999e 100644 --- a/report/loglive/classes/event/content_viewed.php +++ b/report/loglive/classes/event/content_viewed.php @@ -26,6 +26,13 @@ namespace report_loglive\event; /** * Event triggered, when some content in loglive report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * @type string url (optional) url of report page. + * } + * * @package report_loglive * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/report/outline/classes/event/content_viewed.php b/report/outline/classes/event/content_viewed.php index 97f1b0d3f62..8ae161893b6 100644 --- a/report/outline/classes/event/content_viewed.php +++ b/report/outline/classes/event/content_viewed.php @@ -26,6 +26,13 @@ namespace report_outline\event; /** * Event for when some content in outline report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * @type string url (optional) url of report page. + * } + * * @package report_outline * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/report/participation/classes/event/content_viewed.php b/report/participation/classes/event/content_viewed.php index 17026285322..5918f574c74 100644 --- a/report/participation/classes/event/content_viewed.php +++ b/report/participation/classes/event/content_viewed.php @@ -26,6 +26,13 @@ namespace report_participation\event; /** * Event triggered, when some content in participation report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * @type string url (optional) url of report page. + * } + * * @package report_participation * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/report/stats/classes/event/content_viewed.php b/report/stats/classes/event/content_viewed.php index e29544c3b77..836cde892a2 100644 --- a/report/stats/classes/event/content_viewed.php +++ b/report/stats/classes/event/content_viewed.php @@ -26,6 +26,13 @@ namespace report_stats\event; /** * Event triggered, when some content in stats report is viewed. * + * @property-read array $other { + * Extra information about event. + * + * @type string content viewed content identifier. + * @type string url (optional) url of report page. + * } + * * @package report_stats * @copyright 2013 Ankit Agarwal * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later