File: CWidgetFieldView.php

package info (click to toggle)
zabbix 1%3A7.0.10%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 272,688 kB
  • sloc: sql: 946,050; ansic: 389,440; php: 292,698; javascript: 83,388; sh: 5,680; makefile: 3,285; java: 1,420; cpp: 694; perl: 64; xml: 56
file content (140 lines) | stat: -rw-r--r-- 3,235 bytes parent folder | download | duplicates (2)
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
<?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/>.
**/


use Zabbix\Widgets\CWidgetField;

abstract class CWidgetFieldView {

	protected CWidgetField $field;

	protected string $form_name = '';

	protected array $label_class_list = [];
	protected array $field_class_list = [];

	protected bool $has_label = true;

	protected ?CTag $field_hint = null;

	public function setFormName($form_name): self {
		$this->form_name = $form_name;

		return $this;
	}

	public function getFocusableElementId(): string {
		return zbx_formatDomId($this->field->getName());
	}

	public function getLabel(): ?CLabel {
		if (!$this->has_label) {
			return null;
		}

		$label = $this->field->getLabel();

		if ($label === null) {
			return null;
		}

		return (new CLabel([$label, $this->field_hint]))
			->setFor($this->getFocusableElementId())
			->setAsteriskMark($this->isRequired())
			->addClass($this->label_class_list ? implode(' ', $this->label_class_list) : null);
	}

	public function removeLabel(): self {
		$this->has_label = false;

		return $this;
	}

	public function getName(): string {
		return $this->field->getName();
	}

	/**
	 * @return null|array|CTag
	 */
	public function getView() {
		return null;
	}

	public function getViewCollection(): array {
		return [[
			'label' => $this->getLabel(),
			'view' => $this->getView(),
			'class' => $this->getClass()
		]];
	}

	public function setFieldHint(CTag $hint): self {
		$this->field_hint = $hint;

		return $this;
	}

	public function getLabelClass(): ?string {
		return $this->label_class_list ? implode(' ', $this->label_class_list) : null;
	}

	public function addLabelClass(?string $class): self {
		if ($class !== null) {
			$this->label_class_list[] = $class;
		}

		return $this;
	}

	public function getClass(): ?string {
		return $this->field_class_list ? implode(' ', $this->field_class_list) : null;
	}

	public function addClass(?string $class): self {
		if ($class !== null) {
			$this->field_class_list[] = $class;
		}

		return $this;
	}

	public function addRowClass(?string $class): self {
		$this->addLabelClass($class);
		$this->addClass($class);

		return $this;
	}

	public function getJavaScript(): string {
		return '';
	}

	public function getTemplates(): array {
		return [];
	}

	public function isNotEmpty(): bool {
		return ($this->field->getFlags() & CWidgetField::FLAG_NOT_EMPTY) !== 0;
	}

	public function isRequired(): bool {
		return ($this->field->getFlags() & CWidgetField::FLAG_LABEL_ASTERISK) !== 0;
	}

	public function isDisabled(): bool {
		return ($this->field->getFlags() & CWidgetField::FLAG_DISABLED) !== 0;
	}
}