Proyectos de Subversion Moodle

<?php
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.

/**
 * The main mod_stickynotes configuration form.
 *
 * @package     mod_stickynotes
 * @copyright   2021 Olivier VALENTIN
 * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->dirroot.'/course/moodleform_mod.php');

/**
 * Module instance settings form.
 *
 * @package     mod_stickynotes
 * @copyright   2021 Olivier VALENTIN
 * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_stickynotes_mod_form extends moodleform_mod {

    /**
     * Defines forms elements
     */
    public function definition() {
        global $CFG;

        $mform = $this->_form;

        // Adding the "general" fieldset, where all the common settings are shown.
        $mform->addElement('header', 'general', get_string('general', 'form'));

        // Adding the standard "name" field.
        $mform->addElement('text', 'name', get_string('stickynotesname', 'mod_stickynotes'), array('size' => '64'));

        if (!empty($CFG->formatstringstriptags)) {
            $mform->setType('name', PARAM_TEXT);
        } else {
            $mform->setType('name', PARAM_CLEANHTML);
        }

        $mform->addRule('name', null, 'required', null, 'client');
        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');

        // Adding the standard "intro" and "introformat" fields.
        if ($CFG->branch >= 29) {
            $this->standard_intro_elements();
        } else {
            $this->add_intro_editor();
        }

        // Adding the "colors" fieldset.
        $mform->addElement('header', 'settings_notes', get_string('settings_notes', 'stickynotes'));

        // Enable the limitation of notes ?
        $mform->addElement('advcheckbox', 'limitstickynotes', get_string('limitstickynotes', 'stickynotes'));
        $mform->addHelpButton('limitstickynotes', 'limitstickynotes', 'stickynotes');

        // Max number of notes.
        $mform->disabledIf('maxstickynotes', 'limitstickynotes', '0');
        $mform->addElement('text', 'maxstickynotes', get_string('maxstickynotes', 'stickynotes'));
        $mform->setType('maxstickynotes', PARAM_INT);
        $mform->addRule('maxstickynotes', get_string('maxstickynoteserror', 'stickynotes'), 'regex', '/^[0-9]+$/', 'client');

        // Show authors ?
        $mform->addElement('advcheckbox', 'viewauthor', get_string('viewauthor', 'stickynotes'));
        $mform->addHelpButton('viewauthor', 'viewauthor', 'stickynotes');

        // Students can move any notes ?
        $mform->addElement('advcheckbox', 'moveallnotes', get_string('moveallnotes', 'stickynotes'));
        $mform->addHelpButton('moveallnotes', 'moveallnotes', 'stickynotes');

        // Students can see all notes ?
        $mform->addElement('advcheckbox', 'seeallnotes', get_string('seeallnotes', 'stickynotes'));
        $mform->addHelpButton('seeallnotes', 'seeallnotes', 'stickynotes');
        $mform->setDefault('seeallnotes',  '1');

        // Rotate notes ?
        $mform->addElement('advcheckbox', 'rotate', get_string('rotate', 'stickynotes'));
        $mform->addHelpButton('rotate', 'rotate', 'stickynotes');
        $mform->setDefault('rotate',  '1');

        // Adding the "votes" fieldset.
        $mform->addElement('header', 'settings_votes', get_string('settings_votes', 'stickynotes'));

        // Define votes types :0 = no votes, 1 = user can like a vote.
        $options = array(
            '0'      => get_string('votenone', 'stickynotes'),
            '1'      => get_string('votelike', 'stickynotes')
        );

        $mform->addElement('select', 'votes', get_string('votetype', 'stickynotes'), $options);
        $mform->addHelpButton('votes', 'votetype', 'stickynotes');

        // Enable the limitation of votes ?
        $mform->disabledIf('limitvotes', 'votes', '0');
        $mform->addElement('advcheckbox', 'limitvotes', get_string('limitvotes', 'stickynotes'));
        $mform->addHelpButton('limitvotes', 'limitvotes', 'stickynotes');

        // Max number of votes.
        $mform->disabledIf('maxlimitvotes', 'votes', '0');
        $mform->disabledIf('maxlimitvotes', 'limitvotes', '1');
        $maxvoteschoice = array(
            1   => 1,
            2   => 2,
            3   => 3,
            4   => 4,
            5   => 5,
            6   => 6,
            7   => 7,
            8   => 8,
            9   => 9,
            10  => 10,
        );
        $mform->addElement('select', 'maxlimitvotes', get_string('maxlimitvotes', 'stickynotes'), $maxvoteschoice);
        $mform->addHelpButton('maxlimitvotes', 'maxlimitvotes', 'stickynotes');
        $mform->setType('maxlimitvotes', PARAM_INT);

        // Adding the "colors" fieldset.
        $mform->addElement('header', 'settings_colors', get_string('settings_colors', 'stickynotes'));

        // Can users choose background colors ?
        $mform->addElement('advcheckbox', 'colors', get_string('colors', 'stickynotes'));
        $mform->addHelpButton('colors', 'colors', 'stickynotes');
        $mform->setDefault('colors',  '1');

        // Display caption in activity ?
        $mform->addElement('advcheckbox', 'displaystickycaption', get_string('displaystickycaption', 'stickynotes'));
        $mform->addHelpButton('displaystickycaption', 'displaystickycaption', 'stickynotes');

        // Text to introduce choice of colors and their meanings.
        $mform->addElement('static', 'color_show', '', get_string('choosecolors', 'stickynotes'));

        // Color 1.
        $mform->disabledIf('color1', 'colors', '0');
        $mform->addElement('advcheckbox', 'color1', '<div style="background-color:'.get_config('mod_stickynotes', 'color1').'">
'.get_string('color1_title', 'stickynotes').'</div>');
        $mform->setDefault('color1',  '1');

        $mform->disabledIf('color1_meaning', 'colors', '0');
        $mform->disabledIf('color1_meaning', 'color1', '0');
        $mform->addElement('text', 'color1_meaning', get_string('color1_meaning', 'stickynotes'));
        $mform->setType('color1_meaning', PARAM_TEXT);

        // Color 2.
        $mform->disabledIf('color2', 'colors', '0');
        $mform->addElement('advcheckbox', 'color2', '<div style="background-color:'.get_config('mod_stickynotes', 'color2').'">
'.get_string('color2_title', 'stickynotes').'</div>');
        $mform->setDefault('color2',  '1');

        $mform->disabledIf('color2_meaning', 'colors', '0');
        $mform->disabledIf('color2_meaning', 'color2', '0');
        $mform->addElement('text', 'color2_meaning', get_string('color2_meaning', 'stickynotes'));
        $mform->setType('color2_meaning', PARAM_TEXT);

        // Color 3.
        $mform->disabledIf('color3', 'colors', '0');
        $mform->addElement('advcheckbox', 'color3', '<div style="background-color:'.get_config('mod_stickynotes', 'color3').'">
'.get_string('color3_title', 'stickynotes').'</div>');
        $mform->setDefault('color3',  '1');

        $mform->disabledIf('color3_meaning', 'colors', '0');
        $mform->disabledIf('color3_meaning', 'color3', '0');
        $mform->addElement('text', 'color3_meaning', get_string('color3_meaning', 'stickynotes'));
        $mform->setType('color3_meaning', PARAM_TEXT);

        // Color 4.
        $mform->disabledIf('color4', 'colors', '0');
        $mform->addElement('advcheckbox', 'color4', '<div style="background-color:'.get_config('mod_stickynotes', 'color4').'">
'.get_string('color4_title', 'stickynotes').'</div>');
        $mform->setDefault('color4',  '1');

        $mform->disabledIf('color4_meaning', 'colors', '0');
        $mform->disabledIf('color4_meaning', 'color4', '0');
        $mform->addElement('text', 'color4_meaning', get_string('color4_meaning', 'stickynotes'));
        $mform->setType('color4_meaning', PARAM_TEXT);

        // Color 5.
        $mform->disabledIf('color5', 'colors', '0');
        $mform->addElement('advcheckbox', 'color5', '<div style="background-color:'.get_config('mod_stickynotes', 'color5').'">
'.get_string('color5_title', 'stickynotes').'</div>');
        $mform->setDefault('color5',  '1');

        $mform->disabledIf('color5_meaning', 'colors', '0');
        $mform->disabledIf('color5_meaning', 'color5', '0');
        $mform->addElement('text', 'color5_meaning', get_string('color5_meaning', 'stickynotes'));
        $mform->setType('color5_meaning', PARAM_TEXT);

        // Color 6.
        $mform->disabledIf('color6', 'colors', '0');
        $mform->addElement('advcheckbox', 'color6', '<div style="background-color:'.get_config('mod_stickynotes', 'color6').'">
'.get_string('color6_title', 'stickynotes').'</div>');
        $mform->setDefault('color6',  '1');

        $mform->disabledIf('color6_meaning', 'colors', '0');
        $mform->disabledIf('color6_meaning', 'color6', '0');
        $mform->addElement('text', 'color6_meaning', get_string('color6_meaning', 'stickynotes'));
        $mform->setType('color6_meaning', PARAM_TEXT);

        // Add standard elements.
        $this->standard_coursemodule_elements();

        // Add standard buttons.
        $this->add_action_buttons();
    }

    /**
     * Preprocess data.
     * @param array $defaultvalues
     */
    public function data_preprocessing(&$defaultvalues) {
        $defaultvalues['completionstickynotesenabled'] = !empty($defaultvalues['completionstickynotes']) ? 1 : 0;
    }

    /**
     * Add elements for setting the custom completion rules.
     *
     * @category completion
     * @return array List of added element names, or names of wrapping group elements.
     */

    public function add_completion_rules() {
        $mform = $this->_form;

        $group = [
            $mform->createElement(
            'checkbox',
            'completionstickynotesenabled',
            ' ',
            get_string('completionstickynotesenabled', 'mod_stickynotes')
            ),
            $mform->createElement(
                'text',
                'completionstickynotes',
                ' ',
                ['size' => 3]
            ),
        ];
        $mform->setType('completionstickynotes', PARAM_INT);
        $mform->addGroup(
            $group,
            'completionstickynotesgroup',
            get_string('completionstickynotesgroup', 'mod_stickynotes'),
            [' '],
            false);
        $mform->disabledIf('completionstickynotes', 'completionstickynotesenabled', 'notchecked');

        return ['completionstickynotesgroup'];
    }

    /**
     * Determines if completion is enabled for this module.
     *
     * @param array $data
     * @return bool
     */
    public function completion_rule_enabled($data) {
        return (!empty($data['completionstickynotesenabled']) && $data['completionstickynotes'] != 0);
    }

    /**
     * Allows module to modify the data returned by form get_data().
     * This method is also called in the bulk activity completion form.
     *
     * Only available on moodleform_mod.
     *
     * @param stdClass $data the form data to be modified.
     */
    public function data_postprocessing($data) {
        parent::data_postprocessing($data);
        // Turn off completion settings if the checkboxes aren't ticked.
        if (!empty($data->completionunlocked)) {
            $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
            if (empty($data->completionstickynotesenabled) || !$autocompletion) {
                $data->completionstickynotes = 0;
            }
        }
    }
}