[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 viewed 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  use context_course;
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  /**
  33   * User competency viewed event class.
  34   *
  35   * @property-read array $other {
  36   *      Extra information about event.
  37   *
  38   *      - int competencyid: id of competency.
  39   * }
  40   *
  41   * @package    core_competency
  42   * @since      Moodle 3.1
  43   * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  44   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  45   */
  46  class competency_user_competency_viewed extends base {
  47  
  48      /**
  49       * Convenience method to instantiate the event.
  50       *
  51       * @param user_competency $usercompetency The user competency.
  52       * @return self
  53       */
  54      public static function create_from_user_competency_viewed(user_competency $usercompetency) {
  55          if (!$usercompetency->get('id')) {
  56              throw new \coding_exception('The user competency ID must be set.');
  57          }
  58          $params = array(
  59              'contextid' => $usercompetency->get_context()->id,
  60              'objectid' => $usercompetency->get('id'),
  61              'relateduserid' => $usercompetency->get('userid'),
  62              'other' => array(
  63                  'competencyid' => $usercompetency->get('competencyid')
  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' viewed the user competency with id '$this->objectid'";
  79      }
  80  
  81      /**
  82       * Return localised event name.
  83       *
  84       * @return string
  85       */
  86      public static function get_name() {
  87          return get_string('eventusercompetencyviewed', 'core_competency');
  88      }
  89  
  90      /**
  91       * Get URL related to the action
  92       *
  93       * @return \moodle_url
  94       */
  95      public function get_url() {
  96          return \core_competency\url::user_competency($this->objectid);
  97      }
  98  
  99      /**
 100       * Init method.
 101       *
 102       * @return void
 103       */
 104      protected function init() {
 105          $this->data['crud'] = 'r';
 106          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
 107          $this->data['objecttable'] = user_competency::TABLE;
 108      }
 109  
 110      /**
 111       * Get_objectid_mapping method.
 112       *
 113       * @return string the name of the restore mapping the objectid links to
 114       */
 115      public static function get_objectid_mapping() {
 116          return base::NOT_MAPPED;
 117      }
 118  
 119      /**
 120       * Custom validation.
 121       *
 122       * Throw \coding_exception notice in case of any problems.
 123       */
 124      protected function validate_data() {
 125          if (!isset($this->other) || !isset($this->other['competencyid'])) {
 126              throw new \coding_exception('The \'competencyid\' value must be set.');
 127          }
 128      }
 129  
 130  }