/** * Log user competency plan viewed event. * * @param user_competency_plan|int $usercompetencyplanorid The user competency plan object or user competency plan id * @return bool */ public static function user_competency_plan_viewed($usercompetencyplanorid) { static::require_enabled(); $ucp = $usercompetencyplanorid; if (!is_object($ucp)) { $ucp = new user_competency_plan($ucp); } if (!$ucp || !user_competency::can_read_user($ucp->get_userid())) { throw new required_capability_exception($ucp->get_context(), 'moodle/competency:usercompetencyview', 'nopermissions', ''); } $plan = new plan($ucp->get_planid()); if ($plan->get_status() != plan::STATUS_COMPLETE) { throw new coding_exception('To log the user competency in non-completed plan use ' . 'user_competency_viewed_in_plan method.'); } \core\event\competency_user_competency_plan_viewed::create_from_user_competency_plan($ucp)->trigger(); return true; }
/** * Test the user competency plan viewed event. * */ public function test_user_competency_plan_viewed() { $this->resetAfterTest(true); $this->setAdminUser(); $dg = $this->getDataGenerator(); $lpg = $this->getDataGenerator()->get_plugin_generator('core_competency'); $user = $dg->create_user(); $plan = $lpg->create_plan(array('userid' => $user->id)); $fr = $lpg->create_framework(); $c = $lpg->create_competency(array('competencyframeworkid' => $fr->get_id())); $ucp = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c->get_id(), 'planid' => $plan->get_id())); // Can not log the event for user competency using non completed plan. try { api::user_competency_plan_viewed($ucp); $this->fail('To log the user competency in non-completed plan ' . 'use user_competency_viewed_in_plan method.'); } catch (coding_exception $e) { $this->assertRegExp('/To log the user competency in non-completed plan ' . 'use user_competency_viewed_in_plan method./', $e->getMessage()); } // Complete the plan. api::complete_plan($plan); // Trigger and capture the event. $sink = $this->redirectEvents(); api::user_competency_plan_viewed($ucp); // 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_plan_viewed', $event); $this->assertEquals($ucp->get_id(), $event->objectid); $this->assertEquals($ucp->get_context()->id, $event->contextid); $this->assertEquals($ucp->get_userid(), $event->relateduserid); $this->assertEquals($plan->get_id(), $event->other['planid']); $this->assertEquals($c->get_id(), $event->other['competencyid']); $this->assertEventContextNotUsed($event); $this->assertDebuggingNotCalled(); // Test validation. $params = array('objectid' => $ucp->get_id(), 'contextid' => $ucp->get_context()->id, 'other' => null); // Other value null. try { \core\event\competency_user_competency_plan_viewed::create($params)->trigger(); $this->fail('The \'competencyid\' and \'planid\' values must be set.'); } catch (coding_exception $e) { $this->assertRegExp("/The 'competencyid' and 'planid' values must be set./", $e->getMessage()); } $params['other']['anythingelse'] = ''; // Missing competencyid. try { \core\event\competency_user_competency_plan_viewed::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()); } $params['other']['competencyid'] = $c->get_id(); // Missing planid. try { \core\event\competency_user_competency_plan_viewed::create($params)->trigger(); $this->fail('The \'planid\' value must be set.'); } catch (coding_exception $e) { $this->assertRegExp("/The 'planid' value must be set./", $e->getMessage()); } }