Marina Glancy
554 lines
18 KiB
PHP
554 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/>.
|
|
|
|
/**
|
|
* mod_feedback data generator.
|
|
*
|
|
* @package mod_feedback
|
|
* @category test
|
|
* @copyright 2013 Ankit Agarwal
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* mod_feedback data generator class.
|
|
*
|
|
* @package mod_feedback
|
|
* @category test
|
|
* @copyright 2013 Ankit Agarwal
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mod_feedback_generator extends testing_module_generator {
|
|
|
|
public function create_instance($record = null, array $options = null) {
|
|
global $CFG;
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
$record = (object)(array)$record;
|
|
|
|
if (!isset($record->anonymous)) {
|
|
$record->anonymous = FEEDBACK_ANONYMOUS_YES;
|
|
}
|
|
if (!isset($record->email_notification)) {
|
|
$record->email_notification = 0;
|
|
}
|
|
if (!isset($record->multiple_submit)) {
|
|
$record->multiple_submit = 0;
|
|
}
|
|
if (!isset($record->autonumbering)) {
|
|
$record->autonumbering = 0;
|
|
}
|
|
if (!isset($record->site_after_submit)) {
|
|
$record->site_after_submit = '';
|
|
}
|
|
if (!isset($record->page_after_submit)) {
|
|
$record->page_after_submit = 'This is page after submit';
|
|
}
|
|
if (!isset($record->page_after_submitformat)) {
|
|
$record->page_after_submitformat = FORMAT_MOODLE;
|
|
}
|
|
if (!isset($record->publish_stats)) {
|
|
$record->publish_stats = 0;
|
|
}
|
|
if (!isset($record->timeopen)) {
|
|
$record->timeopen = 0;
|
|
}
|
|
if (!isset($record->timeclose)) {
|
|
$record->timeclose = 0;
|
|
}
|
|
if (!isset($record->timemodified)) {
|
|
$record->timemodified = time();
|
|
}
|
|
if (!isset($record->completionsubmit)) {
|
|
$record->completionsubmit = 0;
|
|
}
|
|
|
|
// Hack to bypass draft processing of feedback_add_instance.
|
|
$record->page_after_submit_editor['itemid'] = false;
|
|
|
|
return parent::create_instance($record, (array)$options);
|
|
}
|
|
|
|
/**
|
|
* Create question.
|
|
*
|
|
* @param array $data Question data
|
|
* @return mixed Question instance
|
|
*/
|
|
public function create_question(array $data) {
|
|
global $DB;
|
|
|
|
$questiontype = $data['questiontype'] ?? 'textfield';
|
|
$cm = get_coursemodule_from_id('feedback', $data['cmid']);
|
|
$feedback = $DB->get_record('feedback', ['id' => $cm->instance]);
|
|
|
|
unset($data['questiontype']);
|
|
unset($data['cmid']);
|
|
|
|
if (isset($data['values'])) {
|
|
$data['values'] = $this->format_item_values($questiontype, $data['values']);
|
|
}
|
|
|
|
return call_user_func([$this, "create_item_{$questiontype}"], $feedback, $data);
|
|
}
|
|
|
|
/**
|
|
* Create response.
|
|
*
|
|
* @param array $data Response data.
|
|
* @return stdClass feedback_completed response instance.
|
|
*/
|
|
public function create_response(array $data): stdClass {
|
|
global $DB;
|
|
|
|
$userid = $data['userid'];
|
|
$responsenumber = null;
|
|
$cm = get_coursemodule_from_id('feedback', $data['cmid']);
|
|
$feedback = $DB->get_record('feedback', ['id' => $cm->instance]);
|
|
$answers = [];
|
|
|
|
if (isset($data['responsenumber']) && trim($data['responsenumber']) !== '') {
|
|
$responsenumber = $data['responsenumber'];
|
|
}
|
|
|
|
if (isset($data['anonymous']) && trim($data['anonymous']) !== '') {
|
|
$anonymous = filter_var(trim($data['anonymous']), FILTER_VALIDATE_BOOLEAN);
|
|
$feedback->anonymous = $anonymous ? FEEDBACK_ANONYMOUS_YES : FEEDBACK_ANONYMOUS_NO;
|
|
}
|
|
|
|
unset($data['cmid']);
|
|
unset($data['userid']);
|
|
unset($data['anonymous']);
|
|
unset($data['responsenumber']);
|
|
|
|
foreach ($data as $question => $response) {
|
|
$item = $DB->get_record('feedback_item', ['name' => trim($question)], '*', MUST_EXIST);
|
|
|
|
$answers["{$item->typ}_{$item->id}"] = $this->get_item_response_value($item, $response);
|
|
}
|
|
|
|
$feedbackcompletion = new mod_feedback_completion(
|
|
$feedback,
|
|
$cm,
|
|
$cm->course,
|
|
false,
|
|
null,
|
|
$feedback->anonymous === FEEDBACK_ANONYMOUS_YES ? null : $userid,
|
|
$userid
|
|
);
|
|
|
|
if (!$feedbackcompletion->can_complete()) {
|
|
throw new coding_exception("User {$userid} cannot complete this feedback activity.");
|
|
}
|
|
|
|
if (!$feedbackcompletion->is_open()) {
|
|
throw new coding_exception("This activity is not open.");
|
|
}
|
|
|
|
$feedbackcompletion->set_module_viewed();
|
|
$feedbackcompletion->save_response_tmp((object) $answers);
|
|
$feedbackcompletion->save_response();
|
|
$completed = $feedbackcompletion->get_completed();
|
|
|
|
if (!is_null($responsenumber)) {
|
|
$DB->update_record('feedback_completed', [
|
|
'id' => $completed->id,
|
|
'random_response' => $responsenumber,
|
|
]);
|
|
}
|
|
|
|
return $completed;
|
|
}
|
|
|
|
/**
|
|
* Create info question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_info($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('info');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => \feedback_item_info::MODE_COURSE,
|
|
'typ' => 'info',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
);
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create label question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_label($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('label');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'label',
|
|
'label' => '',
|
|
'presentation' => '',
|
|
'typ' => 'label',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
);
|
|
|
|
if (!isset($record['presentation_editor'])) {
|
|
$record['presentation_editor'] = array(
|
|
'text' => "The label $position text goes here",
|
|
'format' => FORMAT_HTML,
|
|
'itemid' => 0
|
|
);
|
|
}
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create multichoice question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_multichoice($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('multichoice');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => '',
|
|
'typ' => 'multichoice',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
'subtype' => 'r',
|
|
'horizontal' => 0,
|
|
'hidenoselect' => 1,
|
|
'ignoreempty' => 0,
|
|
'values' => "a\nb\nc\nd\ne"
|
|
);
|
|
|
|
$presentation = str_replace("\n", FEEDBACK_MULTICHOICE_LINE_SEP, trim($record['values']));
|
|
|
|
if ($record['horizontal'] == 1 AND $record['subtype'] != 'd') {
|
|
$presentation .= FEEDBACK_MULTICHOICE_ADJUST_SEP.'1';
|
|
}
|
|
$record['presentation'] = $record['subtype'].FEEDBACK_MULTICHOICE_TYPE_SEP.$presentation;
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create multichoicerated question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_multichoicerated($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('multichoicerated');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => '',
|
|
'typ' => 'multichoicerated',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
'subtype' => 'r',
|
|
'horizontal' => 0,
|
|
'hidenoselect' => 1,
|
|
'ignoreempty' => 0,
|
|
'values' => "0/a\n1/b\n2/c\n3/d\n4/e"
|
|
);
|
|
|
|
$itemobj = new feedback_item_multichoicerated();
|
|
$presentation = $itemobj->prepare_presentation_values_save(trim($record['values']),
|
|
FEEDBACK_MULTICHOICERATED_VALUE_SEP2, FEEDBACK_MULTICHOICERATED_VALUE_SEP);
|
|
|
|
if ($record['horizontal'] == 1 AND $record['subtype'] != 'd') {
|
|
$presentation .= FEEDBACK_MULTICHOICERATED_ADJUST_SEP.'1';
|
|
}
|
|
$record['presentation'] = $record['subtype'].FEEDBACK_MULTICHOICERATED_TYPE_SEP.$presentation;
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create numeric question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_numeric($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('numeric');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => '',
|
|
'typ' => 'numeric',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
'rangefrom' => '-',
|
|
'rangeto' => '-',
|
|
);
|
|
|
|
if ($record['rangefrom'] === '-' OR $record['rangeto'] === '-') {
|
|
$record['presentation'] = $record['rangefrom'] . '|'. $record['rangeto'];
|
|
} else if ($record['rangefrom'] > $record['rangeto']) {
|
|
$record['presentation'] = $record['rangeto'] . '|'. $record['rangefrom'];
|
|
} else {
|
|
$record['presentation'] = $record['rangefrom'] . '|'. $record['rangeto'];
|
|
}
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create textarea question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_textarea($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('textarea');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => '',
|
|
'typ' => 'textarea',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
'itemwidth' => '40',
|
|
'itemheight' => '20',
|
|
);
|
|
|
|
$record['presentation'] = $record['itemwidth'] . '|'. $record['itemheight'];
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create textfield question item.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @param array $record (optional) to override default values
|
|
* @return stdClass
|
|
*/
|
|
public function create_item_textfield($feedback, $record = array()) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
$itemobj = feedback_get_item_class('textfield');
|
|
$position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1;
|
|
|
|
$record = (array)$record + array(
|
|
'id' => 0,
|
|
'feedback' => $feedback->id,
|
|
'template' => 0,
|
|
'name' => 'Feedback question item ' . $position,
|
|
'label' => 'Feedback label ' . $position,
|
|
'presentation' => '',
|
|
'typ' => 'textfield',
|
|
'hasvalue' => 0,
|
|
'position' => $position,
|
|
'required' => 0,
|
|
'dependitem' => 0,
|
|
'dependvalue' => '',
|
|
'options' => '',
|
|
'itemsize' => '20',
|
|
'itemmaxlength' => '30',
|
|
);
|
|
|
|
$record['presentation'] = $record['itemsize'] . '|'. $record['itemmaxlength'];
|
|
|
|
$itemobj->set_data((object) $record);
|
|
return $itemobj->save_item();
|
|
}
|
|
|
|
/**
|
|
* Create pagebreak.
|
|
*
|
|
* @param object $feedback feedback record
|
|
* @return int|false false if there already is a pagebreak on last position or the id of the pagebreak-item
|
|
*/
|
|
public function create_item_pagebreak($feedback) {
|
|
global $CFG;
|
|
require_once($CFG->dirroot.'/mod/feedback/lib.php');
|
|
|
|
return feedback_create_pagebreak($feedback->id);
|
|
}
|
|
|
|
/**
|
|
* Format feedback item values.
|
|
*
|
|
* This method will replace newline characters with the proper line separator for each question type.
|
|
*
|
|
* @param string $questiontype Question types
|
|
* @param string $values Values
|
|
* @return string Formatted values
|
|
*/
|
|
protected function format_item_values(string $questiontype, string $values): string {
|
|
global $CFG;
|
|
|
|
if (!file_exists($CFG->dirroot.'/mod/feedback/item/'.$questiontype.'/lib.php')) {
|
|
throw new coding_exception("Question type '$questiontype' not found");
|
|
}
|
|
|
|
require_once($CFG->dirroot.'/mod/feedback/item/'.$questiontype.'/lib.php');
|
|
|
|
$questiontype = strtoupper($questiontype);
|
|
|
|
if (defined("FEEDBACK_{$questiontype}_LINE_SEP")) {
|
|
return implode(constant("FEEDBACK_{$questiontype}_LINE_SEP"), explode('\n', $values));
|
|
}
|
|
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* Given a response to a feedback item, return its corresponding value.
|
|
*
|
|
* @param mixed $record Item record
|
|
* @param string $response Response name
|
|
* @return int|string Response value
|
|
*/
|
|
protected function get_item_response_value($record, string $response) {
|
|
if (strpos($record->typ, 'multichoice') === 0) {
|
|
$item = feedback_get_item_class($record->typ);
|
|
|
|
return $this->get_choice_item_response_value($item, $record, $response);
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Given a response to a feedback choice item, return its corresponding value.
|
|
*
|
|
* @param feedback_item_base $item Feedback item
|
|
* @param mixed $record Item record
|
|
* @param string $response Response
|
|
* @param int $offset Choice to start looking from
|
|
* @return int Response choice index
|
|
*/
|
|
protected function get_choice_item_response_value(feedback_item_base $item, $record, string $response, int $offset = 1): int {
|
|
$printval = $item->get_printval($record, (object) ['value' => $offset]);
|
|
|
|
if (empty($printval)) {
|
|
throw new coding_exception("Value '$offset' not found");
|
|
}
|
|
|
|
if ($printval === $response) {
|
|
return $offset;
|
|
}
|
|
|
|
return $this->get_choice_item_response_value($item, $record, $response, $offset + 1);
|
|
}
|
|
}
|