/**
* Delete a learning plan template
*
* @param int $id The learning plan template id
* @param boolean $deleteplans True to delete the plans associated to template or false to unlink them
* @return boolean
*/
public static function delete_template($id, $deleteplans = true)
{
$params = self::validate_parameters(self::delete_template_parameters(), array('id' => $id, 'deleteplans' => $deleteplans));
$template = api::read_template($params['id']);
self::validate_context($template->get_context());
return api::delete_template($params['id'], $params['deleteplans']);
}
public function test_delete_template_unlink_plans()
{
$this->resetAfterTest(true);
$this->setAdminUser();
$dg = $this->getDataGenerator();
$lpg = $this->getDataGenerator()->get_plugin_generator('core_competency');
$u1 = $dg->create_user();
$f = $lpg->create_framework();
$c1 = $lpg->create_competency(array('competencyframeworkid' => $f->get_id()));
$c2 = $lpg->create_competency(array('competencyframeworkid' => $f->get_id()));
$tpl = $lpg->create_template();
$tplc1 = $lpg->create_template_competency(array('templateid' => $tpl->get_id(), 'competencyid' => $c1->get_id(), 'sortorder' => 1));
$tplc2 = $lpg->create_template_competency(array('templateid' => $tpl->get_id(), 'competencyid' => $c2->get_id(), 'sortorder' => 2));
$p1 = $lpg->create_plan(array('templateid' => $tpl->get_id(), 'userid' => $u1->id));
// Check pre-test.
$this->assertTrue(\core_competency\template::record_exists($tpl->get_id()));
$this->assertEquals(2, \core_competency\template_competency::count_competencies($tpl->get_id()));
$this->assertEquals(1, count(\core_competency\plan::get_records(array('templateid' => $tpl->get_id()))));
$result = api::delete_template($tpl->get_id(), false);
$this->assertTrue($result);
// Check that the template does not exist anymore.
$this->assertFalse(\core_competency\template::record_exists($tpl->get_id()));
// Check that associated competencies are also deleted.
$this->assertEquals(0, \core_competency\template_competency::count_competencies($tpl->get_id()));
// Check that associated plan still exist but unlink from template.
$plans = \core_competency\plan::get_records(array('id' => $p1->get_id()));
$this->assertEquals(1, count($plans));
$this->assertEquals($plans[0]->get_origtemplateid(), $tpl->get_id());
$this->assertNull($plans[0]->get_templateid());
}
/**
* Test the template deleted event.
*
*/
public function test_template_deleted()
{
$this->resetAfterTest(true);
$this->setAdminUser();
$lpg = $this->getDataGenerator()->get_plugin_generator('core_competency');
$template = $lpg->create_template();
// Trigger and capture the event.
$sink = $this->redirectEvents();
api::delete_template($template->get_id());
// Get our event event.
$events = $sink->get_events();
$event = reset($events);
// Check that the event data is valid.
$this->assertInstanceOf('\\core\\event\\competency_template_deleted', $event);
$this->assertEquals($template->get_id(), $event->objectid);
$this->assertEquals($template->get_contextid(), $event->contextid);
$this->assertEventContextNotUsed($event);
$this->assertDebuggingNotCalled();
}
