Current Path : C:/xampp/htdocs/moodle/customfield/field/select/classes/ |
Current File : C:/xampp/htdocs/moodle/customfield/field/select/classes/data_controller.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/>. /** * Select plugin data controller * * @package customfield_select * @copyright 2018 Daniel Neis Araujo <daniel@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace customfield_select; use core_customfield\api; defined('MOODLE_INTERNAL') || die; /** * Class data * * @package customfield_select * @copyright 2018 Daniel Neis Araujo <daniel@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class data_controller extends \core_customfield\data_controller { /** * Return the name of the field where the information is stored * @return string */ public function datafield() : string { return 'intvalue'; } /** * Returns the default value as it would be stored in the database (not in human-readable format). * * @return mixed */ public function get_default_value() { $defaultvalue = $this->get_field()->get_configdata_property('defaultvalue'); if ('' . $defaultvalue !== '') { $options = field_controller::get_options_array($this->get_field()); $key = array_search($defaultvalue, $options); if ($key !== false) { return $key; } } return 0; } /** * Add fields for editing a textarea field. * * @param \MoodleQuickForm $mform */ public function instance_form_definition(\MoodleQuickForm $mform) { $field = $this->get_field(); $config = $field->get('configdata'); $options = field_controller::get_options_array($field); $formattedoptions = array(); $context = $this->get_field()->get_handler()->get_configuration_context(); foreach ($options as $key => $option) { // Multilang formatting with filters. $formattedoptions[$key] = format_string($option, true, ['context' => $context]); } $elementname = $this->get_form_element_name(); $mform->addElement('select', $elementname, $this->get_field()->get_formatted_name(), $formattedoptions); if (($defaultkey = array_search($config['defaultvalue'], $options)) !== false) { $mform->setDefault($elementname, $defaultkey); } if ($field->get_configdata_property('required')) { $mform->addRule($elementname, null, 'required', null, 'client'); } } /** * Validates data for this field. * * @param array $data * @param array $files * @return array */ public function instance_form_validation(array $data, array $files) : array { $errors = parent::instance_form_validation($data, $files); if ($this->get_field()->get_configdata_property('required')) { // Standard required rule does not work on select element. $elementname = $this->get_form_element_name(); if (empty($data[$elementname])) { $errors[$elementname] = get_string('err_required', 'form'); } } return $errors; } /** * Returns value in a human-readable format * * @return mixed|null value or null if empty */ public function export_value() { $value = $this->get_value(); if ($this->is_empty($value)) { return null; } $options = field_controller::get_options_array($this->get_field()); if (array_key_exists($value, $options)) { return format_string($options[$value], true, ['context' => $this->get_field()->get_handler()->get_configuration_context()]); } return null; } }