[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 identities revealed 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 identities revealed 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 identities_revealed 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       * @return identities_revealed
  51       */
  52      public static function create_from_assign(\assign $assign) {
  53          $data = array(
  54              'context' => $assign->get_context(),
  55              'objectid' => $assign->get_instance()->id
  56          );
  57          self::$preventcreatecall = false;
  58          /** @var identities_revealed $event */
  59          $event = self::create($data);
  60          self::$preventcreatecall = true;
  61          $event->set_assign($assign);
  62          return $event;
  63      }
  64  
  65      /**
  66       * Returns description of what happened.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' has revealed identities in the assignment with course module " .
  72              "id '$this->contextinstanceid'.";
  73      }
  74  
  75      /**
  76       * Return localised event name.
  77       *
  78       * @return string
  79       */
  80      public static function get_name() {
  81          return get_string('eventidentitiesrevealed', 'mod_assign');
  82      }
  83  
  84      /**
  85       * Init method.
  86       *
  87       * @return void
  88       */
  89      protected function init() {
  90          $this->data['crud'] = 'u';
  91          $this->data['edulevel'] = self::LEVEL_TEACHING;
  92          $this->data['objecttable'] = 'assign';
  93      }
  94  
  95      /**
  96       * Return legacy data for add_to_log().
  97       *
  98       * @return array
  99       */
 100      protected function get_legacy_logdata() {
 101          $this->set_legacy_logdata('reveal identities', get_string('revealidentities', 'assign'));
 102          return parent::get_legacy_logdata();
 103      }
 104  
 105      /**
 106       * Custom validation.
 107       *
 108       * @throws \coding_exception
 109       * @return void
 110       */
 111      protected function validate_data() {
 112          if (self::$preventcreatecall) {
 113              throw new \coding_exception('cannot call identities_revealed::create() directly, use identities_revealed::create_from_assign() instead.');
 114          }
 115  
 116          parent::validate_data();
 117      }
 118  
 119      public static function get_objectid_mapping() {
 120          return array('db' => 'assign', 'restore' => 'assign');
 121      }
 122  }