@@ -22,9 +22,9 @@ discard block |
||
22 | 22 | */ |
23 | 23 | class RequestHelper_Exception extends BaseException |
24 | 24 | { |
25 | - /** |
|
26 | - * @var RequestHelper_Response|NULL |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var RequestHelper_Response|NULL |
|
27 | + */ |
|
28 | 28 | protected $response = null; |
29 | 29 | |
30 | 30 | public function setResponse(RequestHelper_Response $response) |
@@ -32,11 +32,11 @@ discard block |
||
32 | 32 | $this->response = $response; |
33 | 33 | } |
34 | 34 | |
35 | - /** |
|
36 | - * Retrieves the related response instance, if available. |
|
37 | - * |
|
38 | - * @return RequestHelper_Response|NULL |
|
39 | - */ |
|
35 | + /** |
|
36 | + * Retrieves the related response instance, if available. |
|
37 | + * |
|
38 | + * @return RequestHelper_Response|NULL |
|
39 | + */ |
|
40 | 40 | public function getResponse() : ?RequestHelper_Response |
41 | 41 | { |
42 | 42 | return $this->response; |
@@ -32,23 +32,23 @@ |
||
32 | 32 | $this->info = $info; |
33 | 33 | } |
34 | 34 | |
35 | - /** |
|
36 | - * Enables the authentication information in the URL, |
|
37 | - * if a username and password are present. |
|
38 | - * |
|
39 | - * @param bool $enable Whether to turn it on or off. |
|
40 | - * @return URLInfo_Normalizer |
|
41 | - */ |
|
35 | + /** |
|
36 | + * Enables the authentication information in the URL, |
|
37 | + * if a username and password are present. |
|
38 | + * |
|
39 | + * @param bool $enable Whether to turn it on or off. |
|
40 | + * @return URLInfo_Normalizer |
|
41 | + */ |
|
42 | 42 | public function enableAuth(bool $enable=true) : URLInfo_Normalizer |
43 | 43 | { |
44 | 44 | $this->auth = $enable; |
45 | 45 | return $this; |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Retrieves the normalized URL. |
|
50 | - * @return string |
|
51 | - */ |
|
48 | + /** |
|
49 | + * Retrieves the normalized URL. |
|
50 | + * @return string |
|
51 | + */ |
|
52 | 52 | public function normalize() : string |
53 | 53 | { |
54 | 54 | $method = 'normalize_'.$this->info->getType(); |
@@ -39,7 +39,7 @@ discard block |
||
39 | 39 | * @param bool $enable Whether to turn it on or off. |
40 | 40 | * @return URLInfo_Normalizer |
41 | 41 | */ |
42 | - public function enableAuth(bool $enable=true) : URLInfo_Normalizer |
|
42 | + public function enableAuth(bool $enable = true) : URLInfo_Normalizer |
|
43 | 43 | { |
44 | 44 | $this->auth = $enable; |
45 | 45 | return $this; |
@@ -86,48 +86,48 @@ discard block |
||
86 | 86 | |
87 | 87 | protected function renderAuth(string $normalized) : string |
88 | 88 | { |
89 | - if(!$this->info->hasUsername() || !$this->auth) { |
|
89 | + if (!$this->info->hasUsername() || !$this->auth) { |
|
90 | 90 | return $normalized; |
91 | 91 | } |
92 | 92 | |
93 | - return $normalized . urlencode($this->info->getUsername()).':'.urlencode($this->info->getPassword()).'@'; |
|
93 | + return $normalized.urlencode($this->info->getUsername()).':'.urlencode($this->info->getPassword()).'@'; |
|
94 | 94 | } |
95 | 95 | |
96 | 96 | protected function renderPort(string $normalized) : string |
97 | 97 | { |
98 | - if(!$this->info->hasPort()) { |
|
98 | + if (!$this->info->hasPort()) { |
|
99 | 99 | return $normalized; |
100 | 100 | } |
101 | 101 | |
102 | - return $normalized . ':'.$this->info->getPort(); |
|
102 | + return $normalized.':'.$this->info->getPort(); |
|
103 | 103 | } |
104 | 104 | |
105 | 105 | protected function renderPath(string $normalized) : string |
106 | 106 | { |
107 | - if(!$this->info->hasPath()) { |
|
107 | + if (!$this->info->hasPath()) { |
|
108 | 108 | return $normalized; |
109 | 109 | } |
110 | 110 | |
111 | - return $normalized . $this->info->getPath(); |
|
111 | + return $normalized.$this->info->getPath(); |
|
112 | 112 | } |
113 | 113 | |
114 | 114 | protected function renderParams(string $normalized) : string |
115 | 115 | { |
116 | 116 | $params = $this->info->getParams(); |
117 | 117 | |
118 | - if(empty($params)) { |
|
118 | + if (empty($params)) { |
|
119 | 119 | return $normalized; |
120 | 120 | } |
121 | 121 | |
122 | - return $normalized . '?'.http_build_query($params, '', '&', PHP_QUERY_RFC3986); |
|
122 | + return $normalized.'?'.http_build_query($params, '', '&', PHP_QUERY_RFC3986); |
|
123 | 123 | } |
124 | 124 | |
125 | 125 | protected function renderFragment(string $normalized) : string |
126 | 126 | { |
127 | - if(!$this->info->hasFragment()) { |
|
127 | + if (!$this->info->hasFragment()) { |
|
128 | 128 | return $normalized; |
129 | 129 | } |
130 | 130 | |
131 | - return $normalized . '#'.$this->info->getFragment(); |
|
131 | + return $normalized.'#'.$this->info->getFragment(); |
|
132 | 132 | } |
133 | 133 | } |
@@ -216,8 +216,7 @@ |
||
216 | 216 | curl_errno($ch), |
217 | 217 | curl_error($ch) |
218 | 218 | ); |
219 | - } |
|
220 | - else |
|
219 | + } else |
|
221 | 220 | { |
222 | 221 | $this->response->setBody((string)$output); |
223 | 222 | } |
@@ -39,66 +39,66 @@ discard block |
||
39 | 39 | |
40 | 40 | const ERROR_CANNOT_OPEN_LOGFILE = 17904; |
41 | 41 | |
42 | - /** |
|
43 | - * @var string |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var string |
|
44 | + */ |
|
45 | 45 | protected $eol = "\r\n"; |
46 | 46 | |
47 | - /** |
|
48 | - * @var string |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var string |
|
49 | + */ |
|
50 | 50 | protected $mimeBoundary; |
51 | 51 | |
52 | - /** |
|
53 | - * @var string |
|
54 | - */ |
|
52 | + /** |
|
53 | + * @var string |
|
54 | + */ |
|
55 | 55 | protected $data = ''; |
56 | 56 | |
57 | - /** |
|
58 | - * @var string |
|
59 | - */ |
|
57 | + /** |
|
58 | + * @var string |
|
59 | + */ |
|
60 | 60 | protected $destination; |
61 | 61 | |
62 | - /** |
|
63 | - * @var array |
|
64 | - */ |
|
62 | + /** |
|
63 | + * @var array |
|
64 | + */ |
|
65 | 65 | protected $headers = array(); |
66 | 66 | |
67 | - /** |
|
68 | - * Whether to verify SSL certificates. |
|
69 | - * @var bool |
|
70 | - */ |
|
67 | + /** |
|
68 | + * Whether to verify SSL certificates. |
|
69 | + * @var bool |
|
70 | + */ |
|
71 | 71 | protected $verifySSL = true; |
72 | 72 | |
73 | - /** |
|
74 | - * @var RequestHelper_Boundaries |
|
75 | - */ |
|
73 | + /** |
|
74 | + * @var RequestHelper_Boundaries |
|
75 | + */ |
|
76 | 76 | protected $boundaries; |
77 | 77 | |
78 | - /** |
|
79 | - * @var RequestHelper_Response|NULL |
|
80 | - */ |
|
78 | + /** |
|
79 | + * @var RequestHelper_Response|NULL |
|
80 | + */ |
|
81 | 81 | protected $response; |
82 | 82 | |
83 | - /** |
|
84 | - * @var integer |
|
85 | - */ |
|
83 | + /** |
|
84 | + * @var integer |
|
85 | + */ |
|
86 | 86 | protected $timeout = 30; |
87 | 87 | |
88 | - /** |
|
89 | - * @var string |
|
90 | - */ |
|
88 | + /** |
|
89 | + * @var string |
|
90 | + */ |
|
91 | 91 | protected $logfile = ''; |
92 | 92 | |
93 | - /** |
|
94 | - * @var resource|NULL |
|
95 | - */ |
|
93 | + /** |
|
94 | + * @var resource|NULL |
|
95 | + */ |
|
96 | 96 | protected $logfilePointer = null; |
97 | 97 | |
98 | - /** |
|
99 | - * Creates a new request helper to send POST data to the specified destination URL. |
|
100 | - * @param string $destinationURL |
|
101 | - */ |
|
98 | + /** |
|
99 | + * Creates a new request helper to send POST data to the specified destination URL. |
|
100 | + * @param string $destinationURL |
|
101 | + */ |
|
102 | 102 | public function __construct(string $destinationURL) |
103 | 103 | { |
104 | 104 | $this->destination = $destinationURL; |
@@ -130,13 +130,13 @@ discard block |
||
130 | 130 | return $this; |
131 | 131 | } |
132 | 132 | |
133 | - /** |
|
134 | - * Enables verbose logging of the CURL request, which |
|
135 | - * is then redirected to the target file. |
|
136 | - * |
|
137 | - * @param string $targetFile |
|
138 | - * @return RequestHelper |
|
139 | - */ |
|
133 | + /** |
|
134 | + * Enables verbose logging of the CURL request, which |
|
135 | + * is then redirected to the target file. |
|
136 | + * |
|
137 | + * @param string $targetFile |
|
138 | + * @return RequestHelper |
|
139 | + */ |
|
140 | 140 | public function enableLogging(string $targetFile) : RequestHelper |
141 | 141 | { |
142 | 142 | $this->logfile = $targetFile; |
@@ -144,15 +144,15 @@ discard block |
||
144 | 144 | return $this; |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Adds a file to be sent with the request. |
|
149 | - * |
|
150 | - * @param string $varName The variable name to send the file in |
|
151 | - * @param string $fileName The name of the file as it should be received at the destination |
|
152 | - * @param string $content The raw content of the file |
|
153 | - * @param string $contentType The content type, use the constants to specify this |
|
154 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
155 | - */ |
|
147 | + /** |
|
148 | + * Adds a file to be sent with the request. |
|
149 | + * |
|
150 | + * @param string $varName The variable name to send the file in |
|
151 | + * @param string $fileName The name of the file as it should be received at the destination |
|
152 | + * @param string $content The raw content of the file |
|
153 | + * @param string $contentType The content type, use the constants to specify this |
|
154 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
155 | + */ |
|
156 | 156 | public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper |
157 | 157 | { |
158 | 158 | $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding); |
@@ -160,13 +160,13 @@ discard block |
||
160 | 160 | return $this; |
161 | 161 | } |
162 | 162 | |
163 | - /** |
|
164 | - * Adds arbitrary content. |
|
165 | - * |
|
166 | - * @param string $varName The variable name to send the content in. |
|
167 | - * @param string $content |
|
168 | - * @param string $contentType |
|
169 | - */ |
|
163 | + /** |
|
164 | + * Adds arbitrary content. |
|
165 | + * |
|
166 | + * @param string $varName The variable name to send the content in. |
|
167 | + * @param string $content |
|
168 | + * @param string $contentType |
|
169 | + */ |
|
170 | 170 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper |
171 | 171 | { |
172 | 172 | $this->boundaries->addContent($varName, $content, $contentType); |
@@ -188,13 +188,13 @@ discard block |
||
188 | 188 | return $this; |
189 | 189 | } |
190 | 190 | |
191 | - /** |
|
192 | - * Sets an HTTP header to include in the request. |
|
193 | - * |
|
194 | - * @param string $name |
|
195 | - * @param string $value |
|
196 | - * @return RequestHelper |
|
197 | - */ |
|
191 | + /** |
|
192 | + * Sets an HTTP header to include in the request. |
|
193 | + * |
|
194 | + * @param string $name |
|
195 | + * @param string $value |
|
196 | + * @return RequestHelper |
|
197 | + */ |
|
198 | 198 | public function setHeader(string $name, string $value) : RequestHelper |
199 | 199 | { |
200 | 200 | $this->headers[$name] = $value; |
@@ -202,36 +202,36 @@ discard block |
||
202 | 202 | return $this; |
203 | 203 | } |
204 | 204 | |
205 | - /** |
|
206 | - * Disables SSL certificate checking. |
|
207 | - * |
|
208 | - * @return RequestHelper |
|
209 | - */ |
|
205 | + /** |
|
206 | + * Disables SSL certificate checking. |
|
207 | + * |
|
208 | + * @return RequestHelper |
|
209 | + */ |
|
210 | 210 | public function disableSSLChecks() : RequestHelper |
211 | 211 | { |
212 | 212 | $this->verifySSL = false; |
213 | 213 | return $this; |
214 | 214 | } |
215 | 215 | |
216 | - /** |
|
217 | - * @var integer |
|
218 | - */ |
|
216 | + /** |
|
217 | + * @var integer |
|
218 | + */ |
|
219 | 219 | protected $contentLength = 0; |
220 | 220 | |
221 | - /** |
|
222 | - * Sends the POST request to the destination, and returns |
|
223 | - * the response text. |
|
224 | - * |
|
225 | - * The response object is stored internally, so after calling |
|
226 | - * this method it may be retrieved at any moment using the |
|
227 | - * {@link getResponse()} method. |
|
228 | - * |
|
229 | - * @return string |
|
230 | - * @see RequestHelper::getResponse() |
|
231 | - * @throws RequestHelper_Exception |
|
232 | - * |
|
233 | - * @see RequestHelper::ERROR_REQUEST_FAILED |
|
234 | - */ |
|
221 | + /** |
|
222 | + * Sends the POST request to the destination, and returns |
|
223 | + * the response text. |
|
224 | + * |
|
225 | + * The response object is stored internally, so after calling |
|
226 | + * this method it may be retrieved at any moment using the |
|
227 | + * {@link getResponse()} method. |
|
228 | + * |
|
229 | + * @return string |
|
230 | + * @see RequestHelper::getResponse() |
|
231 | + * @throws RequestHelper_Exception |
|
232 | + * |
|
233 | + * @see RequestHelper::ERROR_REQUEST_FAILED |
|
234 | + */ |
|
235 | 235 | public function send() : string |
236 | 236 | { |
237 | 237 | $info = parseURL($this->destination); |
@@ -274,14 +274,14 @@ discard block |
||
274 | 274 | return $this->data; |
275 | 275 | } |
276 | 276 | |
277 | - /** |
|
278 | - * Creates a new CURL resource configured according to the |
|
279 | - * request's settings. |
|
280 | - * |
|
281 | - * @param URLInfo $url |
|
282 | - * @throws RequestHelper_Exception |
|
283 | - * @return resource |
|
284 | - */ |
|
277 | + /** |
|
278 | + * Creates a new CURL resource configured according to the |
|
279 | + * request's settings. |
|
280 | + * |
|
281 | + * @param URLInfo $url |
|
282 | + * @throws RequestHelper_Exception |
|
283 | + * @return resource |
|
284 | + */ |
|
285 | 285 | protected function createCURL(URLInfo $url) |
286 | 286 | { |
287 | 287 | $ch = curl_init(); |
@@ -329,10 +329,10 @@ discard block |
||
329 | 329 | return $ch; |
330 | 330 | } |
331 | 331 | |
332 | - /** |
|
333 | - * @param resource $ch |
|
334 | - * @return bool Whether logging is enabled. |
|
335 | - */ |
|
332 | + /** |
|
333 | + * @param resource $ch |
|
334 | + * @return bool Whether logging is enabled. |
|
335 | + */ |
|
336 | 336 | protected function configureLogging($ch) : bool |
337 | 337 | { |
338 | 338 | if(empty($this->logfile)) |
@@ -359,13 +359,13 @@ discard block |
||
359 | 359 | return true; |
360 | 360 | } |
361 | 361 | |
362 | - /** |
|
363 | - * Compiles the associative headers array into |
|
364 | - * the format understood by CURL, namely an indexed |
|
365 | - * array with one header string per entry. |
|
366 | - * |
|
367 | - * @return array |
|
368 | - */ |
|
362 | + /** |
|
363 | + * Compiles the associative headers array into |
|
364 | + * the format understood by CURL, namely an indexed |
|
365 | + * array with one header string per entry. |
|
366 | + * |
|
367 | + * @return array |
|
368 | + */ |
|
369 | 369 | protected function renderHeaders() : array |
370 | 370 | { |
371 | 371 | $result = array(); |
@@ -379,12 +379,12 @@ discard block |
||
379 | 379 | return $result; |
380 | 380 | } |
381 | 381 | |
382 | - /** |
|
383 | - * Retrieves the raw response header, in the form of an indexed |
|
384 | - * array containing all response header lines. |
|
385 | - * |
|
386 | - * @return array |
|
387 | - */ |
|
382 | + /** |
|
383 | + * Retrieves the raw response header, in the form of an indexed |
|
384 | + * array containing all response header lines. |
|
385 | + * |
|
386 | + * @return array |
|
387 | + */ |
|
388 | 388 | public function getResponseHeader() : array |
389 | 389 | { |
390 | 390 | $response = $this->getResponse(); |
@@ -240,7 +240,7 @@ discard block |
||
240 | 240 | |
241 | 241 | $output = curl_exec($ch); |
242 | 242 | |
243 | - if(isset($this->logfilePointer)) |
|
243 | + if (isset($this->logfilePointer)) |
|
244 | 244 | { |
245 | 245 | fclose($this->logfilePointer); |
246 | 246 | } |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | // CURL will complain about an empty response when the |
253 | 253 | // server sends a 100-continue code. That should not be |
254 | 254 | // regarded as an error. |
255 | - if($output === false && $this->response->getCode() !== 100) |
|
255 | + if ($output === false && $this->response->getCode() !== 100) |
|
256 | 256 | { |
257 | 257 | $this->response->setError( |
258 | 258 | curl_errno($ch), |
@@ -286,7 +286,7 @@ discard block |
||
286 | 286 | { |
287 | 287 | $ch = curl_init(); |
288 | 288 | |
289 | - if(!is_resource($ch)) |
|
289 | + if (!is_resource($ch)) |
|
290 | 290 | { |
291 | 291 | throw new RequestHelper_Exception( |
292 | 292 | 'Could not initialize a new cURL instance.', |
@@ -296,7 +296,7 @@ discard block |
||
296 | 296 | } |
297 | 297 | |
298 | 298 | $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength()); |
299 | - $this->setHeader('Content-Type', 'multipart/form-data; boundary=' . $this->mimeBoundary); |
|
299 | + $this->setHeader('Content-Type', 'multipart/form-data; boundary='.$this->mimeBoundary); |
|
300 | 300 | |
301 | 301 | curl_setopt($ch, CURLOPT_POST, true); |
302 | 302 | curl_setopt($ch, CURLOPT_URL, $url->getNormalizedWithoutAuth()); |
@@ -309,18 +309,18 @@ discard block |
||
309 | 309 | |
310 | 310 | $loggingEnabled = $this->configureLogging($ch); |
311 | 311 | |
312 | - if(!$loggingEnabled) |
|
312 | + if (!$loggingEnabled) |
|
313 | 313 | { |
314 | 314 | curl_setopt($ch, CURLINFO_HEADER_OUT, true); |
315 | 315 | } |
316 | 316 | |
317 | - if($this->verifySSL) |
|
317 | + if ($this->verifySSL) |
|
318 | 318 | { |
319 | 319 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
320 | 320 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
321 | 321 | } |
322 | 322 | |
323 | - if($url->hasUsername()) |
|
323 | + if ($url->hasUsername()) |
|
324 | 324 | { |
325 | 325 | curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername()); |
326 | 326 | curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword()); |
@@ -335,14 +335,14 @@ discard block |
||
335 | 335 | */ |
336 | 336 | protected function configureLogging($ch) : bool |
337 | 337 | { |
338 | - if(empty($this->logfile)) |
|
338 | + if (empty($this->logfile)) |
|
339 | 339 | { |
340 | 340 | return false; |
341 | 341 | } |
342 | 342 | |
343 | 343 | $res = fopen($this->logfile, 'w+'); |
344 | 344 | |
345 | - if($res === false) |
|
345 | + if ($res === false) |
|
346 | 346 | { |
347 | 347 | throw new RequestHelper_Exception( |
348 | 348 | 'Cannot open logfile for writing.', |
@@ -372,7 +372,7 @@ discard block |
||
372 | 372 | |
373 | 373 | $this->setHeader('Expect', ''); |
374 | 374 | |
375 | - foreach($this->headers as $name => $value) { |
|
375 | + foreach ($this->headers as $name => $value) { |
|
376 | 376 | $result[] = $name.': '.$value; |
377 | 377 | } |
378 | 378 | |
@@ -389,7 +389,7 @@ discard block |
||
389 | 389 | { |
390 | 390 | $response = $this->getResponse(); |
391 | 391 | |
392 | - if($response !== null) { |
|
392 | + if ($response !== null) { |
|
393 | 393 | return $response->getHeaders(); |
394 | 394 | } |
395 | 395 |
@@ -29,7 +29,7 @@ discard block |
||
29 | 29 | |
30 | 30 | public function addClass(string $name) |
31 | 31 | { |
32 | - if(!in_array($name, $this->classes)) { |
|
32 | + if (!in_array($name, $this->classes)) { |
|
33 | 33 | $this->classes[] = $name; |
34 | 34 | } |
35 | 35 | |
@@ -38,7 +38,7 @@ discard block |
||
38 | 38 | |
39 | 39 | public function addClasses(array $names) |
40 | 40 | { |
41 | - foreach($names as $name) { |
|
41 | + foreach ($names as $name) { |
|
42 | 42 | $this->addClass($name); |
43 | 43 | } |
44 | 44 | |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | { |
55 | 55 | $idx = array_search($name, $this->classes); |
56 | 56 | |
57 | - if($idx !== false) { |
|
57 | + if ($idx !== false) { |
|
58 | 58 | unset($this->classes[$idx]); |
59 | 59 | sort($this->classes); |
60 | 60 | } |
@@ -87,37 +87,37 @@ |
||
87 | 87 | */ |
88 | 88 | interface Interface_Classable |
89 | 89 | { |
90 | - /** |
|
91 | - * @param string $name |
|
92 | - * @return $this |
|
93 | - */ |
|
90 | + /** |
|
91 | + * @param string $name |
|
92 | + * @return $this |
|
93 | + */ |
|
94 | 94 | public function addClass(string $name); |
95 | 95 | |
96 | - /** |
|
97 | - * @param array $names |
|
98 | - * @return $this |
|
99 | - */ |
|
96 | + /** |
|
97 | + * @param array $names |
|
98 | + * @return $this |
|
99 | + */ |
|
100 | 100 | public function addClasses(array $names); |
101 | 101 | |
102 | - /** |
|
103 | - * @param string $name |
|
104 | - * @return bool |
|
105 | - */ |
|
102 | + /** |
|
103 | + * @param string $name |
|
104 | + * @return bool |
|
105 | + */ |
|
106 | 106 | public function hasClass(string $name) : bool; |
107 | 107 | |
108 | - /** |
|
109 | - * @param string $name |
|
110 | - * @return $this |
|
111 | - */ |
|
108 | + /** |
|
109 | + * @param string $name |
|
110 | + * @return $this |
|
111 | + */ |
|
112 | 112 | public function removeClass(string $name); |
113 | 113 | |
114 | - /** |
|
115 | - * @return array |
|
116 | - */ |
|
114 | + /** |
|
115 | + * @return array |
|
116 | + */ |
|
117 | 117 | public function getClasses() : array; |
118 | 118 | |
119 | - /** |
|
120 | - * @return string |
|
121 | - */ |
|
119 | + /** |
|
120 | + * @return string |
|
121 | + */ |
|
122 | 122 | public function classesToString() : string; |
123 | 123 | } |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | */ |
45 | 45 | protected static function init() : void |
46 | 46 | { |
47 | - if(!empty(self::$sizes)) { |
|
47 | + if (!empty(self::$sizes)) { |
|
48 | 48 | return; |
49 | 49 | } |
50 | 50 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | |
63 | 63 | self::addSize('b', 1, 1, t('B'), t('Byte'), t('Bytes')); |
64 | 64 | |
65 | - if(class_exists('AppLocalize\Localization')) |
|
65 | + if (class_exists('AppLocalize\Localization')) |
|
66 | 66 | { |
67 | 67 | \AppLocalize\Localization::onLocaleChanged(array(self::class, 'handle_localeChanged')); |
68 | 68 | } |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | |
132 | 132 | $name = strtolower($name); |
133 | 133 | |
134 | - if(isset(self::$sizes[$name])) { |
|
134 | + if (isset(self::$sizes[$name])) { |
|
135 | 135 | return self::$sizes[$name]; |
136 | 136 | } |
137 | 137 | |
@@ -173,9 +173,9 @@ discard block |
||
173 | 173 | |
174 | 174 | $result = array(); |
175 | 175 | |
176 | - foreach(self::$sizes as $size) |
|
176 | + foreach (self::$sizes as $size) |
|
177 | 177 | { |
178 | - if($size->getBase() === $base) { |
|
178 | + if ($size->getBase() === $base) { |
|
179 | 179 | $result[] = $size; |
180 | 180 | } |
181 | 181 | } |
@@ -31,17 +31,17 @@ discard block |
||
31 | 31 | |
32 | 32 | const BASE_2 = 1024; |
33 | 33 | |
34 | - /** |
|
35 | - * @var ConvertHelper_StorageSizeEnum_Size[] |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var ConvertHelper_StorageSizeEnum_Size[] |
|
36 | + */ |
|
37 | 37 | protected static $sizes = array(); |
38 | 38 | |
39 | - /** |
|
40 | - * Initializes the supported unit notations, and |
|
41 | - * how they are supposed to be calculated. |
|
42 | - * |
|
43 | - * @see ConvertHelper_SizeNotation::parseSize() |
|
44 | - */ |
|
39 | + /** |
|
40 | + * Initializes the supported unit notations, and |
|
41 | + * how they are supposed to be calculated. |
|
42 | + * |
|
43 | + * @see ConvertHelper_SizeNotation::parseSize() |
|
44 | + */ |
|
45 | 45 | protected static function init() : void |
46 | 46 | { |
47 | 47 | if(!empty(self::$sizes)) { |
@@ -68,28 +68,28 @@ discard block |
||
68 | 68 | } |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Called whenever the application locale is changed, |
|
73 | - * to reset the size definitions so the labels get |
|
74 | - * translated to the new locale. |
|
75 | - */ |
|
71 | + /** |
|
72 | + * Called whenever the application locale is changed, |
|
73 | + * to reset the size definitions so the labels get |
|
74 | + * translated to the new locale. |
|
75 | + */ |
|
76 | 76 | public static function handle_localeChanged() : void |
77 | 77 | { |
78 | 78 | self::$sizes = array(); |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Adds a storage size to the internal collection. |
|
83 | - * |
|
84 | - * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
85 | - * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
86 | - * @param int $exponent The multiplier of the base to get the byte value |
|
87 | - * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
88 | - * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
89 | - * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
90 | - * |
|
91 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
92 | - */ |
|
81 | + /** |
|
82 | + * Adds a storage size to the internal collection. |
|
83 | + * |
|
84 | + * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
85 | + * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
86 | + * @param int $exponent The multiplier of the base to get the byte value |
|
87 | + * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
88 | + * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
89 | + * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
90 | + * |
|
91 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
92 | + */ |
|
93 | 93 | protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void |
94 | 94 | { |
95 | 95 | self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size( |
@@ -102,11 +102,11 @@ discard block |
||
102 | 102 | ); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Retrieves all known sizes. |
|
107 | - * |
|
108 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
109 | - */ |
|
105 | + /** |
|
106 | + * Retrieves all known sizes. |
|
107 | + * |
|
108 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
109 | + */ |
|
110 | 110 | public static function getSizes() : array |
111 | 111 | { |
112 | 112 | self::init(); |
@@ -114,15 +114,15 @@ discard block |
||
114 | 114 | return self::$sizes; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves a size definition instance by its name. |
|
119 | - * |
|
120 | - * @param string $name Case insensitive. For example "kb", "MiB"... |
|
121 | - * @throws ConvertHelper_Exception |
|
122 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
123 | - * |
|
124 | - * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
125 | - */ |
|
117 | + /** |
|
118 | + * Retrieves a size definition instance by its name. |
|
119 | + * |
|
120 | + * @param string $name Case insensitive. For example "kb", "MiB"... |
|
121 | + * @throws ConvertHelper_Exception |
|
122 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
123 | + * |
|
124 | + * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
125 | + */ |
|
126 | 126 | public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size |
127 | 127 | { |
128 | 128 | self::init(); |
@@ -144,10 +144,10 @@ discard block |
||
144 | 144 | ); |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
149 | - * @return array |
|
150 | - */ |
|
147 | + /** |
|
148 | + * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
149 | + * @return array |
|
150 | + */ |
|
151 | 151 | public static function getSizeNames() : array |
152 | 152 | { |
153 | 153 | self::init(); |
@@ -155,16 +155,16 @@ discard block |
||
155 | 155 | return array_keys(self::$sizes); |
156 | 156 | } |
157 | 157 | |
158 | - /** |
|
159 | - * Retrieves all available storage sizes for the specified |
|
160 | - * base value. |
|
161 | - * |
|
162 | - * @param int $base |
|
163 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
164 | - * |
|
165 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
166 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
167 | - */ |
|
158 | + /** |
|
159 | + * Retrieves all available storage sizes for the specified |
|
160 | + * base value. |
|
161 | + * |
|
162 | + * @param int $base |
|
163 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
164 | + * |
|
165 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
166 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
167 | + */ |
|
168 | 168 | public static function getSizesByBase(int $base) : array |
169 | 169 | { |
170 | 170 | self::init(); |
@@ -20,43 +20,43 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class ConvertHelper_TabsNormalizer |
22 | 22 | { |
23 | - /** |
|
24 | - * @var integer |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var integer |
|
25 | + */ |
|
26 | 26 | protected $max = 0; |
27 | 27 | |
28 | - /** |
|
29 | - * @var integer |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var integer |
|
30 | + */ |
|
31 | 31 | protected $min = PHP_INT_MAX; |
32 | 32 | |
33 | - /** |
|
34 | - * @var bool |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var bool |
|
35 | + */ |
|
36 | 36 | protected $tabs2spaces = false; |
37 | 37 | |
38 | - /** |
|
39 | - * @var array |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var array |
|
40 | + */ |
|
41 | 41 | protected $lines = array(); |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $eol = ''; |
47 | 47 | |
48 | - /** |
|
49 | - * @var integer |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var integer |
|
50 | + */ |
|
51 | 51 | protected $tabSize = 4; |
52 | 52 | |
53 | - /** |
|
54 | - * Whether to enable or disable the conversion |
|
55 | - * of tabs to spaces. |
|
56 | - * |
|
57 | - * @param bool $enable |
|
58 | - * @return ConvertHelper_TabsNormalizer |
|
59 | - */ |
|
53 | + /** |
|
54 | + * Whether to enable or disable the conversion |
|
55 | + * of tabs to spaces. |
|
56 | + * |
|
57 | + * @param bool $enable |
|
58 | + * @return ConvertHelper_TabsNormalizer |
|
59 | + */ |
|
60 | 60 | public function convertTabsToSpaces(bool $enable=true) : ConvertHelper_TabsNormalizer |
61 | 61 | { |
62 | 62 | $this->tabs2spaces = $enable; |
@@ -64,13 +64,13 @@ discard block |
||
64 | 64 | return $this; |
65 | 65 | } |
66 | 66 | |
67 | - /** |
|
68 | - * Sets the size of a tab, in spaces. Used to convert tabs |
|
69 | - * from spaces and the other way around. Defaults to 4. |
|
70 | - * |
|
71 | - * @param int $amountSpaces |
|
72 | - * @return ConvertHelper_TabsNormalizer |
|
73 | - */ |
|
67 | + /** |
|
68 | + * Sets the size of a tab, in spaces. Used to convert tabs |
|
69 | + * from spaces and the other way around. Defaults to 4. |
|
70 | + * |
|
71 | + * @param int $amountSpaces |
|
72 | + * @return ConvertHelper_TabsNormalizer |
|
73 | + */ |
|
74 | 74 | public function setTabSize(int $amountSpaces) : ConvertHelper_TabsNormalizer |
75 | 75 | { |
76 | 76 | $this->tabSize = $amountSpaces; |
@@ -78,15 +78,15 @@ discard block |
||
78 | 78 | return $this; |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Normalizes tabs in the specified string by indenting everything |
|
83 | - * back to the minimum tab distance. With the second parameter, |
|
84 | - * tabs can optionally be converted to spaces as well (recommended |
|
85 | - * for HTML output). |
|
86 | - * |
|
87 | - * @param string $string |
|
88 | - * @return string |
|
89 | - */ |
|
81 | + /** |
|
82 | + * Normalizes tabs in the specified string by indenting everything |
|
83 | + * back to the minimum tab distance. With the second parameter, |
|
84 | + * tabs can optionally be converted to spaces as well (recommended |
|
85 | + * for HTML output). |
|
86 | + * |
|
87 | + * @param string $string |
|
88 | + * @return string |
|
89 | + */ |
|
90 | 90 | public function normalize(string $string) : string |
91 | 91 | { |
92 | 92 | $this->splitLines($string); |
@@ -143,10 +143,10 @@ discard block |
||
143 | 143 | return implode($this->eol, $converted); |
144 | 144 | } |
145 | 145 | |
146 | - /** |
|
147 | - * Finds out the minimum and maximum amount of |
|
148 | - * tabs in the string. |
|
149 | - */ |
|
146 | + /** |
|
147 | + * Finds out the minimum and maximum amount of |
|
148 | + * tabs in the string. |
|
149 | + */ |
|
150 | 150 | protected function countOccurrences() : void |
151 | 151 | { |
152 | 152 | foreach($this->lines as $line) |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | * @param bool $enable |
58 | 58 | * @return ConvertHelper_TabsNormalizer |
59 | 59 | */ |
60 | - public function convertTabsToSpaces(bool $enable=true) : ConvertHelper_TabsNormalizer |
|
60 | + public function convertTabsToSpaces(bool $enable = true) : ConvertHelper_TabsNormalizer |
|
61 | 61 | { |
62 | 62 | $this->tabs2spaces = $enable; |
63 | 63 | |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | |
95 | 95 | $result = $this->_normalize(); |
96 | 96 | |
97 | - if($this->tabs2spaces) |
|
97 | + if ($this->tabs2spaces) |
|
98 | 98 | { |
99 | 99 | $result = ConvertHelper::tabs2spaces($result, $this->tabSize); |
100 | 100 | } |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | { |
109 | 109 | $eol = ConvertHelper::detectEOLCharacter($string); |
110 | 110 | |
111 | - if($eol !== null) |
|
111 | + if ($eol !== null) |
|
112 | 112 | { |
113 | 113 | $this->eol = $eol->getCharacter(); |
114 | 114 | } |
@@ -126,15 +126,15 @@ discard block |
||
126 | 126 | { |
127 | 127 | $converted = array(); |
128 | 128 | |
129 | - foreach($this->lines as $line) |
|
129 | + foreach ($this->lines as $line) |
|
130 | 130 | { |
131 | 131 | $amount = substr_count($line, "\t") - $this->min; |
132 | 132 | |
133 | 133 | $line = trim($line, "\n\r\t"); |
134 | 134 | |
135 | - if($amount >= 1) |
|
135 | + if ($amount >= 1) |
|
136 | 136 | { |
137 | - $line = str_repeat("\t", $amount) . $line; |
|
137 | + $line = str_repeat("\t", $amount).$line; |
|
138 | 138 | } |
139 | 139 | |
140 | 140 | $converted[] = $line; |
@@ -149,23 +149,23 @@ discard block |
||
149 | 149 | */ |
150 | 150 | protected function countOccurrences() : void |
151 | 151 | { |
152 | - foreach($this->lines as $line) |
|
152 | + foreach ($this->lines as $line) |
|
153 | 153 | { |
154 | 154 | $amount = substr_count($line, "\t"); |
155 | 155 | |
156 | - if($amount > $this->max) |
|
156 | + if ($amount > $this->max) |
|
157 | 157 | { |
158 | 158 | $this->max = $amount; |
159 | 159 | continue; |
160 | 160 | } |
161 | 161 | |
162 | - if($amount > 0 && $amount < $this->min) |
|
162 | + if ($amount > 0 && $amount < $this->min) |
|
163 | 163 | { |
164 | 164 | $this->min = $amount; |
165 | 165 | } |
166 | 166 | } |
167 | 167 | |
168 | - if($this->min === PHP_INT_MAX) { |
|
168 | + if ($this->min === PHP_INT_MAX) { |
|
169 | 169 | $this->min = 0; |
170 | 170 | } |
171 | 171 | } |
@@ -69,9 +69,9 @@ discard block |
||
69 | 69 | ) |
70 | 70 | ); |
71 | 71 | |
72 | - /** |
|
73 | - * @var array |
|
74 | - */ |
|
72 | + /** |
|
73 | + * @var array |
|
74 | + */ |
|
75 | 75 | protected $selected = array(); |
76 | 76 | |
77 | 77 | public function convert(string $string) : string |
@@ -81,16 +81,16 @@ discard block |
||
81 | 81 | return str_replace(array_keys($chars), array_values($chars), $string); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Selects a character set to replace. Can be called |
|
86 | - * several times to add additional sets to the collection. |
|
87 | - * |
|
88 | - * @param string $type See the <code>CHAR_XXX</code> constants. |
|
89 | - * @return ConvertHelper_HiddenConverter |
|
90 | - * |
|
91 | - * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
92 | - * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
93 | - */ |
|
84 | + /** |
|
85 | + * Selects a character set to replace. Can be called |
|
86 | + * several times to add additional sets to the collection. |
|
87 | + * |
|
88 | + * @param string $type See the <code>CHAR_XXX</code> constants. |
|
89 | + * @return ConvertHelper_HiddenConverter |
|
90 | + * |
|
91 | + * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
92 | + * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
93 | + */ |
|
94 | 94 | public function selectCharacters(string $type) : ConvertHelper_HiddenConverter |
95 | 95 | { |
96 | 96 | if(!in_array($type, $this->selected)) { |
@@ -100,11 +100,11 @@ discard block |
||
100 | 100 | return $this; |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * Resolves the list of characters to make visible. |
|
105 | - * |
|
106 | - * @return array |
|
107 | - */ |
|
103 | + /** |
|
104 | + * Resolves the list of characters to make visible. |
|
105 | + * |
|
106 | + * @return array |
|
107 | + */ |
|
108 | 108 | protected function resolveSelection() : array |
109 | 109 | { |
110 | 110 | $selected = $this->selected; |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | */ |
94 | 94 | public function selectCharacters(string $type) : ConvertHelper_HiddenConverter |
95 | 95 | { |
96 | - if(!in_array($type, $this->selected)) { |
|
96 | + if (!in_array($type, $this->selected)) { |
|
97 | 97 | $this->selected[] = $type; |
98 | 98 | } |
99 | 99 | |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | { |
110 | 110 | $selected = $this->selected; |
111 | 111 | |
112 | - if(empty($this->selected)) |
|
112 | + if (empty($this->selected)) |
|
113 | 113 | { |
114 | 114 | $selected = array( |
115 | 115 | self::CHARS_WHITESPACE, |
@@ -119,9 +119,9 @@ discard block |
||
119 | 119 | |
120 | 120 | $result = array(); |
121 | 121 | |
122 | - foreach($selected as $type) |
|
122 | + foreach ($selected as $type) |
|
123 | 123 | { |
124 | - if(isset($this->characters[$type])) |
|
124 | + if (isset($this->characters[$type])) |
|
125 | 125 | { |
126 | 126 | $result = array_merge($result, $this->characters[$type]); |
127 | 127 | } |
@@ -126,9 +126,9 @@ discard block |
||
126 | 126 | * @param array $args |
127 | 127 | * @return Request_Param |
128 | 128 | */ |
129 | - public function setCallback($callback, array $args=array()) : Request_Param |
|
129 | + public function setCallback($callback, array $args = array()) : Request_Param |
|
130 | 130 | { |
131 | - if(!is_callable($callback)) { |
|
131 | + if (!is_callable($callback)) { |
|
132 | 132 | throw new Request_Exception( |
133 | 133 | 'Not a valid callback', |
134 | 134 | 'The specified callback is not a valid callable entity.', |
@@ -159,22 +159,22 @@ discard block |
||
159 | 159 | // first off, apply filtering |
160 | 160 | $value = $this->filter($value); |
161 | 161 | |
162 | - if($this->valueType === self::VALUE_TYPE_LIST) |
|
162 | + if ($this->valueType === self::VALUE_TYPE_LIST) |
|
163 | 163 | { |
164 | - if(!is_array($value)) |
|
164 | + if (!is_array($value)) |
|
165 | 165 | { |
166 | 166 | $value = explode(',', $value); |
167 | 167 | } |
168 | 168 | |
169 | 169 | $keep = array(); |
170 | 170 | |
171 | - foreach($value as $subval) |
|
171 | + foreach ($value as $subval) |
|
172 | 172 | { |
173 | 173 | $subval = $this->filter($subval); |
174 | 174 | |
175 | 175 | $subval = $this->applyValidations($subval, true); |
176 | 176 | |
177 | - if($subval !== null) { |
|
177 | + if ($subval !== null) { |
|
178 | 178 | $keep[] = $subval; |
179 | 179 | } |
180 | 180 | } |
@@ -195,11 +195,11 @@ discard block |
||
195 | 195 | * @param mixed $value |
196 | 196 | * @return mixed |
197 | 197 | */ |
198 | - protected function applyValidations($value, bool $subval=false) |
|
198 | + protected function applyValidations($value, bool $subval = false) |
|
199 | 199 | { |
200 | 200 | // go through all enqueued validations in turn, each time |
201 | 201 | // replacing the value with the adjusted, validated value. |
202 | - foreach($this->validations as $validateDef) |
|
202 | + foreach ($this->validations as $validateDef) |
|
203 | 203 | { |
204 | 204 | $value = $this->validateType($value, $validateDef['type'], $validateDef['params'], $subval); |
205 | 205 | } |
@@ -222,7 +222,7 @@ discard block |
||
222 | 222 | { |
223 | 223 | $class = '\AppUtils\Request_Param_Validator_'.ucfirst($type); |
224 | 224 | |
225 | - if(!class_exists($class)) |
|
225 | + if (!class_exists($class)) |
|
226 | 226 | { |
227 | 227 | throw new Request_Exception( |
228 | 228 | 'Unknown validation type.', |
@@ -376,7 +376,7 @@ discard block |
||
376 | 376 | { |
377 | 377 | $args = func_get_args(); // cannot be used as function parameter in some PHP versions |
378 | 378 | |
379 | - if(is_array($args[0])) |
|
379 | + if (is_array($args[0])) |
|
380 | 380 | { |
381 | 381 | $args = $args[0]; |
382 | 382 | } |
@@ -521,10 +521,10 @@ discard block |
||
521 | 521 | * @param mixed $default |
522 | 522 | * @return mixed |
523 | 523 | */ |
524 | - public function get($default=null) |
|
524 | + public function get($default = null) |
|
525 | 525 | { |
526 | 526 | $value = $this->request->getParam($this->paramName); |
527 | - if($value !== null && $value !== '') { |
|
527 | + if ($value !== null && $value !== '') { |
|
528 | 528 | return $value; |
529 | 529 | } |
530 | 530 | |
@@ -543,7 +543,7 @@ discard block |
||
543 | 543 | { |
544 | 544 | $total = count($this->filters); |
545 | 545 | for ($i = 0; $i < $total; $i++) { |
546 | - $method = 'applyFilter_' . $this->filters[$i]['type']; |
|
546 | + $method = 'applyFilter_'.$this->filters[$i]['type']; |
|
547 | 547 | $value = $this->$method($value, $this->filters[$i]['params']); |
548 | 548 | } |
549 | 549 | |
@@ -700,7 +700,7 @@ discard block |
||
700 | 700 | * @param bool $stripEmptyEntries Remove empty entries from the array? |
701 | 701 | * @return \AppUtils\Request_Param |
702 | 702 | */ |
703 | - public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
|
703 | + public function addCommaSeparatedFilter(bool $trimEntries = true, bool $stripEmptyEntries = true) : Request_Param |
|
704 | 704 | { |
705 | 705 | $this->setArray(); |
706 | 706 | |
@@ -713,7 +713,7 @@ discard block |
||
713 | 713 | ); |
714 | 714 | } |
715 | 715 | |
716 | - protected function addClassFilter(string $name, array $params=array()) : Request_Param |
|
716 | + protected function addClassFilter(string $name, array $params = array()) : Request_Param |
|
717 | 717 | { |
718 | 718 | return $this->addFilter( |
719 | 719 | self::FILTER_TYPE_CLASS, |
@@ -114,18 +114,18 @@ discard block |
||
114 | 114 | } |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Adds a callback as a validation method. The callback gets the |
|
119 | - * value to validate as first parameter, and any additional |
|
120 | - * parameters passed here get appended to that. |
|
121 | - * |
|
122 | - * The callback must return boolean true or false depending on |
|
123 | - * whether the value is valid. |
|
124 | - * |
|
125 | - * @param callable $callback |
|
126 | - * @param array $args |
|
127 | - * @return Request_Param |
|
128 | - */ |
|
117 | + /** |
|
118 | + * Adds a callback as a validation method. The callback gets the |
|
119 | + * value to validate as first parameter, and any additional |
|
120 | + * parameters passed here get appended to that. |
|
121 | + * |
|
122 | + * The callback must return boolean true or false depending on |
|
123 | + * whether the value is valid. |
|
124 | + * |
|
125 | + * @param callable $callback |
|
126 | + * @param array $args |
|
127 | + * @return Request_Param |
|
128 | + */ |
|
129 | 129 | public function setCallback($callback, array $args=array()) : Request_Param |
130 | 130 | { |
131 | 131 | if(!is_callable($callback)) { |
@@ -189,12 +189,12 @@ discard block |
||
189 | 189 | return $value; |
190 | 190 | } |
191 | 191 | |
192 | - /** |
|
193 | - * Runs the value through all validations that were added. |
|
194 | - * |
|
195 | - * @param mixed $value |
|
196 | - * @return mixed |
|
197 | - */ |
|
192 | + /** |
|
193 | + * Runs the value through all validations that were added. |
|
194 | + * |
|
195 | + * @param mixed $value |
|
196 | + * @return mixed |
|
197 | + */ |
|
198 | 198 | protected function applyValidations($value, bool $subval=false) |
199 | 199 | { |
200 | 200 | // go through all enqueued validations in turn, each time |
@@ -207,17 +207,17 @@ discard block |
||
207 | 207 | return $value; |
208 | 208 | } |
209 | 209 | |
210 | - /** |
|
211 | - * Validates the specified value using the validation type. Returns |
|
212 | - * the validated value. |
|
213 | - * |
|
214 | - * @param mixed $value |
|
215 | - * @param string $type |
|
216 | - * @param array $params |
|
217 | - * @param bool $subval Whether this is a subvalue in a list |
|
218 | - * @throws Request_Exception |
|
219 | - * @return mixed |
|
220 | - */ |
|
210 | + /** |
|
211 | + * Validates the specified value using the validation type. Returns |
|
212 | + * the validated value. |
|
213 | + * |
|
214 | + * @param mixed $value |
|
215 | + * @param string $type |
|
216 | + * @param array $params |
|
217 | + * @param bool $subval Whether this is a subvalue in a list |
|
218 | + * @throws Request_Exception |
|
219 | + * @return mixed |
|
220 | + */ |
|
221 | 221 | protected function validateType($value, string $type, array $params, bool $subval) |
222 | 222 | { |
223 | 223 | $class = '\AppUtils\Request_Param_Validator_'.ucfirst($type); |
@@ -286,13 +286,13 @@ discard block |
||
286 | 286 | |
287 | 287 | protected $valueType = self::VALUE_TYPE_STRING; |
288 | 288 | |
289 | - /** |
|
290 | - * Sets the variable to contain a comma-separated list of integer IDs. |
|
291 | - * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
292 | - * <code>145</code>. |
|
293 | - * |
|
294 | - * @return Request_Param |
|
295 | - */ |
|
289 | + /** |
|
290 | + * Sets the variable to contain a comma-separated list of integer IDs. |
|
291 | + * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
292 | + * <code>145</code>. |
|
293 | + * |
|
294 | + * @return Request_Param |
|
295 | + */ |
|
296 | 296 | public function setIDList() |
297 | 297 | { |
298 | 298 | $this->valueType = self::VALUE_TYPE_LIST; |
@@ -302,13 +302,13 @@ discard block |
||
302 | 302 | return $this; |
303 | 303 | } |
304 | 304 | |
305 | - /** |
|
306 | - * Sets the variable to be an alias, as defined by the |
|
307 | - * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
308 | - * |
|
309 | - * @return Request_Param |
|
310 | - * @see RegexHelper::REGEX_ALIAS |
|
311 | - */ |
|
305 | + /** |
|
306 | + * Sets the variable to be an alias, as defined by the |
|
307 | + * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
308 | + * |
|
309 | + * @return Request_Param |
|
310 | + * @see RegexHelper::REGEX_ALIAS |
|
311 | + */ |
|
312 | 312 | public function setAlias() |
313 | 313 | { |
314 | 314 | return $this->setRegex(RegexHelper::REGEX_ALIAS); |
@@ -349,12 +349,12 @@ discard block |
||
349 | 349 | return $this->setValidation(self::VALIDATION_TYPE_ALPHA); |
350 | 350 | } |
351 | 351 | |
352 | - /** |
|
353 | - * Sets the parameter value as a string containing lowercase |
|
354 | - * and/or uppercase letters, as well as numbers. |
|
355 | - * |
|
356 | - * @return Request_Param |
|
357 | - */ |
|
352 | + /** |
|
353 | + * Sets the parameter value as a string containing lowercase |
|
354 | + * and/or uppercase letters, as well as numbers. |
|
355 | + * |
|
356 | + * @return Request_Param |
|
357 | + */ |
|
358 | 358 | public function setAlnum() |
359 | 359 | { |
360 | 360 | return $this->setValidation(self::VALIDATION_TYPE_ALNUM); |
@@ -387,17 +387,17 @@ discard block |
||
387 | 387 | ); |
388 | 388 | } |
389 | 389 | |
390 | - /** |
|
391 | - * Only available for array values: the parameter must be |
|
392 | - * an array value, and the array may only contain values |
|
393 | - * specified in the values array. |
|
394 | - * |
|
395 | - * Submitted values that are not in the allowed list of |
|
396 | - * values are stripped from the value. |
|
397 | - * |
|
398 | - * @param array $values List of allowed values |
|
399 | - * @return \AppUtils\Request_Param |
|
400 | - */ |
|
390 | + /** |
|
391 | + * Only available for array values: the parameter must be |
|
392 | + * an array value, and the array may only contain values |
|
393 | + * specified in the values array. |
|
394 | + * |
|
395 | + * Submitted values that are not in the allowed list of |
|
396 | + * values are stripped from the value. |
|
397 | + * |
|
398 | + * @param array $values List of allowed values |
|
399 | + * @return \AppUtils\Request_Param |
|
400 | + */ |
|
401 | 401 | public function setValuesList(array $values) |
402 | 402 | { |
403 | 403 | $this->setArray(); |
@@ -410,11 +410,11 @@ discard block |
||
410 | 410 | ); |
411 | 411 | } |
412 | 412 | |
413 | - /** |
|
414 | - * Whether the parameter is a list of values. |
|
415 | - * |
|
416 | - * @return bool |
|
417 | - */ |
|
413 | + /** |
|
414 | + * Whether the parameter is a list of values. |
|
415 | + * |
|
416 | + * @return bool |
|
417 | + */ |
|
418 | 418 | public function isList() : bool |
419 | 419 | { |
420 | 420 | return $this->valueType === self::VALUE_TYPE_LIST; |
@@ -425,53 +425,53 @@ discard block |
||
425 | 425 | return $this->setValidation(self::VALIDATION_TYPE_ARRAY); |
426 | 426 | } |
427 | 427 | |
428 | - /** |
|
429 | - * Specifies that a JSON-encoded string is expected. |
|
430 | - * |
|
431 | - * NOTE: Numbers or quoted strings are technically valid |
|
432 | - * JSON, but are not accepted, because it is assumed |
|
433 | - * at least an array or object are expected. |
|
434 | - * |
|
435 | - * @return \AppUtils\Request_Param |
|
436 | - */ |
|
428 | + /** |
|
429 | + * Specifies that a JSON-encoded string is expected. |
|
430 | + * |
|
431 | + * NOTE: Numbers or quoted strings are technically valid |
|
432 | + * JSON, but are not accepted, because it is assumed |
|
433 | + * at least an array or object are expected. |
|
434 | + * |
|
435 | + * @return \AppUtils\Request_Param |
|
436 | + */ |
|
437 | 437 | public function setJSON() : Request_Param |
438 | 438 | { |
439 | 439 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true)); |
440 | 440 | } |
441 | 441 | |
442 | - /** |
|
443 | - * Like {@link Request_Param::setJSON()}, but accepts |
|
444 | - * only JSON objects. Arrays will not be accepted. |
|
445 | - * |
|
446 | - * @return \AppUtils\Request_Param |
|
447 | - */ |
|
442 | + /** |
|
443 | + * Like {@link Request_Param::setJSON()}, but accepts |
|
444 | + * only JSON objects. Arrays will not be accepted. |
|
445 | + * |
|
446 | + * @return \AppUtils\Request_Param |
|
447 | + */ |
|
448 | 448 | public function setJSONObject() : Request_Param |
449 | 449 | { |
450 | 450 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false)); |
451 | 451 | } |
452 | 452 | |
453 | - /** |
|
454 | - * The parameter is a string boolean representation. This means |
|
455 | - * it can be any of the following: "yes", "true", "no", "false". |
|
456 | - * The value is automatically converted to a boolean when retrieving |
|
457 | - * the parameter. |
|
458 | - * |
|
459 | - * @return Request_Param |
|
460 | - */ |
|
453 | + /** |
|
454 | + * The parameter is a string boolean representation. This means |
|
455 | + * it can be any of the following: "yes", "true", "no", "false". |
|
456 | + * The value is automatically converted to a boolean when retrieving |
|
457 | + * the parameter. |
|
458 | + * |
|
459 | + * @return Request_Param |
|
460 | + */ |
|
461 | 461 | public function setBoolean() : Request_Param |
462 | 462 | { |
463 | 463 | return $this->addClassFilter('Boolean'); |
464 | 464 | } |
465 | 465 | |
466 | - /** |
|
467 | - * Validates the request parameter as an MD5 string, |
|
468 | - * so that only values resembling md5 values are accepted. |
|
469 | - * |
|
470 | - * NOTE: This can only guarantee the format, not whether |
|
471 | - * it is an actual valid hash of something. |
|
472 | - * |
|
473 | - * @return \AppUtils\Request_Param |
|
474 | - */ |
|
466 | + /** |
|
467 | + * Validates the request parameter as an MD5 string, |
|
468 | + * so that only values resembling md5 values are accepted. |
|
469 | + * |
|
470 | + * NOTE: This can only guarantee the format, not whether |
|
471 | + * it is an actual valid hash of something. |
|
472 | + * |
|
473 | + * @return \AppUtils\Request_Param |
|
474 | + */ |
|
475 | 475 | public function setMD5() : Request_Param |
476 | 476 | { |
477 | 477 | return $this->setRegex(RegexHelper::REGEX_MD5); |
@@ -513,14 +513,14 @@ discard block |
||
513 | 513 | return $this; |
514 | 514 | } |
515 | 515 | |
516 | - /** |
|
517 | - * Retrieves the value of the request parameter, |
|
518 | - * applying all filters (if any) and validation |
|
519 | - * (if any). |
|
520 | - * |
|
521 | - * @param mixed $default |
|
522 | - * @return mixed |
|
523 | - */ |
|
516 | + /** |
|
517 | + * Retrieves the value of the request parameter, |
|
518 | + * applying all filters (if any) and validation |
|
519 | + * (if any). |
|
520 | + * |
|
521 | + * @param mixed $default |
|
522 | + * @return mixed |
|
523 | + */ |
|
524 | 524 | public function get($default=null) |
525 | 525 | { |
526 | 526 | $value = $this->request->getParam($this->paramName); |
@@ -531,14 +531,14 @@ discard block |
||
531 | 531 | return $this->validate($default); |
532 | 532 | } |
533 | 533 | |
534 | - /** |
|
535 | - * Filters the specified value by going through all available |
|
536 | - * filters, if any. If none have been set, the value is simply |
|
537 | - * passed through. |
|
538 | - * |
|
539 | - * @param mixed $value |
|
540 | - * @return mixed |
|
541 | - */ |
|
534 | + /** |
|
535 | + * Filters the specified value by going through all available |
|
536 | + * filters, if any. If none have been set, the value is simply |
|
537 | + * passed through. |
|
538 | + * |
|
539 | + * @param mixed $value |
|
540 | + * @return mixed |
|
541 | + */ |
|
542 | 542 | protected function filter($value) |
543 | 543 | { |
544 | 544 | $total = count($this->filters); |
@@ -608,12 +608,12 @@ discard block |
||
608 | 608 | return $this; |
609 | 609 | } |
610 | 610 | |
611 | - /** |
|
612 | - * Adds a filter that trims whitespace from the request |
|
613 | - * parameter using the PHP <code>trim</code> function. |
|
614 | - * |
|
615 | - * @return \AppUtils\Request_Param |
|
616 | - */ |
|
611 | + /** |
|
612 | + * Adds a filter that trims whitespace from the request |
|
613 | + * parameter using the PHP <code>trim</code> function. |
|
614 | + * |
|
615 | + * @return \AppUtils\Request_Param |
|
616 | + */ |
|
617 | 617 | public function addFilterTrim() : Request_Param |
618 | 618 | { |
619 | 619 | // to guarantee we only work with strings |
@@ -622,13 +622,13 @@ discard block |
||
622 | 622 | return $this->addCallbackFilter('trim'); |
623 | 623 | } |
624 | 624 | |
625 | - /** |
|
626 | - * Converts the value to a string, even if it is not |
|
627 | - * a string value. Complex types like arrays and objects |
|
628 | - * are converted to an empty string. |
|
629 | - * |
|
630 | - * @return \AppUtils\Request_Param |
|
631 | - */ |
|
625 | + /** |
|
626 | + * Converts the value to a string, even if it is not |
|
627 | + * a string value. Complex types like arrays and objects |
|
628 | + * are converted to an empty string. |
|
629 | + * |
|
630 | + * @return \AppUtils\Request_Param |
|
631 | + */ |
|
632 | 632 | public function addStringFilter() : Request_Param |
633 | 633 | { |
634 | 634 | return $this->addClassFilter('String'); |
@@ -678,12 +678,12 @@ discard block |
||
678 | 678 | return $this->addCallbackFilter('strip_tags', array($allowedTags)); |
679 | 679 | } |
680 | 680 | |
681 | - /** |
|
682 | - * Adds a filter that strips all whitespace from the |
|
683 | - * request parameter, from spaces to tabs and newlines. |
|
684 | - * |
|
685 | - * @return \AppUtils\Request_Param |
|
686 | - */ |
|
681 | + /** |
|
682 | + * Adds a filter that strips all whitespace from the |
|
683 | + * request parameter, from spaces to tabs and newlines. |
|
684 | + * |
|
685 | + * @return \AppUtils\Request_Param |
|
686 | + */ |
|
687 | 687 | public function addStripWhitespaceFilter() : Request_Param |
688 | 688 | { |
689 | 689 | // to ensure we only work with strings. |
@@ -692,14 +692,14 @@ discard block |
||
692 | 692 | return $this->addClassFilter('StripWhitespace'); |
693 | 693 | } |
694 | 694 | |
695 | - /** |
|
696 | - * Adds a filter that transforms comma separated values |
|
697 | - * into an array of values. |
|
698 | - * |
|
699 | - * @param bool $trimEntries Trim whitespace from each entry? |
|
700 | - * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
701 | - * @return \AppUtils\Request_Param |
|
702 | - */ |
|
695 | + /** |
|
696 | + * Adds a filter that transforms comma separated values |
|
697 | + * into an array of values. |
|
698 | + * |
|
699 | + * @param bool $trimEntries Trim whitespace from each entry? |
|
700 | + * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
701 | + * @return \AppUtils\Request_Param |
|
702 | + */ |
|
703 | 703 | public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
704 | 704 | { |
705 | 705 | $this->setArray(); |
@@ -724,12 +724,12 @@ discard block |
||
724 | 724 | ); |
725 | 725 | } |
726 | 726 | |
727 | - /** |
|
728 | - * Adds a filter that encodes all HTML special characters |
|
729 | - * using the PHP <code>htmlspecialchars</code> function. |
|
730 | - * |
|
731 | - * @return \AppUtils\Request_Param |
|
732 | - */ |
|
727 | + /** |
|
728 | + * Adds a filter that encodes all HTML special characters |
|
729 | + * using the PHP <code>htmlspecialchars</code> function. |
|
730 | + * |
|
731 | + * @return \AppUtils\Request_Param |
|
732 | + */ |
|
733 | 733 | public function addHTMLSpecialcharsFilter() : Request_Param |
734 | 734 | { |
735 | 735 | return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8')); |
@@ -742,14 +742,14 @@ discard block |
||
742 | 742 | |
743 | 743 | protected $required = false; |
744 | 744 | |
745 | - /** |
|
746 | - * Marks this request parameter as required. To use this feature, |
|
747 | - * you have to call the request's {@link Request::validate()} |
|
748 | - * method. |
|
749 | - * |
|
750 | - * @return Request_Param |
|
751 | - * @see Request::validate() |
|
752 | - */ |
|
745 | + /** |
|
746 | + * Marks this request parameter as required. To use this feature, |
|
747 | + * you have to call the request's {@link Request::validate()} |
|
748 | + * method. |
|
749 | + * |
|
750 | + * @return Request_Param |
|
751 | + * @see Request::validate() |
|
752 | + */ |
|
753 | 753 | public function makeRequired() : Request_Param |
754 | 754 | { |
755 | 755 | $this->required = true; |
@@ -27,14 +27,14 @@ |
||
27 | 27 | */ |
28 | 28 | protected $param; |
29 | 29 | |
30 | - /** |
|
31 | - * @var mixed |
|
32 | - */ |
|
30 | + /** |
|
31 | + * @var mixed |
|
32 | + */ |
|
33 | 33 | protected $value; |
34 | 34 | |
35 | - /** |
|
36 | - * @var bool |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var bool |
|
37 | + */ |
|
38 | 38 | protected $isSubvalue = false; |
39 | 39 | |
40 | 40 | public function __construct(Request_Param $param, bool $subval) |