blob: cb1bc397357edeab24437f3da7cfeb39c9bbfc30 (
plain)
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
|
<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
namespace Icinga\Module\Doc\Renderer;
use Exception;
use Icinga\Exception\IcingaException;
use RecursiveIteratorIterator;
use Icinga\Application\Icinga;
use Icinga\Web\View;
/**
* Base class for toc and section renderer
*/
abstract class DocRenderer extends RecursiveIteratorIterator
{
/**
* URL to images
*
* @var string
*/
protected $imageUrl;
/**
* URL to replace links with
*
* @var string
*/
protected $url;
/**
* Additional URL parameters
*
* @var array
*/
protected $urlParams = array();
/**
* View
*
* @var View|null
*/
protected $view;
/**
* Get the URL to images
*
* @return string
*/
public function getImageUrl()
{
return $this->imageUrl;
}
/**
* Set the URL to images
*
* @param string $imageUrl
*
* @return $this
*/
public function setImageUrl($imageUrl)
{
$this->imageUrl = (string) $imageUrl;
return $this;
}
/**
* Get the URL to replace links with
*
* @return string
*/
public function getUrl()
{
return $this->url;
}
/**
* Set the URL to replace links with
*
* @param string $url
*
* @return $this
*/
public function setUrl($url)
{
$this->url = (string) $url;
return $this;
}
/**
* Get additional URL parameters
*
* @return array
*/
public function getUrlParams()
{
return $this->urlParams;
}
/**
* Set additional URL parameters
*
* @param array $urlParams
*
* @return $this
*/
public function setUrlParams(array $urlParams)
{
$this->urlParams = array_map(array($this, 'encodeUrlParam'), $urlParams);
return $this;
}
/**
* Get the view
*
* @return View
*/
public function getView()
{
if ($this->view === null) {
$this->view = Icinga::app()->getViewRenderer()->view;
}
return $this->view;
}
/**
* Set the view
*
* @param View $view
*
* @return $this
*/
public function setView(View $view)
{
$this->view = $view;
return $this;
}
/**
* Encode an anchor identifier
*
* @param string $anchor
*
* @return string
*/
public static function encodeAnchor($anchor)
{
return rawurlencode($anchor);
}
/**
* Decode an anchor identifier
*
* @param string $anchor
*
* @return string
*/
public static function decodeAnchor($anchor)
{
return rawurldecode($anchor);
}
/**
* Encode a URL parameter
*
* @param string $param
*
* @return string
*/
public static function encodeUrlParam($param)
{
return str_replace(array('%2F','%5C'), array('%252F','%255C'), rawurlencode($param));
}
/**
* Decode a URL parameter
*
* @param string $param
*
* @return string
*/
public static function decodeUrlParam($param)
{
return str_replace(array('%2F', '%5C'), array('/', '\\'), $param);
}
/**
* Render to HTML
*
* @return string
*/
abstract public function render();
/**
* Render to HTML
*
* @return string
* @see \Icinga\Module\Doc\Renderer::render() For the render method.
*/
public function __toString()
{
try {
return $this->render();
} catch (Exception $e) {
return $e->getMessage() . ': ' . IcingaException::getConfidentialTraceAsString($e);
}
}
}
|
