mod_form.php

<?php
// This file is part of the mod_certifygen plugin for 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/>.
// Project implemented by the "Recovery, Transformation and Resilience Plan.
// Funded by the European Union - Next GenerationEU".
//
// Produced by the UNIMOODLE University Group: Universities of
// Valladolid, Complutense de Madrid, UPV/EHU, León, Salamanca,
// Illes Balears, Valencia, Rey Juan Carlos, La Laguna, Zaragoza, Málaga,
// Córdoba, Extremadura, Vigo, Las Palmas de Gran Canaria y Burgos.

/**
 *
 * @package    mod_certifygen
 * @copyright  2024 Proyecto UNIMOODLE
 * @author     UNIMOODLE Group (Coordinator) <direccion.area.estrategia.digital@uva.es>
 * @author     3IPUNT <contacte@tresipunt.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
use core\context\system;
use mod_certifygen\persistents\certifygen;
use mod_certifygen\persistents\certifygen_model;

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

global $CFG;
require_once($CFG->dirroot . '/course/moodleform_mod.php');
require_once("$CFG->dirroot/mod/certifygen/lib.php");

/**
 *  This class adds extra methods to form wrapper specific to be used for module add / update forms
 */
class mod_certifygen_mod_form extends moodleform_mod {
    /**
     * definition
     * @return void
     * @throws coding_exception
     * @throws dml_exception
     * @throws moodle_exception
     */
    protected function definition() {
        global $OUTPUT;
        $mform =& $this->_form;
        $mform->addElement('text', 'name', get_string('name', 'mod_certifygen'), ['size' => '64']);
        $mform->setType('name', PARAM_TEXT);
        $mform->addRule('name', get_string('required'), 'required');

        $this->standard_intro_elements(get_string('introduction', 'mod_certifygen'));

        if (
            !is_null($this->get_instance()) && !empty($this->get_instance())
            && mod_certifygen_are_there_any_certificate_emited_by_instanceid($this->get_instance())
        ) {
            $modelid = certifygen::get_modelid_from_certifygenid($this->get_instance());
            $model = new certifygen_model($modelid);
            $htmlstring = get_string('model', 'mod_certifygen');
            $htmlstring .= ': ' . $model->get('name');
            $mform->addElement('html', '<div class="row p-4">' . $htmlstring . '</div>');
            $mform->addElement('hidden', 'modelid', $modelid);
            $mform->setType('modelid', PARAM_INT);
        } else {
            $canmanagemodels = has_capability('mod/certifygen:manage', system::instance());
            $activitymodels = mod_certifygen_get_activity_models($this->get_course()->id);
            $templateoptions = ['' => get_string('chooseamodel', 'mod_certifygen')] + $activitymodels;
            $manageurl = new \core\url('/mod/certifygen/modelmanager.php');
            $elements = [$mform->createElement('select', 'modelid', get_string('model', 'mod_certifygen'), $templateoptions)];
            $mform->setType('modelid', PARAM_INT);
            // Adding "Manage templates" link if user has capabilities to manage templates.
            if ($canmanagemodels) {
                $elements[] = $mform->createElement(
                    'static',
                    'managemodels',
                    '',
                    $OUTPUT->action_link($manageurl, get_string('modelsmanager', 'mod_certifygen'))
                );
            }
            $mform->addGroup(
                $elements,
                'models_group',
                get_string('model', 'mod_certifygen'),
                html_writer::div('', 'w-100'),
                false
            );
            $mform->addRule('models_group', get_string('required'), 'required');
            $rules = [];
            $rules['modelid'][] = [null, 'required', null, 'client'];
            $mform->addGroupRule('models_group', $rules);

            if (!is_null($this->get_instance())) {
                $modelid = certifygen::get_modelid_from_certifygenid((int)$this->get_instance());
                $mform->setDefault('modelid', $modelid);
            }
        }

        // Course module elements.
        $this->standard_coursemodule_elements();

        $mform->addElement('hidden', 'type', certifygen_model::TYPE_ACTIVITY);
        $mform->setType('type', PARAM_INT);
        $this->add_action_buttons();
    }

    /**
     * completiondownload element.
     *
     * @return array Array of string IDs of added items, empty array if none
     * @throws coding_exception
     */
    public function add_completion_rules() {
        $mform =& $this->_form;
        $mform->addElement('checkbox',
                'completiondownload',
                '',
                get_string('completiondownload', 'mod_certifygen'));
        // Enable this completion rule by default.
        $mform->setDefault('completiondownload', 0);
        return ['completiondownload'];
    }

    /**
     * completion_rule_enabled
     * @param $data
     * @return bool
     */
    public function completion_rule_enabled($data) {
        return !empty($data['completiondownload']);
    }

    /**
     * data_preprocessing
     * @param $default_values
     * @return void
     */
    function data_preprocessing(&$default_values) {
        parent::data_preprocessing($default_values);

        // Set up the completion checkboxes which aren't part of standard data.
        // We also make the default value (if you turn on the checkbox) for those
        // numbers to be 1, this will not apply unless checkbox is ticked.
        $default_values['completiondownloadenabled'] =
                !empty($default_values['completiondownload']) ? 1 : 0;
        if (empty($default_values['completiondownload'])) {
            $default_values['completiondownload'] = 0;
        }
    }
}