first commit

customfield/field/checkbox/classes/data_controller.php

@@ -0,0 +1,87 @@
+<?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/>.
+
+/**
+ * Customfield Checkbox plugin
+ *
+ * @package   customfield_checkbox
+ * @copyright 2018 Daniel Neis Araujo <daniel@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace customfield_checkbox;
+
+use core_customfield\api;
+use core_customfield\output\field_data;
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Class data
+ *
+ * @package customfield_checkbox
+ * @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';
+    }
+
+    /**
+     * Add fields for editing a checkbox field.
+     *
+     * @param \MoodleQuickForm $mform
+     */
+    public function instance_form_definition(\MoodleQuickForm $mform) {
+        $field = $this->get_field();
+        $config = $field->get('configdata');
+        $elementname = $this->get_form_element_name();
+        // If checkbox is required (i.e. "agree to terms") then use 'checkbox' form element.
+        // The advcheckbox element cannot be used for required fields because advcheckbox elements always provide a value.
+        $isrequired = $field->get_configdata_property('required');
+        $mform->addElement($isrequired ? 'checkbox' : 'advcheckbox', $elementname, $this->get_field()->get_formatted_name());
+        $mform->setDefault($elementname, $config['checkbydefault']);
+        $mform->setType($elementname, PARAM_BOOL);
+        if ($isrequired) {
+            $mform->addRule($elementname, null, 'required', null, 'client');
+        }
+    }
+
+    /**
+     * Returns the default value as it would be stored in the database (not in human-readable format).
+     *
+     * @return mixed
+     */
+    public function get_default_value() {
+        return $this->get_field()->get_configdata_property('checkbydefault') ? 1 : 0;
+    }
+
+    /**
+     * Returns value in a human-readable format
+     *
+     * @return mixed|null value or null if empty
+     */
+    public function export_value() {
+        $value = $this->get_value();
+        return $value ? get_string('yes') : get_string('no');
+    }
+}

customfield/field/checkbox/classes/field_controller.php

@@ -0,0 +1,94 @@
+<?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/>.
+
+/**
+ * Customfields checkbox plugin
+ *
+ * @package   customfield_checkbox
+ * @copyright 2018 David Matamoros <davidmc@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace customfield_checkbox;
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Class field
+ *
+ * @package customfield_checkbox
+ * @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 {
+    /**
+     * Plugin type
+     */
+    const TYPE = 'checkbox';
+
+    /**
+     * Add fields for editing a checkbox field.
+     *
+     * @param \MoodleQuickForm $mform
+     */
+    public function config_form_definition(\MoodleQuickForm $mform) {
+        $mform->addElement('header', 'header_specificsettings', get_string('specificsettings', 'customfield_checkbox'));
+        $mform->setExpanded('header_specificsettings', true);
+
+        $mform->addElement('selectyesno', 'configdata[checkbydefault]', get_string('checkedbydefault', 'customfield_checkbox'));
+        $mform->setType('configdata[checkbydefault]', PARAM_BOOL);
+    }
+
+    /**
+     * Validate the data on the field configuration form
+     *
+     * @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 {
+        $errors = parent::config_form_validation($data, $files);
+
+        if ($data['configdata']['uniquevalues']) {
+            $errors['configdata[uniquevalues]'] = get_string('errorconfigunique', 'customfield_checkbox');
+        }
+
+        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 {
+        $name = $this->get_formatted_name();
+        return [
+            1 => $name.': '.get_string('yes'),
+            BLOCK_MYOVERVIEW_CUSTOMFIELD_EMPTY => $name.': '.get_string('no'),
+        ];
+    }
+}

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

@@ -0,0 +1,81 @@
+<?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_checkbox.
+ *
+ * @package    customfield_checkbox
+ * @copyright  2018 Daniel Neis Araujo <danielneis@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace customfield_checkbox\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_checkbox 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) {
+        writer::with_context($data->get_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) {
+    }
+}