You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
3.3 KiB
118 lines
3.3 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* The mod_forum course searched event.
|
|
*
|
|
* @package mod_forum
|
|
* @copyright 2014 Dan Poltawski <dan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace mod_forum\event;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* The mod_forum course searched event class.
|
|
*
|
|
* @property-read array $other {
|
|
* Extra information about the event.
|
|
*
|
|
* - string searchterm: The searchterm used on forum search.
|
|
* }
|
|
*
|
|
* @package mod_forum
|
|
* @since Moodle 2.7
|
|
* @copyright 2014 Dan Poltawski <dan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class course_searched extends \core\event\base {
|
|
|
|
/**
|
|
* Init method.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function init() {
|
|
$this->data['crud'] = 'r';
|
|
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
|
|
}
|
|
|
|
/**
|
|
* Returns description of what happened.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_description() {
|
|
$searchterm = s($this->other['searchterm']);
|
|
return "The user with id '$this->userid' has searched the course with id '$this->courseid' for forum posts " .
|
|
"containing \"{$searchterm}\".";
|
|
}
|
|
|
|
/**
|
|
* Return localised event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_name() {
|
|
return get_string('eventcoursesearched', 'mod_forum');
|
|
}
|
|
|
|
/**
|
|
* Get URL related to the action
|
|
*
|
|
* @return \moodle_url
|
|
*/
|
|
public function get_url() {
|
|
return new \moodle_url('/mod/forum/search.php',
|
|
array('id' => $this->courseid, 'search' => $this->other['searchterm']));
|
|
}
|
|
|
|
/**
|
|
* Return the legacy event log data.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
protected function get_legacy_logdata() {
|
|
// The legacy log table expects a relative path to /mod/forum/.
|
|
$logurl = substr($this->get_url()->out_as_local_url(), strlen('/mod/forum/'));
|
|
|
|
return array($this->courseid, 'forum', 'search', $logurl, $this->other['searchterm']);
|
|
}
|
|
|
|
/**
|
|
* Custom validation.
|
|
*
|
|
* @throws \coding_exception
|
|
* @return void
|
|
*/
|
|
protected function validate_data() {
|
|
parent::validate_data();
|
|
if (!isset($this->other['searchterm'])) {
|
|
throw new \coding_exception('The \'searchterm\' value must be set in other.');
|
|
}
|
|
|
|
if ($this->contextlevel != CONTEXT_COURSE) {
|
|
throw new \coding_exception('Context level must be CONTEXT_COURSE.');
|
|
}
|
|
}
|
|
|
|
public static function get_other_mapping() {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|