Skip to content

Commit

Permalink
MDL-44717 events: Fix multiple issues in events
Browse files Browse the repository at this point in the history
Fix various incorrect urls
Fix incorrect phpdocs and other minor code style issues
Fix missing/incorrect strings

AMOS BEGIN
 MOV [eventblogassociationcreated, core_blog],[eventblogassociationadded, core_blog]
AMOS END
  • Loading branch information
ankitagarwal committed Apr 1, 2014
1 parent 85a4b8a commit b63f773
Show file tree
Hide file tree
Showing 66 changed files with 234 additions and 50 deletions.
7 changes: 7 additions & 0 deletions blog/tests/bloglib_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,8 @@ public function test_blog_entry_created_event() {

// Validate event data.
$this->assertInstanceOf('\core\event\blog_entry_created', $event);
$url = new moodle_url('/blog/index.php', array('entryid' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($sitecontext->id, $event->contextid);
$this->assertEquals($blog->id, $event->objectid);
$this->assertEquals($USER->id, $event->userid);
Expand Down Expand Up @@ -207,6 +209,8 @@ public function test_blog_entry_updated_event() {

// Validate event data.
$this->assertInstanceOf('\core\event\blog_entry_updated', $event);
$url = new moodle_url('/blog/index.php', array('entryid' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($sitecontext->id, $event->contextid);
$this->assertEquals($blog->id, $event->objectid);
$this->assertEquals($USER->id, $event->userid);
Expand Down Expand Up @@ -240,6 +244,7 @@ public function test_blog_entry_deleted_event() {

// Validate event data.
$this->assertInstanceOf('\core\event\blog_entry_deleted', $event);
$this->assertEquals(null, $event->get_url());
$this->assertEquals($sitecontext->id, $event->contextid);
$this->assertEquals($blog->id, $event->objectid);
$this->assertEquals($USER->id, $event->userid);
Expand Down Expand Up @@ -278,6 +283,8 @@ public function test_blog_association_created_event() {
// Validate event data.
$this->assertInstanceOf('\core\event\blog_association_created', $event);
$this->assertEquals($sitecontext->id, $event->contextid);
$url = new moodle_url('/blog/index.php', array('entryid' => $event->other['blogid']));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($blog->id, $event->other['blogid']);
$this->assertEquals($this->courseid, $event->other['associateid']);
$this->assertEquals('course', $event->other['associatetype']);
Expand Down
10 changes: 10 additions & 0 deletions cohort/tests/cohortlib_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ public function test_cohort_add_cohort_event() {
$this->assertEquals('cohort', $event->objecttable);
$this->assertEquals($id, $event->objectid);
$this->assertEquals($cohort->contextid, $event->contextid);
$url = new moodle_url('/cohort/index.php', array('contextid' => $event->contextid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($cohort, $event->get_record_snapshot('cohort', $id));
$this->assertEventLegacyData($cohort, $event);
$this->assertEventContextNotUsed($event);
Expand Down Expand Up @@ -175,6 +177,8 @@ public function test_cohort_update_cohort_event() {
$this->assertEquals('cohort', $event->objecttable);
$this->assertEquals($updatedcohort->id, $event->objectid);
$this->assertEquals($updatedcohort->contextid, $event->contextid);
$url = new moodle_url('/cohort/edit.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($cohort, $event->get_record_snapshot('cohort', $id));
$this->assertEventLegacyData($cohort, $event);
$this->assertEventContextNotUsed($event);
Expand Down Expand Up @@ -213,6 +217,8 @@ public function test_cohort_delete_cohort_event() {
$this->assertInstanceOf('\core\event\cohort_deleted', $event);
$this->assertEquals('cohort', $event->objecttable);
$this->assertEquals($cohort->id, $event->objectid);
$url = new moodle_url('/cohort/index.php', array('contextid' => $event->contextid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($cohort, $event->get_record_snapshot('cohort', $cohort->id));
$this->assertEventLegacyData($cohort, $event);
$this->assertEventContextNotUsed($event);
Expand Down Expand Up @@ -272,6 +278,8 @@ public function test_cohort_add_member_event() {
$this->assertEquals($cohort->id, $event->objectid);
$this->assertEquals($user->id, $event->relateduserid);
$this->assertEquals($USER->id, $event->userid);
$url = new moodle_url('/cohort/assign.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEventLegacyData((object) array('cohortid' => $cohort->id, 'userid' => $user->id), $event);
$this->assertEventContextNotUsed($event);
}
Expand Down Expand Up @@ -316,6 +324,8 @@ public function test_cohort_remove_member_event() {
$this->assertEquals($cohort->id, $event->objectid);
$this->assertEquals($user->id, $event->relateduserid);
$this->assertEquals($USER->id, $event->userid);
$url = new moodle_url('/cohort/assign.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEventLegacyData((object) array('cohortid' => $cohort->id, 'userid' => $user->id), $event);
$this->assertEventContextNotUsed($event);
}
Expand Down
7 changes: 7 additions & 0 deletions course/tests/courselib_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -1496,6 +1496,8 @@ public function test_course_updated_event() {
$this->assertEquals('course', $event->objecttable);
$this->assertEquals($updatedcourse->id, $event->objectid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$url = new moodle_url('/course/edit.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($updatedcourse, $event->get_record_snapshot('course', $event->objectid));
$this->assertEquals('course_updated', $event->get_legacy_eventname());
$this->assertEventLegacyData($updatedcourse, $event);
Expand Down Expand Up @@ -1666,6 +1668,7 @@ public function test_course_category_deleted_event() {
$this->assertEquals($category->id, $event->objectid);
$this->assertEquals($categorycontext->id, $event->contextid);
$this->assertEquals('course_category_deleted', $event->get_legacy_eventname());
$this->assertEquals(null, $event->get_url());
$this->assertEventLegacyData($category, $event);
$expectedlog = array(SITEID, 'category', 'delete', 'index.php', $category->name . '(ID ' . $category->id . ')');
$this->assertEventLegacyLogData($expectedlog, $event);
Expand Down Expand Up @@ -1762,6 +1765,8 @@ public function test_course_restored_event() {
'operation' => $rc->get_operation(),
'samesite' => $rc->is_samesite()
);
$url = new moodle_url('/course/view.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEventLegacyData($legacydata, $event);
$this->assertEventContextNotUsed($event);

Expand Down Expand Up @@ -1813,6 +1818,8 @@ public function test_course_section_updated_event() {
$this->assertEquals($coursecontext->id, $event->contextid);
$expecteddesc = 'Course ' . $event->courseid . ' section ' . $event->other['sectionnum'] . ' updated by user ' . $event->userid;
$this->assertEquals($expecteddesc, $event->get_description());
$url = new moodle_url('/course/editsection.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEquals($section, $event->get_record_snapshot('course_sections', $event->objectid));
$id = $section->id;
$sectionnum = $section->section;
Expand Down
2 changes: 2 additions & 0 deletions enrol/meta/tests/plugin_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,8 @@ public function test_user_enrolment_updated_observer() {
$expectedlegacyeventdata = $dbuserenrolled;
$expectedlegacyeventdata->enrol = 'meta';
$expectedlegacyeventdata->courseid = $course2->id;
$url = new \moodle_url('/enrol/editenrolment.php', array('ue' => $event->objectid));
$this->assertEquals($url, $event->get_url());
$this->assertEventLegacyData($expectedlegacyeventdata, $event);
$this->assertEventContextNotUsed($event);
}
Expand Down
16 changes: 16 additions & 0 deletions group/tests/lib_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ public function test_member_added_event() {
$this->assertEquals($user->id, $event->relateduserid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/members.php', array('group' => $event->objectid));
$this->assertEquals($url, $event->get_url());
}

public function test_member_removed_event() {
Expand Down Expand Up @@ -89,6 +91,8 @@ public function test_member_removed_event() {
$this->assertEquals($user->id, $event->relateduserid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/members.php', array('group' => $event->objectid));
$this->assertEquals($url, $event->get_url());
}

public function test_group_created_event() {
Expand All @@ -108,6 +112,8 @@ public function test_group_created_event() {
$this->assertSame('groups_group_created', $event->get_legacy_eventname());
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/index.php', array('id' => $event->courseid));
$this->assertEquals($url, $event->get_url());
}

public function test_grouping_created_event() {
Expand All @@ -129,6 +135,8 @@ public function test_grouping_created_event() {

$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/groupings.php', array('id' => $event->courseid));
$this->assertEquals($url, $event->get_url());
}

public function test_group_updated_event() {
Expand Down Expand Up @@ -158,6 +166,8 @@ public function test_group_updated_event() {
$this->assertSame('groups_group_updated', $event->get_legacy_eventname());
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/group.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
}

public function test_grouping_updated_event() {
Expand Down Expand Up @@ -196,6 +206,8 @@ public function test_grouping_updated_event() {

$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($grouping->id, $event->objectid);
$url = new moodle_url('/group/grouping.php', array('id' => $event->objectid));
$this->assertEquals($url, $event->get_url());
}

public function test_group_deleted_event() {
Expand All @@ -215,6 +227,8 @@ public function test_group_deleted_event() {
$this->assertSame('groups_group_deleted', $event->get_legacy_eventname());
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/index.php', array('id' => $event->courseid));
$this->assertEquals($url, $event->get_url());
}

public function test_grouping_deleted_event() {
Expand All @@ -234,6 +248,8 @@ public function test_grouping_deleted_event() {
$this->assertSame('groups_grouping_deleted', $event->get_legacy_eventname());
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($group->id, $event->objectid);
$url = new moodle_url('/group/groupings.php', array('id' => $event->courseid));
$this->assertEquals($url, $event->get_url());
}

public function test_groups_delete_group_members() {
Expand Down
2 changes: 1 addition & 1 deletion lang/en/blog.php
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
$string['entrysaved'] = 'Your entry has been saved';
$string['entrytitle'] = 'Entry title';
$string['eventblogentriesviewed'] = 'Blog entries viewed';
$string['eventblogassociationcreated'] = 'Blog association created';
$string['eventblogassociationadded'] = 'Blog association created';
$string['evententryadded'] = 'Blog entry added';
$string['evententrydeleted'] = 'Blog entry deleted';
$string['evententryupdated'] = 'Blog entry updated';
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/blog_association_created.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public function get_description() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid, 'userid' => $this->userid));
return new \moodle_url('/blog/index.php', array('entryid' => $this->other['blogid']));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/blog_entry_created.php
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public function get_description() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid, 'userid' => $this->userid));
return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/blog_entry_updated.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ public function get_description() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid, 'userid' => $this->userid));
return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/cohort_deleted.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ protected function init() {
* @return string
*/
public static function get_name() {
return get_string('event_core_deleted', 'core_cohort');
return get_string('event_cohort_deleted', 'core_cohort');
}

/**
Expand Down
9 changes: 9 additions & 0 deletions lib/classes/event/course_category_created.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ public static function get_name() {
return get_string('eventcoursecategorycreated');
}

/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/course/management.php', array('categoryid' => $this->objectid));
}

/**
* Returns non-localised description of what happened.
*
Expand Down
9 changes: 9 additions & 0 deletions lib/classes/event/course_category_updated.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ public static function get_name() {
return get_string('eventcoursecategoryupdated');
}

/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/course/editcategory.php', array('id' => $this->objectid));
}

/**
* Returns non-localised description of what happened.
*
Expand Down
4 changes: 2 additions & 2 deletions lib/classes/event/course_module_instance_list_viewed.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
*/
abstract class course_module_instance_list_viewed extends base{

/** @var string private var to store mod name */
private $modname;
/** @var string protected var to store mod name */
protected $modname;

/**
* Init method.
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/course_updated.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public function get_description() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/course/view.php', array('id' => $this->objectid));
return new \moodle_url('/course/edit.php', array('id' => $this->objectid));
}

/**
Expand Down
4 changes: 2 additions & 2 deletions lib/classes/event/group_member_added.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function get_description() {
/**
* Legacy event data if get_legacy_eventname() is not empty.
*
* @return stdClass
* @return \stdClass
*/
protected function get_legacy_eventdata() {
$eventdata = new \stdClass();
Expand Down Expand Up @@ -88,7 +88,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/members.php', array('group' => $this->objectid));
}

/**
Expand Down
4 changes: 2 additions & 2 deletions lib/classes/event/group_member_removed.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function get_description() {
/**
* Legacy event data if get_legacy_eventname() is not empty.
*
* @return stdClass
* @return \stdClass
*/
protected function get_legacy_eventdata() {
$eventdata = new \stdClass();
Expand Down Expand Up @@ -79,7 +79,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/members.php', array('group' => $this->objectid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/group_updated.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/group.php', array('id' => $this->objectid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/grouping_created.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/groupings/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/groupings.php', array('id' => $this->courseid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/grouping_deleted.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/groupings/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/groupings.php', array('id' => $this->courseid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/grouping_updated.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/groupings/index.php', array('id' => $this->courseid));
return new \moodle_url('/group/grouping.php', array('id' => $this->objectid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/message_contact_added.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('message/index.php', array('user1' => $this->relateduserid, 'user2' => $this->userid));
return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/message_contact_blocked.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('message/index.php', array('user1' => $this->relateduserid, 'user2' => $this->userid));
return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
}

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/event/message_contact_removed.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static function get_name() {
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('message/index.php', array('user1' => $this->relateduserid, 'user2' => $this->userid));
return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
}

/**
Expand Down
Loading

0 comments on commit b63f773

Please sign in to comment.