mirror of
https://github.com/moodle/moodle.git
synced 2025-07-19 13:21:42 +02:00
88 lines
2.9 KiB
PHP
88 lines
2.9 KiB
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/>.
|
|
|
|
/**
|
|
* 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');
|
|
}
|
|
}
|