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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?php
/**
* A confItemSelect defines a configuration item that is defined using a selectbox
*
* This file is part of Zoph.
*
* Zoph 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 2 of the License, or
* (at your option) any later version.
*
* Zoph 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 Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
*/
namespace conf\item;
use template\block;
/**
* A confItemSelect defines a configuration item that is defined using a selectbox
*
* @package Zoph
* @author Jeroen Roos
*/
class select extends item {
/** @var array list of options */
private $options=array();
/** @var bool translate options */
private $translate=true;
/**
* Add an option
* @param string key
* @param string description
*/
public function addOption(string $key, string $desc) : void {
$this->options[$key]=$desc;
}
/**
* Add multiple options
* @param array array of options
*/
public function addOptions(array $options) : void {
foreach ($options as $key => $desc) {
$this->addOption($key, $desc);
}
}
/**
* Get array of options
* @return array options
*/
public function getOptions() : array {
return $this->options;
}
/**
* Set whether or not the options must be translated
* @param bool translate yes/no
*/
public function setOptionsTranslate(bool $translate) : void {
$this->translate=$translate;
}
/**
* Check value
* check if a specific value is legal for this option
* @param string value
* @return bool
*/
public function checkValue(?string $value) : bool {
return array_key_exists($value, $this->options);
}
/**
* Display this option through template
* @return block template block
*/
public function display() : ?block {
if ($this->internal) {
return null;
}
$params=array(
"label" => e(translate($this->getLabel(), 0)),
"name" => e($this->getName()),
"value" => e($this->getValue()),
"desc" => e(translate($this->getDesc(), 0)) .
$this->displayUnmetRequirements() .
$this->displayDeprecationWarning(),
"hint" => e(translate($this->getHint(), 0)),
"enabled" => (bool) $this->requirementsMet()
);
if ($this->translate) {
$params["options"] = translate($this->getOptions(), 0);
} else {
$params["options"] = $this->getOptions();
}
return new block("confItemSelect", $params);
}
}
|
