David Mudrák
d34ea7dc33
There was a plan to make use of it initially when Workshop was rewritten for Moodle 2.0. The idea was that the Workshop could be switched into a simplified mode where teachers only make assessments (with all the grading strategies available). But things evolved since then and now we have Advanced grading methods available in the new Assignment module that solves the use case well. So, having this option available is not only confusing but - looking at the code - pretty useless. For now, I am just hiding the setting from the settings form and the code always considers it as if it was enabled. In the future, the field can disappear from the database, too.
372 lines
18 KiB
PHP
372 lines
18 KiB
PHP
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* The main workshop configuration form
|
|
*
|
|
* The UI mockup has been proposed in MDL-18688
|
|
* It uses the standard core Moodle formslib. For more info about them, please
|
|
* visit: http://docs.moodle.org/dev/lib/formslib.php
|
|
*
|
|
* @package mod
|
|
* @subpackage workshop
|
|
* @copyright 2009 David Mudrak <david.mudrak@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once($CFG->dirroot . '/course/moodleform_mod.php');
|
|
require_once(dirname(__FILE__) . '/locallib.php');
|
|
require_once($CFG->libdir . '/filelib.php');
|
|
|
|
/**
|
|
* Module settings form for Workshop instances
|
|
*/
|
|
class mod_workshop_mod_form extends moodleform_mod {
|
|
|
|
/** @var object the course this instance is part of */
|
|
protected $course = null;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct($current, $section, $cm, $course) {
|
|
$this->course = $course;
|
|
parent::__construct($current, $section, $cm, $course);
|
|
}
|
|
|
|
/**
|
|
* Defines the workshop instance configuration form
|
|
*
|
|
* @return void
|
|
*/
|
|
public function definition() {
|
|
global $CFG;
|
|
|
|
$workshopconfig = get_config('workshop');
|
|
$mform = $this->_form;
|
|
|
|
// General --------------------------------------------------------------------
|
|
$mform->addElement('header', 'general', get_string('general', 'form'));
|
|
|
|
// Workshop name
|
|
$label = get_string('workshopname', 'workshop');
|
|
$mform->addElement('text', 'name', $label, array('size'=>'64'));
|
|
if (!empty($CFG->formatstringstriptags)) {
|
|
$mform->setType('name', PARAM_TEXT);
|
|
} else {
|
|
$mform->setType('name', PARAM_CLEANHTML);
|
|
}
|
|
$mform->addRule('name', null, 'required', null, 'client');
|
|
$mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
|
|
|
|
// Introduction
|
|
$this->add_intro_editor(false, get_string('introduction', 'workshop'));
|
|
|
|
// Workshop features ----------------------------------------------------------
|
|
$mform->addElement('header', 'workshopfeatures', get_string('workshopfeatures', 'workshop'));
|
|
|
|
$label = get_string('useexamples', 'workshop');
|
|
$text = get_string('useexamples_desc', 'workshop');
|
|
$mform->addElement('checkbox', 'useexamples', $label, $text);
|
|
$mform->addHelpButton('useexamples', 'useexamples', 'workshop');
|
|
|
|
$label = get_string('useselfassessment', 'workshop');
|
|
$text = get_string('useselfassessment_desc', 'workshop');
|
|
$mform->addElement('checkbox', 'useselfassessment', $label, $text);
|
|
$mform->addHelpButton('useselfassessment', 'useselfassessment', 'workshop');
|
|
|
|
// Grading settings -----------------------------------------------------------
|
|
$mform->addElement('header', 'gradingsettings', get_string('gradingsettings', 'workshop'));
|
|
|
|
$grades = workshop::available_maxgrades_list();
|
|
$gradecategories = grade_get_categories_menu($this->course->id);
|
|
|
|
$label = get_string('submissiongrade', 'workshop');
|
|
$mform->addGroup(array(
|
|
$mform->createElement('select', 'grade', '', $grades),
|
|
$mform->createElement('select', 'gradecategory', '', $gradecategories),
|
|
), 'submissiongradegroup', $label, ' ', false);
|
|
$mform->setDefault('grade', $workshopconfig->grade);
|
|
$mform->addHelpButton('submissiongradegroup', 'submissiongrade', 'workshop');
|
|
|
|
$label = get_string('gradinggrade', 'workshop');
|
|
$mform->addGroup(array(
|
|
$mform->createElement('select', 'gradinggrade', '', $grades),
|
|
$mform->createElement('select', 'gradinggradecategory', '', $gradecategories),
|
|
), 'gradinggradegroup', $label, ' ', false);
|
|
$mform->setDefault('gradinggrade', $workshopconfig->gradinggrade);
|
|
$mform->addHelpButton('gradinggradegroup', 'gradinggrade', 'workshop');
|
|
|
|
$label = get_string('strategy', 'workshop');
|
|
$mform->addElement('select', 'strategy', $label, workshop::available_strategies_list());
|
|
$mform->setDefault('strategy', $workshopconfig->strategy);
|
|
$mform->addHelpButton('strategy', 'strategy', 'workshop');
|
|
|
|
$options = array();
|
|
for ($i=5; $i>=0; $i--) {
|
|
$options[$i] = $i;
|
|
}
|
|
$label = get_string('gradedecimals', 'workshop');
|
|
$mform->addElement('select', 'gradedecimals', $label, $options);
|
|
$mform->setAdvanced('gradedecimals');
|
|
$mform->setDefault('gradedecimals', $workshopconfig->gradedecimals);
|
|
|
|
// Submission settings --------------------------------------------------------
|
|
$mform->addElement('header', 'submissionsettings', get_string('submissionsettings', 'workshop'));
|
|
|
|
$label = get_string('instructauthors', 'workshop');
|
|
$mform->addElement('editor', 'instructauthorseditor', $label, null,
|
|
workshop::instruction_editors_options($this->context));
|
|
|
|
$options = array();
|
|
for ($i=7; $i>=0; $i--) {
|
|
$options[$i] = $i;
|
|
}
|
|
$label = get_string('nattachments', 'workshop');
|
|
$mform->addElement('select', 'nattachments', $label, $options);
|
|
$mform->setDefault('nattachments', 1);
|
|
|
|
$options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes);
|
|
$mform->addElement('select', 'maxbytes', get_string('maxbytes', 'workshop'), $options);
|
|
$mform->setDefault('maxbytes', $workshopconfig->maxbytes);
|
|
|
|
$label = get_string('latesubmissions', 'workshop');
|
|
$text = get_string('latesubmissions_desc', 'workshop');
|
|
$mform->addElement('checkbox', 'latesubmissions', $label, $text);
|
|
$mform->addHelpButton('latesubmissions', 'latesubmissions', 'workshop');
|
|
$mform->setAdvanced('latesubmissions');
|
|
|
|
// Assessment settings --------------------------------------------------------
|
|
$mform->addElement('header', 'assessmentsettings', get_string('assessmentsettings', 'workshop'));
|
|
|
|
$label = get_string('instructreviewers', 'workshop');
|
|
$mform->addElement('editor', 'instructreviewerseditor', $label, null,
|
|
workshop::instruction_editors_options($this->context));
|
|
|
|
$mform->addElement('select', 'overallfeedbackmode', get_string('overallfeedbackmode', 'mod_workshop'), array(
|
|
0 => get_string('overallfeedbackmode_0', 'mod_workshop'),
|
|
1 => get_string('overallfeedbackmode_1', 'mod_workshop'),
|
|
2 => get_string('overallfeedbackmode_2', 'mod_workshop')));
|
|
$mform->addHelpButton('overallfeedbackmode', 'overallfeedbackmode', 'mod_workshop');
|
|
$mform->setDefault('overallfeedbackmode', 1);
|
|
$mform->setAdvanced('overallfeedbackmode');
|
|
|
|
$options = array();
|
|
for ($i = 7; $i >= 0; $i--) {
|
|
$options[$i] = $i;
|
|
}
|
|
$mform->addElement('select', 'overallfeedbackfiles', get_string('overallfeedbackfiles', 'workshop'), $options);
|
|
$mform->setDefault('overallfeedbackfiles', 0);
|
|
$mform->setAdvanced('overallfeedbackfiles');
|
|
$mform->disabledIf('overallfeedbackfiles', 'overallfeedbackmode', 'eq', 0);
|
|
|
|
$options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes);
|
|
$mform->addElement('select', 'overallfeedbackmaxbytes', get_string('overallfeedbackmaxbytes', 'workshop'), $options);
|
|
$mform->setAdvanced('overallfeedbackmaxbytes');
|
|
$mform->setDefault('overallfeedbackmaxbytes', $workshopconfig->maxbytes);
|
|
$mform->disabledIf('overallfeedbackmaxbytes', 'overallfeedbackmode', 'eq', 0);
|
|
$mform->disabledIf('overallfeedbackmaxbytes', 'overallfeedbackfiles', 'eq', 0);
|
|
|
|
$label = get_string('examplesmode', 'workshop');
|
|
$options = workshop::available_example_modes_list();
|
|
$mform->addElement('select', 'examplesmode', $label, $options);
|
|
$mform->setDefault('examplesmode', $workshopconfig->examplesmode);
|
|
$mform->disabledIf('examplesmode', 'useexamples');
|
|
$mform->setAdvanced('examplesmode');
|
|
|
|
// Miscellaneous settings
|
|
$mform->addElement('header', 'miscellaneoussettings', get_string('miscellaneoussettings', 'workshop'));
|
|
|
|
$label = get_string('conclusion', 'workshop');
|
|
$mform->addElement('editor', 'conclusioneditor', $label, null,
|
|
workshop::instruction_editors_options($this->context));
|
|
$mform->addHelpButton('conclusioneditor', 'conclusion', 'workshop');
|
|
|
|
// Access control -------------------------------------------------------------
|
|
$mform->addElement('header', 'accesscontrol', get_string('accesscontrol', 'workshop'));
|
|
|
|
$label = get_string('submissionstart', 'workshop');
|
|
$mform->addElement('date_time_selector', 'submissionstart', $label, array('optional' => true));
|
|
$mform->setAdvanced('submissionstart');
|
|
|
|
$label = get_string('submissionend', 'workshop');
|
|
$mform->addElement('date_time_selector', 'submissionend', $label, array('optional' => true));
|
|
$mform->setAdvanced('submissionend');
|
|
|
|
$label = get_string('submissionendswitch', 'mod_workshop');
|
|
$mform->addElement('checkbox', 'phaseswitchassessment', $label);
|
|
$mform->setAdvanced('phaseswitchassessment');
|
|
$mform->disabledIf('phaseswitchassessment', 'submissionend[enabled]');
|
|
$mform->addHelpButton('phaseswitchassessment', 'submissionendswitch', 'mod_workshop');
|
|
|
|
$label = get_string('assessmentstart', 'workshop');
|
|
$mform->addElement('date_time_selector', 'assessmentstart', $label, array('optional' => true));
|
|
$mform->setAdvanced('assessmentstart');
|
|
|
|
$label = get_string('assessmentend', 'workshop');
|
|
$mform->addElement('date_time_selector', 'assessmentend', $label, array('optional' => true));
|
|
$mform->setAdvanced('assessmentend');
|
|
|
|
$coursecontext = context_course::instance($this->course->id);
|
|
plagiarism_get_form_elements_module($mform, $coursecontext, 'mod_workshop');
|
|
|
|
// Common module settings, Restrict availability, Activity completion etc. ----
|
|
$features = array('groups'=>true, 'groupings'=>true, 'groupmembersonly'=>true,
|
|
'outcomes'=>true, 'gradecat'=>false, 'idnumber'=>false);
|
|
|
|
$this->standard_coursemodule_elements();
|
|
|
|
// Standard buttons, common to all modules ------------------------------------
|
|
$this->add_action_buttons();
|
|
}
|
|
|
|
/**
|
|
* Prepares the form before data are set
|
|
*
|
|
* Additional wysiwyg editor are prepared here, the introeditor is prepared automatically by core.
|
|
* Grade items are set here because the core modedit supports single grade item only.
|
|
*
|
|
* @param array $data to be set
|
|
* @return void
|
|
*/
|
|
public function data_preprocessing(&$data) {
|
|
if ($this->current->instance) {
|
|
// editing an existing workshop - let us prepare the added editor elements (intro done automatically)
|
|
$draftitemid = file_get_submitted_draft_itemid('instructauthors');
|
|
$data['instructauthorseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
|
|
'mod_workshop', 'instructauthors', 0,
|
|
workshop::instruction_editors_options($this->context),
|
|
$data['instructauthors']);
|
|
$data['instructauthorseditor']['format'] = $data['instructauthorsformat'];
|
|
$data['instructauthorseditor']['itemid'] = $draftitemid;
|
|
|
|
$draftitemid = file_get_submitted_draft_itemid('instructreviewers');
|
|
$data['instructreviewerseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
|
|
'mod_workshop', 'instructreviewers', 0,
|
|
workshop::instruction_editors_options($this->context),
|
|
$data['instructreviewers']);
|
|
$data['instructreviewerseditor']['format'] = $data['instructreviewersformat'];
|
|
$data['instructreviewerseditor']['itemid'] = $draftitemid;
|
|
|
|
$draftitemid = file_get_submitted_draft_itemid('conclusion');
|
|
$data['conclusioneditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
|
|
'mod_workshop', 'conclusion', 0,
|
|
workshop::instruction_editors_options($this->context),
|
|
$data['conclusion']);
|
|
$data['conclusioneditor']['format'] = $data['conclusionformat'];
|
|
$data['conclusioneditor']['itemid'] = $draftitemid;
|
|
} else {
|
|
// adding a new workshop instance
|
|
$draftitemid = file_get_submitted_draft_itemid('instructauthors');
|
|
file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructauthors', 0); // no context yet, itemid not used
|
|
$data['instructauthorseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
|
|
|
|
$draftitemid = file_get_submitted_draft_itemid('instructreviewers');
|
|
file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructreviewers', 0); // no context yet, itemid not used
|
|
$data['instructreviewerseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
|
|
|
|
$draftitemid = file_get_submitted_draft_itemid('conclusion');
|
|
file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'conclusion', 0); // no context yet, itemid not used
|
|
$data['conclusioneditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the grade item categories when editing an instance
|
|
*/
|
|
public function definition_after_data() {
|
|
|
|
$mform =& $this->_form;
|
|
|
|
if ($id = $mform->getElementValue('update')) {
|
|
$instance = $mform->getElementValue('instance');
|
|
|
|
$gradeitems = grade_item::fetch_all(array(
|
|
'itemtype' => 'mod',
|
|
'itemmodule' => 'workshop',
|
|
'iteminstance' => $instance,
|
|
'courseid' => $this->course->id));
|
|
|
|
if (!empty($gradeitems)) {
|
|
foreach ($gradeitems as $gradeitem) {
|
|
// here comes really crappy way how to set the value of the fields
|
|
// gradecategory and gradinggradecategory - grrr QuickForms
|
|
if ($gradeitem->itemnumber == 0) {
|
|
$group = $mform->getElement('submissiongradegroup');
|
|
$elements = $group->getElements();
|
|
foreach ($elements as $element) {
|
|
if ($element->getName() == 'gradecategory') {
|
|
$element->setValue($gradeitem->categoryid);
|
|
}
|
|
}
|
|
} else if ($gradeitem->itemnumber == 1) {
|
|
$group = $mform->getElement('gradinggradegroup');
|
|
$elements = $group->getElements();
|
|
foreach ($elements as $element) {
|
|
if ($element->getName() == 'gradinggradecategory') {
|
|
$element->setValue($gradeitem->categoryid);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
parent::definition_after_data();
|
|
}
|
|
|
|
/**
|
|
* Validates the form input
|
|
*
|
|
* @param array $data submitted data
|
|
* @param array $files submitted files
|
|
* @return array eventual errors indexed by the field name
|
|
*/
|
|
public function validation($data, $files) {
|
|
$errors = array();
|
|
|
|
// check the phases borders are valid
|
|
if ($data['submissionstart'] > 0 and $data['submissionend'] > 0 and $data['submissionstart'] >= $data['submissionend']) {
|
|
$errors['submissionend'] = get_string('submissionendbeforestart', 'mod_workshop');
|
|
}
|
|
if ($data['assessmentstart'] > 0 and $data['assessmentend'] > 0 and $data['assessmentstart'] >= $data['assessmentend']) {
|
|
$errors['assessmentend'] = get_string('assessmentendbeforestart', 'mod_workshop');
|
|
}
|
|
|
|
// check the phases do not overlap
|
|
if (max($data['submissionstart'], $data['submissionend']) > 0 and max($data['assessmentstart'], $data['assessmentend']) > 0) {
|
|
$phasesubmissionend = max($data['submissionstart'], $data['submissionend']);
|
|
$phaseassessmentstart = min($data['assessmentstart'], $data['assessmentend']);
|
|
if ($phaseassessmentstart == 0) {
|
|
$phaseassessmentstart = max($data['assessmentstart'], $data['assessmentend']);
|
|
}
|
|
if ($phasesubmissionend > 0 and $phaseassessmentstart > 0 and $phaseassessmentstart < $phasesubmissionend) {
|
|
foreach (array('submissionend', 'submissionstart', 'assessmentstart', 'assessmentend') as $f) {
|
|
if ($data[$f] > 0) {
|
|
$errors[$f] = get_string('phasesoverlap', 'mod_workshop');
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $errors;
|
|
}
|
|
}
|