Proyectos de Subversion Moodle

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

namespace customfield_select;

use coding_exception;

/**

 * Class field

 *

 * @package customfield_select

 * @copyright 2018 David Matamoros <davidmc@moodle.com>

 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class field_controller extends \core_customfield\field_controller {

    /**

     * Customfield type

     */

    const TYPE = 'select';

    /**

     * Add fields for editing a select field.

     *

     * @param \MoodleQuickForm $mform

     */

    public function config_form_definition(\MoodleQuickForm $mform) {

        $mform->addElement('header', 'header_specificsettings', get_string('specificsettings', 'customfield_select'));

        $mform->setExpanded('header_specificsettings', true);

        $mform->addElement('textarea', 'configdata[options]', get_string('menuoptions', 'customfield_select'));

        $mform->setType('configdata[options]', PARAM_TEXT);

        $mform->addElement('text', 'configdata[defaultvalue]', get_string('defaultvalue', 'core_customfield'), 'size="50"');

        $mform->setType('configdata[defaultvalue]', PARAM_TEXT);

    }

    /**

     * @deprecated since Moodle 3.10 - MDL-68569 please use $field->get_options

     */

    public static function get_options_array(): void {

        throw new coding_exception('get_options_array() is deprecated, please use $field->get_options() instead');

    }

    /**

     * Return configured field options

     *

     * @return array

     */

    public function get_options(): array {

        $optionconfig = $this->get_configdata_property('options');

        if ($optionconfig) {

            $context = $this->get_handler()->get_configuration_context();

            $options = array_map(

                fn(string $option) => format_string($option, true, ['context' => $context]),

                preg_split("/\s*\n\s*/", trim($optionconfig), -1, PREG_SPLIT_NO_EMPTY),

            );

        } else {

            $options = array();

        }

        return array_merge([''], $options);

    }

    /**

     * Validate the data from the config form.

     * Sub classes must reimplement it.

     *

     * @param array $data from the add/edit profile field form

     * @param array $files

     * @return array associative array of error messages

     */

    public function config_form_validation(array $data, $files = array()): array {

        $options = preg_split("/\s*\n\s*/", trim($data['configdata']['options']));

        $errors = [];

        if (!$options || count($options) < 2) {

            $errors['configdata[options]'] = get_string('errornotenoughoptions', 'customfield_select');

        } else if (!empty($data['configdata']['defaultvalue'])) {

            $defaultkey = array_search($data['configdata']['defaultvalue'], $options);

            if ($defaultkey === false) {

                $errors['configdata[defaultvalue]'] = get_string('errordefaultvaluenotinlist', 'customfield_select');

            }

        }

        return $errors;

    }

    /**

     * Does this custom field type support being used as part of the block_myoverview

     * custom field grouping?

     * @return bool

     */

    public function supports_course_grouping(): bool {

        return true;

    }

    /**

     * If this field supports course grouping, then this function needs overriding to

     * return the formatted values for this.

     * @param array $values the used values that need formatting

     * @return array

     */

    public function course_grouping_format_values($values): array {

        $options = $this->get_options();

        $ret = [];

        foreach ($values as $value) {

            if (isset($options[$value])) {

                $ret[$value] = $options[$value];

            }

        }

        $ret[BLOCK_MYOVERVIEW_CUSTOMFIELD_EMPTY] = get_string('nocustomvalue', 'block_myoverview',

            $this->get_formatted_name());

        return $ret;

    }

    /**

     * Locate the value parameter in the field options array, and return it's index

     *

     * @param string $value

     * @return int

     */

    public function parse_value(string $value) {

        return (int) array_search($value, $this->get_options());

    }

}