xAPI-vle/moodle-logstore_xapi

<?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/>.
 
/**
 * Transformer utilities for creating Question xAPI Activity object definitions.
 *
 * @package   logstore_xapi
 * @copyright Jerret Fowler <jerrett.fowler@gmail.com>
 *            Ryan Smith <https://www.linkedin.com/in/ryan-smith-uk/>
 *            David Pesce <david.pesce@exputo.com>
 *            Milt Reder <milt@yetanalytics.com>
 * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
 
namespace src\transformer\utils\get_activity\definition\question;
 
use src\transformer\utils as utils;
use src\transformer\utils\get_activity\definition\cmi as cmi;
 
/**
 * Transformer util for creating essay definitions
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 */
function get_essay_definition(array $config, \stdClass $question, string $lang) {
    return cmi\long_fill_in(
        $config,
        $question->name,
        utils\get_string_html_removed($question->questiontext),
        $lang
    );
}
 
/**
 * Transformer util for creating multichoice definitions.
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 * @param ?string $interactiontype The type of interaction.
 * @param ?string $rightanswer The correct answer, not always available.
 * @return array
 */
Method `get_multichoice_definition` has 35 lines of code (exceeds 25 allowed). Consider refactoring.
function get_multichoice_definition(
Method `get_multichoice_definition` has 5 arguments (exceeds 4 allowed). Consider refactoring.
    array $config,
    \stdClass $question,
    string $lang,
        ?string $interactiontype = 'choice',
        ?string $rightanswer = null
) {
    $repo = $config['repo'];
    $answers = $repo->read_records('question_answers', [
        'question' => $question->id
    ]);
 
    $choices = array_values(
        array_map(
            function($answer) {
                return utils\get_string_html_removed($answer->answer);
            },
            $answers
        )
    );
 
    if ($interactiontype === 'sequencing') {
        return cmi\sequencing(
            $config,
            $question->name,
            utils\get_string_html_removed($question->questiontext),
            $choices,
            $lang,
            (!is_null($rightanswer))
                ? explode('} {', trim($rightanswer, '{}'))
                : null
        );
    } else {
        return cmi\choice(
            $config,
            $question->name,
            utils\get_string_html_removed($question->questiontext),
            $choices,
            $lang,
            (!is_null($rightanswer))
                ? explode('; ', utils\get_string_html_removed($rightanswer))
                : null
        );
    }
}
 
 
/**
 * Transformer util for creating match definitions
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 */
function get_match_definition(array $config, \stdClass $question, string $lang) {
    $repo = $config['repo'];
    $subqs = $repo->read_records('qtype_match_subquestions', [
        'questionid' => $question->id
    ]);
 
    $source = [];
    $target = [];
 
    foreach ($subqs as $subq) {
        $source[] = utils\get_string_html_removed($subq->questiontext);
        $target[] = $subq->answertext;
    }
 
    return cmi\matching(
        $config,
        $question->name,
        utils\get_string_html_removed($question->questiontext),
        $source,
        $target,
        $lang
    );
}
 
/**
 * Transformer util for creating numerical definitions
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 */
function get_numerical_definition(array $config, \stdClass $question, string $lang) {
    [
        'min' => $min,
        'max' => $max,
        'target' => $target
    ] = utils\quiz_question\get_numerical_answer($config, $question->id);
 
    return cmi\numeric(
        $config,
        $question->name,
        utils\get_string_html_removed($question->questiontext),
        $min,
        $max,
        $lang,
        // if we have an exact match, send that
        ($min === $target && $max === $target)
            ? $target
            : null
    );
}
 
/**
 * Transformer util for creating shortanswer definitions
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 */
function get_shortanswer_definition(array $config, \stdClass $question, string $lang) {
    return cmi\fill_in(
        $config,
        $question->name,
        utils\get_string_html_removed($question->questiontext),
        $lang
    );
}
 
/**
 * Transformer util for creating true/false definitions
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question object.
 * @param string $lang The language.
 */
function get_true_false_definition(array $config, \stdClass $question, string $lang) {
    $repo = $config['repo'];
    $answers = $repo->read_records('question_answers', [
        'question' => $question->id
    ]);
    $correctanswerobjarr = array_filter(
        $answers,
        function ($answer) {
            return $answer->fraction == 1.0;
        }
 
    );
    $correctanswerobj = reset(
        $correctanswerobjarr
    );
 
    $correctanswer = ($correctanswerobj->answer === 'True')
        ? true
        : false;
 
    return cmi\true_false(
        $config,
        $question->name,
        utils\get_string_html_removed($question->questiontext),
        $lang,
        $correctanswer
    );
}
 
/**
 * Generic handler for question definitions.
 *
 * @param array $config The transformer config settings.
 * @param \stdClass $question The question.
 * @param string $lang The language to use.
 * @return array
 */
function get_definition(array $config, \stdClass $question, string $lang) {
    switch ($question->qtype) {
    case 'essay':
        return get_essay_definition($config, $question, $lang);
    case 'gapselect':
        return get_multichoice_definition(
            $config, $question, $lang, 'sequencing'
        );
    case 'truefalse':
        return get_true_false_definition($config, $question, $lang);
    case 'randomsamatch':
    case 'match':
        return get_match_definition($config, $question, $lang);
    case 'shortanswer':
Avoid too many `return` statements within this method.
        return get_shortanswer_definition($config, $question, $lang);
    case 'multichoice':
    case 'multichoiceset':
Avoid too many `return` statements within this method.
        return get_multichoice_definition(
            $config, $question, $lang, 'choice'
        );
    case 'numerical':
Avoid too many `return` statements within this method.
        return get_numerical_definition($config, $question, $lang);
    default:
Avoid too many `return` statements within this method.
        return [];
    }
}