MDL-51324 forms: Add a new course selector
[moodle.git] / lib / form / course.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/>.
18 /**
19  * Course selector field.
20  *
21  * Allows auto-complete ajax searching for courses and can restrict by enrolment, permissions, viewhidden...
22  *
23  * @package   core_form
24  * @copyright 2015 Damyon Wiese <damyon@moodle.com>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 global $CFG;
29 require_once($CFG->libdir . '/form/autocomplete.php');
31 /**
32  * Form field type for choosing a course.
33  *
34  * Allows auto-complete ajax searching for courses and can restrict by enrolment, permissions, viewhidden...
35  *
36  * @package   core_form
37  * @copyright 2015 Damyon Wiese <damyon@moodle.com>
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class MoodleQuickForm_course extends MoodleQuickForm_autocomplete {
42     /**
43      * @var array $exclude Exclude a list of courses from the list (e.g. the current course).
44      */
45     protected $exclude = array();
47     /**
48      * @var boolean $allowmultiple Allow selecting more than one course.
49      */
50     protected $multiple = false;
52     /**
53      * @var array $requiredcapabilities Array of extra capabilities to check at the course context.
54      */
55     protected $requiredcapabilities = array();
57     /**
58      * Constructor
59      *
60      * @param string $elementname Element name
61      * @param mixed $elementlabel Label(s) for an element
62      * @param array $options Options to control the element's display
63      *                       Valid options are:
64      *                       'multiple' - boolean multi select
65      *                       'exclude' - array or int, list of course ids to never show
66      *                       'requiredcapabilities' - array of capabilities. Uses ANY to combine them.
67      */
68     public function __construct($elementname = null, $elementlabel = null, $options = array()) {
69         if (isset($options['multiple'])) {
70             $this->multiple = $options['multiple'];
71         }
72         if (isset($options['exclude'])) {
73             $this->exclude = $options['exclude'];
74             if (!is_array($this->exclude)) {
75                 $this->exclude = array($this->exclude);
76             }
77         }
78         if (isset($options['requiredcapabilities'])) {
79             $this->requiredcapabilities = $options['requiredcapabilities'];
80         }
82         $validattributes = array(
83             'ajax' => 'core/form-course-selector',
84             'data-requiredcapabilities' => implode(',', $this->requiredcapabilities),
85             'data-exclude' => implode(',', $this->exclude)
86         );
87         if ($this->multiple) {
88             $validattributes['multiple'] = 'multiple';
89         }
91         parent::__construct($elementname, $elementlabel, array(), $validattributes);
92     }
94     /**
95      * Set the value of this element. If values can be added or are unknown, we will
96      * make sure they exist in the options array.
97      * @param string|array $value The value to set.
98      * @return boolean
99      */
100     public function setValue($value) {
101         global $DB;
102         $values = (array) $value;
103         $coursestofetch = array();
105         foreach ($values as $onevalue) {
106             if ((!$this->optionExists($onevalue)) &&
107                     ($onevalue !== '_qf__force_multiselect_submission')) {
108                 array_push($coursestofetch, $onevalue);
109             }
110         }
112         if (empty($coursestofetch)) {
113             return $this->setSelected(array());
114         }
116         // There is no API function to load a list of course from a list of ids.
117         $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
118         $fields = array('c.id', 'c.category', 'c.sortorder',
119                         'c.shortname', 'c.fullname', 'c.idnumber',
120                         'c.startdate', 'c.visible', 'c.cacherev');
121         list($whereclause, $params) = $DB->get_in_or_equal($coursestofetch, SQL_PARAMS_NAMED, 'id');
123         $sql = "SELECT ". join(',', $fields). ", $ctxselect
124                 FROM {course} c
125                 JOIN {context} ctx ON c.id = ctx.instanceid AND ctx.contextlevel = :contextcourse
126                 WHERE c.id ". $whereclause." ORDER BY c.sortorder";
127         $list = $DB->get_records_sql($sql, array('contextcourse' => CONTEXT_COURSE) + $params);
129         $coursestoselect = array();
130         foreach ($list as $course) {
131             context_helper::preload_from_record($course);
132             // Make sure we can see the course.
133             if (!$course->visible && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
134                 continue;
135             }
136             $label = get_course_display_name_for_list($course);
137             $this->addOption($label, $course->id);
138             array_push($coursestoselect, $course->id);
139         }
140         return $this->setSelected($coursestoselect);
141     }