[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 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   * Settings form for overrides in the lesson module.
  19   *
  20   * @package    mod_lesson
  21   * @copyright  2015 Jean-Michel Vedrine
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  require_once($CFG->libdir . '/formslib.php');
  29  require_once($CFG->dirroot . '/mod/lesson/mod_form.php');
  30  
  31  
  32  /**
  33   * Form for editing settings overrides.
  34   *
  35   * @copyright  2015 Jean-Michel Vedrine
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class lesson_override_form extends moodleform {
  39  
  40      /** @var object course module object. */
  41      protected $cm;
  42  
  43      /** @var object the lesson settings object. */
  44      protected $lesson;
  45  
  46      /** @var context the lesson context. */
  47      protected $context;
  48  
  49      /** @var bool editing group override (true) or user override (false). */
  50      protected $groupmode;
  51  
  52      /** @var int groupid, if provided. */
  53      protected $groupid;
  54  
  55      /** @var int userid, if provided. */
  56      protected $userid;
  57  
  58      /**
  59       * Constructor.
  60       * @param moodle_url $submiturl the form action URL.
  61       * @param object $cm course module object.
  62       * @param object $lesson the lesson settings object.
  63       * @param object $context the lesson context.
  64       * @param bool $groupmode editing group override (true) or user override (false).
  65       * @param object $override the override being edited, if it already exists.
  66       */
  67      public function __construct($submiturl, $cm, $lesson, $context, $groupmode, $override) {
  68  
  69          $this->cm = $cm;
  70          $this->lesson = $lesson;
  71          $this->context = $context;
  72          $this->groupmode = $groupmode;
  73          $this->groupid = empty($override->groupid) ? 0 : $override->groupid;
  74          $this->userid = empty($override->userid) ? 0 : $override->userid;
  75  
  76          parent::__construct($submiturl, null, 'post');
  77  
  78      }
  79  
  80      /**
  81       * Define this form - called by the parent constructor
  82       */
  83      protected function definition() {
  84          global $DB;
  85  
  86          $cm = $this->cm;
  87          $mform = $this->_form;
  88  
  89          $mform->addElement('header', 'override', get_string('override', 'lesson'));
  90  
  91          $lessongroupmode = groups_get_activity_groupmode($cm);
  92          $accessallgroups = ($lessongroupmode == NOGROUPS) || has_capability('moodle/site:accessallgroups', $this->context);
  93  
  94          if ($this->groupmode) {
  95              // Group override.
  96              if ($this->groupid) {
  97                  // There is already a groupid, so freeze the selector.
  98                  $groupchoices = [
  99                      $this->groupid => format_string(groups_get_group_name($this->groupid), true, [
 100                          'context' => $this->context,
 101                      ]),
 102                  ];
 103                  $mform->addElement('select', 'groupid',
 104                          get_string('overridegroup', 'lesson'), $groupchoices);
 105                  $mform->freeze('groupid');
 106              } else {
 107                  // Prepare the list of groups.
 108                  // Only include the groups the current can access.
 109                  $groups = $accessallgroups ? groups_get_all_groups($cm->course) :  groups_get_activity_allowed_groups($cm);
 110                  if (empty($groups)) {
 111                      // Generate an error.
 112                      $link = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $cm->id));
 113                      throw new \moodle_exception('groupsnone', 'lesson', $link);
 114                  }
 115  
 116                  $groupchoices = array();
 117                  foreach ($groups as $group) {
 118                      $groupchoices[$group->id] = format_string($group->name, true, [
 119                          'context' => $this->context,
 120                      ]);
 121                  }
 122                  unset($groups);
 123  
 124                  if (count($groupchoices) == 0) {
 125                      $groupchoices[0] = get_string('none');
 126                  }
 127  
 128                  $mform->addElement('select', 'groupid',
 129                          get_string('overridegroup', 'lesson'), $groupchoices);
 130                  $mform->addRule('groupid', get_string('required'), 'required', null, 'client');
 131              }
 132          } else {
 133              // User override.
 134              if ($this->userid) {
 135                  // There is already a userid, so freeze the selector.
 136                  $user = $DB->get_record('user', array('id' => $this->userid));
 137                  $userchoices = array();
 138                  $userchoices[$this->userid] = fullname($user);
 139                  $mform->addElement('select', 'userid',
 140                          get_string('overrideuser', 'lesson'), $userchoices);
 141                  $mform->freeze('userid');
 142              } else {
 143                  // Prepare the list of users.
 144                  $users = [];
 145                  list($sort) = users_order_by_sql('u');
 146  
 147                  // Get the list of appropriate users, depending on whether and how groups are used.
 148                  $userfieldsapi = \core_user\fields::for_name();
 149                  if ($accessallgroups) {
 150                      $users = get_enrolled_users($this->context, '', 0,
 151                              'u.id, u.email, ' . $userfieldsapi->get_sql('u', false, '', '', false)->selects, $sort);
 152                  } else if ($groups = groups_get_activity_allowed_groups($cm)) {
 153                      $enrolledjoin = get_enrolled_join($this->context, 'u.id');
 154                      $userfields = 'u.id, u.email, ' . $userfieldsapi->get_sql('u', false, '', '', false)->selects;
 155                      list($ingroupsql, $ingroupparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
 156                      $params = $enrolledjoin->params + $ingroupparams;
 157                      $sql = "SELECT $userfields
 158                                FROM {user} u
 159                                JOIN {groups_members} gm ON gm.userid = u.id
 160                                     {$enrolledjoin->joins}
 161                               WHERE gm.groupid $ingroupsql
 162                                     AND {$enrolledjoin->wheres}
 163                            ORDER BY $sort";
 164                      $users = $DB->get_records_sql($sql, $params);
 165                  }
 166  
 167                  // Filter users based on any fixed restrictions (groups, profile).
 168                  $info = new \core_availability\info_module($cm);
 169                  $users = $info->filter_user_list($users);
 170  
 171                  if (empty($users)) {
 172                      // Generate an error.
 173                      $link = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $cm->id));
 174                      throw new \moodle_exception('usersnone', 'lesson', $link);
 175                  }
 176  
 177                  $userchoices = array();
 178                  // TODO Does not support custom user profile fields (MDL-70456).
 179                  $canviewemail = in_array('email', \core_user\fields::get_identity_fields($this->context, false));
 180                  foreach ($users as $id => $user) {
 181                      if (empty($invalidusers[$id]) || (!empty($override) &&
 182                              $id == $override->userid)) {
 183                          if ($canviewemail) {
 184                              $userchoices[$id] = fullname($user) . ', ' . $user->email;
 185                          } else {
 186                              $userchoices[$id] = fullname($user);
 187                          }
 188                      }
 189                  }
 190                  unset($users);
 191  
 192                  if (count($userchoices) == 0) {
 193                      $userchoices[0] = get_string('none');
 194                  }
 195                  $mform->addElement('searchableselector', 'userid',
 196                          get_string('overrideuser', 'lesson'), $userchoices);
 197                  $mform->addRule('userid', get_string('required'), 'required', null, 'client');
 198              }
 199          }
 200  
 201          // Password.
 202          // This field has to be above the date and timelimit fields,
 203          // otherwise browsers will clear it when those fields are changed.
 204          $mform->addElement('passwordunmask', 'password', get_string('usepassword', 'lesson'));
 205          $mform->setType('password', PARAM_TEXT);
 206          $mform->addHelpButton('password', 'usepassword', 'lesson');
 207          $mform->setDefault('password', $this->lesson->password);;
 208  
 209          // Open and close dates.
 210          $mform->addElement('date_time_selector', 'available', get_string('available', 'lesson'), array('optional' => true));
 211          $mform->setDefault('available', $this->lesson->available);
 212  
 213          $mform->addElement('date_time_selector', 'deadline', get_string('deadline', 'lesson'), array('optional' => true));
 214          $mform->setDefault('deadline', $this->lesson->deadline);
 215  
 216          // Lesson time limit.
 217          $mform->addElement('duration', 'timelimit',
 218                  get_string('timelimit', 'lesson'), array('optional' => true));
 219          if ($this->lesson->timelimit != 0) {
 220              $mform->setDefault('timelimit', 0);
 221          } else {
 222              $mform->setDefault('timelimit', $this->lesson->timelimit);
 223          }
 224  
 225          // Try a question again.
 226          $mform->addElement('selectyesno', 'review', get_string('displayreview', 'lesson'));
 227          $mform->addHelpButton('review', 'displayreview', 'lesson');
 228          $mform->setDefault('review', $this->lesson->review);
 229  
 230          // Number of attempts.
 231          $numbers = ['0' => get_string('unlimited')];
 232          for ($i = 10; $i > 0; $i--) {
 233              $numbers[$i] = $i;
 234          }
 235          $mform->addElement('select', 'maxattempts', get_string('maximumnumberofattempts', 'lesson'), $numbers);
 236          $mform->addHelpButton('maxattempts', 'maximumnumberofattempts', 'lesson');
 237          $mform->setDefault('maxattempts', $this->lesson->maxattempts);
 238  
 239          // Retake allowed.
 240          $mform->addElement('selectyesno', 'retake', get_string('retakesallowed', 'lesson'));
 241          $mform->addHelpButton('retake', 'retakesallowed', 'lesson');
 242          $mform->setDefault('retake', $this->lesson->retake);
 243  
 244          // Submit buttons.
 245          $mform->addElement('submit', 'resetbutton',
 246                  get_string('reverttodefaults', 'lesson'));
 247  
 248          $buttonarray = array();
 249          $buttonarray[] = $mform->createElement('submit', 'submitbutton',
 250                  get_string('save', 'lesson'));
 251          $buttonarray[] = $mform->createElement('submit', 'againbutton',
 252                  get_string('saveoverrideandstay', 'lesson'));
 253          $buttonarray[] = $mform->createElement('cancel');
 254  
 255          $mform->addGroup($buttonarray, 'buttonbar', '', array(' '), false);
 256          $mform->closeHeaderBefore('buttonbar');
 257  
 258      }
 259  
 260      /**
 261       * Validate the submitted form data.
 262       *
 263       * @param array $data array of ("fieldname"=>value) of submitted data
 264       * @param array $files array of uploaded files "element_name"=>tmp_file_path
 265       * @return array of "element_name"=>"error_description" if there are errors
 266       */
 267      public function validation($data, $files) {
 268          $errors = parent::validation($data, $files);
 269  
 270          $mform =& $this->_form;
 271          $lesson = $this->lesson;
 272  
 273          if ($mform->elementExists('userid')) {
 274              if (empty($data['userid'])) {
 275                  $errors['userid'] = get_string('required');
 276              }
 277          }
 278  
 279          if ($mform->elementExists('groupid')) {
 280              if (empty($data['groupid'])) {
 281                  $errors['groupid'] = get_string('required');
 282              }
 283          }
 284  
 285          // Ensure that the dates make sense.
 286          if (!empty($data['available']) && !empty($data['deadline'])) {
 287              if ($data['deadline'] < $data['available'] ) {
 288                  $errors['deadline'] = get_string('closebeforeopen', 'lesson');
 289              }
 290          }
 291  
 292          // Ensure that at least one lesson setting was changed.
 293          $changed = false;
 294          $keys = array('available', 'deadline', 'review', 'timelimit', 'maxattempts', 'retake', 'password');
 295          foreach ($keys as $key) {
 296              if ($data[$key] != $lesson->{$key}) {
 297                  $changed = true;
 298                  break;
 299              }
 300          }
 301  
 302          if (!$changed) {
 303              $errors['available'] = get_string('nooverridedata', 'lesson');
 304          }
 305  
 306          return $errors;
 307      }
 308  }