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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 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.
**/
class CTag extends CObject {
/**
* Encodes the '<', '>', '"' and '&' symbols.
*/
const ENC_ALL = 1;
/**
* Encodes all symbols in ENC_ALL except for '&'.
*/
const ENC_NOAMP = 2;
/**
* The HTML encoding strategy to use for the contents of the tag.
*
* @var int
*/
protected $encStrategy = self::ENC_NOAMP;
/**
* The HTML encoding strategy for the "value", "name" and "id" attributes.
*
* @var int
*/
protected $attrEncStrategy = self::ENC_ALL;
/**
* Hint element for the current CTag.
*
* @var CSpan
*/
protected $hint = null;
public function __construct($tagname, $paired = false, $body = null) {
parent::__construct();
$this->attributes = [];
$this->tagname = $tagname;
$this->paired = $paired;
if (!is_null($body)) {
$this->addItem($body);
}
}
// do not put new line symbol (\n) before or after html tags, it adds spaces in unwanted places
protected function startToString() {
$res = '<'.$this->tagname;
foreach ($this->attributes as $key => $value) {
if ($value === null) {
continue;
}
// a special encoding strategy should be used for the "value", "name" and "id" attributes
$strategy = in_array($key, ['value', 'name', 'id'], true) ? $this->attrEncStrategy : $this->encStrategy;
$value = $this->encode($value, $strategy);
$res .= ' '.$key.'="'.$value.'"';
}
$res .= '>';
// $res .= ($this->paired) ? '>' : ' />';
return $res;
}
protected function bodyToString() {
return parent::toString(false);
}
protected function endToString() {
$res = ($this->paired) ? '</'.$this->tagname.'>' : '';
return $res;
}
public function toString($destroy = true) {
$res = $this->startToString();
$res .= $this->bodyToString();
$res .= $this->endToString();
if ($this->hint !== null) {
$res .= $this->hint->toString();
}
if ($destroy) {
$this->destroy();
}
return $res;
}
public function addItem($value) {
// the string contents of an HTML tag should be properly encoded
if (is_string($value)) {
$value = $this->encode($value, $this->getEncStrategy());
}
parent::addItem($value);
return $this;
}
public function setName($value) {
$this->setAttribute('name', $value);
return $this;
}
public function getName() {
return $this->getAttribute('name');
}
public function addClass($class) {
if ($class !== null) {
if (!array_key_exists('class', $this->attributes) || $this->attributes['class'] === '') {
$this->attributes['class'] = $class;
}
else {
$this->attributes['class'] .= ' '.$class;
}
}
return $this;
}
public function getAttribute($name) {
return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
}
public function setAttribute($name, $value) {
if (is_object($value)) {
$value = unpack_object($value);
}
elseif (is_array($value)) {
$value = CHtml::serialize($value);
}
$this->attributes[$name] = $value;
return $this;
}
public function removeAttribute($name) {
unset($this->attributes[$name]);
return $this;
}
private function addAction($name, $value) {
$this->attributes[$name] = $value;
return $this;
}
/**
* Adds a hint box to the element.
*
* @param string|array|CTag $text Hint content.
* @param string $span_class Wrap the content in a span element and assign this class
* to the span.
* @param bool $freeze_on_click If set to true, it will be possible to "freeze" the hint box
* via a mouse click.
* @param string $styles Custom css styles.
* Syntax:
* property1: value1; property2: value2; property(n): value(n)
*
* @return CTag
*/
public function setHint($text, $span_class = '', $freeze_on_click = true, $styles = '') {
$this->hint = (new CDiv($text))
->addClass('hint-box')
->setAttribute('style', 'display: none;');
$this->setAttribute('data-hintbox', '1');
if ($span_class !== '') {
$this->setAttribute('data-hintbox-class', $span_class);
}
if ($styles !== '') {
$this->setAttribute('data-hintbox-style', $styles);
}
if ($freeze_on_click) {
$this->setAttribute('data-hintbox-static', '1');
}
return $this;
}
/**
* Set data for menu popup.
*
* @param array $data
*/
public function setMenuPopup(array $data) {
$this->setAttribute('data-menu-popup', $data);
return $this;
}
public function onChange($script) {
$this->addAction('onchange', $script);
return $this;
}
public function onClick($script) {
$this->addAction('onclick', $script);
return $this;
}
public function onMouseover($script) {
$this->addAction('onmouseover', $script);
return $this;
}
public function onMouseout($script) {
$this->addAction('onmouseout', $script);
return $this;
}
public function onKeyup($script) {
$this->addAction('onkeyup', $script);
return $this;
}
public function addStyle($value) {
if (!isset($this->attributes['style'])) {
$this->attributes['style'] = '';
}
if (isset($value)) {
$this->attributes['style'] .= htmlspecialchars(strval($value));
}
else {
unset($this->attributes['style']);
}
return $this;
}
public function error($value) {
error('class('.get_class($this).') - '.$value);
return 1;
}
public function getForm($method = 'post', $action = null, $enctype = null) {
$form = (new CForm($method, $action, $enctype))
->addItem($this);
return $form;
}
public function setTitle($value) {
$this->setAttribute('title', $value);
return $this;
}
public function setId($id) {
$this->setAttribute('id', $id);
return $this;
}
public function getId() {
return $this->getAttribute('id');
}
/**
* Remove ID attribute from tag.
*
* @return CTag
*/
public function removeId() {
$this->removeAttribute('id');
return $this;
}
/**
* Sanitizes a string according to the given strategy before outputting it to the browser.
*
* @param string $value
* @param int $strategy
*
* @return string
*/
protected function encode($value, $strategy = self::ENC_NOAMP) {
if ($strategy == self::ENC_NOAMP) {
$value = str_replace(['<', '>', '"'], ['<', '>', '"'], $value);
}
else {
$value = CHtml::encode($value);
}
return $value;
}
/**
* @param int $encStrategy
*/
public function setEncStrategy($encStrategy) {
$this->encStrategy = $encStrategy;
return $this;
}
/**
* @return int
*/
public function getEncStrategy() {
return $this->encStrategy;
}
/**
* Set or reset element 'aria-required' attribute.
*
* @param bool $is_required Define aria-required attribute for element.
*
* @return CTag
*/
public function setAriaRequired($is_required = true) {
if ($is_required) {
$this->setAttribute('aria-required', 'true');
}
else {
$this->removeAttribute('aria-required');
}
return $this;
}
}
|