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
|
<?php
/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
namespace Icinga\Web;
use Closure;
use Icinga\Application\Icinga;
use ipl\I18n\Translation;
use Zend_View_Abstract;
use Icinga\Authentication\Auth;
use Icinga\Exception\ProgrammingError;
/**
* Icinga view
*
* @method Url href($path = null, $params = null) {
* @param Url|string|null $path
* @param string[]|null $params
* }
*
* @method Url url($path = null, $params = null) {
* @param Url|string|null $path
* @param string[]|null $params
* }
*
* @method Url qlink($title, $url, $params = null, $properties = null, $escape = true) {
* @param string $title
* @param Url|string|null $url
* @param string[]|null $params
* @param string[]|null $properties
* @param bool $escape
* }
*
* @method string img($url, $params = null, array $properties = array()) {
* @param Url|string|null $url
* @param string[]|null $params
* @param string[] $properties
* }
*
* @method string icon($img, $title = null, array $properties = array()) {
* @param string $img
* @param string|null $title
* @param string[] $properties
* }
*
* @method string propertiesToString($properties) {
* @param string[] $properties
* }
*
* @method string attributeToString($key, $value) {
* @param string $key
* @param string $value
* }
*/
class View extends Zend_View_Abstract
{
use Translation;
/**
* Charset to be used - we only support UTF-8
*/
const CHARSET = 'UTF-8';
/**
* Registered helper functions
*/
private $helperFunctions = array();
/**
* Authentication manager
*
* @var Auth|null
*/
private $auth;
/**
* Create a new view object
*
* @param array $config
* @see Zend_View_Abstract::__construct
*/
public function __construct($config = array())
{
$config['helperPath']['Icinga\\Web\\View\\Helper\\'] = Icinga::app()->getLibraryDir('Icinga/Web/View/Helper');
parent::__construct($config);
}
/**
* Initialize the view
*
* @see Zend_View_Abstract::init
*/
public function init()
{
$this->loadGlobalHelpers();
}
/**
* Escape the given value top be safely used in view scripts
*
* @param ?string $var The output to be escaped
* @return string
*/
public function escape($var)
{
return htmlspecialchars($var ?? '', ENT_COMPAT | ENT_SUBSTITUTE | ENT_HTML5, self::CHARSET, true);
}
/**
* Whether a specific helper (closure) has been registered
*
* @param string $name The desired function name
* @return boolean
*/
public function hasHelperFunction($name)
{
return array_key_exists($name, $this->helperFunctions);
}
/**
* Add a new helper function
*
* @param string $name The desired function name
* @param Closure $function An anonymous function
* @return $this
*/
public function addHelperFunction($name, Closure $function)
{
if ($this->hasHelperFunction($name)) {
throw new ProgrammingError(
'Cannot assign the same helper function twice: "%s"',
$name
);
}
$this->helperFunctions[$name] = $function;
return $this;
}
/**
* Set or overwrite a helper function
*
* @param string $name
* @param Closure $function
*
* @return $this
*/
public function setHelperFunction($name, Closure $function)
{
$this->helperFunctions[$name] = $function;
return $this;
}
/**
* Drop a helper function
*
* @param string $name
*
* @return $this
*/
public function dropHelperFunction($name)
{
unset($this->helperFunctions[$name]);
return $this;
}
/**
* Call a helper function
*
* @param string $name The desired function name
* @param Array $args Function arguments
* @return mixed
*/
public function callHelperFunction($name, $args)
{
return call_user_func_array(
$this->helperFunctions[$name],
$args
);
}
/**
* Load helpers
*/
private function loadGlobalHelpers()
{
$pattern = dirname(__FILE__) . '/View/helpers/*.php';
$files = glob($pattern);
foreach ($files as $file) {
require_once $file;
}
}
/**
* Get the authentication manager
*
* @return Auth
*/
public function Auth()
{
if ($this->auth === null) {
$this->auth = Auth::getInstance();
}
return $this->auth;
}
/**
* Whether the current user has the given permission
*
* @param string $permission Name of the permission
*
* @return bool
*/
public function hasPermission($permission)
{
return $this->Auth()->hasPermission($permission);
}
/**
* Use to include the view script in a scope that only allows public
* members.
*
* @return mixed
*
* @see Zend_View_Abstract::run
*/
protected function _run()
{
foreach ($this->getVars() as $k => $v) {
// Exporting global variables to view scripts:
$$k = $v;
}
include func_get_arg(0);
}
/**
* Accesses a helper object from within a script
*
* @param string $name
* @param array $args
*
* @return string
*/
public function __call($name, $args)
{
if ($this->hasHelperFunction($name)) {
return $this->callHelperFunction($name, $args);
} else {
return parent::__call($name, $args);
}
}
}
|
