[Summary view] [Print] [Text 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   * 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       * Define whether a user can view the event or not. Make sure no one except admin can see details of an anonymous response.
  55       *
  56       * @deprecated since 2.7
  57       *
  58       * @param int|\stdClass $userorid ID of the user.
  59       * @return bool True if the user can view the event, false otherwise.
  60       */
  61      public function can_view($userorid = null) {
  62          global $USER;
  63          debugging('can_view() method is deprecated, use anonymous flag instead if necessary.', DEBUG_DEVELOPER);
  64  
  65          if (empty($userorid)) {
  66              $userorid = $USER;
  67          }
  68          if ($this->anonymous) {
  69              return is_siteadmin($userorid);
  70          } else {
  71              return has_capability('mod/feedback:viewreports', $this->context, $userorid);
  72          }
  73      }
  74  
  75      /**
  76       * Replace add_to_log() statement.Do this only for the case when anonymous mode is off,
  77       * since this is what was happening before.
  78       *
  79       * @return array of parameters to be passed to legacy add_to_log() function.
  80       */
  81      protected function get_legacy_logdata() {
  82          if ($this->anonymous) {
  83              return null;
  84          } else {
  85              return parent::get_legacy_logdata();
  86          }
  87      }
  88  
  89      /**
  90       * Custom validations.
  91       *
  92       * @throws \coding_exception in case of any problems.
  93       */
  94      protected function validate_data() {
  95          parent::validate_data();
  96  
  97          if (!isset($this->other['anonymous'])) {
  98              throw new \coding_exception('The \'anonymous\' value must be set in other.');
  99          }
 100      }
 101  }
 102