[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   * Courses searched event.
  19   *
  20   * @package    core
  21   * @copyright  2016 Stephen Bourget
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Courses searched event class.
  30   *
  31   * Class for event to be triggered when a courses are searched (using course search).
  32   *
  33   * @property-read array $other {
  34   *      Extra information about event.
  35   *
  36   *      - string query: search query performed.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 3.2
  41   * @copyright  2016 Stephen Bourget
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class courses_searched extends base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'r';
  53          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  54      }
  55  
  56      /**
  57       * Returns description of what happened.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62  
  63          return "The user with id '$this->userid' searched course information for the term '".$this->other['query']."'.";
  64      }
  65  
  66      /**
  67       * Return localised event name.
  68       *
  69       * @return string
  70       */
  71      public static function get_name() {
  72          return get_string('eventcoursessearched', 'core');
  73      }
  74  
  75      /**
  76       * Get URL related to the action.
  77       *
  78       * @return \moodle_url|null
  79       */
  80      public function get_url() {
  81          return new \moodle_url('/course/search.php', array('search' => $this->other['query']));
  82      }
  83  
  84      /**
  85       * Custom validations.
  86       *
  87       * @throws \coding_exception
  88       * @return void
  89       */
  90      protected function validate_data() {
  91          parent::validate_data();
  92  
  93          if (!isset($this->other['query'])) {
  94              throw new \coding_exception('The \'query\' must be set in other.');
  95          }
  96      }
  97  
  98      /**
  99       * Used for maping events on restore
 100       *
 101       * @return bool
 102       */
 103      public static function get_other_mapping() {
 104          // No mapping required.
 105          return false;
 106      }
 107  }