MDL-45445 events: trivial changes

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

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

lib/classes/event/course_user_report_viewed.php

@@ -41,7 +41,7 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright  2014 Adrian Greeve <[email protected]>
  * @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.

lib/classes/event/course_viewed.php

@@ -41,7 +41,7 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright  2014 Adrian Greeve <[email protected]>
  * @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.

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 <[email protected]>

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 <[email protected]>

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() {

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.

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() {

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

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.
  * }
  *

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.');
         }
     }
-
 }

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';
     }
-
 }

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';
     }
-
 }

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;
-    }
-
 }

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.');
         }
     }
-
 }

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.');
         }
     }
-
 }

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';
     }
-
 }

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.');
         }
     }
 }

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.');
         }
     }
 }

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.');
         }
     }
 }

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

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.');
         }
     }
 }

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

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

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

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

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

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

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

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

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

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

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

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