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) {
+    }
+}

customfield/field/checkbox/lang/en/customfield_checkbox.php

@@ -0,0 +1,30 @@
+<?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 Toni Barbera <toni@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$string['checkedbydefault'] = 'Checked by default';
+$string['errorconfigunique'] = 'The checkbox field cannot be defined as unique.';
+$string['pluginname'] = 'Checkbox';
+$string['privacy:metadata'] = 'The Checkbox field type plugin doesn\'t store any personal data; it uses tables defined in core.';
+$string['specificsettings'] = 'Checkbox field settings';

customfield/field/checkbox/tests/behat/field.feature

@@ -0,0 +1,78 @@
+@customfield @customfield_checkbox @javascript
+Feature: Managers can manage course custom fields checkbox
+  In order to have additional data on the course
+  As a manager
+  I need to create, edit, remove and sort custom fields
+
+  Background:
+    Given the following "custom field categories" exist:
+      | name              | component   | area   | itemid |
+      | Category for test | core_course | course | 0      |
+    And I log in as "admin"
+    And I navigate to "Courses > Default settings > Course custom fields" in site administration
+
+  Scenario: Create a custom course checkbox field
+    When I click on "Add a new custom field" "link"
+    And I click on "Checkbox" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Checkbox" "dialogue"
+    Then I should see "Test field"
+    And I log out
+
+  Scenario: Edit a custom course checkbox field
+    When I click on "Add a new custom field" "link"
+    And I click on "Checkbox" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Checkbox" "dialogue"
+    And I click on "Edit" "link" in the "Test field" "table_row"
+    And I set the following fields to these values:
+      | Name | Edited field |
+    And I click on "Save changes" "button" in the "Updating Test field" "dialogue"
+    Then I should see "Edited field"
+    And I should not see "Test field"
+
+  Scenario: Delete a custom course checkbox field
+    When I click on "Add a new custom field" "link"
+    And I click on "Checkbox" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Checkbox" "dialogue"
+    And I click on "Delete" "link" in the "Test field" "table_row"
+    And I click on "Yes" "button" in the "Confirm" "dialogue"
+    Then I should not see "Test field"
+    And I log out
+
+  Scenario: A checkbox checked by default must be shown on listing but allow uncheck that will keep showing
+    Given the following "users" exist:
+      | username | firstname | lastname  | email                |
+      | teacher1 | Teacher   | Example 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname | shortname | format |
+      | Course 1 | C1        | topics |
+    And the following "course enrolments" exist:
+      | user     | course | role           |
+      | teacher1 | C1     | editingteacher |
+    When I click on "Add a new custom field" "link"
+    And I click on "Checkbox" "link"
+    And I set the following fields to these values:
+      | Name               | Test field |
+      | Short name         | testfield  |
+      | Checked by default | Yes        |
+    And I click on "Save changes" "button" in the "Adding a new Checkbox" "dialogue"
+    And I log out
+    And I log in as "teacher1"
+    And I am on site homepage
+    Then I should see "Test field: Yes"
+    When I am on "Course 1" course homepage
+    And I navigate to "Settings" in current page administration
+    And I expand all fieldsets
+    And I set the field "Test field" to ""
+    And I press "Save and display"
+    And I am on site homepage
+    Then I should see "Test field: No"
+    And I log out

customfield/field/checkbox/tests/plugin_test.php

@@ -0,0 +1,172 @@
+<?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_checkbox;
+
+use core_customfield_generator;
+use core_customfield_test_instance_form;
+
+/**
+ * Functional test for customfield_checkbox
+ *
+ * @package    customfield_checkbox
+ * @copyright  2019 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class plugin_test extends \advanced_testcase {
+
+    /** @var \stdClass[]  */
+    private $courses = [];
+    /** @var \core_customfield\category_controller */
+    private $cfcat;
+    /** @var \core_customfield\field_controller[] */
+    private $cfields;
+    /** @var \core_customfield\data_controller[] */
+    private $cfdata;
+
+    /**
+     * Tests set up.
+     */
+    public function setUp(): void {
+        $this->resetAfterTest();
+
+        $this->cfcat = $this->get_generator()->create_category();
+
+        $this->cfields[1] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield1', 'type' => 'checkbox']);
+        $this->cfields[2] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'checkbox',
+                'configdata' => ['required' => 1]]);
+        $this->cfields[3] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield3', 'type' => 'checkbox',
+                'configdata' => ['checkbydefault' => 1]]);
+
+        $this->courses[1] = $this->getDataGenerator()->create_course();
+        $this->courses[2] = $this->getDataGenerator()->create_course();
+        $this->courses[3] = $this->getDataGenerator()->create_course();
+
+        $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id, 1);
+        $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id, 1);
+
+        $this->setUser($this->getDataGenerator()->create_user());
+    }
+
+    /**
+     * Get generator
+     * @return core_customfield_generator
+     */
+    protected function get_generator(): core_customfield_generator {
+        return $this->getDataGenerator()->get_plugin_generator('core_customfield');
+    }
+
+    /**
+     * Test for initialising field and data controllers
+     */
+    public function test_initialise(): void {
+        $f = \core_customfield\field_controller::create($this->cfields[1]->get('id'));
+        $this->assertTrue($f instanceof field_controller);
+
+        $f = \core_customfield\field_controller::create(0, (object)['type' => 'checkbox'], $this->cfcat);
+        $this->assertTrue($f instanceof field_controller);
+
+        $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id'));
+        $this->assertTrue($d instanceof data_controller);
+
+        $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]);
+        $this->assertTrue($d instanceof data_controller);
+    }
+
+    /**
+     * Test for configuration form functions
+     *
+     * Create a configuration form and submit it with the same values as in the field
+     */
+    public function test_config_form(): void {
+        $this->setAdminUser();
+        $submitdata = (array)$this->cfields[1]->to_record();
+        $submitdata['configdata'] = $this->cfields[1]->get('configdata');
+
+        $submitdata = \core_customfield\field_config_form::mock_ajax_submit($submitdata);
+        $form = new \core_customfield\field_config_form(null, null, 'post', '', null, true,
+            $submitdata, true);
+        $form->set_data_for_dynamic_submission();
+        $this->assertTrue($form->is_validated());
+        $form->process_dynamic_submission();
+
+        // Try submitting with 'unique values' checked.
+        $submitdata['configdata']['uniquevalues'] = 1;
+
+        $submitdata = \core_customfield\field_config_form::mock_ajax_submit($submitdata);
+        $form = new \core_customfield\field_config_form(null, null, 'post', '', null, true,
+            $submitdata, true);
+        $form->set_data_for_dynamic_submission();
+        $this->assertFalse($form->is_validated());
+    }
+
+    /**
+     * Test for instance form functions
+     */
+    public function test_instance_form(): void {
+        global $CFG;
+        require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php');
+        $this->setAdminUser();
+        $handler = $this->cfcat->get_handler();
+
+        // First try to submit without required field.
+        $submitdata = (array)$this->courses[1];
+        core_customfield_test_instance_form::mock_submit($submitdata, []);
+        $form = new core_customfield_test_instance_form('POST',
+            ['handler' => $handler, 'instance' => $this->courses[1]]);
+        $this->assertFalse($form->is_validated());
+
+        // Now with required field.
+        $submitdata['customfield_myfield2'] = 1;
+        core_customfield_test_instance_form::mock_submit($submitdata, []);
+        $form = new core_customfield_test_instance_form('POST',
+            ['handler' => $handler, 'instance' => $this->courses[1]]);
+        $this->assertTrue($form->is_validated());
+
+        $data = $form->get_data();
+        $this->assertNotEmpty($data->customfield_myfield1);
+        $this->assertNotEmpty($data->customfield_myfield2);
+        $handler->instance_form_save($data);
+    }
+
+    /**
+     * Test for data_controller::get_value and export_value
+     */
+    public function test_get_export_value(): void {
+        $this->assertEquals(1, $this->cfdata[1]->get_value());
+        $this->assertEquals('Yes', $this->cfdata[1]->export_value());
+
+        // Field without data.
+        $d = \core_customfield\data_controller::create(0, null, $this->cfields[2]);
+        $this->assertEquals(0, $d->get_value());
+        $this->assertEquals('No', $d->export_value());
+
+        // Field without data that is checked by default.
+        $d = \core_customfield\data_controller::create(0, null, $this->cfields[3]);
+        $this->assertEquals(1, $d->get_value());
+        $this->assertEquals('Yes', $d->export_value());
+    }
+
+    /**
+     * Deleting fields and data
+     */
+    public function test_delete(): void {
+        $this->cfcat->get_handler()->delete_all();
+    }
+}

customfield/field/checkbox/version.php

@@ -0,0 +1,28 @@
+<?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 Toni Barbera <toni@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'customfield_checkbox';
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;