MDL-43557 events: fixed minor issues in existing events

roddle · Apr 30, 2014 · 02a5a4b · 02a5a4b
1 parent 4d9c1b5
commit 02a5a4b
Show file tree

Hide file tree

Showing 319 changed files with 2,569 additions and 1,935 deletions.
diff --git a/admin/tool/capability/classes/event/report_viewed.php b/admin/tool/capability/classes/event/report_viewed.php
@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Event for when capability report is viewed.
+ * The tool_capability report viewed event.
  *
  * @package    tool_capability
  * @copyright  2014 Petr Skoda
@@ -24,7 +24,7 @@
 namespace tool_capability\event;
 
 /**
- * Event triggered, when capability report is viewed.
+ * The tool_capability report viewed event class.
  *
  * @package    tool_capability
  * @since      Moodle 2.7
@@ -59,7 +59,7 @@ public static function get_name() {
      * @return string
      */
     public function get_description() {
-        return "The user with id " . $this->userid . " viewed capability overview report";
+        return "The user with the id '$this->userid' viewed the capability overview report.";
     }
 
     /**

diff --git a/badges/classes/observer.php b/badges/classes/observer.php
@@ -81,7 +81,7 @@ public static function course_criteria_review(\core\event\course_completed $even
             require_once($CFG->dirroot.'/lib/badgeslib.php');
 
             $eventdata = $event->get_record_snapshot('course_completions', $event->objectid);
-            $userid = $event->other['relateduserid'];
+            $userid = $event->relateduserid;
             $courseid = $event->courseid;
 
             // Need to take into account that course can be a part of course_completion and courseset_completion criteria.

diff --git a/blog/tests/bloglib_test.php b/blog/tests/bloglib_test.php
@@ -328,15 +328,15 @@ public function test_blog_association_created_event_validations() {
                 'objectid' => 3,
                 'other' => array('associateid' => 2 , 'blogid' => 3, 'subject' => 'blog subject')));
         } catch (coding_exception $e) {
-            $this->assertContains('Invalid associatetype', $e->getMessage());
+            $this->assertContains('The \'associatetype\' value must be set in other and be a valid type.', $e->getMessage());
         }
         try {
             \core\event\blog_association_created::create(array(
                 'contextid' => 1,
                 'objectid' => 3,
                 'other' => array('associateid' => 2 , 'blogid' => 3, 'associatetype' => 'random', 'subject' => 'blog subject')));
         } catch (coding_exception $e) {
-            $this->assertContains('Invalid associatetype', $e->getMessage());
+            $this->assertContains('The \'associatetype\' value must be set in other and be a valid type.', $e->getMessage());
         }
         // Make sure associateid validations work.
         try {
@@ -345,7 +345,7 @@ public function test_blog_association_created_event_validations() {
                 'objectid' => 3,
                 'other' => array('blogid' => 3, 'associatetype' => 'course', 'subject' => 'blog subject')));
         } catch (coding_exception $e) {
-            $this->assertContains('Associate id must be set', $e->getMessage());
+            $this->assertContains('The \'associateid\' value must be set in other.', $e->getMessage());
         }
         // Make sure blogid validations work.
         try {
@@ -354,7 +354,7 @@ public function test_blog_association_created_event_validations() {
                 'objectid' => 3,
                 'other' => array('associateid' => 3, 'associatetype' => 'course', 'subject' => 'blog subject')));
         } catch (coding_exception $e) {
-            $this->assertContains('Blog id must be set', $e->getMessage());
+            $this->assertContains('The \'blogid\' value must be set in other.', $e->getMessage());
         }
         // Make sure blogid validations work.
         try {
@@ -363,7 +363,7 @@ public function test_blog_association_created_event_validations() {
                 'objectid' => 3,
                 'other' => array('blogid' => 3, 'associateid' => 3, 'associatetype' => 'course')));
         } catch (coding_exception $e) {
-            $this->assertContains('Subject must be set', $e->getMessage());
+            $this->assertContains('The \'subject\' value must be set in other.', $e->getMessage());
         }
     }
 

diff --git a/calendar/tests/event_test.php → calendar/tests/events_test.php b/calendar/tests/event_test.php → calendar/tests/events_test.php
@@ -33,7 +33,7 @@
  * @copyright 2014 Ankit Agarwal <[email protected]>
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class core_calendar_event_testcase extends advanced_testcase {
+class core_calendar_events_testcase extends advanced_testcase {
 
     /**
      * The test user.
@@ -126,7 +126,7 @@ public function test_calendar_event_created_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_created to be triggered without
                     other['repeatid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['repeatid'] must be set", $e->getMessage());
+            $this->assertContains('The \'repeatid\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['name'].
@@ -142,7 +142,7 @@ public function test_calendar_event_created_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_created to be triggered without
                     other['name']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['name'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'name\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['timestart'].
@@ -158,7 +158,7 @@ public function test_calendar_event_created_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_deleted to be triggered without
                     other['timestart']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['timestart'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'timestart\' value must be set in other.', $e->getMessage());
         }
     }
 
@@ -239,7 +239,7 @@ public function test_calendar_event_updated_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_updated to be triggered without
                     other['repeatid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['repeatid'] must be set", $e->getMessage());
+            $this->assertContains('The \'repeatid\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['name'].
@@ -255,7 +255,7 @@ public function test_calendar_event_updated_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_updated to be triggered without
                     other['name']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['name'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'name\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['timestart'].
@@ -271,7 +271,7 @@ public function test_calendar_event_updated_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_deleted to be triggered without
                     other['timestart']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['timestart'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'timestart\' value must be set in other.', $e->getMessage());
         }
     }
 
@@ -351,7 +351,7 @@ public function test_calendar_event_deleted_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_deleted to be triggered without
                     other['repeatid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['repeatid'] must be set", $e->getMessage());
+            $this->assertContains('The \'repeatid\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['name'].
@@ -367,7 +367,7 @@ public function test_calendar_event_deleted_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_deleted to be triggered without
                     other['name']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['name'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'name\' value must be set in other.', $e->getMessage());
         }
 
         // Test not setting other['timestart'].
@@ -383,7 +383,7 @@ public function test_calendar_event_deleted_validations() {
             $this->fail("Event validation should not allow \\core\\event\\calendar_event_deleted to be triggered without
                     other['timestart']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['timestart'] cannot be empty", $e->getMessage());
+            $this->assertContains('The \'timestart\' value must be set in other.', $e->getMessage());
         }
     }
 }
diff --git a/completion/completion_completion.php b/completion/completion_completion.php
@@ -165,9 +165,9 @@ public function mark_complete($timecomplete = null) {
                 array(
                     'objectid' => $data->id,
                     'userid' => $USER->id,
+                    'relateduserid' => $data->userid,
                     'context' => context_course::instance($data->course),
-                    'courseid' => $data->course,
-                    'other' => array('relateduserid' => $data->userid)
+                    'courseid' => $data->course
                     )
                 );
             $event->add_record_snapshot('course_completions', $data);

diff --git a/course/tests/courselib_test.php b/course/tests/courselib_test.php
@@ -2014,7 +2014,7 @@ public function test_course_module_created_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_created to be triggered without
                     other['instanceid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['instanceid'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'instanceid' value must be set in other.", $e->getMessage());
         }
 
         // Test not setting modulename.
@@ -2031,7 +2031,7 @@ public function test_course_module_created_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_created to be triggered without
                     other['modulename']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['modulename'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'modulename' value must be set in other.", $e->getMessage());
         }
 
         // Test not setting name.
@@ -2049,7 +2049,7 @@ public function test_course_module_created_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_created to be triggered without
                     other['name']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['name'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'name' value must be set in other.", $e->getMessage());
         }
 
     }
@@ -2166,7 +2166,7 @@ public function test_course_module_updated_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_updated to be triggered without
                     other['instanceid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['instanceid'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'instanceid' value must be set in other.", $e->getMessage());
         }
 
         // Test not setting modulename.
@@ -2183,7 +2183,7 @@ public function test_course_module_updated_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_updated to be triggered without
                     other['modulename']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['modulename'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'modulename' value must be set in other.", $e->getMessage());
         }
 
         // Test not setting name.
@@ -2201,7 +2201,7 @@ public function test_course_module_updated_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_updated to be triggered without
                     other['name']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['name'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'name' value must be set in other.", $e->getMessage());
         }
 
     }
@@ -2269,7 +2269,7 @@ public function test_course_module_deleted_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_deleted to be triggered without
                     other['instanceid']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['instanceid'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'instanceid' value must be set in other.", $e->getMessage());
         }
 
         // Test not setting modulename.
@@ -2286,7 +2286,7 @@ public function test_course_module_deleted_event_exceptions() {
             $this->fail("Event validation should not allow \\core\\event\\course_module_deleted to be triggered without
                     other['modulename']");
         } catch (coding_exception $e) {
-            $this->assertContains("Field other['modulename'] cannot be empty", $e->getMessage());
+            $this->assertContains("The 'modulename' value must be set in other.", $e->getMessage());
         }
     }
 
@@ -2468,8 +2468,6 @@ public function test_view_resources_list() {
         $this->assertEquals(null, $event->objectid);
         $this->assertEquals($course->id, $event->courseid);
         $this->assertEquals($coursecontext->id, $event->contextid);
-        $expecteddesc = "User with id '$event->userid' viewed list of resources in course with id '$event->courseid'";
-        $this->assertEquals($expecteddesc, $event->get_description());
         $expectedlegacydata = array(
             array($course->id, "book", "view all", 'index.php?id=' . $course->id, ''),
             array($course->id, "page", "view all", 'index.php?id=' . $course->id, ''),

diff --git a/lib/accesslib.php b/lib/accesslib.php
@@ -1756,9 +1756,16 @@ function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0,
         reload_all_capabilities();
     }
 
-    $event = \core\event\role_assigned::create(
-        array('context'=>$context, 'objectid'=>$ra->roleid, 'relateduserid'=>$ra->userid,
-            'other'=>array('id'=>$ra->id, 'component'=>$ra->component, 'itemid'=>$ra->itemid)));
+    $event = \core\event\role_assigned::create(array(
+        'context' => $context,
+        'objectid' => $ra->roleid,
+        'relateduserid' => $ra->userid,
+        'other' => array(
+            'id' => $ra->id,
+            'component' => $ra->component,
+            'itemid' => $ra->itemid
+        )
+    ));
     $event->add_record_snapshot('role_assignments', $ra);
     $event->trigger();
 
@@ -1844,9 +1851,16 @@ function role_unassign_all(array $params, $subcontexts = false, $includemanual =
             if (!empty($USER->id) && $USER->id == $ra->userid) {
                 reload_all_capabilities();
             }
-            $event = \core\event\role_unassigned::create(
-                array('context'=>$context, 'objectid'=>$ra->roleid, 'relateduserid'=>$ra->userid,
-                    'other'=>array('id'=>$ra->id, 'component'=>$ra->component, 'itemid'=>$ra->itemid)));
+            $event = \core\event\role_unassigned::create(array(
+                'context' => $context,
+                'objectid' => $ra->roleid,
+                'relateduserid' => $ra->userid,
+                'other' => array(
+                    'id' => $ra->id,
+                    'component' => $ra->component,
+                    'itemid' => $ra->itemid
+                )
+            ));
             $event->add_record_snapshot('role_assignments', $ra);
             $event->trigger();
         }

diff --git a/lib/classes/event/assessable_submitted.php b/lib/classes/event/assessable_submitted.php
@@ -41,7 +41,7 @@
  * @copyright  2013 Frédéric Massart
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-abstract class assessable_submitted extends \core\event\base {
+abstract class assessable_submitted extends base {
 
     /**
      * Init method.

diff --git a/lib/classes/event/assessable_uploaded.php b/lib/classes/event/assessable_uploaded.php
@@ -39,16 +39,16 @@
  * @property-read array $other {
  *      Extra information about event.
  *
- *      @type array pathnamehashes uploaded files path name hashes.
- *      @type string content string.
+ *      - array pathnamehashes: uploaded files path name hashes.
+ *      - string content: the content.
  * }
  *
  * @package    core
  * @since      Moodle 2.6
  * @copyright  2013 Frédéric Massart
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-abstract class assessable_uploaded extends \core\event\base {
+abstract class assessable_uploaded extends base {
 
     /**
      * Init method.
@@ -69,11 +69,11 @@ protected function init() {
     protected function validate_data() {
         parent::validate_data();
         if ($this->contextlevel != CONTEXT_MODULE) {
-            throw new \coding_exception('Context passed must be module context.');
+            throw new \coding_exception('Context level must be CONTEXT_MODULE.');
         } else if (!isset($this->other['pathnamehashes']) || !is_array($this->other['pathnamehashes'])) {
-            throw new \coding_exception('pathnamehashes must be set in $other and must be an array.');
+            throw new \coding_exception('The \'pathnamehashes\' value must be set in other and must be an array.');
         } else if (!isset($this->other['content']) || !is_string($this->other['content'])) {
-            throw new \coding_exception('content must be set in $other and must be a string.');
+            throw new \coding_exception('The \'content\' value must be set in other and must be a string.');
         }
     }