[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

   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   * The mod_assign extension granted event.
  19   *
  20   * @package    mod_assign
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_assign\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_assign extension granted event class.
  31   *
  32   * @package    mod_assign
  33   * @since      Moodle 2.6
  34   * @copyright  2013 Frédéric Massart
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class extension_granted extends base {
  38      /**
  39       * Flag for prevention of direct create() call.
  40       * @var bool
  41       */
  42      protected static $preventcreatecall = true;
  43  
  44      /**
  45       * Create instance of event.
  46       *
  47       * @since Moodle 2.7
  48       *
  49       * @param \assign $assign
  50       * @param int $userid
  51       * @return extension_granted
  52       */
  53      public static function create_from_assign(\assign $assign, $userid) {
  54          $data = array(
  55              'context' => $assign->get_context(),
  56              'objectid' => $assign->get_instance()->id,
  57              'relateduserid' => $userid,
  58          );
  59          self::$preventcreatecall = false;
  60          /** @var extension_granted $event */
  61          $event = self::create($data);
  62          self::$preventcreatecall = true;
  63          $event->set_assign($assign);
  64          return $event;
  65      }
  66  
  67      /**
  68       * Returns description of what happened.
  69       *
  70       * @return string
  71       */
  72      public function get_description() {
  73          return "The user with id '$this->userid' has granted an extension for the user with id '$this->relateduserid' " .
  74              "for the assignment with course module id '$this->contextinstanceid'.";
  75      }
  76  
  77      /**
  78       * Return localised event name.
  79       *
  80       * @return string
  81       */
  82      public static function get_name() {
  83          return get_string('eventextensiongranted', 'mod_assign');
  84      }
  85  
  86      /**
  87       * Init method.
  88       *
  89       * @return void
  90       */
  91      protected function init() {
  92          $this->data['crud'] = 'u';
  93          $this->data['edulevel'] = self::LEVEL_TEACHING;
  94          $this->data['objecttable'] = 'assign';
  95      }
  96  
  97      /**
  98       * Return legacy data for add_to_log().
  99       *
 100       * @return array
 101       */
 102      protected function get_legacy_logdata() {
 103          $this->set_legacy_logdata('grant extension', $this->relateduserid);
 104          return parent::get_legacy_logdata();
 105      }
 106  
 107      /**
 108       * Custom validation.
 109       *
 110       * @throws \coding_exception
 111       * @return void
 112       */
 113      protected function validate_data() {
 114          if (self::$preventcreatecall) {
 115              throw new \coding_exception('cannot call extension_granted::create() directly, use extension_granted::create_from_assign() instead.');
 116          }
 117  
 118          parent::validate_data();
 119  
 120          if (!isset($this->relateduserid)) {
 121              throw new \coding_exception('The \'relateduserid\' must be set.');
 122          }
 123      }
 124  
 125      public static function get_objectid_mapping() {
 126          return array('db' => 'assign', 'restore' => 'assign');
 127      }
 128  }