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
|
<?php declare(strict_types = 0);
/*
** 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/>.
**/
/**
* A structure used by CSelect that describes a single option of select element.
*/
class CSelectOption {
/**
* @var string
*/
protected $label;
/**
* @var mixed
*/
protected $value;
/**
* Arbitrary data associated with this option.
*
* @var array
*/
protected $extra = [];
/**
* @var array
*/
protected $class_names = [];
/**
* @var bool
*/
protected $disabled = false;
/**
* @param mixed $value Option value.
* @param string $label Option name.
*/
public function __construct($value, string $label) {
$this->value = $value;
$this->label = $label;
}
/**
* Add arbitrary data associated with this option.
*
* @param string $key
* @param string $value
*
* @return self
*/
public function setExtra(string $key, string $value): self {
$this->extra[$key] = $value;
return $this;
}
/**
* @param bool $value
*
* @return self
*/
public function setDisabled(bool $value = true): self {
$this->disabled = $value;
return $this;
}
/**
* @param string $class_name
*
* @return self
*/
public function addClass(?string $class_name): self {
if ($class_name) {
$this->class_names[] = $class_name;
}
return $this;
}
/**
* Formats this object into associative array.
*
* @return array
*/
public function toArray(): array {
$option = [
'value' => $this->value,
'label' => $this->label
];
if ($this->extra) {
$option['extra'] = $this->extra;
}
if ($this->class_names) {
$option['class_name'] = implode(' ', $this->class_names);
}
if ($this->disabled) {
$option['is_disabled'] = true;
}
return $option;
}
}
|