[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * User competency grade rated event.
  19   *
  20   * @package    core_competency
  21   * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  use core\event\base;
  28  use core_competency\user_competency;
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * User competency grade rated event class.
  33   *
  34   * @property-read array $other {
  35   *      Extra information about event.
  36   *
  37   *      - int grade: grade name of the user competency
  38   * }
  39   *
  40   * @package    core_competency
  41   * @since      Moodle 3.1
  42   * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class competency_user_competency_rated extends base {
  46  
  47      /**
  48       * Convenience method to instantiate the event.
  49       *
  50       * @param user_competency $usercompetency The user competency.
  51       * @return self
  52       */
  53      public static function create_from_user_competency(user_competency $usercompetency) {
  54          if (!$usercompetency->get('id')) {
  55              throw new \coding_exception('The user competency ID must be set.');
  56          }
  57  
  58          $params = array(
  59              'contextid' => $usercompetency->get_context()->id,
  60              'objectid' => $usercompetency->get('id'),
  61              'relateduserid' => $usercompetency->get('userid'),
  62              'other' => array(
  63                  'grade' => $usercompetency->get('grade')
  64              )
  65          );
  66  
  67          $event = static::create($params);
  68          $event->add_record_snapshot(user_competency::TABLE, $usercompetency->to_record());
  69          return $event;
  70      }
  71  
  72      /**
  73       * Returns description of what happened.
  74       *
  75       * @return string
  76       */
  77      public function get_description() {
  78          return "The user with id '$this->userid' rated the user competency with id '$this->objectid' "
  79                  . "with '" . $this->other['grade'] . "' rating";
  80      }
  81  
  82      /**
  83       * Return localised event name.
  84       *
  85       * @return string
  86       */
  87      public static function get_name() {
  88          return get_string('eventusercompetencyrated', 'core_competency');
  89      }
  90  
  91      /**
  92       * Get URL related to the action
  93       *
  94       * @return \moodle_url
  95       */
  96      public function get_url() {
  97          return \core_competency\url::user_competency($this->objectid);
  98      }
  99  
 100      /**
 101       * Init method.
 102       *
 103       * @return void
 104       */
 105      protected function init() {
 106          $this->data['crud'] = 'u';
 107          $this->data['edulevel'] = self::LEVEL_TEACHING;
 108          $this->data['objecttable'] = user_competency::TABLE;
 109      }
 110  
 111      /**
 112       * Get_objectid_mapping method.
 113       *
 114       * @return string the name of the restore mapping the objectid links to
 115       */
 116      public static function get_objectid_mapping() {
 117          return base::NOT_MAPPED;
 118      }
 119  
 120      /**
 121       * Custom validation.
 122       *
 123       * Throw \coding_exception notice in case of any problems.
 124       */
 125      protected function validate_data() {
 126          if (!$this->relateduserid) {
 127              throw new \coding_exception('The \'relateduserid\' value must be set.');
 128          }
 129  
 130          if (!isset($this->other) || !isset($this->other['grade'])) {
 131              throw new \coding_exception('The \'grade\' value must be set.');
 132          }
 133      }
 134  
 135  }