MDL-69773 block_section_links: Add an option to display section name
[moodle.git] / cohort / edit_form.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  * Cohort related management functions, this file needs to be included manually.
19  *
20  * @package    core_cohort
21  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot . '/lib/formslib.php');
29 class cohort_edit_form extends moodleform {
31     /**
32      * Define the cohort edit form
33      */
34     public function definition() {
35         global $CFG;
37         $mform = $this->_form;
38         $editoroptions = $this->_customdata['editoroptions'];
39         $cohort = $this->_customdata['data'];
41         $mform->addElement('text', 'name', get_string('name', 'cohort'), 'maxlength="254" size="50"');
42         $mform->addRule('name', get_string('required'), 'required', null, 'client');
43         $mform->setType('name', PARAM_TEXT);
45         $options = $this->get_category_options($cohort->contextid);
46         $mform->addElement('autocomplete', 'contextid', get_string('context', 'role'), $options);
48         $mform->addElement('text', 'idnumber', get_string('idnumber', 'cohort'), 'maxlength="254" size="50"');
49         $mform->setType('idnumber', PARAM_RAW); // Idnumbers are plain text, must not be changed.
51         $mform->addElement('advcheckbox', 'visible', get_string('visible', 'cohort'));
52         $mform->setDefault('visible', 1);
53         $mform->addHelpButton('visible', 'visible', 'cohort');
55         $mform->addElement('editor', 'description_editor', get_string('description', 'cohort'), null, $editoroptions);
56         $mform->setType('description_editor', PARAM_RAW);
58         if (!empty($CFG->allowcohortthemes)) {
59             $themes = array_merge(array('' => get_string('forceno')), cohort_get_list_of_themes());
60             $mform->addElement('select', 'theme', get_string('forcetheme'), $themes);
61         }
63         $mform->addElement('hidden', 'id');
64         $mform->setType('id', PARAM_INT);
66         if (isset($this->_customdata['returnurl'])) {
67             $mform->addElement('hidden', 'returnurl', $this->_customdata['returnurl']->out_as_local_url());
68             $mform->setType('returnurl', PARAM_LOCALURL);
69         }
71         $this->add_action_buttons();
73         $this->set_data($cohort);
74     }
76     public function validation($data, $files) {
77         global $DB;
79         $errors = parent::validation($data, $files);
81         $idnumber = trim($data['idnumber']);
82         if ($idnumber === '') {
83             // Fine, empty is ok.
85         } else if ($data['id']) {
86             $current = $DB->get_record('cohort', array('id'=>$data['id']), '*', MUST_EXIST);
87             if ($current->idnumber !== $idnumber) {
88                 if ($DB->record_exists('cohort', array('idnumber'=>$idnumber))) {
89                     $errors['idnumber'] = get_string('duplicateidnumber', 'cohort');
90                 }
91             }
93         } else {
94             if ($DB->record_exists('cohort', array('idnumber'=>$idnumber))) {
95                 $errors['idnumber'] = get_string('duplicateidnumber', 'cohort');
96             }
97         }
99         return $errors;
100     }
102     protected function get_category_options($currentcontextid) {
103         $displaylist = core_course_category::make_categories_list('moodle/cohort:manage');
104         $options = array();
105         $syscontext = context_system::instance();
106         if (has_capability('moodle/cohort:manage', $syscontext)) {
107             $options[$syscontext->id] = $syscontext->get_context_name();
108         }
109         foreach ($displaylist as $cid=>$name) {
110             $context = context_coursecat::instance($cid);
111             $options[$context->id] = $name;
112         }
113         // Always add current - this is not likely, but if the logic gets changed it might be a problem.
114         if (!isset($options[$currentcontextid])) {
115             $context = context::instance_by_id($currentcontextid, MUST_EXIST);
116             $options[$context->id] = $syscontext->get_context_name();
117         }
118         return $options;
119     }