Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/cohort/ -> index.php (source)

Differences Between: [Versions 39 and 310] [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

   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/>.
  16  
  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   */
  24  
  25  require('../config.php');
  26  require_once($CFG->dirroot.'/cohort/lib.php');
  27  require_once($CFG->libdir.'/adminlib.php');
  28  
  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);
  33  
  34  require_login();
  35  
  36  if ($contextid) {
  37      $context = context::instance_by_id($contextid, MUST_EXIST);
  38  } else {
  39      $context = context_system::instance();
  40  }
  41  
  42  if ($context->contextlevel != CONTEXT_COURSECAT and $context->contextlevel != CONTEXT_SYSTEM) {
  43      print_error('invalidcontext');
  44  }
  45  
  46  $category = null;
  47  if ($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);
  52  $canassign = has_capability('moodle/cohort:assign', $context);
  53  if (!$manager) {
  54      require_capability('moodle/cohort:view', $context);
  55  }
  56  
  57  $strcohorts = get_string('cohorts', 'cohort');
  58  
  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  }
  69  
  70  echo $OUTPUT->header();
  71  
  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  }
  77  
  78  $count = '';
  79  if ($cohorts['allcohorts'] > 0) {
  80      if ($searchquery === '') {
  81          $count = ' ('.$cohorts['allcohorts'].')';
  82      } else {
  83          $count = ' ('.$cohorts['totalcohorts'].'/'.$cohorts['allcohorts'].')';
  84      }
  85  }
  86  
  87  echo $OUTPUT->heading(get_string('cohortsin', 'cohort', $context->get_context_name()).$count);
  88  
  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);
 100  
 101  if ($editcontrols = cohort_edit_controls($context, $baseurl)) {
 102      echo $OUTPUT->render($editcontrols);
 103  }
 104  
 105  // Add search form.
 106  $search  = html_writer::start_tag('form', array('id'=>'searchcohortquery', 'method'=>'get', 'class' => 'form-inline search-cohort'));
 107  $search .= html_writer::start_div('mb-1');
 108  $search .= html_writer::label(get_string('searchcohort', 'cohort'), 'cohort_search_q', true,
 109          array('class' => 'mr-1')); // No : in form labels!
 110  $search .= html_writer::empty_tag('input', array('id' => 'cohort_search_q', 'type' => 'text', 'name' => 'search',
 111          'value' => $searchquery, 'class' => 'form-control mr-1'));
 112  $search .= html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('search', 'cohort'),
 113          'class' => 'btn btn-secondary'));
 114  $search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'contextid', 'value'=>$contextid));
 115  $search .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'showall', 'value'=>$showall));
 116  $search .= html_writer::end_div();
 117  $search .= html_writer::end_tag('form');
 118  echo $search;
 119  
 120  // Output pagination bar.
 121  echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
 122  
 123  $data = array();
 124  $editcolumnisempty = true;
 125  foreach($cohorts['cohorts'] as $cohort) {
 126      $line = array();
 127      $cohortcontext = context::instance_by_id($cohort->contextid);
 128      $cohort->description = file_rewrite_pluginfile_urls($cohort->description, 'pluginfile.php', $cohortcontext->id,
 129              'cohort', 'description', $cohort->id);
 130      if ($showall) {
 131          if ($cohortcontext->contextlevel == CONTEXT_COURSECAT) {
 132              $line[] = html_writer::link(new moodle_url('/cohort/index.php' ,
 133                      array('contextid' => $cohort->contextid)), $cohortcontext->get_context_name(false));
 134          } else {
 135              $line[] = $cohortcontext->get_context_name(false);
 136          }
 137      }
 138      $tmpl = new \core_cohort\output\cohortname($cohort);
 139      $line[] = $OUTPUT->render_from_template('core/inplace_editable', $tmpl->export_for_template($OUTPUT));
 140      $tmpl = new \core_cohort\output\cohortidnumber($cohort);
 141      $line[] = $OUTPUT->render_from_template('core/inplace_editable', $tmpl->export_for_template($OUTPUT));
 142      $line[] = format_text($cohort->description, $cohort->descriptionformat);
 143  
 144      $line[] = $DB->count_records('cohort_members', array('cohortid'=>$cohort->id));
 145  
 146      if (empty($cohort->component)) {
 147          $line[] = get_string('nocomponent', 'cohort');
 148      } else {
 149          $line[] = get_string('pluginname', $cohort->component);
 150      }
 151  
 152      $buttons = array();
 153      if (empty($cohort->component)) {
 154          $cohortmanager = has_capability('moodle/cohort:manage', $cohortcontext);
 155          $cohortcanassign = has_capability('moodle/cohort:assign', $cohortcontext);
 156  
 157          $urlparams = array('id' => $cohort->id, 'returnurl' => $baseurl->out_as_local_url(false));
 158          $showhideurl = new moodle_url('/cohort/edit.php', $urlparams + array('sesskey' => sesskey()));
 159          if ($cohortmanager) {
 160              if ($cohort->visible) {
 161                  $showhideurl->param('hide', 1);
 162                  $visibleimg = $OUTPUT->pix_icon('t/hide', get_string('hide'));
 163                  $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('hide')));
 164              } else {
 165                  $showhideurl->param('show', 1);
 166                  $visibleimg = $OUTPUT->pix_icon('t/show', get_string('show'));
 167                  $buttons[] = html_writer::link($showhideurl, $visibleimg, array('title' => get_string('show')));
 168              }
 169              $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams + array('delete' => 1)),
 170                  $OUTPUT->pix_icon('t/delete', get_string('delete')),
 171                  array('title' => get_string('delete')));
 172              $buttons[] = html_writer::link(new moodle_url('/cohort/edit.php', $urlparams),
 173                  $OUTPUT->pix_icon('t/edit', get_string('edit')),
 174                  array('title' => get_string('edit')));
 175              $editcolumnisempty = false;
 176          }
 177          if ($cohortcanassign) {
 178              $buttons[] = html_writer::link(new moodle_url('/cohort/assign.php', $urlparams),
 179                  $OUTPUT->pix_icon('i/users', get_string('assign', 'core_cohort')),
 180                  array('title' => get_string('assign', 'core_cohort')));
 181              $editcolumnisempty = false;
 182          }
 183      }
 184      $line[] = implode(' ', $buttons);
 185  
 186      $data[] = $row = new html_table_row($line);
 187      if (!$cohort->visible) {
 188          $row->attributes['class'] = 'dimmed_text';
 189      }
 190  }
 191  $table = new html_table();
 192  $table->head  = array(get_string('name', 'cohort'), get_string('idnumber', 'cohort'), get_string('description', 'cohort'),
 193                        get_string('memberscount', 'cohort'), get_string('component', 'cohort'));
 194  $table->colclasses = array('leftalign name', 'leftalign id', 'leftalign description', 'leftalign size','centeralign source');
 195  if ($showall) {
 196      array_unshift($table->head, get_string('category'));
 197      array_unshift($table->colclasses, 'leftalign category');
 198  }
 199  if (!$editcolumnisempty) {
 200      $table->head[] = get_string('edit');
 201      $table->colclasses[] = 'centeralign action';
 202  } else {
 203      // Remove last column from $data.
 204      foreach ($data as $row) {
 205          array_pop($row->cells);
 206      }
 207  }
 208  $table->id = 'cohorts';
 209  $table->attributes['class'] = 'admintable generaltable';
 210  $table->data  = $data;
 211  echo html_writer::table($table);
 212  echo $OUTPUT->paging_bar($cohorts['totalcohorts'], $page, 25, $baseurl);
 213  echo $OUTPUT->footer();