[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_feedback course module viewed event.
  19   *
  20   * @package    mod_feedback
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_feedback\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_feedback course module viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int anonymous if feedback is anonymous.
  35   * }
  36   *
  37   * @package    mod_feedback
  38   * @since      Moodle 2.6
  39   * @copyright  2013 Ankit Agarwal
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class course_module_viewed extends \core\event\course_module_viewed {
  43  
  44      /**
  45       * Init method.
  46       */
  47      protected function init() {
  48          $this->data['crud'] = 'r';
  49          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  50          $this->data['objecttable'] = 'feedback';
  51      }
  52  
  53      /**
  54       * Creates an instance from feedback record
  55       *
  56       * @param stdClass $feedback
  57       * @param cm_info|stdClass $cm
  58       * @param stdClass $course
  59       * @return course_module_viewed
  60       */
  61      public static function create_from_record($feedback, $cm, $course) {
  62          $event = self::create(array(
  63              'objectid' => $feedback->id,
  64              'context' => \context_module::instance($cm->id),
  65              'anonymous' => ($feedback->anonymous == FEEDBACK_ANONYMOUS_YES),
  66              'other' => array(
  67                  'anonymous' => $feedback->anonymous // Deprecated.
  68              )
  69          ));
  70          $event->add_record_snapshot('course_modules', $cm);
  71          $event->add_record_snapshot('course', $course);
  72          $event->add_record_snapshot('feedback', $feedback);
  73          return $event;
  74      }
  75  
  76      /**
  77       * Define whether a user can view the event or not. Make sure no one except admin can see details of an anonymous response.
  78       *
  79       * @deprecated since 2.7
  80       *
  81       * @param int|\stdClass $userorid ID of the user.
  82       * @return bool True if the user can view the event, false otherwise.
  83       */
  84      public function can_view($userorid = null) {
  85          global $USER;
  86          debugging('can_view() method is deprecated, use anonymous flag instead if necessary.', DEBUG_DEVELOPER);
  87  
  88          if (empty($userorid)) {
  89              $userorid = $USER;
  90          }
  91          if ($this->anonymous) {
  92              return is_siteadmin($userorid);
  93          } else {
  94              return has_capability('mod/feedback:viewreports', $this->context, $userorid);
  95          }
  96      }
  97  
  98      /**
  99       * Replace add_to_log() statement.Do this only for the case when anonymous mode is off,
 100       * since this is what was happening before.
 101       *
 102       * @return array of parameters to be passed to legacy add_to_log() function.
 103       */
 104      protected function get_legacy_logdata() {
 105          if ($this->anonymous) {
 106              return null;
 107          } else {
 108              return parent::get_legacy_logdata();
 109          }
 110      }
 111  
 112      /**
 113       * Custom validations.
 114       *
 115       * @throws \coding_exception in case of any problems.
 116       */
 117      protected function validate_data() {
 118          parent::validate_data();
 119  
 120          if (!isset($this->other['anonymous'])) {
 121              throw new \coding_exception('The \'anonymous\' value must be set in other.');
 122          }
 123      }
 124  
 125      public static function get_objectid_mapping() {
 126          return array('db' => 'feedback', 'restore' => 'feedback');
 127      }
 128  
 129      public static function get_other_mapping() {
 130          // No need to map the 'anonymous' flag.
 131          return false;
 132      }
 133  }
 134