Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 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.
<?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. * Create info question item. > * * > * @param array $data Question data * @param object $feedback feedback record > * @return mixed Question instance * @param array $record (optional) to override default values > */ * @return int > public function create_question(array $data) { */ > global $DB; public function create_item_info($feedback, $record = array()) { > global $DB, $CFG; > $questiontype = $data['questiontype'] ?? 'textfield'; > $cm = get_coursemodule_from_id('feedback', $data['cmid']); require_once($CFG->dirroot.'/mod/feedback/lib.php'); > $feedback = $DB->get_record('feedback', ['id' => $cm->instance]); > $itemobj = feedback_get_item_class('info'); > unset($data['questiontype']); $position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1; > unset($data['cmid']); > $record = (array)$record + array( > if (isset($data['values'])) { 'id' => 0, > $data['values'] = $this->format_item_values($questiontype, $data['values']); 'feedback' => $feedback->id, > } 'template' => 0, > 'name' => 'Feedback question item ' . $position, > return call_user_func([$this, "create_item_{$questiontype}"], $feedback, $data); 'label' => 'Feedback label ' . $position, > } 'presentation' => $itemobj::MODE_COURSE, > 'typ' => 'info', > /** 'hasvalue' => 0, > * Create response. 'position' => $position, > * 'required' => 0, > * @param array $data Response data. 'dependitem' => 0, > * @return stdClass feedback_completed response instance. 'dependvalue' => '', > */ 'options' => '', > public function create_response(array $data): stdClass { ); > global $DB; > $itemobj->set_data((object) $record); > $userid = $data['userid']; return $itemobj->save_item(); > $responsenumber = null; } > $cm = get_coursemodule_from_id('feedback', $data['cmid']); > $feedback = $DB->get_record('feedback', ['id' => $cm->instance]); /** > $answers = []; * Create label question item. > * > if (isset($data['responsenumber']) && trim($data['responsenumber']) !== '') { * @param object $feedback feedback record > $responsenumber = $data['responsenumber']; * @param array $record (optional) to override default values > } * @return int > */ > if (isset($data['anonymous']) && trim($data['anonymous']) !== '') { public function create_item_label($feedback, $record = array()) { > $anonymous = filter_var(trim($data['anonymous']), FILTER_VALIDATE_BOOLEAN); global $DB, $CFG; > $feedback->anonymous = $anonymous ? FEEDBACK_ANONYMOUS_YES : FEEDBACK_ANONYMOUS_NO; > } require_once($CFG->dirroot.'/mod/feedback/lib.php'); > > unset($data['cmid']); $itemobj = feedback_get_item_class('label'); > unset($data['userid']); $position = $DB->count_records('feedback_item', array('feedback' => $feedback->id)) + 1; > unset($data['anonymous']); > unset($data['responsenumber']); $record = (array)$record + array( > 'id' => 0, > foreach ($data as $question => $response) { 'feedback' => $feedback->id, > $item = $DB->get_record('feedback_item', ['name' => trim($question)], '*', MUST_EXIST); 'template' => 0, > 'name' => 'label', > $answers["{$item->typ}_{$item->id}"] = $this->get_item_response_value($item, $response); 'label' => '', > } 'presentation' => '', > 'typ' => 'label', > $feedbackcompletion = new mod_feedback_completion( 'hasvalue' => 0, > $feedback, 'position' => $position, > $cm, 'required' => 0, > $cm->course, 'dependitem' => 0, > false, 'dependvalue' => '', > null, 'options' => '', > $feedback->anonymous === FEEDBACK_ANONYMOUS_YES ? null : $userid, ); > $userid > ); if (!isset($record['presentation_editor'])) { > $record['presentation_editor'] = array( > if (!$feedbackcompletion->can_complete()) { 'text' => "The label $position text goes here", > throw new coding_exception("User {$userid} cannot complete this feedback activity."); 'format' => FORMAT_HTML, > } 'itemid' => 0 > ); > if (!$feedbackcompletion->is_open()) { } > throw new coding_exception("This activity is not open."); > } $itemobj->set_data((object) $record); > return $itemobj->save_item(); > $feedbackcompletion->set_module_viewed(); } > $feedbackcompletion->save_response_tmp((object) $answers); > $feedbackcompletion->save_response(); /** > $completed = $feedbackcompletion->get_completed(); * Create multichoice question item. > * > if (!is_null($responsenumber)) { * @param object $feedback feedback record > $DB->update_record('feedback_completed', [ * @param array $record (optional) to override default values > 'id' => $completed->id, * @return int > 'random_response' => $responsenumber, */ > ]); public function create_item_multichoice($feedback, $record = array()) { > } global $DB, $CFG; > > return $completed; 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 int */ 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 int */ 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 int */ 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 int */ 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 mixed 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); > } > }