locallib.php

<?php

defined('MOODLE_INTERNAL') || die();

// import various files logic is organized in
require_once($CFG->dirroot . '/mod/assign/submission/dta/models/DtaResult.php');
require_once($CFG->dirroot . '/mod/assign/submission/dta/utils/database.php');
require_once($CFG->dirroot . '/mod/assign/submission/dta/utils/backend.php');
require_once($CFG->dirroot . '/mod/assign/submission/dta/utils/view.php');

/**
 * library class for DTA submission plugin extending assign submission plugin base class
 *
 * @package assignsubmission_dta
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class assign_submission_dta extends assign_submission_plugin {

    // broadly used in logic, parametrized for easier change
    const COMPONENT_NAME = "assignsubmission_dta";

    // draft file area for dta tests to be uploaded by the teacher
    const ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST = "tests_draft_dta";
    // file area for dta tests to be uploaded by the teacher
    const ASSIGNSUBMISSION_DTA_FILEAREA_TEST = "tests_dta";
    // file area for dta submission assignment
    const ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION = "submissions_dta";

    // ========== abstract methods to be implemented ========== //

    /**
     * get plugin name
     * @return string
     */
    public function get_name(): string {
        return get_string("pluginname", self::COMPONENT_NAME);
    }

    // ========== end of section ========== //

    // ========== parent methods overloaded ========== //

        // ===== assignment settings ===== //
    /**
     * Get default settings for assignment submission settings
     *
     * @param MoodleQuickForm $mform form to add elements to
     * @return void
     */
    public function get_settings(MoodleQuickForm $mform): void {
        // add draft filemanager to form
        $mform->addElement(
            // filemanager
            "filemanager",
            // unique element name in form
            self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST,
            // label shown to user left of filemanager
            get_string("submission_settings_label", self::COMPONENT_NAME),
            // attributes
            null,
            // options array
            $this->get_file_options(true)
        );

        // add help button to added filemanager
        $mform->addHelpButton(
            // form-unique element id to add button to
            self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST,
            // key to search for
            "submission_settings_label",