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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
|
<?php
/*
** Copyright (C) 2001-2025 Zabbix SIA
**
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
**
** This program 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 Affero General Public License for more details.
**
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
**/
class CCheckBoxList extends CList {
private const ZBX_STYLE_CLASS = 'checkbox-list';
private const ZBX_STYLE_LAYOUT_FIXED = 'fixed';
private const ZBX_STYLE_VERTICAL = 'vertical';
/**
* @var array $values
*/
protected array $values = [];
/**
* @var string $name
*/
protected $name;
/**
* Checkboxes id unique suffix.
*/
protected $uniqid = '';
/**
* @var bool $enabled
*/
protected $enabled = true;
/**
* @var bool $readonly
*/
protected $readonly = false;
/**
* @var bool $layout_fixed
*/
protected $layout_fixed = false;
/**
* @var bool $vertical
*/
protected $vertical = false;
/**
* @var int $columns
*/
protected int $columns = 1;
/**
* @var bool
*/
protected bool $show_titles = false;
/**
* @param string $name
*/
public function __construct($name = '') {
parent::__construct();
$this->addClass(self::ZBX_STYLE_CLASS);
$this->name = $name;
}
/**
* Set unique ID, is used as suffix for generated check-box IDs.
*
* @param string $uniqid Unique id string.
*/
public function setUniqid(string $uniqid) {
$this->uniqid = $uniqid;
return $this;
}
/**
* @param array $values
*
* @return CCheckBoxList
*/
public function setChecked(array $values) {
$values = array_flip($values);
foreach ($this->values as &$value) {
$value['checked'] = array_key_exists($value['value'], $values);
}
unset($value);
return $this;
}
/**
* @param array $values
*
* @return CCheckBoxList
*/
public function setOptions(array $values) {
$this->values = [];
foreach ($values as $value) {
$this->values[] = $value + [
'label' => '',
'value' => null,
'checked' => false
];
}
return $this;
}
/**
* Sets the width of the checkbox list.
*
* @return CCheckBoxList
*/
public function setWidth($value) {
$this->addStyle('width: '.$value.'px;');
return $this;
}
/**
* Set checkboxes enabled state.
*
* @param bool $enabled State of checkboxes.
*/
public function setEnabled($enabled) {
$this->enabled = $enabled;
return $this;
}
/**
* Set checkboxes readonly state.
*
* @param bool $readonly State of checkboxes.
*/
public function setReadonly(bool $readonly) {
$this->readonly = $readonly;
return $this;
}
/**
* Make columns the same size.
*
* @param bool $layout_fixed
*
* @return CCheckBoxList
*/
public function setLayoutFixed(bool $layout_fixed = true): CCheckBoxList {
$this->layout_fixed = $layout_fixed;
return $this;
}
/**
* Display checkboxes in vertical order.
*
* @param bool $vertical
*
* @return CCheckBoxList
*/
public function setVertical(bool $vertical = true): self {
$this->vertical = $vertical;
return $this;
}
/**
* Set number of columns.
*
* @param int $columns
*
* @return CCheckBoxList
*/
public function setColumns(int $columns): self {
$this->columns = $columns;
return $this;
}
/**
* Set if checkboxes inside have a title.
*
* @param bool $show_titles
*
* @return CCheckBoxList
*/
public function showTitles(bool $show_titles = true): self {
$this->show_titles = $show_titles;
return $this;
}
/**
* @param bool $destroy
*
* @return string
*/
public function toString($destroy = true) {
$this->addStyle('--columns: '.$this->columns.';');
if ($this->layout_fixed) {
$this->addClass(self::ZBX_STYLE_LAYOUT_FIXED);
}
if ($this->vertical) {
$max_rows = (int) ceil(count($this->values) / $this->columns);
$this->addClass(self::ZBX_STYLE_VERTICAL);
$this->addStyle('--rows: '.$max_rows.';');
}
foreach ($this->values as $value) {
$name = array_key_exists('name', $value) ? $value['name'] : $this->name.'['.$value['value'].']';
$checkbox = (new CCheckBox($name, $value['value']))
->setLabel($value['label'])
->setChecked($value['checked'])
->setEnabled($this->enabled)
->setReadonly($this->readonly);
if ($this->show_titles) {
$checkbox->setTitle($value['label']);
}
if (array_key_exists('id', $value) || $this->uniqid !== '') {
$checkbox->setId(array_key_exists('id', $value)
? $value['id']
: $checkbox->getId().'_'.$this->uniqid
);
}
if (array_key_exists('unchecked_value', $value)) {
$checkbox->setUncheckedValue($value['unchecked_value']);
}
parent::addItem($checkbox);
}
return parent::toString($destroy);
}
}
|