This repository has been archived by the owner on Dec 2, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 120
/
essential_admin_setting_configinteger.php
90 lines (81 loc) · 3.27 KB
/
essential_admin_setting_configinteger.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?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/>.
/**
* Integer admin setting with lower and upper limits.
*
* @package theme
* @subpackage essential
* @copyright © 2014-onwards G J Barnard.
* @author G J Barnard - {@link http://moodle.org/user/profile.php?id=442195}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
class essential_admin_setting_configinteger extends admin_setting_configtext {
/** @var int lower range limit */
public $lower;
/** @var int upper range limit */
public $upper;
/**
* Config text constructor
*
* @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in
* config_plugins.
* @param string $visiblename localised
* @param string $description long localised info
* @param string $defaultsetting
* @param int $lower lower range limit
* @param int $upper upper range limit
*/
public function __construct($name, $visiblename, $description, $defaultsetting, $lower, $upper) {
if ($upper < $lower) {
throw new coding_exception('Upper range limit is less than the lower range limit.');
}
$this->lower = $lower;
$this->upper = $upper;
parent::__construct($name, $visiblename, $description, $defaultsetting, PARAM_INT);
}
public function write_setting($data) {
// Trim any spaces to avoid spaces typo.
$data = trim($data);
if ($data === '') {
// Override parent behaviour and set to default if empty string.
$data = $this->get_defaultsetting();
}
return parent::write_setting($data);
}
/**
* Validate data before storage
* @param string data
* @return mixed true if ok string if error found
*/
public function validate($data) {
if (!is_number($data)) {
$validated = get_string('asconfigintnan', 'theme_essential', array('value' => $data));
} else {
$validated = parent::validate($data); // Pass parent validation first.
if ($validated == true) {
if ($data < $this->lower) {
$validated = get_string('asconfigintlower', 'theme_essential', array('value' => $data, 'lower' => $this->lower));
} else if ($data > $this->upper) {
$validated = get_string('asconfigintupper', 'theme_essential', array('value' => $data, 'upper' => $this->upper));
} else {
$validated = true;
}
}
}
return $validated;
}
}