first commit

customfield/field/select/classes/data_controller.php

@@ -0,0 +1,121 @@
+<?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;
+
+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 !== '') {
+            $key = array_search($defaultvalue, $this->get_field()->get_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->get_options();
+
+        $elementname = $this->get_form_element_name();
+        $mform->addElement('select', $elementname, $this->get_field()->get_formatted_name(), $options);
+
+        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 = $this->get_field()->get_options();
+        if (array_key_exists($value, $options)) {
+            return $options[$value];
+        }
+
+        return null;
+    }
+}

customfield/field/select/classes/field_controller.php

@@ -0,0 +1,135 @@
+<?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());
+    }
+}

customfield/field/select/classes/privacy/provider.php

@@ -0,0 +1,83 @@
+<?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/>.
+/**
+ * Privacy Subsystem implementation for customfield_select.
+ *
+ * @package    customfield_select
+ * @copyright  2018 Daniel Neis Araujo <danielneis@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace customfield_select\privacy;
+
+use core_customfield\data_controller;
+use core_customfield\privacy\customfield_provider;
+use core_privacy\local\request\writer;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for customfield_select implementing null_provider.
+ *
+ * @copyright  2018 Daniel Neis Araujo <danielneis@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider, customfield_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+
+    /**
+     * Preprocesses data object that is going to be exported
+     *
+     * @param data_controller $data
+     * @param \stdClass $exportdata
+     * @param array $subcontext
+     */
+    public static function export_customfield_data(data_controller $data, \stdClass $exportdata, array $subcontext) {
+        $context = $data->get_context();
+        $exportdata->value = $data->export_value();
+        writer::with_context($context)
+            ->export_data($subcontext, $exportdata);
+    }
+
+    /**
+     * Allows plugins to delete everything they store related to the data (usually files)
+     *
+     * @param string $dataidstest
+     * @param array $params
+     * @param array $contextids
+     * @return mixed|void
+     */
+    public static function before_delete_data(string $dataidstest, array $params, array $contextids) {
+    }
+
+    /**
+     * Allows plugins to delete everything they store related to the field configuration (usually files)
+     *
+     * @param string $fieldidstest
+     * @param array $params
+     * @param array $contextids
+     */
+    public static function before_delete_fields(string $fieldidstest, array $params, array $contextids) {
+    }
+}