File: CWidgetFieldMultiSelect.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 (121 lines) | stat: -rw-r--r-- 3,120 bytes parent folder | download
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/>.
**/


namespace Zabbix\Widgets\Fields;

use Zabbix\Widgets\CWidgetField;

abstract class CWidgetFieldMultiSelect extends CWidgetField {

	public const DEFAULT_VALUE = [];

	// Is selecting multiple objects or a single one?
	private bool $is_multiple = true;

	public function __construct(string $name, ?string $label = null) {
		parent::__construct($name, $label);

		$this->setDefault(self::DEFAULT_VALUE);
	}

	public function setValue($value): self {
		$this->value = (array) $value;

		return $this;
	}

	/**
	 * Is selecting multiple values or a single value?
	 */
	public function isMultiple(): bool {
		return $this->is_multiple;
	}

	/**
	 * Set field to multiple objects mode.
	 */
	public function setMultiple(bool $is_multiple = true): self {
		$this->is_multiple = $is_multiple;

		return $this;
	}

	public function preventDefault($default_prevented = true): self {
		if ($default_prevented) {
			$this->setMultiple(false);
		}

		return parent::preventDefault($default_prevented);
	}

	public function validate(bool $strict = false): array {
		$errors = parent::validate($strict);

		if ($errors) {
			return $errors;
		}

		if ($strict) {
			$value = $this->getValue();

			if (array_key_exists(self::FOREIGN_REFERENCE_KEY, $value) && $value[self::FOREIGN_REFERENCE_KEY] === '') {
				$errors[] = _s('Invalid parameter "%1$s": %2$s.', $this->getErrorLabel(),
					_('referred widget is unavailable')
				);
			}
		}

		return $errors;
	}

	public function toApi(array &$widget_fields = []): void {
		$value = $this->getValue();

		if ($value === $this->getDefault()) {
			return;
		}

		if (array_key_exists(self::FOREIGN_REFERENCE_KEY, $value)) {
			$widget_fields[] = [
				'type' => ZBX_WIDGET_FIELD_TYPE_STR,
				'name' => $this->name.'.'.self::FOREIGN_REFERENCE_KEY,
				'value' => $value[self::FOREIGN_REFERENCE_KEY]
			];
		}
		else {
			parent::toApi($widget_fields);
		}
	}

	protected function getValidationRules(bool $strict = false): array {
		$value = $this->getValue();

		if (array_key_exists(self::FOREIGN_REFERENCE_KEY, $value)) {
			$validation_rules = ['type' => API_OBJECT, 'fields' => [
				self::FOREIGN_REFERENCE_KEY => ['type' => API_STRING_UTF8]
			]];
		}
		else {
			$validation_rules = parent::getValidationRules($strict);

			if ($strict && ($this->getFlags() & self::FLAG_NOT_EMPTY) !== 0) {
				self::setValidationRuleFlag($validation_rules, API_NOT_EMPTY);
			}
		}

		return $validation_rules;
	}
}