weekly release 4.0dev
[moodle.git] / mod / label / classes / search / activity.php
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/>.
17 /**
18  * Search area for mod_label activities.
19  *
20  * @package    mod_label
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  */
25 namespace mod_label\search;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Search area for mod_label activities.
31  *
32  * Although there is no name field the intro value is stored internally, so no need
33  * to overwrite self::get_document.
34  *
35  * @package    mod_label
36  * @copyright  2015 David Monllao {@link http://www.davidmonllao.com}
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class activity extends \core_search\base_activity {
41     /**
42      * Returns true if this area uses file indexing.
43      *
44      * @return bool
45      */
46     public function uses_file_indexing() {
47         return true;
48     }
50     /**
51      * Overwritten as labels are displayed in-course.
52      *
53      * @param \core_search\document $doc
54      * @return \moodle_url
55      */
56     public function get_doc_url(\core_search\document $doc) {
57         // Get correct URL to section that contains label, from course format.
58         $cminfo = $this->get_cm($this->get_module_name(), strval($doc->get('itemid')), $doc->get('courseid'));
59         $format = course_get_format($cminfo->get_course());
60         $url = $format->get_view_url($cminfo->sectionnum);
62         // Add the ID of the label to the section URL.
63         $url->set_anchor('module-' . $cminfo->id);
64         return $url;
65     }
67     /**
68      * Overwritten as labels are displayed in-course. Link to the course.
69      *
70      * @param \core_search\document $doc
71      * @return \moodle_url
72      */
73     public function get_context_url(\core_search\document $doc) {
74         return new \moodle_url('/course/view.php', array('id' => $doc->get('courseid')));
76     }
78 }