-
Notifications
You must be signed in to change notification settings - Fork 2
/
VariableProfileHelper.php
221 lines (210 loc) · 8.89 KB
/
VariableProfileHelper.php
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
<?php
/**
* @addtogroup generic
* @{
*
* @package generic
* @file VariableProfileHelper.php
* @author Michael Tröger <micha@nall-chan.net>
* @copyright 2018 Michael Tröger
* @license https://creativecommons.org/licenses/by-nc-sa/4.0/ CC BY-NC-SA 4.0
* @version 5.0
*/
/**
* Trait mit Hilfsfunktionen für Variablenprofile.
*/
trait VariableProfileHelper
{
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ bool mit Assoziationen.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param array $Associations Assoziationen der Werte als Array.
*/
protected function RegisterProfileBooleanEx($Name, $Icon, $Prefix, $Suffix, $Associations)
{
$this->RegisterProfileEx(VARIABLETYPE_BOOLEAN, $Name, $Icon, $Prefix, $Suffix, $Associations);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ integer mit Assoziationen.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param array $Associations Assoziationen der Werte als Array.
*/
protected function RegisterProfileIntegerEx($Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue = -1, $StepSize = 0)
{
$this->RegisterProfileEx(VARIABLETYPE_INTEGER, $Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue, $StepSize);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ float mit Assoziationen.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param array $Associations Assoziationen der Werte als Array.
*/
protected function RegisterProfileFloatEx($Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue = -1, $StepSize = 0, $Digits = 0)
{
$this->RegisterProfileEx(VARIABLETYPE_FLOAT, $Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue, $StepSize, $Digits);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ string mit Assoziationen.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param array $Associations Assoziationen der Werte als Array.
*/
protected function RegisterProfileStringEx($Name, $Icon, $Prefix, $Suffix, $Associations)
{
$this->RegisterProfileEx(VARIABLETYPE_STRING, $Name, $Icon, $Prefix, $Suffix, $Associations);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ bool.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
*/
protected function RegisterProfileBoolean($Name, $Icon, $Prefix, $Suffix)
{
$this->RegisterProfile(VARIABLETYPE_BOOLEAN, $Name, $Icon, $Prefix, $Suffix, 0, 0, 0);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ integer.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param int $MinValue Minimaler Wert.
* @param int $MaxValue Maximaler wert.
* @param int $StepSize Schrittweite
*/
protected function RegisterProfileInteger($Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize)
{
$this->RegisterProfile(VARIABLETYPE_INTEGER, $Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ float.
*
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param int $MinValue Minimaler Wert.
* @param int $MaxValue Maximaler wert.
* @param int $StepSize Schrittweite
*/
protected function RegisterProfileFloat($Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize, $Digits)
{
$this->RegisterProfile(VARIABLETYPE_FLOAT, $Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize, $Digits);
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ VarType mit Assoziationen.
*
* @param int $VarTyp Typ der Variable
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param array $Associations Assoziationen der Werte als Array.
*/
protected function RegisterProfileEx($VarTyp, $Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue = -1, $StepSize = 0, $Digits = 0)
{
if (is_int($Associations)) {
$this->RegisterProfile($VarTyp, $Name, $Icon, $Prefix, $Suffix, $Associations, $MaxValue, $StepSize, $Digits);
return;
}
if (count($Associations) === 0) {
$MinValue = 0;
$MaxValue = 0;
} else {
$MinMax = array_column($Associations, 0);
sort($MinMax);
$MinValue = $MinMax[0];
if ($MaxValue == -1) {
$MaxValue = $Associations[count($Associations) - 1][0];
} else {
$MaxValue = array_pop($MinMax);
}
}
$this->RegisterProfile($VarTyp, $Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize, $Digits);
$old = IPS_GetVariableProfile($Name)['Associations'];
$OldValues = array_column($old, 'Value');
foreach ($Associations as $Association) {
IPS_SetVariableProfileAssociation($Name, $Association[0], $this->Translate($Association[1]), $Association[2], $Association[3]);
$OldKey = array_search($Association[0], $OldValues);
if (!($OldKey === false)) {
unset($OldValues[$OldKey]);
}
}
foreach ($OldValues as $OldKey => $OldValue) {
IPS_SetVariableProfileAssociation($Name, $OldValue, '', '', 0);
}
}
/**
* Erstellt und konfiguriert ein VariablenProfil für den Typ float.
*
* @param int $VarTyp Typ der Variable
* @param string $Name Name des Profils.
* @param string $Icon Name des Icon.
* @param string $Prefix Prefix für die Darstellung.
* @param string $Suffix Suffix für die Darstellung.
* @param int $MinValue Minimaler Wert.
* @param int $MaxValue Maximaler wert.
* @param int $StepSize Schrittweite
*/
protected function RegisterProfile($VarTyp, $Name, $Icon, $Prefix, $Suffix, $MinValue, $MaxValue, $StepSize, $Digits = 0)
{
if (!IPS_VariableProfileExists($Name)) {
IPS_CreateVariableProfile($Name, $VarTyp);
} else {
$profile = IPS_GetVariableProfile($Name);
if ($profile['ProfileType'] != $VarTyp) {
throw new \Exception('Variable profile type does not match for profile ' . $Name, E_USER_WARNING);
}
}
IPS_SetVariableProfileIcon($Name, $Icon);
IPS_SetVariableProfileText($Name, $this->Translate($Prefix), $this->Translate($Suffix));
if (($VarTyp != VARIABLETYPE_BOOLEAN) && ($VarTyp != VARIABLETYPE_STRING)) {
IPS_SetVariableProfileValues($Name, $MinValue, $MaxValue, $StepSize);
}
if ($VarTyp == VARIABLETYPE_FLOAT) {
IPS_SetVariableProfileDigits($Name, $Digits);
}
}
/**
* Löscht ein Variablenprofile, sofern es nicht außerhalb dieser Instanz noch verwendet wird.
*
* @param string $Name Name des zu löschenden Profils.
*/
protected function UnregisterProfile(string $Name)
{
if (!IPS_VariableProfileExists($Name)) {
return;
}
foreach (IPS_GetVariableList() as $VarID) {
if (IPS_GetParent($VarID) == $this->InstanceID) {
continue;
}
if (IPS_GetVariable($VarID)['VariableCustomProfile'] == $Name) {
return;
}
if (IPS_GetVariable($VarID)['VariableProfile'] == $Name) {
return;
}
}
IPS_DeleteVariableProfile($Name);
}
}
/* @} */