NOBUG: Added page heading
[moodle.git] / enrol / instances.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  * Main course enrolment management UI.
19  *
20  * @package    core
21  * @subpackage enrol
22  * @copyright  2010 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require('../config.php');
28 $id         = required_param('id', PARAM_INT); // course id
29 $action     = optional_param('action', '', PARAM_ACTION);
30 $instanceid = optional_param('instance', 0, PARAM_INT);
31 $confirm    = optional_param('confirm', 0, PARAM_BOOL);
33 $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
34 $context = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
36 if ($course->id == SITEID) {
37     redirect("$CFG->wwwroot/");
38 }
40 require_login($course);
41 require_capability('moodle/course:enrolreview', $context);
43 $canconfig = has_capability('moodle/course:enrolconfig', $context);
45 $PAGE->set_url('/enrol/instances.php', array('id'=>$course->id));
46 $PAGE->set_pagelayout('admin');
47 $PAGE->set_title(get_string('enrolmentinstances', 'enrol'));
48 $PAGE->set_heading($course->fullname);
50 $instances = enrol_get_instances($course->id, false);
51 $plugins   = enrol_get_plugins(false);
53 if ($canconfig and $action and confirm_sesskey()) {
54     if (isset($instances[$instanceid]) and isset($plugins[$instances[$instanceid]->enrol])) {
55         if ($action === 'up') {
56             $order = array_keys($instances);
57             $order = array_flip($order);
58             $pos = $order[$instanceid];
59             if ($pos > 0) {
60                 $switch = $pos - 1;
61                 $resorted = array_values($instances);
62                 $temp = $resorted[$pos];
63                 $resorted[$pos] = $resorted[$switch];
64                 $resorted[$switch] = $temp;
65                 // now update db sortorder
66                 foreach ($resorted as $sortorder=>$instance) {
67                     if ($instance->sortorder != $sortorder) {
68                         $instance->sortorder = $sortorder;
69                         $DB->update_record('enrol', $instance);
70                     }
71                 }
72             }
73             redirect($PAGE->url);
75         } else if ($action === 'down') {
76             $order = array_keys($instances);
77             $order = array_flip($order);
78             $pos = $order[$instanceid];
79             if ($pos < count($instances) - 1) {
80                 $switch = $pos + 1;
81                 $resorted = array_values($instances);
82                 $temp = $resorted[$pos];
83                 $resorted[$pos] = $resorted[$switch];
84                 $resorted[$switch] = $temp;
85                 // now update db sortorder
86                 foreach ($resorted as $sortorder=>$instance) {
87                     if ($instance->sortorder != $sortorder) {
88                         $instance->sortorder = $sortorder;
89                         $DB->update_record('enrol', $instance);
90                     }
91                 }
92             }
93             redirect($PAGE->url);
95         } else if ($action === 'delete') {
96             $instance = $instances[$instanceid];
97             $plugin = $plugins[$instance->enrol];
99             if ($confirm) {
100                 $plugin->delete_instance($instance);
101                 redirect($PAGE->url);
102             }
104             echo $OUTPUT->header();
105             $yesurl = new moodle_url('/enrol/instances.php', array('id'=>$course->id, 'action'=>'delete', 'instance'=>$instance->id, 'confirm'=>1,'sesskey'=>sesskey()));
106             $displayname = $plugin->get_instance_name($instance);
107             $users = $DB->count_records('user_enrolments', array('enrolid'=>$instance->id));
108             $message = get_string('deleteinstanceconfirm', 'enrol', array('name'=>$displayname, 'users'=>$users));
109             echo $OUTPUT->confirm($message, $yesurl, $PAGE->url);
110             echo $OUTPUT->footer();
111             die();
113         } else if ($action === 'disable') {
114             $instance = $instances[$instanceid];
115             if ($instance->status == ENROL_INSTANCE_ENABLED) {
116                 $instance->status = ENROL_INSTANCE_DISABLED;
117                 $DB->update_record('enrol', $instance);
118                 redirect($PAGE->url);
119             }
121         } else if ($action === 'enable') {
122             $instance = $instances[$instanceid];
123             if ($instance->status == ENROL_INSTANCE_DISABLED) {
124                 $instance->status = ENROL_INSTANCE_ENABLED;
125                 $DB->update_record('enrol', $instance);
126                 redirect($PAGE->url);
127             }
128         }
129     }
133 echo $OUTPUT->header();
134 echo $OUTPUT->heading(get_string('enrolmentinstances', 'enrol'));
136 echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthnormal');
138 // display strings
139 $strup      = get_string('up');
140 $strdown    = get_string('down');
141 $strdelete  = get_string('delete');
142 $strenable  = get_string('enable');
143 $strdisable = get_string('disable');
144 $strmanage  = get_string('manageinstance', 'enrol');
146 $table = new html_table();
147 $table->head  = array(get_string('name'), get_string('users'), $strup.'/'.$strdown, get_string('edit'));
148 $table->align = array('left', 'center', 'center', 'center');
149 $table->width = '100%';
150 $table->data  = array();
152 // iterate through enrol plugins and add to the display table
153 $updowncount = 1;
154 $icount = count($instances);
155 $url = new moodle_url('/enrol/instances.php', array('sesskey'=>sesskey(), 'id'=>$course->id));
156 foreach ($instances as $instance) {
157     if (!isset($plugins[$instance->enrol])) {
158         continue;
159     }
160     $plugin = $plugins[$instance->enrol];
162     $displayname = $plugin->get_instance_name($instance);
163     if (!enrol_is_enabled($instance->enrol) or $instance->status != ENROL_INSTANCE_ENABLED) {
164         $displayname = html_writer::tag('span', $displayname, array('class'=>'dimmed_text'));
165     }
167     $users = $DB->count_records('user_enrolments', array('enrolid'=>$instance->id));
169     $updown = array();
170     $edit = array();
172     if ($canconfig) {
173         // up/down link
174         $updown = '';
175         if ($updowncount > 1) {
176             $aurl = new moodle_url($url, array('action'=>'up', 'instance'=>$instance->id));
177             $updown[] = html_writer::link($aurl, html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/up'), 'alt'=>$strup, 'class'=>'smallicon')));
178         } else {
179             $updown[] = html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('spacer'), 'alt'=>'', 'class'=>'smallicon'));
180         }
181         if ($updowncount < $icount) {
182             $aurl = new moodle_url($url, array('action'=>'down', 'instance'=>$instance->id));
183             $updown[] = html_writer::link($aurl, html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/down'), 'alt'=>$strdown, 'class'=>'smallicon')));
184         } else {
185             $updown[] = html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('spacer'), 'alt'=>'', 'class'=>'smallicon'));
186         }
187         ++$updowncount;
189         // edit links
190         if ($plugin->instance_deleteable($instance)) {
191             $aurl = new moodle_url($url, array('action'=>'delete', 'instance'=>$instance->id));
192             $edit[] = html_writer::link($aurl, html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/delete'), 'alt'=>$strdelete, 'class'=>'smallicon')));
193         }
195         if (enrol_is_enabled($instance->enrol)) {
196             if ($instance->status == ENROL_INSTANCE_ENABLED) {
197                 $aurl = new moodle_url($url, array('action'=>'disable', 'instance'=>$instance->id));
198                 $edit[] = html_writer::link($aurl, html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/hide'), 'alt'=>$strdisable, 'class'=>'smallicon')));
199             } else if ($instance->status == ENROL_INSTANCE_DISABLED) {
200                 $aurl = new moodle_url($url, array('action'=>'enable', 'instance'=>$instance->id));
201                 $edit[] = html_writer::link($aurl, html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/show'), 'alt'=>$strenable, 'class'=>'smallicon')));
202             } else {
203                 // plugin specific state - do not mess with it!
204                 $edit[] = html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('t/show'), 'alt'=>'', 'class'=>'smallicon'));
205             }
207         }
208     }
210     // link to instance management
211     if (enrol_is_enabled($instance->enrol)) {
212         if ($icons = $plugin->get_action_icons($instance)) {
213             $edit = array_merge($edit, $icons);
214         }
215     }
217     // add a row to the table
218     $table->data[] = array($displayname, $users, implode('&nbsp;', $updown), implode('&nbsp;', $edit));
221 echo html_writer::table($table);
223 // access security is in each plugin
224 $candidates = array();
225 foreach (enrol_get_plugins(true) as $name=>$plugin) {
226     if (!$link = $plugin->get_newinstance_link($course->id)) {
227         continue;
228     }
229     $candidates[$link->out(false)] = get_string('pluginname', 'enrol_'.$name);
232 if ($candidates) {
233     $select = new url_select($candidates);
234     $select->set_label(get_string('addinstance', 'enrol'));
235     echo $OUTPUT->render($select);
238 echo $OUTPUT->box_end();
240 echo $OUTPUT->footer();