Merge branch 'wip-MDL-28954-master' of https://github.com/marinaglancy/moodle
[moodle.git] / cohort / index.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 require('../config.php');
26 require($CFG->dirroot.'/cohort/lib.php');
27 require_once($CFG->libdir.'/adminlib.php');
29 $contextid = optional_param('contextid', 0, PARAM_INT);
30 $page = optional_param('page', 0, PARAM_INT);
31 $searchquery  = optional_param('search', '', PARAM_RAW);
32 $showall = optional_param('showall', false, PARAM_BOOL);
34 require_login();
36 if ($contextid) {
37     $context = context::instance_by_id($contextid, MUST_EXIST);
38 } else {
39     $context = context_system::instance();
40 }
42 if ($context->contextlevel != CONTEXT_COURSECAT and $context->contextlevel != CONTEXT_SYSTEM) {
43     print_error('invalidcontext');
44 }
46 $category = null;
47 if ($context->contextlevel == CONTEXT_COURSECAT) {
48     $category = $DB->get_record('course_categories', array('id'=>$context->instanceid), '*', MUST_EXIST);
49 }
51 $manager = has_capability('moodle/cohort:manage', $context);
52 $canassign = has_capability('moodle/cohort:assign', $context);
53 if (!$manager) {
54     require_capability('moodle/cohort:view', $context);
55 }
57 $strcohorts = get_string('cohorts', 'cohort');
59 if ($category) {
60     $PAGE->set_pagelayout('admin');
61     $PAGE->set_context($context);
62     $PAGE->set_url('/cohort/index.php', array('contextid'=>$context->id));
63     $PAGE->set_title($strcohorts);
64     $PAGE->set_heading($COURSE->fullname);
65     $showall = false;
66 } else {
67     admin_externalpage_setup('cohorts', '', null, '', array('pagelayout'=>'report'));
68 }
70 echo $OUTPUT->header();
72 if ($showall) {
73     $cohorts = cohort_get_all_cohorts($page, 25, $searchquery);
74 } else {
75     $cohorts = cohort_get_cohorts($context->id, $page, 25, $searchquery);
76 }
78 $count = '';
79 if ($cohorts['allcohorts'] > 0) {
80     if ($searchquery === '') {
81         $count = ' ('.$cohorts['allcohorts'].')';
82     } else {
83         $count = ' ('.$cohorts['totalcohorts'].'/'.$cohorts['allcohorts'].')';
84     }
85 }
87 echo $OUTPUT->heading(get_string('cohortsin', 'cohort', $context->get_context_name()).$count);
89 $params = array('page' => $page);
90 if ($contextid) {
91     $params['contextid'] = $contextid;
92 }
93 if ($searchquery) {
94     $params['search'] = $searchquery;
95 }
96 if ($showall) {
97     $params['showall'] = true;
98 }
99 $baseurl = new moodle_url('/cohort/index.php', $params);
101 if ($editcontrols = cohort_edit_controls($context, $baseurl)) {
102     echo $OUTPUT->render($editcontrols);
105 // Add search form.
106 $search  = html_writer::start_tag('form', array('id'=>'searchcohortquery', 'method'=>'get'));
107 $search .= html_writer::start_tag('div');
108 $search .= html_writer::label(get_string('searchcohort', 'cohort'), 'cohort_search_q'); // No : in form labels!
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')));
111 $search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'contextid', 'value'=>$contextid));
112 $search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'showall', 'value'=>$showall));
113 $search .= html_writer::end_tag('div');
114 $search .= html_writer::end_tag('form');
115 echo $search;
117 // Output pagination bar.
118 echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
120 $data = array();
121 $editcolumnisempty = true;
122 foreach($cohorts['cohorts'] as $cohort) {
123     $line = array();
124     $cohortcontext = context::instance_by_id($cohort->contextid);
125     $cohort->description = file_rewrite_pluginfile_urls($cohort->description, 'pluginfile.php', $cohortcontext->id,
126             'cohort', 'description', $cohort->id);
127     if ($showall) {
128         if ($cohortcontext->contextlevel == CONTEXT_COURSECAT) {
129             $line[] = html_writer::link(new moodle_url('/cohort/index.php' ,
130                     array('contextid' => $cohort->contextid)), $cohortcontext->get_context_name(false));
131         } else {
132             $line[] = $cohortcontext->get_context_name(false);
133         }
134     }
135     $line[] = format_string($cohort->name);
136     $line[] = s($cohort->idnumber); // All idnumbers are plain text.
137     $line[] = format_text($cohort->description, $cohort->descriptionformat);
139     $line[] = $DB->count_records('cohort_members', array('cohortid'=>$cohort->id));
141     if (empty($cohort->component)) {
142         $line[] = get_string('nocomponent', 'cohort');
143     } else {
144         $line[] = get_string('pluginname', $cohort->component);
145     }
147     $buttons = array();
148     if (empty($cohort->component)) {
149         $cohortmanager = has_capability('moodle/cohort:manage', $cohortcontext);
150         $cohortcanassign = has_capability('moodle/cohort:assign', $cohortcontext);
152         $urlparams = array('id' => $cohort->id, 'returnurl' => $baseurl->out_as_local_url());
153         $showhideurl = new moodle_url('/cohort/edit.php', $urlparams + array('sesskey' => sesskey()));
154         if ($cohortmanager) {
155             if ($cohort->visible) {
156                 $showhideurl->param('hide', 1);
157                 $visibleimg = html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/hide'), 'alt' => get_string('hide'), 'class' => 'iconsmall'));
158                 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('hide')));
159             } else {
160                 $showhideurl->param('show', 1);
161                 $visibleimg = html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/show'), 'alt' => get_string('show'), 'class' => 'iconsmall'));
162                 $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('show')));
163             }
164             $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams + array('delete' => 1)),
165                 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/delete'), 'alt' => get_string('delete'), 'class' => 'iconsmall')),
166                 array('title' => get_string('delete')));
167             $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams),
168                 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/edit'), 'alt' => get_string('edit'), 'class' => 'iconsmall')),
169                 array('title' => get_string('edit')));
170             $editcolumnisempty = false;
171         }
172         if ($cohortcanassign) {
173             $buttons[] = html_writer::link(new moodle_url('/cohort/assign.php', $urlparams),
174                 html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('i/users'), 'alt' => get_string('assign', 'core_cohort'), 'class' => 'iconsmall')),
175                 array('title' => get_string('assign', 'core_cohort')));
176             $editcolumnisempty = false;
177         }
178     }
179     $line[] = implode(' ', $buttons);
181     $data[] = $row = new html_table_row($line);
182     if (!$cohort->visible) {
183         $row->attributes['class'] = 'dimmed_text';
184     }
186 $table = new html_table();
187 $table->head  = array(get_string('name', 'cohort'), get_string('idnumber', 'cohort'), get_string('description', 'cohort'),
188                       get_string('memberscount', 'cohort'), get_string('component', 'cohort'));
189 $table->colclasses = array('leftalign name', 'leftalign id', 'leftalign description', 'leftalign size','centeralign source');
190 if ($showall) {
191     array_unshift($table->head, get_string('category'));
192     array_unshift($table->colclasses, 'leftalign category');
194 if (!$editcolumnisempty) {
195     $table->head[] = get_string('edit');
196     $table->colclasses[] = 'centeralign action';
197 } else {
198     // Remove last column from $data.
199     foreach ($data as $row) {
200         array_pop($row->cells);
201     }
203 $table->id = 'cohorts';
204 $table->attributes['class'] = 'admintable generaltable';
205 $table->data  = $data;
206 echo html_writer::table($table);
207 echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
208 echo $OUTPUT->footer();