weekly release 3.11.12+
[moodle.git] / course / search.php
blobccaf4b302a994f7541dbb403c3c0fde52515a2c9
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.
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 * Displays external information about a course
19 * @package core_course
20 * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 require_once("../config.php");
25 require_once($CFG->dirroot.'/course/lib.php');
27 $q = optional_param('q', '', PARAM_RAW); // Global search words.
28 $search = optional_param('search', '', PARAM_RAW); // search words
29 $page = optional_param('page', 0, PARAM_INT); // which page to show
30 $perpage = optional_param('perpage', '', PARAM_RAW); // how many per page, may be integer or 'all'
31 $blocklist = optional_param('blocklist', 0, PARAM_INT);
32 $modulelist= optional_param('modulelist', '', PARAM_PLUGIN);
33 $tagid = optional_param('tagid', '', PARAM_INT); // searches for courses tagged with this tag id
35 // Use global search.
36 if ($q) {
37 $search = $q;
40 // List of minimum capabilities which user need to have for editing/moving course
41 $capabilities = array('moodle/course:create', 'moodle/category:manage');
43 // Populate usercatlist with list of category id's with course:create and category:manage capabilities.
44 $usercatlist = core_course_category::make_categories_list($capabilities);
46 $search = trim(strip_tags($search)); // trim & clean raw searched string
48 $site = get_site();
50 $searchcriteria = array();
51 foreach (array('search', 'blocklist', 'modulelist', 'tagid') as $param) {
52 if (!empty($$param)) {
53 $searchcriteria[$param] = $$param;
56 $urlparams = array();
57 if ($perpage !== 'all' && !($perpage = (int)$perpage)) {
58 // default number of courses per page
59 $perpage = $CFG->coursesperpage;
60 } else {
61 $urlparams['perpage'] = $perpage;
63 if (!empty($page)) {
64 $urlparams['page'] = $page;
66 $PAGE->set_url('/course/search.php', $searchcriteria + $urlparams);
67 $PAGE->set_context(context_system::instance());
68 $PAGE->set_pagelayout('standard');
69 $courserenderer = $PAGE->get_renderer('core', 'course');
71 if ($CFG->forcelogin) {
72 require_login();
75 $strcourses = new lang_string("courses");
76 $strsearch = new lang_string("search");
77 $strsearchresults = new lang_string("searchresults");
78 $strnovalidcourses = new lang_string('novalidcourses');
80 $courseurl = core_course_category::user_top() ? new moodle_url('/course/index.php') : null;
81 $PAGE->navbar->add($strcourses, $courseurl);
82 $PAGE->navbar->add($strsearch, new moodle_url('/course/search.php'));
83 if (!empty($search)) {
84 $PAGE->navbar->add(s($search));
87 if (empty($searchcriteria)) {
88 // no search criteria specified, print page with just search form
89 $PAGE->set_title("$site->fullname : $strsearch");
90 } else {
91 // this is search results page
92 $PAGE->set_title("$site->fullname : $strsearchresults");
93 // Link to manage search results should be visible if user have system or category level capability
94 if ((can_edit_in_category() || !empty($usercatlist))) {
95 $aurl = new moodle_url('/course/management.php', $searchcriteria);
96 $searchform = $OUTPUT->single_button($aurl, get_string('managecourses'), 'get');
97 } else {
98 $searchform = $courserenderer->course_search_form($search);
100 $PAGE->set_button($searchform);
102 // Trigger event, courses searched.
103 $eventparams = array('context' => $PAGE->context, 'other' => array('query' => $search));
104 $event = \core\event\courses_searched::create($eventparams);
105 $event->trigger();
108 $PAGE->set_heading($site->fullname);
110 echo $OUTPUT->header();
111 echo $courserenderer->search_courses($searchcriteria);
112 echo $OUTPUT->footer();