/**
* Log user competency viewed in course event.
*
* @param user_competency_course|int $usercoursecompetencyorid The user competency course object or its ID.
* @param int $courseid The course ID
* @return bool
*/
public static function user_competency_viewed_in_course($usercoursecompetencyorid)
{
static::require_enabled();
$ucc = $usercoursecompetencyorid;
if (!is_object($ucc)) {
$ucc = new user_competency_course($ucc);
}
if (!$ucc || !user_competency::can_read_user_in_course($ucc->get_userid(), $ucc->get_courseid())) {
throw new required_capability_exception($ucc->get_context(), 'moodle/competency:usercompetencyview', 'nopermissions', '');
}
// Validate the course, this will throw an exception if not valid.
self::validate_course($ucc->get_courseid());
\core\event\competency_user_competency_viewed_in_course::create_from_user_competency_viewed_in_course($ucc)->trigger();
return true;
}
/**
* Test the user competency viewed event in course.
*
*/
public function test_user_competency_viewed_in_course()
{
$this->resetAfterTest(true);
$this->setAdminUser();
$dg = $this->getDataGenerator();
$lpg = $this->getDataGenerator()->get_plugin_generator('core_competency');
$user = $dg->create_user();
$course = $dg->create_course();
$fr = $lpg->create_framework();
$c = $lpg->create_competency(array('competencyframeworkid' => $fr->get_id()));
$pc = $lpg->create_course_competency(array('courseid' => $course->id, 'competencyid' => $c->get_id()));
$params = array('userid' => $user->id, 'competencyid' => $c->get_id(), 'courseid' => $course->id);
$ucc = $lpg->create_user_competency_course($params);
// Trigger and capture the event.
$sink = $this->redirectEvents();
api::user_competency_viewed_in_course($ucc);
// Get our event event.
$events = $sink->get_events();
$event = reset($events);
// Check that the event data is valid.
$this->assertInstanceOf('\\core\\event\\competency_user_competency_viewed_in_course', $event);
$this->assertEquals($ucc->get_id(), $event->objectid);
$this->assertEquals(context_course::instance($course->id)->id, $event->contextid);
$this->assertEquals($ucc->get_userid(), $event->relateduserid);
$this->assertEquals($course->id, $event->courseid);
$this->assertEquals($c->get_id(), $event->other['competencyid']);
$this->assertEventContextNotUsed($event);
$this->assertDebuggingNotCalled();
// Test validation.
$params = array('objectid' => $ucc->get_id(), 'contextid' => $ucc->get_context()->id, 'other' => null);
// Missing courseid.
try {
\core\event\competency_user_competency_viewed_in_course::create($params)->trigger();
$this->fail('The \'courseid\' value must be set.');
} catch (coding_exception $e) {
$this->assertRegExp("/The 'courseid' value must be set./", $e->getMessage());
}
$params['contextid'] = context_course::instance($course->id)->id;
$params['courseid'] = $course->id;
// Missing competencyid.
try {
\core\event\competency_user_competency_viewed_in_course::create($params)->trigger();
$this->fail('The \'competencyid\' value must be set.');
} catch (coding_exception $e) {
$this->assertRegExp("/The 'competencyid' value must be set./", $e->getMessage());
}
}
