See Release Notes
Long Term Support Release
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_forum course searched event. 19 * 20 * @package mod_forum 21 * @copyright 2014 Dan Poltawski <dan@moodle.com> 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 namespace mod_forum\event; 26 27 defined('MOODLE_INTERNAL') || die(); 28 29 /** 30 * The mod_forum course searched event class. 31 * 32 * @property-read array $other { 33 * Extra information about the event. 34 * 35 * - string searchterm: The searchterm used on forum search. 36 * } 37 * 38 * @package mod_forum 39 * @since Moodle 2.7 40 * @copyright 2014 Dan Poltawski <dan@moodle.com> 41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 42 */ 43 class course_searched extends \core\event\base { 44 45 /** 46 * Init method. 47 * 48 * @return void 49 */ 50 protected function init() { 51 $this->data['crud'] = 'r'; 52 $this->data['edulevel'] = self::LEVEL_PARTICIPATING; 53 } 54 55 /** 56 * Returns description of what happened. 57 * 58 * @return string 59 */ 60 public function get_description() { 61 $searchterm = s($this->other['searchterm']); 62 return "The user with id '$this->userid' has searched the course with id '$this->courseid' for forum posts " . 63 "containing \"{$searchterm}\"."; 64 } 65 66 /** 67 * Return localised event name. 68 * 69 * @return string 70 */ 71 public static function get_name() { 72 return get_string('eventcoursesearched', 'mod_forum'); 73 } 74 75 /** 76 * Get URL related to the action 77 * 78 * @return \moodle_url 79 */ 80 public function get_url() { 81 return new \moodle_url('/mod/forum/search.php', 82 array('id' => $this->courseid, 'search' => $this->other['searchterm'])); 83 } 84 85 /** 86 * Return the legacy event log data. 87 * 88 * @return array|null 89 */ 90 protected function get_legacy_logdata() { 91 // The legacy log table expects a relative path to /mod/forum/. 92 $logurl = substr($this->get_url()->out_as_local_url(), strlen('/mod/forum/')); 93 94 return array($this->courseid, 'forum', 'search', $logurl, $this->other['searchterm']); 95 } 96 97 /** 98 * Custom validation. 99 * 100 * @throws \coding_exception 101 * @return void 102 */ 103 protected function validate_data() { 104 parent::validate_data(); 105 if (!isset($this->other['searchterm'])) { 106 throw new \coding_exception('The \'searchterm\' value must be set in other.'); 107 } 108 109 if ($this->contextlevel != CONTEXT_COURSE) { 110 throw new \coding_exception('Context level must be CONTEXT_COURSE.'); 111 } 112 } 113 114 public static function get_other_mapping() { 115 return false; 116 } 117 } 118
title
Description
Body
title
Description
Body
title
Description
Body
title
Body