mod_form.php

<?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/>.

/**
 * The main icontent configuration form
 *
 * It uses the standard core Moodle formslib. For more info about them, please
 * visit: http://docs.moodle.org/en/Development:lib/formslib.php
 *
 * @package    mod_icontent
 * @copyright  2016 Leo Renis Santos
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->dirroot.'/course/moodleform_mod.php');
require_once(dirname(__FILE__).'/locallib.php');
require_once($CFG->libdir.'/filelib.php');
$PAGE->requires->js(new moodle_url($CFG->wwwroot.'/mod/icontent/js/jscolor/jscolor.js'));

/**
 * Module instance settings form
 *
 * @package    mod_icontent
 * @copyright  2015 Leo Renis Santos
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_icontent_mod_form extends moodleform_mod {

    /**
     * Defines forms elements.
     */
    public function definition() {
        global $COURSE;
        $mform = $this->_form;
        $icontentconfig = get_config('mod_icontent');
        // Cache the plugin name.
        $plugin = 'mod_icontent';

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

        // Adding the standard "name" field.
        $mform->addElement('text', 'name', get_string('icontentname', 'icontent'), ['class' => 'input-xxlarge']);
        if (!empty($CFG->formatstringstriptags)) {
            $mform->setType('name', PARAM_TEXT);
        } else {
            $mform->setType('name', PARAM_CLEAN);
        }
        $mform->addRule('name', null, 'required', null, 'client');
        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
        $mform->addHelpButton('name', 'icontentname', 'icontent');

        // Adding the standard "intro" and "introformat" fields.
        $this->standard_intro_elements();

        // Adding a spot for the content creator to add a copyright.
        $mform->addElement('text', 'copyright', get_string('copyright', 'icontent'), ['class' => 'input-xxlarge']);
        $mform->setType('copyright', PARAM_RAW);
        $mform->addHelpButton('copyright', 'copyright', 'icontent');

        // Set up options for the filemanager setting.
        $filemanageroptions = [];
                $filemanageroptions['subdirs'] = 0;
                $filemanageroptions['maxbytes'] = $COURSE->maxbytes;
                $filemanageroptions['areamaxbytes'] = $COURSE->maxbytes;
                $filemanageroptions['maxfiles'] = 1;
                $filemanageroptions['accepted_types'] = ['.jpg', '.png'];
                $filemanageroptions['return_types'] = FILE_INTERNAL | FILE_EXTERNAL;

        $mform->addElement('filemanager', 'bgimage', get_string('bgimage', 'icontent'), null, $filemanageroptions);
        $mform->setType('bgimage', PARAM_INT);
        $mform->addHelpButton('bgimage', 'bgimagehelp', 'icontent');
//////////

        // Content Pages activity setup, Availability settings.
        $mform->addElement('header', 'availabilityhdr', get_string('availability'));

        $mform->addElement('date_time_selector',
            'timeopen',
            get_string('icontentopentime', 'icontent'),
            ['optional' => true, 'step' => 1]
            );
        $mform->addElement('date_time_selector',
            'timeclose',
            get_string('icontentclosetime', 'icontent'),
            ['optional' => true, 'step' => 1]
            );
        // Content Pages activity password setup.
        $mform->addElement('selectyesno', 'usepassword', get_string('usepassword', 'icontent'));
        $mform->addHelpButton('usepassword', 'usepassword', 'icontent');
        $mform->setDefault('usepassword', $icontentconfig->password);
        $mform->setAdvanced('usepassword', $icontentconfig->password_adv);

        $mform->addElement('passwordunmask', 'password', get_string('password', 'icontent'));
        $mform->setDefault('password', '');
        $mform->setAdvanced('password', $icontentconfig->password_adv);
        $mform->setType('password', PARAM_RAW);
        $mform->disabledIf('password', 'usepassword', 'eq', 0);
        $mform->disabledIf('passwordunmask', 'usepassword', 'eq', 0);


/////////////
        // Appearance.
        $mform->addElement('header', 'appearancehdr', get_string('appearance'));

        // phpcs:ignore
        // Setup the overall background color for each page.
        // ...$mform->addElement('text', 'bgcolor', get_string('bgcolor', 'icontent'), ['class' => 'color', 'value' => 'FCFCFC']);.
        // ...$mform->setType('bgcolor', PARAM_TEXT);.
        // ...$mform->addHelpButton('bgcolor', 'bgcolorhelp', 'icontent');.

        // 20240216 Modified setting for the overall background color for each page.
        $attributes = ['class' => "color",
                       'value' => $icontentconfig->bgcolor,
                       'size' => "10",
                      ];
        $name = 'bgcolor';
        $label = get_string('bgcolor', 'icontent');
        $description = get_string('bgcolor', 'icontent');
        $default = get_string('bgcolor', 'icontent');
        $mform->setType($name, PARAM_NOTAGS);
        $mform->addElement('text', $name, $label, $attributes);
        $mform->addHelpButton($name, $name, $plugin);
        $mform->setDefault($name, $icontentconfig->bgcolor);
        // 20240713 Color input experiments.
        // phpcs:ignore
        /*
        $mform->addElement('html', '<label for="bgcolor">Color Picker:</label>
            <input type="color" id="bgcolor" value="#0000ff">');
        */
        // phpcs:ignore
        /*
        $mform->addElement('html', '<label for="'.$icontentconfig->bgcolor.'">Color Picker:</label>
            <input type="color" id="'.$icontentconfig->bgcolor.'" value="#0000ff">');
        */
        // phpcs:ignore
        /*
        $mform->addElement('html', '<label for="bgcolor">Color Picker:</label>
            <input type="text" name="text">
            <input type="color" name="color">
            <input type="submit" name="btn_submit" value="Submit">');
        */

        // 20240619 Modified the setting for the bordercolor.
        $attributes = ['class' => "color",
               'value' => $icontentconfig->bordercolor,
               'size' => "10",
              ];
        $mform->addElement('text', 'bordercolor', get_string('bordercolor', 'icontent'), ['class' => 'color', 'value' => 'E4E4E4']);
        $mform->setType('bordercolor', PARAM_TEXT);
        $mform->addHelpButton('bordercolor', 'bordercolorhelp', 'icontent');

        // 20240619 Modified the setting for the border width.
        $options = icontent_add_borderwidth_options();
        $mform->addElement('select', 'borderwidth', get_string('borderwidth', 'icontent'), $options);
        $mform->setType('borderwidth', PARAM_INT);
        $mform->addHelpButton('borderwidth', 'borderwidthhelp', 'icontent');
        $mform->setDefault('borderwidth', 1);

        // 20240619 Modified the setting for maxpages.
        $mform->addElement('text', 'maxpages', get_string('maxpages', 'icontent'), ['class' => 'x-large']);
        $mform->setType('maxpages', PARAM_INT);
        $mform->addHelpButton('maxpages', 'maxpageshelp', 'icontent');
        $mform->addRule('maxpages', null, 'numeric', null, 'client');
        $mform->addRule('maxpages', get_string('maximumdigits', 'icontent', 3), 'maxlength', 3, 'client');
        $mform->setDefault('maxpages', 55);

        // 20240619 Modified the setting for the show notes area.
        $mform->addElement('selectyesno', 'shownotesarea', get_string('shownotesarea', 'icontent'));
        $mform->addHelpButton('shownotesarea', 'shownotesarea', 'icontent');
        $mform->setType('shownotesarea', PARAM_INT);
        $mform->setDefault('shownotesarea', 1);

        // 20240619 Modified the setting for the maxnotesperpage.
        $mform->addElement('text', 'maxnotesperpages', get_string('maxnotesperpages', 'icontent'), ['class' => 'x-large']);
        $mform->setType('maxnotesperpages', PARAM_INT);
        $mform->addHelpButton('maxnotesperpages', 'maxnotesperpageshelp', 'icontent');
        $mform->addRule('maxnotesperpages', null, 'numeric', null, 'client');
        $mform->addRule('maxnotesperpages', get_string('maximumdigits', 'icontent', 3), 'maxlength', 3, 'client');
        $mform->setDefault('maxnotesperpages', 15);

        // 20240619 Modified the setting for showing the progress bar.
        $mform->addElement('selectyesno', 'progressbar', get_string('progressbar', 'icontent'));
        $mform->addHelpButton('progressbar', 'progressbar', 'icontent');
        $mform->setType('progressbar', PARAM_INT);
        $mform->setDefault('progressbar', 1);

        // Show the standard Grade elements.
        $this->standard_grading_coursemodule_elements();

        // Add standard elements, common to all modules.
        $this->standard_coursemodule_elements();

        // Add standard buttons, common to all modules.
        $this->add_action_buttons();
    }

    /**
     * Defines form pre-processing elements.
     *
     * @param array $defaultvalues
     */
    public function data_preprocessing(&$defaultvalues) {
        if ($this->current->instance) {
            $draftitemid = file_get_submitted_draft_itemid('bgimage');
            file_save_draft_area_files($defaultvalues['bgimage'], $this->context->id, 'mod_icontent', 'icontent', 0,
                [
                    'subdirs' => 0,
                    'maxbytes' => 0,
                    'maxfiles' => 1,
                ]
            );
        }
    }
}