weekly on-sync release 3.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');
543009cb 26require($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.
543009cb
RK
106$search = html_writer::start_tag('form', array('id'=>'searchcohortquery', 'method'=>'get'));
107$search .= html_writer::start_tag('div');
6eb8bf7f 108$search .= html_writer::label(get_string('searchcohort', 'cohort'), 'cohort_search_q'); // No : in form labels!
543009cb
RK
109$search .= html_writer::empty_tag('input', array('id'=>'cohort_search_q', 'type'=>'text', 'name'=>'search', 'value'=>$searchquery));
110$search .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('search', 'cohort')));
0fa01f4e 111$search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'contextid', 'value'=>$contextid));
274dc068 112$search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'showall', 'value'=>$showall));
543009cb
RK
113$search .= html_writer::end_tag('div');
114$search .= html_writer::end_tag('form');
115echo $search;
116
6eb8bf7f 117// Output pagination bar.
543009cb 118echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
b980c56e
PS
119
120$data = array();
543009cb 121foreach($cohorts['cohorts'] as $cohort) {
b980c56e 122 $line = array();
274dc068
MG
123 $cohortcontext = context::instance_by_id($cohort->contextid);
124 if ($showall) {
125 if ($cohortcontext->contextlevel == CONTEXT_COURSECAT) {
5076b961
MG
126 $line[] = html_writer::link(new moodle_url('/cohort/index.php' ,
127 array('contextid' => $cohort->contextid)), $cohortcontext->get_context_name(false));
274dc068 128 } else {
5076b961 129 $line[] = $cohortcontext->get_context_name(false);
274dc068
MG
130 }
131 }
b980c56e 132 $line[] = format_string($cohort->name);
6eb8bf7f 133 $line[] = s($cohort->idnumber); // All idnumbers are plain text.
b980c56e
PS
134 $line[] = format_text($cohort->description, $cohort->descriptionformat);
135
136 $line[] = $DB->count_records('cohort_members', array('cohortid'=>$cohort->id));
137
138 if (empty($cohort->component)) {
139 $line[] = get_string('nocomponent', 'cohort');
140 } else {
141 $line[] = get_string('pluginname', $cohort->component);
142 }
143
50584dd3
PS
144 $buttons = array();
145 if (empty($cohort->component)) {
274dc068
MG
146 $cohortmanager = has_capability('moodle/cohort:manage', $cohortcontext);
147 $cohortcanassign = has_capability('moodle/cohort:assign', $cohortcontext);
148
149 $urlparams = array('id' => $cohort->id, 'returnurl' => $baseurl->out_as_local_url());
80f98467
MG
150 $showhideurl = new moodle_url('/cohort/edit.php', $urlparams + array('sesskey' => sesskey()));
151 if ($cohort->visible) {
152 $showhideurl->param('hide', 1);
153 $visibleimg = html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/hide'), 'alt' => get_string('hide'), 'class' => 'iconsmall'));
154 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('hide')));
155 } else {
156 $showhideurl->param('show', 1);
157 $visibleimg = html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/show'), 'alt' => get_string('show'), 'class' => 'iconsmall'));
158 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('show')));
159 }
274dc068
MG
160 if ($cohortmanager) {
161 $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams + array('delete' => 1)),
80f98467
MG
162 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/delete'), 'alt' => get_string('delete'), 'class' => 'iconsmall')),
163 array('title' => get_string('delete')));
274dc068 164 $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams),
80f98467
MG
165 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/edit'), 'alt' => get_string('edit'), 'class' => 'iconsmall')),
166 array('title' => get_string('edit')));
50584dd3 167 }
274dc068
MG
168 if ($cohortcanassign) {
169 $buttons[] = html_writer::link(new moodle_url('/cohort/assign.php', $urlparams),
80f98467
MG
170 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('i/users'), 'alt' => get_string('assign', 'core_cohort'), 'class' => 'iconsmall')),
171 array('title' => get_string('assign', 'core_cohort')));
b980c56e 172 }
b980c56e 173 }
50584dd3 174 $line[] = implode(' ', $buttons);
b980c56e 175
80f98467
MG
176 $data[] = $row = new html_table_row($line);
177 if (!$cohort->visible) {
178 $row->attributes['class'] = 'dimmed_text';
179 }
b980c56e
PS
180}
181$table = new html_table();
182$table->head = array(get_string('name', 'cohort'), get_string('idnumber', 'cohort'), get_string('description', 'cohort'),
183 get_string('memberscount', 'cohort'), get_string('component', 'cohort'), get_string('edit'));
6fc61f2d 184$table->colclasses = array('leftalign name', 'leftalign id', 'leftalign description', 'leftalign size','centeralign source', 'centeralign action');
274dc068
MG
185if ($showall) {
186 array_unshift($table->head, get_string('category'));
187 array_unshift($table->colclasses, 'leftalign category');
188}
6fc61f2d
RW
189$table->id = 'cohorts';
190$table->attributes['class'] = 'admintable generaltable';
b980c56e
PS
191$table->data = $data;
192echo html_writer::table($table);
543009cb 193echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
6eb8bf7f 194echo $OUTPUT->footer();