| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Class profile_field_checkbox
|
|
|
19 |
*
|
|
|
20 |
* @package profilefield_checkbox
|
|
|
21 |
* @copyright 2008 onwards Shane Elliot {@link http://pukunui.com}
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
class profile_field_checkbox extends profile_field_base {
|
|
|
25 |
|
|
|
26 |
/**
|
|
|
27 |
* Add elements for editing the profile field value.
|
|
|
28 |
* @param moodleform $mform
|
|
|
29 |
*/
|
|
|
30 |
public function edit_field_add($mform) {
|
|
|
31 |
// Create the form field.
|
|
|
32 |
$checkbox = $mform->addElement('advcheckbox', $this->inputname, format_string($this->field->name));
|
|
|
33 |
if ($this->data == '1') {
|
|
|
34 |
$checkbox->setChecked(true);
|
|
|
35 |
}
|
|
|
36 |
$mform->setType($this->inputname, PARAM_BOOL);
|
|
|
37 |
if ($this->is_required() and !has_capability('moodle/user:update', context_system::instance())) {
|
|
|
38 |
$mform->addRule($this->inputname, get_string('required'), 'nonzero', null, 'client');
|
|
|
39 |
}
|
|
|
40 |
}
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* Override parent {@see profile_field_base::is_empty} check
|
|
|
44 |
*
|
|
|
45 |
* We can't check the "data" property, because if not set by the user then it's populated by "defaultdata" of the field,
|
|
|
46 |
* which can also be 0 (false) therefore ensuring the parent class check could never return true for this comparison
|
|
|
47 |
*
|
|
|
48 |
* @return bool
|
|
|
49 |
*/
|
|
|
50 |
public function is_empty() {
|
|
|
51 |
return ($this->userid && !$this->field->hasuserdata);
|
|
|
52 |
}
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Override parent {@see profile_field_base::show_field_content} check
|
|
|
56 |
*
|
|
|
57 |
* We only need to determine whether the field is visible, because we also want to show the "defaultdata" of the field,
|
|
|
58 |
* even if the user hasn't explicitly filled it in
|
|
|
59 |
*
|
|
|
60 |
* @param context|null $context
|
|
|
61 |
* @return bool
|
|
|
62 |
*/
|
|
|
63 |
public function show_field_content(?context $context = null): bool {
|
|
|
64 |
return $this->is_visible($context);
|
|
|
65 |
}
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* Display the data for this field
|
|
|
69 |
*
|
|
|
70 |
* @return string HTML.
|
|
|
71 |
*/
|
|
|
72 |
public function display_data() {
|
|
|
73 |
return $this->data ? get_string('yes') : get_string('no');
|
|
|
74 |
}
|
|
|
75 |
|
|
|
76 |
/**
|
|
|
77 |
* Return the field type and null properties.
|
|
|
78 |
* This will be used for validating the data submitted by a user.
|
|
|
79 |
*
|
|
|
80 |
* @return array the param type and null property
|
|
|
81 |
* @since Moodle 3.2
|
|
|
82 |
*/
|
|
|
83 |
public function get_field_properties() {
|
|
|
84 |
return array(PARAM_BOOL, NULL_NOT_ALLOWED);
|
|
|
85 |
}
|
|
|
86 |
}
|
|
|
87 |
|
|
|
88 |
|