on-demand release 4.0dev+
[moodle.git] / cohort / index.php
CommitLineData
b980c56e 1<?php
b980c56e
PS
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/>.
16
17/**
18 * Cohort related management functions, this file needs to be included manually.
19 *
6eb8bf7f 20 * @package core_cohort
707f4136 21 * @copyright 2010 Petr Skoda {@link http://skodak.org}
b980c56e
PS
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25require('../config.php');
6b6fd4b0 26require_once($CFG->dirroot.'/cohort/lib.php');
864e2805 27require_once($CFG->libdir.'/adminlib.php');
b980c56e
PS
28
29$contextid = optional_param('contextid', 0, PARAM_INT);
543009cb
RK
30$page = optional_param('page', 0, PARAM_INT);
31$searchquery = optional_param('search', '', PARAM_RAW);
274dc068 32$showall = optional_param('showall', false, PARAM_BOOL);
b980c56e
PS
33
34require_login();
35
36if ($contextid) {
d197ea43 37 $context = context::instance_by_id($contextid, MUST_EXIST);
b980c56e 38} else {
6ca657a7 39 $context = context_system::instance();
b980c56e
PS
40}
41
42if ($context->contextlevel != CONTEXT_COURSECAT and $context->contextlevel != CONTEXT_SYSTEM) {
43 print_error('invalidcontext');
44}
45
46$category = null;
47if ($context->contextlevel == CONTEXT_COURSECAT) {
48 $category = $DB->get_record('course_categories', array('id'=>$context->instanceid), '*', MUST_EXIST);
49}
50
51$manager = has_capability('moodle/cohort:manage', $context);
50584dd3 52$canassign = has_capability('moodle/cohort:assign', $context);
b980c56e
PS
53if (!$manager) {
54 require_capability('moodle/cohort:view', $context);
55}
56
b980c56e
PS
57$strcohorts = get_string('cohorts', 'cohort');
58
3f873af7 59if ($category) {
d5814f4e 60 $PAGE->set_pagelayout('admin');
f6eb428e 61 $PAGE->set_context($context);
864e2805
PS
62 $PAGE->set_url('/cohort/index.php', array('contextid'=>$context->id));
63 $PAGE->set_title($strcohorts);
bd08a24a 64 $PAGE->set_heading($COURSE->fullname);
274dc068 65 $showall = false;
864e2805 66} else {
367a75fa 67 admin_externalpage_setup('cohorts', '', null, '', array('pagelayout'=>'report'));
b980c56e 68}
b980c56e
PS
69
70echo $OUTPUT->header();
71
274dc068
MG
72if ($showall) {
73 $cohorts = cohort_get_all_cohorts($page, 25, $searchquery);
74} else {
75 $cohorts = cohort_get_cohorts($context->id, $page, 25, $searchquery);
76}
9a2f6770
PS
77
78$count = '';
79if ($cohorts['allcohorts'] > 0) {
80 if ($searchquery === '') {
81 $count = ' ('.$cohorts['allcohorts'].')';
82 } else {
83 $count = ' ('.$cohorts['totalcohorts'].'/'.$cohorts['allcohorts'].')';
84 }
85}
86
87echo $OUTPUT->heading(get_string('cohortsin', 'cohort', $context->get_context_name()).$count);
b980c56e 88
274dc068
MG
89$params = array('page' => $page);
90if ($contextid) {
91 $params['contextid'] = $contextid;
92}
93if ($searchquery) {
94 $params['search'] = $searchquery;
95}
96if ($showall) {
97 $params['showall'] = true;
98}
99$baseurl = new moodle_url('/cohort/index.php', $params);
100
101if ($editcontrols = cohort_edit_controls($context, $baseurl)) {
102 echo $OUTPUT->render($editcontrols);
103}
104
6eb8bf7f 105// Add search form.
702d1ed5
BB
106$hiddenfields = [
107 (object) ['name' => 'contextid', 'value' => $contextid],
108 (object) ['name' => 'showall', 'value' => $showall]
109];
110
111$data = [
112 'action' => new moodle_url('/cohort/index.php'),
113 'inputname' => 'search',
114 'searchstring' => get_string('search', 'cohort'),
115 'query' => $searchquery,
116 'hiddenfields' => $hiddenfields,
117 'extraclasses' => 'mb-3'
118];
119
120echo $OUTPUT->render_from_template('core/search_input', $data);
543009cb 121
6eb8bf7f 122// Output pagination bar.
543009cb 123echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
b980c56e
PS
124
125$data = array();
e65d05c1 126$editcolumnisempty = true;
543009cb 127foreach($cohorts['cohorts'] as $cohort) {
b980c56e 128 $line = array();
274dc068 129 $cohortcontext = context::instance_by_id($cohort->contextid);
62184733
MG
130 $cohort->description = file_rewrite_pluginfile_urls($cohort->description, 'pluginfile.php', $cohortcontext->id,
131 'cohort', 'description', $cohort->id);
274dc068
MG
132 if ($showall) {
133 if ($cohortcontext->contextlevel == CONTEXT_COURSECAT) {
5076b961
MG
134 $line[] = html_writer::link(new moodle_url('/cohort/index.php' ,
135 array('contextid' => $cohort->contextid)), $cohortcontext->get_context_name(false));
274dc068 136 } else {
5076b961 137 $line[] = $cohortcontext->get_context_name(false);
274dc068
MG
138 }
139 }
48983fb9
MG
140 $tmpl = new \core_cohort\output\cohortname($cohort);
141 $line[] = $OUTPUT->render_from_template('core/inplace_editable', $tmpl->export_for_template($OUTPUT));
142 $tmpl = new \core_cohort\output\cohortidnumber($cohort);
143 $line[] = $OUTPUT->render_from_template('core/inplace_editable', $tmpl->export_for_template($OUTPUT));
b980c56e
PS
144 $line[] = format_text($cohort->description, $cohort->descriptionformat);
145
146 $line[] = $DB->count_records('cohort_members', array('cohortid'=>$cohort->id));
147
148 if (empty($cohort->component)) {
149 $line[] = get_string('nocomponent', 'cohort');
150 } else {
151 $line[] = get_string('pluginname', $cohort->component);
152 }
153
50584dd3
PS
154 $buttons = array();
155 if (empty($cohort->component)) {
274dc068
MG
156 $cohortmanager = has_capability('moodle/cohort:manage', $cohortcontext);
157 $cohortcanassign = has_capability('moodle/cohort:assign', $cohortcontext);
158
1d4dbcde 159 $urlparams = array('id' => $cohort->id, 'returnurl' => $baseurl->out_as_local_url(false));
80f98467 160 $showhideurl = new moodle_url('/cohort/edit.php', $urlparams + array('sesskey' => sesskey()));
274dc068 161 if ($cohortmanager) {
e65d05c1
MG
162 if ($cohort->visible) {
163 $showhideurl->param('hide', 1);
663640f5 164 $visibleimg = $OUTPUT->pix_icon('t/hide', get_string('hide'));
e65d05c1
MG
165 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('hide')));
166 } else {
167 $showhideurl->param('show', 1);
663640f5 168 $visibleimg = $OUTPUT->pix_icon('t/show', get_string('show'));
e65d05c1
MG
169 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('show')));
170 }
274dc068 171 $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams + array('delete' => 1)),
663640f5 172 $OUTPUT->pix_icon('t/delete', get_string('delete')),
80f98467 173 array('title' => get_string('delete')));
274dc068 174 $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams),
663640f5 175 $OUTPUT->pix_icon('t/edit', get_string('edit')),
80f98467 176 array('title' => get_string('edit')));
e65d05c1 177 $editcolumnisempty = false;
50584dd3 178 }
274dc068
MG
179 if ($cohortcanassign) {
180 $buttons[] = html_writer::link(new moodle_url('/cohort/assign.php', $urlparams),
663640f5 181 $OUTPUT->pix_icon('i/users', get_string('assign', 'core_cohort')),
80f98467 182 array('title' => get_string('assign', 'core_cohort')));
e65d05c1 183 $editcolumnisempty = false;
b980c56e 184 }
b980c56e 185 }
50584dd3 186 $line[] = implode(' ', $buttons);
b980c56e 187
80f98467
MG
188 $data[] = $row = new html_table_row($line);
189 if (!$cohort->visible) {
190 $row->attributes['class'] = 'dimmed_text';
191 }
b980c56e
PS
192}
193$table = new html_table();
194$table->head = array(get_string('name', 'cohort'), get_string('idnumber', 'cohort'), get_string('description', 'cohort'),
e65d05c1
MG
195 get_string('memberscount', 'cohort'), get_string('component', 'cohort'));
196$table->colclasses = array('leftalign name', 'leftalign id', 'leftalign description', 'leftalign size','centeralign source');
274dc068
MG
197if ($showall) {
198 array_unshift($table->head, get_string('category'));
199 array_unshift($table->colclasses, 'leftalign category');
200}
e65d05c1
MG
201if (!$editcolumnisempty) {
202 $table->head[] = get_string('edit');
203 $table->colclasses[] = 'centeralign action';
204} else {
205 // Remove last column from $data.
206 foreach ($data as $row) {
207 array_pop($row->cells);
208 }
209}
6fc61f2d
RW
210$table->id = 'cohorts';
211$table->attributes['class'] = 'admintable generaltable';
b980c56e
PS
212$table->data = $data;
213echo html_writer::table($table);
543009cb 214echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
6eb8bf7f 215echo $OUTPUT->footer();