Skip to content
Permalink
Browse files

MDL-52959 tool_lp: Create C(R)UD events for competencies

  • Loading branch information...
taboubi authored and FMCorz committed Feb 10, 2016
1 parent 7deba3c commit d32d64bcbcbcb59d14483e33247577047224415f
@@ -118,6 +118,8 @@ public static function create_competency(stdClass $record) {
$competency->set_sortorder(null);
$competency->create();
\tool_lp\event\competency_created::create_from_competency($competency)->trigger();
// Reset the rule of the parent.
$parent = $competency->get_parent();
if ($parent) {
@@ -143,7 +145,9 @@ public static function delete_competency($id) {
// First we do a permissions check.
require_capability('tool/lp:competencymanage', $competency->get_context());
$events = array();
$competencyids = array(intval($competency->get_id()));
$contextid = $competency->get_context()->id;
$competencyids = array_merge(competency::get_descendants_ids($competency), $competencyids);
if (!competency::can_all_be_deleted($competencyids)) {
return false;
@@ -171,12 +175,20 @@ public static function delete_competency($id) {
// Delete competency evidences.
user_evidence_competency::delete_by_competencyids($competencyids);
$transaction->allow_commit();
return true;
// Register the competencies deleted events.
$events = \tool_lp\event\competency_deleted::create_multiple_from_competencyids($competencyids, $contextid);
} catch (\Exception $e) {
$transaction->rollback($e);
}
$transaction->allow_commit();
// Trigger events.
foreach ($events as $event) {
$event->trigger();
}
return true;
}
/**
@@ -216,8 +228,9 @@ public static function move_down_competency($id) {
}
// OK - all set.
$current->update();
$result = $current->update();
return $result;
}
/**
@@ -252,7 +265,9 @@ public static function move_up_competency($id) {
}
// OK - all set.
return $current->update();
$result = $current->update();
return $result;
}
/**
@@ -315,12 +330,12 @@ public static function set_parent_competency($id, $newparentid) {
// Do the actual move.
$current->set_parentid($newparentid);
$current->update();
$result = $current->update();
// All right, let's commit this.
$transaction->allow_commit();
return true;
return $result;
}
/**
@@ -348,7 +363,12 @@ public static function update_competency($record) {
require_capability('tool/lp:competencymanage', $competency->get_context());
// OK - all set.
return $competency->update();
$result = $competency->update();
// Trigger the update event.
\tool_lp\event\competency_updated::create_from_competency($competency)->trigger();
return $result;
}
/**
@@ -563,7 +583,9 @@ public static function delete_framework($id) {
$framework = new competency_framework($id);
require_capability('tool/lp:competencymanage', $framework->get_context());
$events = array();
$competenciesid = competency::get_ids_by_frameworkid($id);
$contextid = $framework->get_contextid();
if (!competency::can_all_be_deleted($competenciesid)) {
return false;
}
@@ -584,6 +606,9 @@ public static function delete_framework($id) {
$event = \tool_lp\event\competency_framework_deleted::create_from_framework($framework);
$result = $framework->delete();
// Register the deleted events competencies.
$events = \tool_lp\event\competency_deleted::create_multiple_from_competencyids($competenciesid, $contextid);
} catch (\Exception $e) {
$transaction->rollback($e);
}
@@ -594,6 +619,11 @@ public static function delete_framework($id) {
// If all operations are successfull then trigger the delete event.
$event->trigger();
// Trigger deleted event competencies.
foreach ($events as $event) {
$event->trigger();
}
return $result;
}
@@ -3489,6 +3519,9 @@ protected static function duplicate_competency_tree($frameworkid, $tree, $oldpar
$competency->reset_rule();
$competency->create();
// Trigger the created event competency.
\tool_lp\event\competency_created::create_from_competency($competency)->trigger();
// Match the old id with the new one.
$matchids[$parentid] = $competency;
@@ -0,0 +1,110 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Competency created event.
*
* @package tool_lp
* @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace tool_lp\event;
use core\event\base;
use tool_lp\competency;
defined('MOODLE_INTERNAL') || die();
/**
* Competency created event class.
*
*
* @package tool_lp
* @since Moodle 3.1
* @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class competency_created extends base {
/**
* Convenience method to instantiate the event.
*
* @param competency $competency The competency.
* @return self
*/
public static function create_from_competency(competency $competency) {
if (!$competency->get_id()) {
throw new \coding_exception('The competency ID must be set.');
}
$event = static::create(array(
'contextid' => $competency->get_context()->id,
'objectid' => $competency->get_id()
));
return $event;
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' created the competency with id '$this->objectid'";
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventcompetencycreated', 'tool_lp');
}
/**
* Get URL related to the action
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/admin/tool/lp/editcompetency.php', array(
'id' => $this->objectid,
'pagecontextid' => $this->contextid
));
}
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_OTHER;
$this->data['objecttable'] = competency::TABLE;
}
/**
* Get_objectid_mapping method.
*
* @return string the name of the restore mapping the objectid links to
*/
public static function get_objectid_mapping() {
return base::NOT_MAPPED;
}
}
@@ -0,0 +1,115 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Competency deleted event.
*
* @package tool_lp
* @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace tool_lp\event;
use core\event\base;
use tool_lp\competency;
defined('MOODLE_INTERNAL') || die();
/**
* Competency deleted event class.
*
* @package tool_lp
* @since Moodle 3.1
* @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class competency_deleted extends base {
/**
* Convenience method to instantiate the event.
*
* @param competency $competency The competency.
* @return self
*/
public static function create_from_competency(competency $competency) {
if (!$competency->get_id()) {
throw new \coding_exception('The competency ID must be set.');
}
$event = static::create(array(
'contextid' => $competency->get_context()->id,
'objectid' => $competency->get_id()
));
return $event;
}
/**
* Instantiate events from competency ids.
*
* @param array $competencyids Array of competency ids.
* @param int $contextid The context id.
* @return self[] Array of events.
*/
public static function create_multiple_from_competencyids($competencyids, $contextid) {
$events = array();
foreach ($competencyids as $id) {
$events[$id] = static::create(array(
'contextid' => $contextid,
'objectid' => $id
));
}
return $events;
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' deleted the competency with id '$this->objectid'";
}
/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventcompetencydeleted', 'tool_lp');
}
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_OTHER;
$this->data['objecttable'] = competency::TABLE;
}
/**
* Get_objectid_mapping method.
*
* @return string the name of the restore mapping the objectid links to
*/
public static function get_objectid_mapping() {
return base::NOT_MAPPED;
}
}

0 comments on commit d32d64b

Please sign in to comment.
You can’t perform that action at this time.