MDL-31989 search: New search areas
[moodle.git] / mod / url / classes / search / activity.php
CommitLineData
e2be9961
DM
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 * Search area for mod_url activities.
19 *
20 * @package mod_url
21 * @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace mod_url\search;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Search area for mod_url activities.
31 *
32 * @package mod_url
33 * @copyright 2016 Dan Poltawski
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 */
36class activity extends \core_search\area\base_activity {
37
38 /**
39 * Returns the document associated with this activity.
40 *
41 * Overwrites base_activity to add the provided URL as description.
42 *
43 * @param stdClass $record
44 * @return \core_search\document
45 */
46 public function get_document($record) {
47 $doc = parent::get_document($record);
48 if (!$doc) {
49 return false;
50 }
51
52 $doc->set('description1', $record->externalurl);
53 return $doc;
54 }
55}