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
|
<?php declare(strict_types = 0);
/*
** Zabbix
** Copyright (C) 2001-2021 Zabbix SIA
**
** This program 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.
**
** 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
namespace Zabbix\Widgets\Fields;
use Zabbix\Widgets\CWidgetField;
class CWidgetFieldColumnsList extends CWidgetField {
// Source of value to display in column.
public const DATA_ITEM_VALUE = 1;
public const DATA_HOST_NAME = 2;
public const DATA_TEXT = 3;
// Column value display type.
public const DISPLAY_AS_IS = 1;
public const DISPLAY_BAR = 2;
public const DISPLAY_INDICATORS = 3;
// Where to select data for aggregation function.
public const HISTORY_DATA_AUTO = 1;
public const HISTORY_DATA_HISTORY = 2;
public const HISTORY_DATA_TRENDS = 3;
// Predefined colors for thresholds. Each next threshold takes next sequential value from palette.
public const THRESHOLDS_DEFAULT_COLOR_PALETTE = [
'FF465C', 'B0AF07', '0EC9AC', '524BBC', 'ED1248', 'D1E754', '2AB5FF', '385CC7', 'EC1594', 'BAE37D',
'6AC8FF', 'EE2B29', '3CA20D', '6F4BBC', '00A1FF', 'F3601B', '1CAE59', '45CFDB', '894BBC', '6D6D6D'
];
public function __construct(string $name, string $label = null) {
parent::__construct($name, $label);
$this
->setSaveType(ZBX_WIDGET_FIELD_TYPE_STR)
->setValidationRules(['type' => API_OBJECTS, 'fields' => [
'name' => ['type' => API_STRING_UTF8, 'default' => '', 'length' => 255],
'data' => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => implode(',', [self::DATA_ITEM_VALUE, self::DATA_HOST_NAME, self::DATA_TEXT])],
'item' => ['type' => API_MULTIPLE, 'rules' => [
['if' => ['field' => 'data', 'in' => self::DATA_ITEM_VALUE],
'type' => API_STRING_UTF8, 'flags' => API_REQUIRED, 'length' => 255],
['else' => true,
'type' => API_STRING_UTF8]
]],
'timeshift' => ['type' => API_TIME_UNIT, 'in' => implode(':', [ZBX_MIN_TIMESHIFT, ZBX_MAX_TIMESHIFT])],
'aggregate_function' => ['type' => API_INT32, 'in' => implode(',', [AGGREGATE_NONE, AGGREGATE_MIN, AGGREGATE_MAX, AGGREGATE_AVG, AGGREGATE_COUNT, AGGREGATE_SUM, AGGREGATE_FIRST, AGGREGATE_LAST]), 'default' => AGGREGATE_NONE],
'aggregate_interval' => ['type' => API_MULTIPLE, 'rules' => [
['if' => ['field' => 'aggregate_function', 'in' => implode(',', [AGGREGATE_MIN, AGGREGATE_MAX, AGGREGATE_AVG, AGGREGATE_COUNT, AGGREGATE_SUM, AGGREGATE_FIRST, AGGREGATE_LAST])],
'type' => API_TIME_UNIT, 'flags' => API_REQUIRED | API_NOT_EMPTY | API_TIME_UNIT_WITH_YEAR, 'in' => implode(':', [1, ZBX_MAX_TIMESHIFT])],
['else' => true,
'type' => API_STRING_UTF8]
]],
'display' => ['type' => API_MULTIPLE, 'rules' => [
['if' => ['field' => 'data', 'in' => self::DATA_ITEM_VALUE],
'type' => API_INT32, 'default' => self::DISPLAY_AS_IS, 'in' => implode(',', [self::DISPLAY_AS_IS, self::DISPLAY_BAR, self::DISPLAY_INDICATORS])],
['else' => true,
'type' => API_INT32]
]],
'history' => ['type' => API_MULTIPLE, 'rules' => [
['if' => ['field' => 'data', 'in' => self::DATA_ITEM_VALUE],
'type' => API_INT32, 'default' => self::HISTORY_DATA_AUTO, 'in' => implode(',', [self::HISTORY_DATA_AUTO, self::HISTORY_DATA_HISTORY, self::HISTORY_DATA_TRENDS])],
['else' => true,
'type' => API_INT32]
]],
'base_color' => ['type' => API_COLOR],
'min' => ['type' => API_NUMERIC],
'max' => ['type' => API_NUMERIC],
'thresholds' => ['type' => API_OBJECTS, 'uniq' => [['threshold']], 'fields' => [
'color' => ['type' => API_COLOR],
'threshold' => ['type' => API_NUMERIC]
]],
'text' => ['type' => API_MULTIPLE, 'rules' => [
['if' => ['field' => 'data', 'in' => self::DATA_TEXT],
'type' => API_STRING_UTF8, 'flags' => API_REQUIRED | API_NOT_EMPTY, 'length' => 255],
['else' => true,
'type' => API_STRING_UTF8]
]]
]]);
}
public function setValue($value): self {
$this->value = (array) $value;
return $this;
}
public function toApi(array &$widget_fields = []): void {
$fields = [
'name' => ZBX_WIDGET_FIELD_TYPE_STR,
'data' => ZBX_WIDGET_FIELD_TYPE_INT32,
'item' => ZBX_WIDGET_FIELD_TYPE_STR,
'timeshift' => ZBX_WIDGET_FIELD_TYPE_STR,
'aggregate_function' => ZBX_WIDGET_FIELD_TYPE_INT32,
'aggregate_interval' => ZBX_WIDGET_FIELD_TYPE_STR,
'min' => ZBX_WIDGET_FIELD_TYPE_STR,
'max' => ZBX_WIDGET_FIELD_TYPE_STR,
'display' => ZBX_WIDGET_FIELD_TYPE_INT32,
'history' => ZBX_WIDGET_FIELD_TYPE_INT32,
'base_color' => ZBX_WIDGET_FIELD_TYPE_STR,
'text' => ZBX_WIDGET_FIELD_TYPE_STR
];
foreach ($this->getValue() as $column_index => $val) {
foreach (array_intersect_key($fields, $val) as $field => $field_type) {
$widget_fields[] = [
'type' => $field_type,
'name' => implode('.', [$this->name, $field, $column_index]),
'value' => $val[$field]
];
}
if (!array_key_exists('thresholds', $val) || !$val['thresholds']) {
continue;
}
foreach ($val['thresholds'] as $threshold_index => $threshold) {
$widget_fields[] = [
'type' => ZBX_WIDGET_FIELD_TYPE_STR,
'name' => implode('.', [$this->name.'thresholds.color', $column_index, $threshold_index]),
'value' => $threshold['color']
];
$widget_fields[] = [
'type' => ZBX_WIDGET_FIELD_TYPE_STR,
'name' => implode('.', [$this->name.'thresholds.threshold', $column_index, $threshold_index]),
'value' => $threshold['threshold']
];
}
}
}
}
|
