diff --git a/lib/classes/event/blog_entries_viewed.php b/lib/classes/event/blog_entries_viewed.php index 117d0a47c7f..b94303f67cb 100644 --- a/lib/classes/event/blog_entries_viewed.php +++ b/lib/classes/event/blog_entries_viewed.php @@ -30,7 +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. * } * * @package core diff --git a/lib/classes/event/content_viewed.php b/lib/classes/event/content_viewed.php index d083cbab36f..18231bf91b8 100644 --- a/lib/classes/event/content_viewed.php +++ b/lib/classes/event/content_viewed.php @@ -36,6 +36,12 @@ debugging('core\event\content_viewed has been deprecated. Please extend base eve * * This class has been deprecated, please extend base event or other relevent abstract class. * + * @property-read array $other { + * Extra information about the event. + * + * - string content: name of the content viewed. + * } + * * @package core * @since Moodle 2.6 * @copyright 2013 Ankit Agarwal diff --git a/lib/classes/event/course_user_report_viewed.php b/lib/classes/event/course_user_report_viewed.php index c465a03e207..1e55e562afb 100644 --- a/lib/classes/event/course_user_report_viewed.php +++ b/lib/classes/event/course_user_report_viewed.php @@ -41,7 +41,7 @@ defined('MOODLE_INTERNAL') || die(); * @copyright 2014 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class course_user_report_viewed extends \core\event\base { +class course_user_report_viewed extends base { /** * Init method. diff --git a/lib/classes/event/course_viewed.php b/lib/classes/event/course_viewed.php index 7148cde7578..1af160a04e8 100644 --- a/lib/classes/event/course_viewed.php +++ b/lib/classes/event/course_viewed.php @@ -41,7 +41,7 @@ defined('MOODLE_INTERNAL') || die(); * @copyright 2014 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class course_viewed extends \core\event\base { +class course_viewed extends base { /** * Init method. diff --git a/lib/classes/event/mnet_access_control_created.php b/lib/classes/event/mnet_access_control_created.php index 90ae3eae06c..1725ddd8222 100644 --- a/lib/classes/event/mnet_access_control_created.php +++ b/lib/classes/event/mnet_access_control_created.php @@ -30,6 +30,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Mnet access control created event class. * + * @property-read array $other { + * Extra information about event. + * + * - string username: the username of the user. + * - string hostname: the name of the host the user came from. + * - string accessctrl: the access control value. + * } + * * @package core * @since Moodle 2.7 * @copyright 2013 Mark Nelson diff --git a/lib/classes/event/mnet_access_control_updated.php b/lib/classes/event/mnet_access_control_updated.php index e42398569c8..cc8b8752351 100644 --- a/lib/classes/event/mnet_access_control_updated.php +++ b/lib/classes/event/mnet_access_control_updated.php @@ -30,6 +30,14 @@ defined('MOODLE_INTERNAL') || die(); /** * Mnet access control updated event class. * + * @property-read array $other { + * Extra information about event. + * + * - string username: the username of the user. + * - string hostname: the name of the host the user came from. + * - string accessctrl: the access control value. + * } + * * @package core * @since Moodle 2.7 * @copyright 2013 Mark Nelson diff --git a/lib/classes/event/notes_viewed.php b/lib/classes/event/notes_viewed.php index b3c4ce6766f..ccbbc5d2148 100644 --- a/lib/classes/event/notes_viewed.php +++ b/lib/classes/event/notes_viewed.php @@ -70,6 +70,7 @@ class notes_viewed extends base { /** * Returns relevant URL. + * * @return \moodle_url */ public function get_url() { diff --git a/lib/classes/event/recent_activity_viewed.php b/lib/classes/event/recent_activity_viewed.php index b70c0f615ae..17fd3bb9896 100644 --- a/lib/classes/event/recent_activity_viewed.php +++ b/lib/classes/event/recent_activity_viewed.php @@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die(); * @copyright 2014 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class recent_activity_viewed extends \core\event\base { +class recent_activity_viewed extends base { /** * Init method. diff --git a/lib/classes/event/user_graded.php b/lib/classes/event/user_graded.php index 2deb07790b0..157b90b4e0e 100644 --- a/lib/classes/event/user_graded.php +++ b/lib/classes/event/user_graded.php @@ -72,6 +72,7 @@ class user_graded extends base { /** * Get grade object. * + * @throws \coding_exception * @return \grade_grade */ public function get_grade() { diff --git a/lib/classes/event/user_login_failed.php b/lib/classes/event/user_login_failed.php index 3186d25b7a5..cc1d1a2b2af 100644 --- a/lib/classes/event/user_login_failed.php +++ b/lib/classes/event/user_login_failed.php @@ -32,8 +32,8 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string username name of user. - * - int reason failure reason. + * - string username: name of user. + * - int reason: failure reason. * } * * @package core diff --git a/lib/classes/event/user_profile_viewed.php b/lib/classes/event/user_profile_viewed.php index ec11331546b..d120303ce8b 100644 --- a/lib/classes/event/user_profile_viewed.php +++ b/lib/classes/event/user_profile_viewed.php @@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die(); * Extra information about event. * * - int courseid: id of course. - * - string courseshortname: short name of course. + * - string courseshortname: shortname of course. * - string coursefullname: fullname of course. * } * diff --git a/lib/classes/event/webservice_function_called.php b/lib/classes/event/webservice_function_called.php index 64ac2beed62..b1bde22dbc3 100644 --- a/lib/classes/event/webservice_function_called.php +++ b/lib/classes/event/webservice_function_called.php @@ -105,5 +105,4 @@ class webservice_function_called extends base { throw new \coding_exception('The \'function\' value must be set in other.'); } } - } diff --git a/lib/classes/event/webservice_service_created.php b/lib/classes/event/webservice_service_created.php index f6d27f566df..c844c8aff89 100644 --- a/lib/classes/event/webservice_service_created.php +++ b/lib/classes/event/webservice_service_created.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string: sessionid session id. + * - string sessionid: session id. * } * * @package core @@ -91,5 +91,4 @@ class webservice_service_created extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'external_services'; } - } diff --git a/lib/classes/event/webservice_service_deleted.php b/lib/classes/event/webservice_service_deleted.php index 56e40beb3ce..120dc708a0a 100644 --- a/lib/classes/event/webservice_service_deleted.php +++ b/lib/classes/event/webservice_service_deleted.php @@ -85,5 +85,4 @@ class webservice_service_deleted extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'external_services'; } - } diff --git a/lib/classes/event/webservice_service_updated.php b/lib/classes/event/webservice_service_updated.php index e278b481058..a84f4fc20b1 100644 --- a/lib/classes/event/webservice_service_updated.php +++ b/lib/classes/event/webservice_service_updated.php @@ -85,14 +85,4 @@ class webservice_service_updated extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'external_services'; } - - /** - * Set the legacy event log data. - * - * @return void - */ - public function set_legacy_logdata($legacylogdata) { - $this->legacylogdata = $legacylogdata; - } - } diff --git a/lib/classes/event/webservice_service_user_added.php b/lib/classes/event/webservice_service_user_added.php index 9a3f3e68843..2d423782ec6 100644 --- a/lib/classes/event/webservice_service_user_added.php +++ b/lib/classes/event/webservice_service_user_added.php @@ -98,5 +98,4 @@ class webservice_service_user_added extends base { throw new \coding_exception('The \'relateduserid\' must be set.'); } } - } diff --git a/lib/classes/event/webservice_service_user_removed.php b/lib/classes/event/webservice_service_user_removed.php index c2248d82d94..50ae27c472b 100644 --- a/lib/classes/event/webservice_service_user_removed.php +++ b/lib/classes/event/webservice_service_user_removed.php @@ -98,5 +98,4 @@ class webservice_service_user_removed extends base { throw new \coding_exception('The \'relateduserid\' must be set.'); } } - } diff --git a/lib/classes/event/webservice_token_sent.php b/lib/classes/event/webservice_token_sent.php index d73d1824a49..f9d9f21c3e6 100644 --- a/lib/classes/event/webservice_token_sent.php +++ b/lib/classes/event/webservice_token_sent.php @@ -73,5 +73,4 @@ class webservice_token_sent extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'external_tokens'; } - } diff --git a/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php b/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php index d76411fded1..34913303588 100644 --- a/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php +++ b/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php @@ -119,7 +119,7 @@ class reveal_identities_confirmation_page_viewed extends base { parent::validate_data(); if (!isset($this->other['assignid'])) { - throw new \coding_exception('The \'assignid\' must be set in other.'); + throw new \coding_exception('The \'assignid\' value must be set in other.'); } } } diff --git a/mod/assign/classes/event/submission_confirmation_form_viewed.php b/mod/assign/classes/event/submission_confirmation_form_viewed.php index 43980de7ea5..833d2801b0a 100644 --- a/mod/assign/classes/event/submission_confirmation_form_viewed.php +++ b/mod/assign/classes/event/submission_confirmation_form_viewed.php @@ -120,7 +120,7 @@ class submission_confirmation_form_viewed extends base { parent::validate_data(); if (!isset($this->other['assignid'])) { - throw new \coding_exception('The \'assignid\' must be set in other.'); + throw new \coding_exception('The \'assignid\' value must be set in other.'); } } } diff --git a/mod/assign/classes/event/submission_status_viewed.php b/mod/assign/classes/event/submission_status_viewed.php index ce3ea152fae..898042d04c6 100644 --- a/mod/assign/classes/event/submission_status_viewed.php +++ b/mod/assign/classes/event/submission_status_viewed.php @@ -121,7 +121,7 @@ class submission_status_viewed extends base { parent::validate_data(); if (!isset($this->other['assignid'])) { - throw new \coding_exception('The \'assignid\' must be set in other.'); + throw new \coding_exception('The \'assignid\' value must be set in other.'); } } } diff --git a/mod/assign/classes/event/workflow_state_updated.php b/mod/assign/classes/event/workflow_state_updated.php index e7585994484..cfba9dbb1e8 100644 --- a/mod/assign/classes/event/workflow_state_updated.php +++ b/mod/assign/classes/event/workflow_state_updated.php @@ -32,7 +32,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about event. * - * - string newstatus: status of submission. + * - string newstate: state of submission. * } * * @package mod_assign diff --git a/mod/assign/submission/onlinetext/classes/event/submission_updated.php b/mod/assign/submission/onlinetext/classes/event/submission_updated.php index fbde4ac0687..356d3a66514 100644 --- a/mod/assign/submission/onlinetext/classes/event/submission_updated.php +++ b/mod/assign/submission/onlinetext/classes/event/submission_updated.php @@ -77,7 +77,7 @@ class submission_updated extends \mod_assign\event\submission_updated { protected function validate_data() { parent::validate_data(); if (!isset($this->other['onlinetextwordcount'])) { - throw new \coding_exception('Other must contain the key onlinetextwordcount.'); + throw new \coding_exception('The \'onlinetextwordcount\' value must be set in other.'); } } } diff --git a/mod/workshop/classes/event/assessable_uploaded.php b/mod/workshop/classes/event/assessable_uploaded.php index c0b3610ed39..861f92de9ed 100644 --- a/mod/workshop/classes/event/assessable_uploaded.php +++ b/mod/workshop/classes/event/assessable_uploaded.php @@ -29,13 +29,6 @@ defined('MOODLE_INTERNAL') || die(); /** * The mod_workshop assessable uploaded event class. * - * @property-read array $other { - * Extra information about event. - * - * - array pathnamehashes: uploaded files path name hashes. - * - string content: string. - * } - * * @package mod_workshop * @since Moodle 2.6 * @copyright 2013 Frédéric Massart diff --git a/mod/workshop/classes/event/assessment_evaluated.php b/mod/workshop/classes/event/assessment_evaluated.php index 61bf086510a..a865b738239 100644 --- a/mod/workshop/classes/event/assessment_evaluated.php +++ b/mod/workshop/classes/event/assessment_evaluated.php @@ -29,10 +29,10 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop assessment evaluated event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - string currentgrade: (could be null) current saved grade. - * - string finalgrade: (could be null) final grade. + * - string currentgrade: (may be null) current saved grade. + * - string finalgrade: (may be null) final grade. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/assessment_evaluations_reset.php b/mod/workshop/classes/event/assessment_evaluations_reset.php index eebc2740b40..6a68335a23b 100644 --- a/mod/workshop/classes/event/assessment_evaluations_reset.php +++ b/mod/workshop/classes/event/assessment_evaluations_reset.php @@ -30,9 +30,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop assessment_evaluations reset event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopid: the ID of the workshop. + * - int workshopid: the ID of the workshop. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/assessment_reevaluated.php b/mod/workshop/classes/event/assessment_reevaluated.php index e3c599afd0d..1e401c473f2 100644 --- a/mod/workshop/classes/event/assessment_reevaluated.php +++ b/mod/workshop/classes/event/assessment_reevaluated.php @@ -29,10 +29,10 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop assessment_reevaluated event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - float currentgrade: (may be null) current saved grade. - * - float finalgrade: (may be null) final grade. + * - float currentgrade: (may be null) current saved grade. + * - float finalgrade: (may be null) final grade. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/assessments_reset.php b/mod/workshop/classes/event/assessments_reset.php index 1c0bc14a0bc..c3b89928d35 100644 --- a/mod/workshop/classes/event/assessments_reset.php +++ b/mod/workshop/classes/event/assessments_reset.php @@ -29,9 +29,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission assessments reset event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopid: the ID of the workshop. + * - int workshopid: the ID of the workshop. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/phase_switched.php b/mod/workshop/classes/event/phase_switched.php index 7786d4ea08a..0d4d3b34389 100644 --- a/mod/workshop/classes/event/phase_switched.php +++ b/mod/workshop/classes/event/phase_switched.php @@ -29,9 +29,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop phase switched event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopphase: Workshop phase. + * - int workshopphase: Workshop phase. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_assessed.php b/mod/workshop/classes/event/submission_assessed.php index 2c5e7c3f2bd..d878233eb0d 100644 --- a/mod/workshop/classes/event/submission_assessed.php +++ b/mod/workshop/classes/event/submission_assessed.php @@ -29,10 +29,10 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission assessed event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopid: Workshop ID. - * - int submissionid: Submission ID. + * - int workshopid: Workshop ID. + * - int submissionid: Submission ID. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_created.php b/mod/workshop/classes/event/submission_created.php index 6fdff423af8..97564c5553f 100644 --- a/mod/workshop/classes/event/submission_created.php +++ b/mod/workshop/classes/event/submission_created.php @@ -29,9 +29,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission created event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - string submissiontitle: Submission title. + * - string submissiontitle: Submission title. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_reassessed.php b/mod/workshop/classes/event/submission_reassessed.php index c7f34bb83c5..5d4393d9283 100644 --- a/mod/workshop/classes/event/submission_reassessed.php +++ b/mod/workshop/classes/event/submission_reassessed.php @@ -29,11 +29,11 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission reassessed event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopid: Workshop ID. - * - int submissionid: Submission ID. - * - float grade: Assessment grade. + * - int workshopid: Workshop ID. + * - int submissionid: Submission ID. + * - float grade: Assessment grade. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_updated.php b/mod/workshop/classes/event/submission_updated.php index 909e7aed655..8275ded6731 100644 --- a/mod/workshop/classes/event/submission_updated.php +++ b/mod/workshop/classes/event/submission_updated.php @@ -29,9 +29,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission updated event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - string submissiontitle: Submission title. + * - string submissiontitle: Submission title. * } * * @package mod_workshop diff --git a/mod/workshop/classes/event/submission_viewed.php b/mod/workshop/classes/event/submission_viewed.php index 3f2dc7cb259..5c2e3126241 100644 --- a/mod/workshop/classes/event/submission_viewed.php +++ b/mod/workshop/classes/event/submission_viewed.php @@ -29,9 +29,9 @@ defined('MOODLE_INTERNAL') || die(); * The mod_workshop submission viewed event class. * * @property-read array $other { - * Extra information about the event. + * Extra information about the event. * - * - int workshopid: workshop ID. + * - int workshopid: workshop ID. * } * * @package mod_workshop diff --git a/report/questioninstances/classes/event/report_viewed.php b/report/questioninstances/classes/event/report_viewed.php index c001a539d64..5e79da8f724 100644 --- a/report/questioninstances/classes/event/report_viewed.php +++ b/report/questioninstances/classes/event/report_viewed.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @property-read array $other { * Extra information about the event. * - * -string requestedqtype: Requested question type. + * - string requestedqtype: Requested question type. * } * * @package report_questioninstances