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
|
<?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\Core;
use API,
CController as CAction;
/**
* Base class for user modules. If Module.php is not provided by user module, this class will be instantiated instead.
*/
class CModule {
public const TYPE_MODULE = 'module';
public const TYPE_WIDGET = 'widget';
protected array $manifest;
protected string $moduleid;
protected string $relative_path;
public function __construct(array $manifest, string $moduleid, string $relative_path) {
$this->manifest = $manifest;
$this->moduleid = $moduleid;
$this->relative_path = $relative_path;
}
public function init(): void {
}
public function getManifest(): array {
return $this->manifest;
}
public function getId(): string {
return $this->manifest['id'];
}
public function getName(): string {
return $this->manifest['name'];
}
public function getNamespace(): string {
return $this->manifest['namespace'];
}
public function getVersion(): string {
return $this->manifest['version'];
}
public function getType(): string {
return $this->manifest['type'];
}
public function getAuthor(): string {
return $this->manifest['author'];
}
public function getUrl(): string {
return $this->manifest['url'];
}
public function getDescription(): string {
return $this->manifest['description'];
}
public function getActions(): array {
return $this->manifest['actions'];
}
public function getAssets(): array {
return $this->manifest['assets'];
}
public function getConfig(): array {
return $this->manifest['config'];
}
public function setConfig(array $config): self {
$this->manifest['config'] = $config;
API::Module()->update([[
'moduleid' => $this->moduleid,
'config' => $config
]]);
return $this;
}
/**
* Get module configuration option.
*
* @param string|null $name Option name.
* @param mixed $default Default value.
*
* @return mixed Configuration option (if exists) or the $default value.
*/
public function getOption(?string $name = null, $default = null) {
return array_key_exists($name, $this->manifest['config']) ? $this->manifest['config'][$name] : $default;
}
public function getModuleId(): string {
return $this->moduleid;
}
public function getRelativePath(): string {
return $this->relative_path;
}
public function getTranslationStrings(): array {
return [];
}
/**
* Event handler, triggered before executing the action.
*
* @param CAction $action Action instance responsible for current request.
*/
public function onBeforeAction(CAction $action): void {
}
/**
* Event handler, triggered on application exit.
*
* @param CAction $action Action instance responsible for current request.
*/
public function onTerminate(CAction $action): void {
}
}
|
