L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-43238 events: Added event other information in event php doc block

Browse Source
This commit is contained in:
Rajesh Taneja
2014-01-03 15:03:48 +08:00
parent bbb291b7b7
commit 184afb6b73
76 changed files with 538 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/classes/event/assessable_uploaded.php
+7
View File
@@ -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
lib/classes/event/blog_association_created.php
+9
View File
@@ -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
lib/classes/event/blog_entries_viewed.php
+6
View File
@@ -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
lib/classes/event/comment_created.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/comment_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/content_viewed.php
+6
View File
@@ -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
lib/classes/event/course_category_deleted.php
+7 -1
View File
@@ -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 <[email protected]>
lib/classes/event/course_content_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/course_created.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/course_deleted.php
+8
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/course_module_created.php
+8
View File
@@ -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.
lib/classes/event/course_module_deleted.php
+7
View File
@@ -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.
lib/classes/event/course_module_updated.php
+8
View File
@@ -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.
lib/classes/event/course_reset_ended.php
+6
View File
@@ -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
lib/classes/event/course_reset_started.php
+6
View File
@@ -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
lib/classes/event/course_restored.php
+10
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/course_section_updated.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/course_updated.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/group_member_added.php
+7
View File
@@ -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
lib/classes/event/note_created.php
+6
View File
@@ -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
lib/classes/event/note_deleted.php
+6
View File
@@ -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
lib/classes/event/note_updated.php
+6
View File
@@ -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
lib/classes/event/notes_viewed.php
+6
View File
@@ -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
lib/classes/event/role_assigned.php
+8
View File
@@ -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
lib/classes/event/role_deleted.php
+8
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/role_unassigned.php
+8
View File
@@ -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
lib/classes/event/user_deleted.php
+10
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_enrolment_created.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_enrolment_deleted.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_enrolment_updated.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_list_viewed.php
+8
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_loggedin.php
+6
View File
@@ -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
lib/classes/event/user_loggedinas.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_loggedout.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/user_profile_viewed.php
+8
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
lib/classes/event/webservice_function_called.php
+6
View File
@@ -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
lib/classes/event/webservice_login_failed.php
+8
View File
@@ -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
lib/classes/event/webservice_service_created.php
+6
View File
@@ -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
lib/classes/event/webservice_token_created.php
+6
View File
@@ -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
mod/assign/classes/event/assessable_submitted.php
+6
View File
@@ -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
mod/assign/classes/event/marker_updated.php
+6
View File
@@ -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
mod/assign/classes/event/submission_status_updated.php
+6
View File
@@ -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
mod/assign/classes/event/workflow_state_updated.php
+6
View File
@@ -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
mod/assign/submission/file/classes/event/assessable_uploaded.php
+7
View File
@@ -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
mod/assign/submission/onlinetext/classes/event/assessable_uploaded.php
+20
View File
@@ -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.');
}
}
}
mod/assignment/type/online/classes/event/assessable_uploaded.php
+8
View File
@@ -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
mod/assignment/type/upload/classes/event/assessable_submitted.php
+10
View File
@@ -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.');
}
}
}
mod/assignment/type/upload/classes/event/assessable_uploaded.php
+8
View File
@@ -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
mod/chat/classes/event/sessions_viewed.php
+7
View File
@@ -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
mod/choice/classes/event/answer_submitted.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/choice/classes/event/answer_updated.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/choice/classes/event/report_viewed.php
+6
View File
@@ -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
mod/feedback/classes/event/course_module_viewed.php
+7
View File
@@ -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
mod/feedback/classes/event/response_deleted.php
+8
View File
@@ -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.
mod/feedback/classes/event/response_submitted.php
+8
View File
@@ -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.
mod/forum/classes/event/assessable_uploaded.php
+9
View File
@@ -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
mod/lti/classes/event/unknown_service_api_called.php
+10
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/quiz/classes/event/attempt_abandoned.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/quiz/classes/event/attempt_becameoverdue.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/quiz/classes/event/attempt_submitted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/comment_created.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/comment_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_diff_viewed.php
+7
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_locks_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_map_viewed.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_updated.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_version_deleted.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_version_restored.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/wiki/classes/event/page_version_viewed.php
+6
View File
@@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
mod/workshop/classes/event/assessable_uploaded.php
+7
View File
@@ -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
report/log/classes/event/content_viewed.php
+7
View File
@@ -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
report/loglive/classes/event/content_viewed.php
+7
View File
@@ -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
report/outline/classes/event/content_viewed.php
+7
View File
@@ -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
report/participation/classes/event/content_viewed.php
+7
View File
@@ -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
report/stats/classes/event/content_viewed.php
+7
View File
@@ -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