[Summary view]

   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   * This file contains the forms to set the marking workflow for selected submissions.
  19   *
  20   * @package   mod_assign
  21   * @copyright 2013 Catalyst IT {@link http://www.catalyst.net.nz}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
  26  
  27  require_once($CFG->libdir.'/formslib.php');
  28  require_once($CFG->dirroot . '/mod/assign/feedback/file/locallib.php');
  29  
  30  /**
  31   * Set marking workflow form.
  32   *
  33   * @package   mod_assign
  34   * @copyright 2013 Catalyst IT {@link http://www.catalyst.net.nz}
  35   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class mod_assign_batch_set_marking_workflow_state_form extends moodleform {
  38      /**
  39       * Define this form - called by the parent constructor
  40       */
  41      public function definition() {
  42          $mform = $this->_form;
  43          $params = $this->_customdata;
  44          $formheader = get_string('batchsetmarkingworkflowstateforusers', 'assign', $params['userscount']);
  45  
  46          $mform->addElement('header', 'general', $formheader);
  47          $mform->addElement('static', 'userslist', get_string('selectedusers', 'assign'), $params['usershtml']);
  48  
  49          $options = $params['markingworkflowstates'];
  50          $mform->addElement('select', 'markingworkflowstate', get_string('markingworkflowstate', 'assign'), $options);
  51  
  52          // Don't allow notification to be sent until in "Released" state.
  53          $mform->addElement('selectyesno', 'sendstudentnotifications', get_string('sendstudentnotifications', 'assign'));
  54          $mform->setDefault('sendstudentnotifications', 0);
  55          $mform->disabledIf('sendstudentnotifications', 'markingworkflowstate', 'neq', ASSIGN_MARKING_WORKFLOW_STATE_RELEASED);
  56  
  57          $mform->addElement('hidden', 'id');
  58          $mform->setType('id', PARAM_INT);
  59          $mform->addElement('hidden', 'action', 'setbatchmarkingworkflowstate');
  60          $mform->setType('action', PARAM_ALPHA);
  61          $mform->addElement('hidden', 'selectedusers');
  62          $mform->setType('selectedusers', PARAM_SEQUENCE);
  63          $this->add_action_buttons(true, get_string('savechanges'));
  64  
  65      }
  66  
  67      /**
  68       * Validate the submitted form data.
  69       *
  70       * @param array $data array of ("fieldname"=>value) of submitted data
  71       * @param array $files array of uploaded files "element_name"=>tmp_file_path
  72       * @return array of "element_name"=>"error_description" if there are errors
  73       */
  74      public function validation($data, $files) {
  75          $errors = parent::validation($data, $files);
  76  
  77          // As the implementation of this feature exists currently, no user will see a validation
  78          // failure from this form, but this check ensures the form won't validate if someone
  79          // manipulates the 'sendstudentnotifications' field's disabled attribute client-side.
  80          if (!empty($data['sendstudentnotifications']) && $data['markingworkflowstate'] != ASSIGN_MARKING_WORKFLOW_STATE_RELEASED) {
  81              $errors['sendstudentnotifications'] = get_string('studentnotificationworkflowstateerror', 'assign');
  82          }
  83  
  84          return $errors;
  85      }
  86  }
  87