Current Path : C:/Users/Mahmood/Desktop/moodle/lib/form/ |
Current File : C:/Users/Mahmood/Desktop/moodle/lib/form/course.php |
<?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/>. /** * Course selector field. * * Allows auto-complete ajax searching for courses and can restrict by enrolment, permissions, viewhidden... * * @package core_form * @copyright 2015 Damyon Wiese <damyon@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ global $CFG; require_once($CFG->libdir . '/form/autocomplete.php'); /** * Form field type for choosing a course. * * Allows auto-complete ajax searching for courses and can restrict by enrolment, permissions, viewhidden... * * @package core_form * @copyright 2015 Damyon Wiese <damyon@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class MoodleQuickForm_course extends MoodleQuickForm_autocomplete { /** * @var array $exclude Exclude a list of courses from the list (e.g. the current course). */ protected $exclude = array(); /** * @var boolean $allowmultiple Allow selecting more than one course. */ protected $multiple = false; /** * @var array $requiredcapabilities Array of extra capabilities to check at the course context. */ protected $requiredcapabilities = array(); /** * @var bool $limittoenrolled Only allow enrolled courses. */ protected $limittoenrolled = false; /** * Constructor * * @param string $elementname Element name * @param mixed $elementlabel Label(s) for an element * @param mixed $attributes Array of typical HTML attributes plus additional options, such as: * 'multiple' - boolean multi select * 'exclude' - array or int, list of course ids to never show * 'requiredcapabilities' - array of capabilities. Uses ANY to combine them. * 'limittoenrolled' - boolean Limits to enrolled courses. * 'includefrontpage' - boolean Enables the frontpage to be selected. * 'onlywithcompletion' - boolean Limits to courses where completion is enabled. */ public function __construct($elementname = null, $elementlabel = null, $attributes = array()) { if (!is_array($attributes)) { $attributes = []; } if (isset($attributes['multiple'])) { $this->multiple = $attributes['multiple']; } if (isset($attributes['exclude'])) { $this->exclude = $attributes['exclude']; if (!is_array($this->exclude)) { $this->exclude = array($this->exclude); } unset($attributes['exclude']); } if (isset($attributes['requiredcapabilities'])) { $this->requiredcapabilities = $attributes['requiredcapabilities']; unset($attributes['requiredcapabilities']); } if (isset($attributes['limittoenrolled'])) { $this->limittoenrolled = $attributes['limittoenrolled']; unset($attributes['limittoenrolled']); } $attributes += array( 'ajax' => 'core/form-course-selector', 'data-requiredcapabilities' => implode(',', $this->requiredcapabilities), 'data-exclude' => implode(',', $this->exclude), 'data-limittoenrolled' => (int)$this->limittoenrolled ); if (!empty($attributes['includefrontpage'])) { $attributes['data-includefrontpage'] = SITEID; unset($attributes['includefrontpage']); } if (!empty($attributes['onlywithcompletion'])) { $attributes['data-onlywithcompletion'] = 1; unset($attributes['onlywithcompletion']); } parent::__construct($elementname, $elementlabel, array(), $attributes); } /** * Set the value of this element. If values can be added or are unknown, we will * make sure they exist in the options array. * @param string|array $value The value to set. * @return boolean */ public function setValue($value) { global $DB; $values = (array) $value; $coursestofetch = array(); foreach ($values as $onevalue) { if ($onevalue && !$this->optionExists($onevalue) && ($onevalue !== '_qf__force_multiselect_submission')) { array_push($coursestofetch, $onevalue); } } if (empty($coursestofetch)) { return $this->setSelected($values); } // There is no API function to load a list of course from a list of ids. $ctxselect = context_helper::get_preload_record_columns_sql('ctx'); $fields = array('c.id', 'c.category', 'c.sortorder', 'c.shortname', 'c.fullname', 'c.idnumber', 'c.startdate', 'c.visible', 'c.cacherev'); list($whereclause, $params) = $DB->get_in_or_equal($coursestofetch, SQL_PARAMS_NAMED, 'id'); $sql = "SELECT ". join(',', $fields). ", $ctxselect FROM {course} c JOIN {context} ctx ON c.id = ctx.instanceid AND ctx.contextlevel = :contextcourse WHERE c.id ". $whereclause." ORDER BY c.sortorder"; $list = $DB->get_records_sql($sql, array('contextcourse' => CONTEXT_COURSE) + $params); $mycourses = enrol_get_my_courses(null, null, 0, array_keys($list)); $coursestoselect = array(); foreach ($list as $course) { context_helper::preload_from_record($course); $context = context_course::instance($course->id); // Make sure we can see the course. if (!array_key_exists($course->id, $mycourses) && !core_course_category::can_view_course_info($course)) { continue; } $label = format_string(get_course_display_name_for_list($course), true, ['context' => $context]); $this->addOption($label, $course->id); array_push($coursestoselect, $course->id); } return $this->setSelected($values); } }