Passed
Push — master ( 986f6c...ae2e8a )
by Sebastian
03:10
created
src/URLInfo/ConnectionTester.php 1 patch
Indentation   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -22,9 +22,9 @@  discard block
 block discarded – undo
22 22
 {
23 23
     use Traits_Optionable;
24 24
     
25
-   /**
26
-    * @var URLInfo
27
-    */
25
+    /**
26
+     * @var URLInfo
27
+     */
28 28
     private $url;
29 29
     
30 30
     public function __construct(URLInfo $url)
@@ -41,13 +41,13 @@  discard block
 block discarded – undo
41 41
         );
42 42
     }
43 43
     
44
-   /**
45
-    * Whether to verify the host's SSL certificate, in
46
-    * case of an https connection.
47
-    * 
48
-    * @param bool $verifySSL
49
-    * @return URLInfo_ConnectionTester
50
-    */
44
+    /**
45
+     * Whether to verify the host's SSL certificate, in
46
+     * case of an https connection.
47
+     * 
48
+     * @param bool $verifySSL
49
+     * @return URLInfo_ConnectionTester
50
+     */
51 51
     public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester
52 52
     {
53 53
         $this->setOption('verify-ssl', $verifySSL);
@@ -81,12 +81,12 @@  discard block
 block discarded – undo
81 81
         return $this->getIntOption('timeout');
82 82
     }
83 83
     
84
-   /**
85
-    * Initializes the CURL instance.
86
-    * 
87
-    * @throws BaseException
88
-    * @return resource
89
-    */
84
+    /**
85
+     * Initializes the CURL instance.
86
+     * 
87
+     * @throws BaseException
88
+     * @return resource
89
+     */
90 90
     private function initCURL()
91 91
     {
92 92
         requireCURL();
@@ -105,9 +105,9 @@  discard block
 block discarded – undo
105 105
         return $ch;
106 106
     }
107 107
     
108
-   /**
109
-    * @param resource $ch
110
-    */
108
+    /**
109
+     * @param resource $ch
110
+     */
111 111
     private function configureOptions($ch) : void
112 112
     {
113 113
         if($this->isVerboseModeEnabled())
Please login to merge, or discard this patch.
src/RequestHelper/Response.php 1 patch
Indentation   +65 added lines, -65 removed lines patch added patch discarded remove patch
@@ -19,51 +19,51 @@  discard block
 block discarded – undo
19 19
  */
20 20
 class RequestHelper_Response
21 21
 {
22
-   /**
23
-    * @var RequestHelper
24
-    */
22
+    /**
23
+     * @var RequestHelper
24
+     */
25 25
     protected $request;
26 26
     
27
-   /**
28
-    * @var string
29
-    */
27
+    /**
28
+     * @var string
29
+     */
30 30
     protected $body = '';
31 31
     
32
-   /**
33
-    * @var array
34
-    */
32
+    /**
33
+     * @var array
34
+     */
35 35
     protected $info;
36 36
     
37
-   /**
38
-    * @var bool
39
-    */
37
+    /**
38
+     * @var bool
39
+     */
40 40
     protected $isError = false;
41 41
     
42
-   /**
43
-    * @var string
44
-    */
42
+    /**
43
+     * @var string
44
+     */
45 45
     protected $errorMessage = '';
46 46
     
47
-   /**
48
-    * @var integer
49
-    */
47
+    /**
48
+     * @var integer
49
+     */
50 50
     protected $errorCode = 0;
51 51
     
52
-   /**
53
-    * @param RequestHelper $helper
54
-    * @param array $info The CURL info array from curl_getinfo().
55
-    */
52
+    /**
53
+     * @param RequestHelper $helper
54
+     * @param array $info The CURL info array from curl_getinfo().
55
+     */
56 56
     public function __construct(RequestHelper $helper, array $info)
57 57
     {
58 58
         $this->request = $helper;
59 59
         $this->info = $info;
60 60
     }
61 61
     
62
-   /**
63
-    * Retrieves the request instance that initiated the request.
64
-    *  
65
-    * @return RequestHelper
66
-    */
62
+    /**
63
+     * Retrieves the request instance that initiated the request.
64
+     *  
65
+     * @return RequestHelper
66
+     */
67 67
     public function getRequest() : RequestHelper
68 68
     {
69 69
         return $this->request;
@@ -84,79 +84,79 @@  discard block
 block discarded – undo
84 84
         return $this;
85 85
     }
86 86
     
87
-   /**
88
-    * Whether an error occurred in the request.
89
-    * @return bool
90
-    */
87
+    /**
88
+     * Whether an error occurred in the request.
89
+     * @return bool
90
+     */
91 91
     public function isError() : bool
92 92
     {
93 93
         return $this->isError;
94 94
     }
95 95
     
96
-   /**
97
-    * Whether the request timed out.
98
-    * @return bool
99
-    */
96
+    /**
97
+     * Whether the request timed out.
98
+     * @return bool
99
+     */
100 100
     public function isTimeout() : bool
101 101
     {
102 102
         return $this->errorCode === RequestHelper_CURL::OPERATION_TIMEDOUT;
103 103
     }
104 104
     
105
-   /**
106
-    * Retrieves the native error message, if an error occurred.
107
-    * @return string
108
-    */
105
+    /**
106
+     * Retrieves the native error message, if an error occurred.
107
+     * @return string
108
+     */
109 109
     public function getErrorMessage() : string
110 110
     {
111 111
         return $this->errorMessage;
112 112
     }
113 113
     
114
-   /**
115
-    * Retrieves the native CURL error code, if an error occurred.
116
-    * @return int
117
-    * @see RequestHelper_CURL For a list of error codes.
118
-    */
114
+    /**
115
+     * Retrieves the native CURL error code, if an error occurred.
116
+     * @return int
117
+     * @see RequestHelper_CURL For a list of error codes.
118
+     */
119 119
     public function getErrorCode() : int
120 120
     {
121 121
         return $this->errorCode;
122 122
     }
123 123
     
124
-   /**
125
-    * Retrieves the full body of the request.
126
-    * 
127
-    * @return string
128
-    */
124
+    /**
125
+     * Retrieves the full body of the request.
126
+     * 
127
+     * @return string
128
+     */
129 129
     public function getRequestBody() : string
130 130
     {
131 131
         return $this->request->getBody();
132 132
     }
133 133
     
134
-   /**
135
-    * Retrieves the body of the response, if any.
136
-    * 
137
-    * @return string
138
-    */
134
+    /**
135
+     * Retrieves the body of the response, if any.
136
+     * 
137
+     * @return string
138
+     */
139 139
     public function getResponseBody() : string
140 140
     {
141 141
         return $this->body;
142 142
     }
143 143
     
144
-   /**
145
-    * The response HTTP code.
146
-    * 
147
-    * @return int The code, or 0 if none was sent (on error).
148
-    */
144
+    /**
145
+     * The response HTTP code.
146
+     * 
147
+     * @return int The code, or 0 if none was sent (on error).
148
+     */
149 149
     public function getCode() : int
150 150
     {
151 151
         return intval($this->getInfoKey('http_code'));
152 152
     }
153 153
     
154
-   /**
155
-    * Retrieves the actual headers that were sent in the request:
156
-    * one header by entry in the indexed array.
157
-    * 
158
-    * @return array
159
-    */
154
+    /**
155
+     * Retrieves the actual headers that were sent in the request:
156
+     * one header by entry in the indexed array.
157
+     * 
158
+     * @return array
159
+     */
160 160
     public function getHeaders() : array
161 161
     {
162 162
         return ConvertHelper::explodeTrim("\n", $this->getInfoKey('request_header'));
Please login to merge, or discard this patch.
src/StringBuilder/Interface.php 1 patch
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -25,17 +25,17 @@
 block discarded – undo
25 25
      * 
26 26
      * @return string
27 27
      */
28
-     function render() : string;
28
+        function render() : string;
29 29
      
30 30
     /**
31 31
      * Converts the string builder to a string.
32 32
      * 
33 33
      * @return string
34 34
      */
35
-     function __toString();
35
+        function __toString();
36 36
      
37 37
     /**
38 38
      * Renders the string and echos it.
39 39
      */
40
-     function display() : void;
40
+        function display() : void;
41 41
 }
Please login to merge, or discard this patch.
src/RequestHelper.php 1 patch
Indentation   +151 added lines, -151 removed lines patch added patch discarded remove patch
@@ -32,62 +32,62 @@  discard block
 block discarded – undo
32 32
     const ERROR_CURL_INIT_FAILED = 17903;
33 33
     const ERROR_CANNOT_OPEN_LOGFILE = 17904;
34 34
 
35
-   /**
36
-    * @var string
37
-    */
35
+    /**
36
+     * @var string
37
+     */
38 38
     protected $eol = "\r\n";
39 39
 
40
-   /**
41
-    * @var string
42
-    */
40
+    /**
41
+     * @var string
42
+     */
43 43
     protected $mimeBoundary;
44 44
 
45
-   /**
46
-    * @var string
47
-    */
45
+    /**
46
+     * @var string
47
+     */
48 48
     protected $destination;
49 49
 
50
-   /**
51
-    * @var array<string,string>
52
-    */
50
+    /**
51
+     * @var array<string,string>
52
+     */
53 53
     protected $headers = array();
54 54
     
55
-   /**
56
-    * Whether to verify SSL certificates.
57
-    * @var bool
58
-    */
55
+    /**
56
+     * Whether to verify SSL certificates.
57
+     * @var bool
58
+     */
59 59
     protected $verifySSL = true;
60 60
     
61
-   /**
62
-    * @var RequestHelper_Boundaries
63
-    */
61
+    /**
62
+     * @var RequestHelper_Boundaries
63
+     */
64 64
     protected $boundaries;
65 65
     
66
-   /**
67
-    * @var RequestHelper_Response|NULL
68
-    */
66
+    /**
67
+     * @var RequestHelper_Response|NULL
68
+     */
69 69
     protected $response;
70 70
 
71
-   /**
72
-    * Timeout duration, in seconds.
73
-    * @var integer
74
-    */
71
+    /**
72
+     * Timeout duration, in seconds.
73
+     * @var integer
74
+     */
75 75
     protected $timeout = 30;
76 76
     
77
-   /**
78
-    * @var string
79
-    */
77
+    /**
78
+     * @var string
79
+     */
80 80
     protected $logfile = '';
81 81
 
82
-   /**
83
-    * @var resource|NULL
84
-    */
82
+    /**
83
+     * @var resource|NULL
84
+     */
85 85
     protected $logfilePointer = null;
86 86
     
87
-   /**
88
-    * Creates a new request helper to send POST data to the specified destination URL.
89
-    * @param string $destinationURL
90
-    */
87
+    /**
88
+     * Creates a new request helper to send POST data to the specified destination URL.
89
+     * @param string $destinationURL
90
+     */
91 91
     public function __construct(string $destinationURL)
92 92
     {
93 93
         $this->destination = $destinationURL;
@@ -112,13 +112,13 @@  discard block
 block discarded – undo
112 112
         return $this->eol;
113 113
     }
114 114
     
115
-   /**
116
-    * Sets the timeout for the request, in seconds. If the request
117
-    * takes longer, it will be cancelled and an exception triggered.
118
-    * 
119
-    * @param int $seconds
120
-    * @return RequestHelper
121
-    */
115
+    /**
116
+     * Sets the timeout for the request, in seconds. If the request
117
+     * takes longer, it will be cancelled and an exception triggered.
118
+     * 
119
+     * @param int $seconds
120
+     * @return RequestHelper
121
+     */
122 122
     public function setTimeout(int $seconds) : RequestHelper
123 123
     {
124 124
         $this->timeout = $seconds;
@@ -131,13 +131,13 @@  discard block
 block discarded – undo
131 131
         return $this->timeout;
132 132
     }
133 133
     
134
-   /**
135
-    * Enables verbose logging of the CURL request, which
136
-    * is then redirected to the target file.
137
-    * 
138
-    * @param string $targetFile
139
-    * @return RequestHelper
140
-    */
134
+    /**
135
+     * Enables verbose logging of the CURL request, which
136
+     * is then redirected to the target file.
137
+     * 
138
+     * @param string $targetFile
139
+     * @return RequestHelper
140
+     */
141 141
     public function enableLogging(string $targetFile) : RequestHelper
142 142
     {
143 143
         $this->logfile = $targetFile;
@@ -145,15 +145,15 @@  discard block
 block discarded – undo
145 145
         return $this;
146 146
     }
147 147
 
148
-   /**
149
-    * Adds a file to be sent with the request.
150
-    *
151
-    * @param string $varName The variable name to send the file in
152
-    * @param string $fileName The name of the file as it should be received at the destination
153
-    * @param string $content The raw content of the file
154
-    * @param string $contentType The content type, use the constants to specify this
155
-    * @param string $encoding The encoding of the file, use the constants to specify this
156
-    */
148
+    /**
149
+     * Adds a file to be sent with the request.
150
+     *
151
+     * @param string $varName The variable name to send the file in
152
+     * @param string $fileName The name of the file as it should be received at the destination
153
+     * @param string $content The raw content of the file
154
+     * @param string $contentType The content type, use the constants to specify this
155
+     * @param string $encoding The encoding of the file, use the constants to specify this
156
+     */
157 157
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper
158 158
     {
159 159
         $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding);
@@ -161,13 +161,13 @@  discard block
 block discarded – undo
161 161
         return $this;
162 162
     }
163 163
     
164
-   /**
165
-    * Adds arbitrary content.
166
-    * 
167
-    * @param string $varName The variable name to send the content in.
168
-    * @param string $content
169
-    * @param string $contentType
170
-    */
164
+    /**
165
+     * Adds arbitrary content.
166
+     * 
167
+     * @param string $varName The variable name to send the content in.
168
+     * @param string $content
169
+     * @param string $contentType
170
+     */
171 171
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper
172 172
     {
173 173
         $this->boundaries->addContent($varName, $content, $contentType);
@@ -175,13 +175,13 @@  discard block
 block discarded – undo
175 175
         return $this;
176 176
     }
177 177
 
178
-   /**
179
-    * Adds a variable to be sent with the request. If it
180
-    * already exists, its value is overwritten.
181
-    *
182
-    * @param string $name
183
-    * @param string $value
184
-    */
178
+    /**
179
+     * Adds a variable to be sent with the request. If it
180
+     * already exists, its value is overwritten.
181
+     *
182
+     * @param string $name
183
+     * @param string $value
184
+     */
185 185
     public function addVariable(string $name, string $value) : RequestHelper
186 186
     {
187 187
         $this->boundaries->addVariable($name, $value);
@@ -189,13 +189,13 @@  discard block
 block discarded – undo
189 189
         return $this;
190 190
     }
191 191
     
192
-   /**
193
-    * Sets an HTTP header to include in the request.
194
-    * 
195
-    * @param string $name
196
-    * @param string $value
197
-    * @return RequestHelper
198
-    */
192
+    /**
193
+     * Sets an HTTP header to include in the request.
194
+     * 
195
+     * @param string $name
196
+     * @param string $value
197
+     * @return RequestHelper
198
+     */
199 199
     public function setHeader(string $name, string $value) : RequestHelper
200 200
     {
201 201
         $this->headers[$name] = $value;
@@ -203,36 +203,36 @@  discard block
 block discarded – undo
203 203
         return $this;
204 204
     }
205 205
     
206
-   /**
207
-    * Disables SSL certificate checking.
208
-    * 
209
-    * @return RequestHelper
210
-    */
206
+    /**
207
+     * Disables SSL certificate checking.
208
+     * 
209
+     * @return RequestHelper
210
+     */
211 211
     public function disableSSLChecks() : RequestHelper
212 212
     {
213 213
         $this->verifySSL = false;
214 214
         return $this;
215 215
     }
216 216
    
217
-   /**
218
-    * @var integer
219
-    */
217
+    /**
218
+     * @var integer
219
+     */
220 220
     protected $contentLength = 0;
221 221
 
222
-   /**
223
-    * Sends the POST request to the destination, and returns
224
-    * the response text.
225
-    *
226
-    * The response object is stored internally, so after calling
227
-    * this method it may be retrieved at any moment using the
228
-    * {@link getResponse()} method.
229
-    *
230
-    * @return string
231
-    * @see RequestHelper::getResponse()
232
-    * @throws RequestHelper_Exception
233
-    * 
234
-    * @see RequestHelper::ERROR_REQUEST_FAILED
235
-    */
222
+    /**
223
+     * Sends the POST request to the destination, and returns
224
+     * the response text.
225
+     *
226
+     * The response object is stored internally, so after calling
227
+     * this method it may be retrieved at any moment using the
228
+     * {@link getResponse()} method.
229
+     *
230
+     * @return string
231
+     * @see RequestHelper::getResponse()
232
+     * @throws RequestHelper_Exception
233
+     * 
234
+     * @see RequestHelper::ERROR_REQUEST_FAILED
235
+     */
236 236
     public function send() : string
237 237
     {
238 238
         $info = parseURL($this->destination);
@@ -272,26 +272,26 @@  discard block
 block discarded – undo
272 272
         return $this->response->getResponseBody();
273 273
     }
274 274
     
275
-   /**
276
-    * Retrieves the request's body content. This is an alias
277
-    * for {@see RequestHelper::getMimeBody()}.
278
-    * 
279
-    * @return string
280
-    * @see RequestHelper::getMimeBody()
281
-    */
275
+    /**
276
+     * Retrieves the request's body content. This is an alias
277
+     * for {@see RequestHelper::getMimeBody()}.
278
+     * 
279
+     * @return string
280
+     * @see RequestHelper::getMimeBody()
281
+     */
282 282
     public function getBody() : string
283 283
     {
284 284
         return $this->getMimeBody();
285 285
     }
286 286
     
287
-   /**
288
-    * Creates a new CURL resource configured according to the
289
-    * request's settings.
290
-    * 
291
-    * @param URLInfo $url
292
-    * @throws RequestHelper_Exception
293
-    * @return resource
294
-    */
287
+    /**
288
+     * Creates a new CURL resource configured according to the
289
+     * request's settings.
290
+     * 
291
+     * @param URLInfo $url
292
+     * @throws RequestHelper_Exception
293
+     * @return resource
294
+     */
295 295
     protected function createCURL(URLInfo $url)
296 296
     {
297 297
         $ch = curl_init();
@@ -339,10 +339,10 @@  discard block
 block discarded – undo
339 339
         return $ch;
340 340
     }
341 341
     
342
-   /**
343
-    * @param resource $ch
344
-    * @return bool Whether logging is enabled.
345
-    */
342
+    /**
343
+     * @param resource $ch
344
+     * @return bool Whether logging is enabled.
345
+     */
346 346
     protected function configureLogging($ch) : bool
347 347
     {
348 348
         if(empty($this->logfile))
@@ -369,13 +369,13 @@  discard block
 block discarded – undo
369 369
         return true;
370 370
     }
371 371
 
372
-   /**
373
-    * Compiles the associative headers array into
374
-    * the format understood by CURL, namely an indexed
375
-    * array with one header string per entry.
376
-    * 
377
-    * @return array
378
-    */
372
+    /**
373
+     * Compiles the associative headers array into
374
+     * the format understood by CURL, namely an indexed
375
+     * array with one header string per entry.
376
+     * 
377
+     * @return array
378
+     */
379 379
     protected function renderHeaders() : array
380 380
     {
381 381
         $result = array();
@@ -389,12 +389,12 @@  discard block
 block discarded – undo
389 389
         return $result;
390 390
     }
391 391
     
392
-   /**
393
-    * Retrieves the raw response header, in the form of an indexed
394
-    * array containing all response header lines.
395
-    * 
396
-    * @return array
397
-    */
392
+    /**
393
+     * Retrieves the raw response header, in the form of an indexed
394
+     * array containing all response header lines.
395
+     * 
396
+     * @return array
397
+     */
398 398
     public function getResponseHeader() : array
399 399
     {
400 400
         $response = $this->getResponse();
@@ -406,33 +406,33 @@  discard block
 block discarded – undo
406 406
         return array();
407 407
     }
408 408
 
409
-   /**
410
-    * After calling the {@link send()} method, this may be used to
411
-    * retrieve the response text from the POST request.
412
-    *
413
-    * @return RequestHelper_Response|NULL
414
-    */
409
+    /**
410
+     * After calling the {@link send()} method, this may be used to
411
+     * retrieve the response text from the POST request.
412
+     *
413
+     * @return RequestHelper_Response|NULL
414
+     */
415 415
     public function getResponse() : ?RequestHelper_Response
416 416
     {
417 417
         return $this->response;
418 418
     }
419 419
     
420
-   /**
421
-    * Retrieves all headers set until now.
422
-    * 
423
-    * @return array<string,string>
424
-    */
420
+    /**
421
+     * Retrieves all headers set until now.
422
+     * 
423
+     * @return array<string,string>
424
+     */
425 425
     public function getHeaders() : array
426 426
     {
427 427
         return $this->headers;
428 428
     }
429 429
     
430
-   /**
431
-    * Retrieves the value of a header by its name.
432
-    * 
433
-    * @param string $name
434
-    * @return string The header value, or an empty string if not set.
435
-    */
430
+    /**
431
+     * Retrieves the value of a header by its name.
432
+     * 
433
+     * @param string $name
434
+     * @return string The header value, or an empty string if not set.
435
+     */
436 436
     public function getHeader(string $name) : string
437 437
     {
438 438
         if(isset($this->headers[$name]))
Please login to merge, or discard this patch.
src/StringBuilder.php 1 patch
Indentation   +145 added lines, -145 removed lines patch added patch discarded remove patch
@@ -33,24 +33,24 @@  discard block
 block discarded – undo
33 33
  */
34 34
 class StringBuilder implements StringBuilder_Interface
35 35
 {
36
-   /**
37
-    * @var string
38
-    */
36
+    /**
37
+     * @var string
38
+     */
39 39
     protected $separator = ' ';
40 40
 
41
-   /**
42
-    * @var string[]
43
-    */
41
+    /**
42
+     * @var string[]
43
+     */
44 44
     protected $strings = array();
45 45
 
46
-   /**
47
-    * @var string
48
-    */
46
+    /**
47
+     * @var string
48
+     */
49 49
     protected $mode = 'html';
50 50
 
51
-   /**
52
-    * @var string
53
-    */
51
+    /**
52
+     * @var string
53
+     */
54 54
     protected $noSpace = '§!§';
55 55
     
56 56
     public function __construct()
@@ -58,12 +58,12 @@  discard block
 block discarded – undo
58 58
         
59 59
     }
60 60
     
61
-   /**
62
-    * Adds a subject as a string. Is ignored if empty.
63
-    * 
64
-    * @param string|number|StringBuilder_Interface $string
65
-    * @return $this
66
-    */
61
+    /**
62
+     * Adds a subject as a string. Is ignored if empty.
63
+     * 
64
+     * @param string|number|StringBuilder_Interface $string
65
+     * @return $this
66
+     */
67 67
     public function add($string) : StringBuilder
68 68
     {
69 69
         $string = strval($string);
@@ -76,57 +76,57 @@  discard block
 block discarded – undo
76 76
         return $this;
77 77
     }
78 78
     
79
-   /**
80
-    * Adds a string without appending an automatic space.
81
-    * 
82
-    * @param string|number|StringBuilder_Interface $string
83
-    * @return $this
84
-    */
79
+    /**
80
+     * Adds a string without appending an automatic space.
81
+     * 
82
+     * @param string|number|StringBuilder_Interface $string
83
+     * @return $this
84
+     */
85 85
     public function nospace($string) : StringBuilder
86 86
     {
87 87
         return $this->add($this->noSpace.strval($string));
88 88
     }
89 89
     
90
-   /**
91
-    * Adds raw HTML code. Does not add an automatic space.
92
-    * 
93
-    * @param string|number|StringBuilder_Interface $html
94
-    * @return $this
95
-    */
90
+    /**
91
+     * Adds raw HTML code. Does not add an automatic space.
92
+     * 
93
+     * @param string|number|StringBuilder_Interface $html
94
+     * @return $this
95
+     */
96 96
     public function html($html) : StringBuilder
97 97
     {
98 98
         return $this->nospace($html);
99 99
     }
100 100
     
101
-   /**
102
-    * Adds an unordered list with the specified items.
103
-    * 
104
-    * @param array<int,string|number|StringBuilder_Interface> $items
105
-    * @return $this
106
-    */
101
+    /**
102
+     * Adds an unordered list with the specified items.
103
+     * 
104
+     * @param array<int,string|number|StringBuilder_Interface> $items
105
+     * @return $this
106
+     */
107 107
     public function ul(array $items) : StringBuilder
108 108
     {
109 109
         return $this->list('ul', $items);
110 110
     }
111 111
     
112
-   /**
113
-    * Adds an ordered list with the specified items.
114
-    * 
115
-    * @param array<int,string|number|StringBuilder_Interface> $items
116
-    * @return $this
117
-    */
112
+    /**
113
+     * Adds an ordered list with the specified items.
114
+     * 
115
+     * @param array<int,string|number|StringBuilder_Interface> $items
116
+     * @return $this
117
+     */
118 118
     public function ol(array $items) : StringBuilder
119 119
     {
120 120
         return $this->list('ol', $items);
121 121
     }
122 122
     
123
-   /**
124
-    * Creates a list tag with the items list.
125
-    * 
126
-    * @param string $type The list type, `ol` or `ul`.
127
-    * @param array<int,string|number|StringBuilder_Interface> $items
128
-    * @return $this
129
-    */
123
+    /**
124
+     * Creates a list tag with the items list.
125
+     * 
126
+     * @param string $type The list type, `ol` or `ul`.
127
+     * @param array<int,string|number|StringBuilder_Interface> $items
128
+     * @return $this
129
+     */
130 130
     protected function list(string $type, array $items) : StringBuilder
131 131
     {
132 132
         return $this->html(sprintf(
@@ -136,13 +136,13 @@  discard block
 block discarded – undo
136 136
         ));
137 137
     }
138 138
     
139
-   /**
140
-    * Add a translated string.
141
-    * 
142
-    * @param string $format The native string to translate.
143
-    * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
144
-    * @return $this
145
-    */
139
+    /**
140
+     * Add a translated string.
141
+     * 
142
+     * @param string $format The native string to translate.
143
+     * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
144
+     * @return $this
145
+     */
146 146
     public function t(string $format, ...$arguments) : StringBuilder
147 147
     {
148 148
         array_unshift($arguments, $format);
@@ -158,47 +158,47 @@  discard block
 block discarded – undo
158 158
         ));
159 159
     }
160 160
     
161
-   /**
162
-    * Adds a "5 months ago" age since the specified date.
163
-    * 
164
-    * @param DateTime $since
165
-    * @return $this
166
-    */
161
+    /**
162
+     * Adds a "5 months ago" age since the specified date.
163
+     * 
164
+     * @param DateTime $since
165
+     * @return $this
166
+     */
167 167
     public function age(DateTime $since) : StringBuilder
168 168
     {
169 169
         return $this->add(ConvertHelper::duration2string($since));
170 170
     }
171 171
     
172
-   /**
173
-    * Adds HTML quotes around the string.
174
-    * 
175
-    * @param string|number|StringBuilder_Interface $string
176
-    * @return $this
177
-    */
172
+    /**
173
+     * Adds HTML quotes around the string.
174
+     * 
175
+     * @param string|number|StringBuilder_Interface $string
176
+     * @return $this
177
+     */
178 178
     public function quote($string)
179 179
     {
180 180
         return $this->sf('&quot;%s&quot;', strval($string));
181 181
     }
182 182
     
183
-   /**
184
-    * Adds a text that is meant as a reference to an UI element,
185
-    * like a menu item, button, etc.
186
-    * 
187
-    * @param string|number|StringBuilder_Interface $string 
188
-    * @return $this
189
-    */
183
+    /**
184
+     * Adds a text that is meant as a reference to an UI element,
185
+     * like a menu item, button, etc.
186
+     * 
187
+     * @param string|number|StringBuilder_Interface $string 
188
+     * @return $this
189
+     */
190 190
     public function reference($string) : StringBuilder
191 191
     {
192 192
         return $this->sf('"%s"', $string);
193 193
     }
194 194
 
195
-   /**
196
-    * Add a string using the `sprintf` method.
197
-    * 
198
-    * @param string $format The format string
199
-    * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
200
-    * @return $this
201
-    */
195
+    /**
196
+     * Add a string using the `sprintf` method.
197
+     * 
198
+     * @param string $format The format string
199
+     * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
200
+     * @return $this
201
+     */
202 202
     public function sf(string $format, ...$arguments) : StringBuilder
203 203
     {
204 204
         array_unshift($arguments, $format);
@@ -206,12 +206,12 @@  discard block
 block discarded – undo
206 206
         return $this->add(call_user_func_array('sprintf', $arguments));
207 207
     }
208 208
     
209
-   /**
210
-    * Adds a bold string.
211
-    * 
212
-    * @param string|number|StringBuilder_Interface $string
213
-    * @return $this
214
-    */
209
+    /**
210
+     * Adds a bold string.
211
+     * 
212
+     * @param string|number|StringBuilder_Interface $string
213
+     * @return $this
214
+     */
215 215
     public function bold($string) : StringBuilder
216 216
     {
217 217
         return $this->sf(
@@ -220,74 +220,74 @@  discard block
 block discarded – undo
220 220
         );
221 221
     }
222 222
     
223
-   /**
224
-    * Adds a HTML `br` tag.
225
-    * 
226
-    * @return $this
227
-    */
223
+    /**
224
+     * Adds a HTML `br` tag.
225
+     * 
226
+     * @return $this
227
+     */
228 228
     public function nl() : StringBuilder
229 229
     {
230 230
         return $this->html('<br>');
231 231
     }
232 232
     
233
-   /**
234
-    * Adds the current time, in the format <code>H:i:s</code>.
235
-    * 
236
-    * @return $this
237
-    */
233
+    /**
234
+     * Adds the current time, in the format <code>H:i:s</code>.
235
+     * 
236
+     * @return $this
237
+     */
238 238
     public function time() : StringBuilder
239 239
     {
240 240
         return $this->add(date('H:i:s'));
241 241
     }
242 242
     
243
-   /**
244
-    * Adds the "Note:" text.
245
-    * 
246
-    * @return $this
247
-    */
243
+    /**
244
+     * Adds the "Note:" text.
245
+     * 
246
+     * @return $this
247
+     */
248 248
     public function note() : StringBuilder
249 249
     {
250 250
         return $this->t('Note:');
251 251
     }
252 252
     
253
-   /**
254
-    * Like `note()`, but as bold text.
255
-    * 
256
-    * @return $this
257
-    */
253
+    /**
254
+     * Like `note()`, but as bold text.
255
+     * 
256
+     * @return $this
257
+     */
258 258
     public function noteBold() : StringBuilder
259 259
     {
260 260
         return $this->bold(sb()->note());
261 261
     }
262 262
     
263
-   /**
264
-    * Adds the "Hint:" text.
265
-    * 
266
-    * @return $this
267
-    */
263
+    /**
264
+     * Adds the "Hint:" text.
265
+     * 
266
+     * @return $this
267
+     */
268 268
     public function hint() : StringBuilder
269 269
     {
270 270
         return $this->t('Hint:');
271 271
     }
272 272
     
273
-   /**
274
-    * Adds two linebreaks.
275
-    * 
276
-    * @return $this
277
-    */
273
+    /**
274
+     * Adds two linebreaks.
275
+     * 
276
+     * @return $this
277
+     */
278 278
     public function para() : StringBuilder
279 279
     {
280 280
         return $this->nl()->nl();
281 281
     }
282 282
     
283
-   /**
284
-    * Adds an anchor HTML tag.
285
-    * 
286
-    * @param string $label
287
-    * @param string $url
288
-    * @param bool $newTab
289
-    * @return $this
290
-    */
283
+    /**
284
+     * Adds an anchor HTML tag.
285
+     * 
286
+     * @param string $label
287
+     * @param string $url
288
+     * @param bool $newTab
289
+     * @return $this
290
+     */
291 291
     public function link(string $label, string $url, bool $newTab=false) : StringBuilder
292 292
     {
293 293
         $target = '';
@@ -303,12 +303,12 @@  discard block
 block discarded – undo
303 303
         );
304 304
     }
305 305
     
306
-   /**
307
-    * Wraps the string in a `code` tag.
308
-    * 
309
-    * @param string|number|StringBuilder_Interface $string
310
-    * @return $this
311
-    */
306
+    /**
307
+     * Wraps the string in a `code` tag.
308
+     * 
309
+     * @param string|number|StringBuilder_Interface $string
310
+     * @return $this
311
+     */
312 312
     public function code($string) : StringBuilder
313 313
     {
314 314
         return $this->sf(
@@ -317,24 +317,24 @@  discard block
 block discarded – undo
317 317
         );
318 318
     }
319 319
     
320
-   /**
321
-    * Wraps the string in a `pre` tag.
322
-    * 
323
-    * @param string|number|StringBuilder_Interface $string
324
-    * @return $this
325
-    */
320
+    /**
321
+     * Wraps the string in a `pre` tag.
322
+     * 
323
+     * @param string|number|StringBuilder_Interface $string
324
+     * @return $this
325
+     */
326 326
     public function pre($string) : StringBuilder
327 327
     {
328 328
         return $this->sf('<pre>%s</pre>', strval($string));
329 329
     }
330 330
     
331
-   /**
332
-    * Wraps the text in a `span` tag with the specified classes.
333
-    * 
334
-    * @param string|number|StringBuilder_Interface $string
335
-    * @param string|string[] $classes
336
-    * @return $this
337
-    */
331
+    /**
332
+     * Wraps the text in a `span` tag with the specified classes.
333
+     * 
334
+     * @param string|number|StringBuilder_Interface $string
335
+     * @param string|string[] $classes
336
+     * @return $this
337
+     */
338 338
     protected function spanned($string, $classes) : StringBuilder
339 339
     {
340 340
         if(!is_array($classes)) 
Please login to merge, or discard this patch.
src/XMLHelper.php 1 patch
Indentation   +172 added lines, -172 removed lines patch added patch discarded remove patch
@@ -28,9 +28,9 @@  discard block
 block discarded – undo
28 28
 {
29 29
     const ERROR_CANNOT_APPEND_FRAGMENT = 491001; 
30 30
 
31
-   /**
32
-    * @var boolean
33
-    */
31
+    /**
32
+     * @var boolean
33
+     */
34 34
     private static $simulation = false;
35 35
 
36 36
     /**
@@ -38,11 +38,11 @@  discard block
 block discarded – undo
38 38
      */
39 39
     private $dom;
40 40
     
41
-   /**
42
-    * Creates a new XMLHelper instance.
43
-    * 
44
-    * @return XMLHelper
45
-    */
41
+    /**
42
+     * Creates a new XMLHelper instance.
43
+     * 
44
+     * @return XMLHelper
45
+     */
46 46
     public static function create() : XMLHelper
47 47
     {
48 48
         $dom = new DOMDocument('1.0', 'UTF-8');
@@ -51,72 +51,72 @@  discard block
 block discarded – undo
51 51
         return new XMLHelper($dom);
52 52
     }
53 53
     
54
-   /**
55
-    * Creates a converter instance from an XML file.
56
-    * @param string $xmlFile
57
-    * @return XMLHelper_Converter
58
-    */
54
+    /**
55
+     * Creates a converter instance from an XML file.
56
+     * @param string $xmlFile
57
+     * @return XMLHelper_Converter
58
+     */
59 59
     public static function convertFile(string $xmlFile) : XMLHelper_Converter
60 60
     {
61 61
         return XMLHelper_Converter::fromFile($xmlFile);
62 62
     }
63 63
     
64
-   /**
65
-    * Creates a converter from an XML string.
66
-    * @param string $xmlString
67
-    * @return XMLHelper_Converter
68
-    */
64
+    /**
65
+     * Creates a converter from an XML string.
66
+     * @param string $xmlString
67
+     * @return XMLHelper_Converter
68
+     */
69 69
     public static function convertString(string $xmlString) : XMLHelper_Converter
70 70
     {
71 71
         return XMLHelper_Converter::fromString($xmlString);
72 72
     }
73 73
 
74
-   /**
75
-    * Creates a converter from a SimpleXMLElement instance.
76
-    * @param SimpleXMLElement $element
77
-    * @return XMLHelper_Converter
78
-    */
74
+    /**
75
+     * Creates a converter from a SimpleXMLElement instance.
76
+     * @param SimpleXMLElement $element
77
+     * @return XMLHelper_Converter
78
+     */
79 79
     public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter
80 80
     {
81 81
         return XMLHelper_Converter::fromElement($element);
82 82
     }
83 83
    
84
-   /**
85
-    * Creates a converter from a DOMElement instance.
86
-    * @param DOMElement $element
87
-    * @return XMLHelper_Converter
88
-    */
84
+    /**
85
+     * Creates a converter from a DOMElement instance.
86
+     * @param DOMElement $element
87
+     * @return XMLHelper_Converter
88
+     */
89 89
     public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter
90 90
     {
91 91
         return XMLHelper_Converter::fromDOMElement($element);
92 92
     }
93 93
 
94
-   /**
95
-    * Creates a new helper using an existing DOMDocument object.
96
-    * @param DOMDocument $dom
97
-    */
94
+    /**
95
+     * Creates a new helper using an existing DOMDocument object.
96
+     * @param DOMDocument $dom
97
+     */
98 98
     public function __construct(DOMDocument $dom)
99 99
     {
100 100
         $this->dom = $dom;
101 101
     }
102 102
 
103
-   /**
104
-    * @return DOMDocument
105
-    */
103
+    /**
104
+     * @return DOMDocument
105
+     */
106 106
     public function getDOM() : DOMDocument
107 107
     {
108 108
         return $this->dom;
109 109
     }
110 110
 
111
-   /**
112
-    * Adds an attribute to an existing tag with
113
-    * the specified value.
114
-    *
115
-    * @param DOMNode $parent
116
-    * @param string $name
117
-    * @param mixed $value
118
-    * @return DOMNode
119
-    */
111
+    /**
112
+     * Adds an attribute to an existing tag with
113
+     * the specified value.
114
+     *
115
+     * @param DOMNode $parent
116
+     * @param string $name
117
+     * @param mixed $value
118
+     * @return DOMNode
119
+     */
120 120
     public function addAttribute(DOMNode $parent, string $name, $value)
121 121
     {
122 122
         $node = $this->dom->createAttribute($name);
@@ -126,12 +126,12 @@  discard block
 block discarded – undo
126 126
         return $parent->appendChild($node);
127 127
     }
128 128
 
129
-   /**
130
-    * Adds several attributes to the target node.
131
-    * 
132
-    * @param DOMNode $parent
133
-    * @param array<string,mixed> $attributes
134
-    */
129
+    /**
130
+     * Adds several attributes to the target node.
131
+     * 
132
+     * @param DOMNode $parent
133
+     * @param array<string,mixed> $attributes
134
+     */
135 135
     public function addAttributes(DOMNode $parent, array $attributes) : void
136 136
     {
137 137
         foreach ($attributes as $name => $value) {
@@ -139,14 +139,14 @@  discard block
 block discarded – undo
139 139
         }
140 140
     }
141 141
 
142
-   /**
143
-    * Adds a tag without content.
144
-    *
145
-    * @param DOMNode $parent
146
-    * @param string $name
147
-    * @param integer $indent
148
-    * @return DOMNode
149
-    */
142
+    /**
143
+     * Adds a tag without content.
144
+     *
145
+     * @param DOMNode $parent
146
+     * @param string $name
147
+     * @param integer $indent
148
+     * @return DOMNode
149
+     */
150 150
     public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode
151 151
     {
152 152
         if ($indent > 0) {
@@ -168,17 +168,17 @@  discard block
 block discarded – undo
168 168
         $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount)));
169 169
     }
170 170
 
171
-   /**
172
-    * Adds a tag with textual content, like:
173
-    *
174
-    * <tagname>text</tagname>
175
-    *
176
-    * @param DOMNode $parent
177
-    * @param string $name
178
-    * @param string $text
179
-    * @param integer $indent
180
-    * @return DOMNode
181
-    */
171
+    /**
172
+     * Adds a tag with textual content, like:
173
+     *
174
+     * <tagname>text</tagname>
175
+     *
176
+     * @param DOMNode $parent
177
+     * @param string $name
178
+     * @param string $text
179
+     * @param integer $indent
180
+     * @return DOMNode
181
+     */
182 182
     public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode
183 183
     {
184 184
         if ($indent > 0) {
@@ -192,19 +192,19 @@  discard block
 block discarded – undo
192 192
         return $parent->appendChild($tag);
193 193
     }
194 194
 
195
-   /**
196
-    * Adds a tag with textual content, like:
197
-    *
198
-    * <tagname>text</tagname>
199
-    *
200
-    * and removes <p> tags
201
-    *
202
-    * @param DOMNode $parent
203
-    * @param string $name
204
-    * @param string $text
205
-    * @param integer $indent
206
-    * @return DOMNode
207
-    */
195
+    /**
196
+     * Adds a tag with textual content, like:
197
+     *
198
+     * <tagname>text</tagname>
199
+     *
200
+     * and removes <p> tags
201
+     *
202
+     * @param DOMNode $parent
203
+     * @param string $name
204
+     * @param string $text
205
+     * @param integer $indent
206
+     * @return DOMNode
207
+     */
208 208
     public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0)
209 209
     {
210 210
         if ($indent > 0) {
@@ -220,19 +220,19 @@  discard block
 block discarded – undo
220 220
         return $parent->appendChild($tag);
221 221
     }
222 222
 
223
-   /**
224
-    * Adds a tag with HTML content, like:
225
-    *
226
-    * <tagname><i>text</i></tagname>
227
-    *
228
-    * Tags will not be escaped.
229
-    *
230
-    * @param DOMNode $parent
231
-    * @param string $name
232
-    * @param string $text
233
-    * @param integer $indent
234
-    * @return DOMNode
235
-    */
223
+    /**
224
+     * Adds a tag with HTML content, like:
225
+     *
226
+     * <tagname><i>text</i></tagname>
227
+     *
228
+     * Tags will not be escaped.
229
+     *
230
+     * @param DOMNode $parent
231
+     * @param string $name
232
+     * @param string $text
233
+     * @param integer $indent
234
+     * @return DOMNode
235
+     */
236 236
     public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0)
237 237
     {
238 238
         if ($indent > 0) {
@@ -260,16 +260,16 @@  discard block
 block discarded – undo
260 260
         return $parent->appendChild($tag);
261 261
     }
262 262
 
263
-   /**
264
-    * Adds a tag with CDATA content, like:
265
-    *
266
-    * <tagname><![CDATA[value]]></tagname>
267
-    *
268
-    * @param DOMNode $parent
269
-    * @param string $name
270
-    * @param string $content
271
-    * @return DOMNode
272
-    */
263
+    /**
264
+     * Adds a tag with CDATA content, like:
265
+     *
266
+     * <tagname><![CDATA[value]]></tagname>
267
+     *
268
+     * @param DOMNode $parent
269
+     * @param string $name
270
+     * @param string $content
271
+     * @return DOMNode
272
+     */
273 273
     public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode
274 274
     {
275 275
         $tag = $this->dom->createElement($name);
@@ -279,12 +279,12 @@  discard block
 block discarded – undo
279 279
         return $parent->appendChild($tag);
280 280
     }
281 281
 
282
-   /**
283
-    * Creates the root element of the document.
284
-    * @param string $name
285
-    * @param array<string,mixed> $attributes
286
-    * @return DOMNode
287
-    */
282
+    /**
283
+     * Creates the root element of the document.
284
+     * @param string $name
285
+     * @param array<string,mixed> $attributes
286
+     * @return DOMNode
287
+     */
288 288
     public function createRoot(string $name, array $attributes=array())
289 289
     {
290 290
         $root = $this->dom->appendChild($this->dom->createElement($name));
@@ -292,12 +292,12 @@  discard block
 block discarded – undo
292 292
         return $root;
293 293
     }
294 294
 
295
-   /**
296
-    * Escaped the string for use in XML.
297
-    * 
298
-    * @param string $string
299
-    * @return string
300
-    */
295
+    /**
296
+     * Escaped the string for use in XML.
297
+     * 
298
+     * @param string $string
299
+     * @return string
300
+     */
301 301
     public function escape(string $string) : string
302 302
     {
303 303
         $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string);
@@ -317,18 +317,18 @@  discard block
 block discarded – undo
317 317
         return $string;
318 318
     }
319 319
 
320
-   /**
321
-    * Sends the specified XML string to the browser with
322
-    * the correct headers to trigger a download of the XML
323
-    * to a local file.
324
-    * 
325
-    * NOTE: Ensure calling exit after this is done, and to
326
-    * not send additional content, which would corrupt the 
327
-    * download.
328
-    *
329
-    * @param string $xml
330
-    * @param string $filename
331
-    */
320
+    /**
321
+     * Sends the specified XML string to the browser with
322
+     * the correct headers to trigger a download of the XML
323
+     * to a local file.
324
+     * 
325
+     * NOTE: Ensure calling exit after this is done, and to
326
+     * not send additional content, which would corrupt the 
327
+     * download.
328
+     *
329
+     * @param string $xml
330
+     * @param string $filename
331
+     */
332 332
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
333 333
     {
334 334
         if(!headers_sent() && !self::$simulation) 
@@ -339,12 +339,12 @@  discard block
 block discarded – undo
339 339
         echo $xml;
340 340
     }
341 341
 
342
-   /**
343
-    * Sends the specified XML string to the browser with
344
-    * the correct headers and terminates the request.
345
-    *
346
-    * @param string $xml
347
-    */
342
+    /**
343
+     * Sends the specified XML string to the browser with
344
+     * the correct headers and terminates the request.
345
+     *
346
+     * @param string $xml
347
+     */
348 348
     public static function displayXML(string $xml) : void
349 349
     {
350 350
         if(!headers_sent() && !self::$simulation) 
@@ -411,23 +411,23 @@  discard block
 block discarded – undo
411 411
         return $xml->saveXML();
412 412
     }
413 413
 
414
-   /**
415
-    * Creates XML markup to describe an application error
416
-    * when using XML services. Creates XML with the
417
-    * following structure:
418
-    *
419
-    * <error>
420
-    *     <id>99</id>
421
-    *     <message>Full error message text</message>
422
-    *     <title>Short error label</title>
423
-    * </error>
424
-    *
425
-    * @param string|number $code
426
-    * @param string $message
427
-    * @param string $title
428
-    * @param array<string,string> $customInfo
429
-    * @return string
430
-    */
414
+    /**
415
+     * Creates XML markup to describe an application error
416
+     * when using XML services. Creates XML with the
417
+     * following structure:
418
+     *
419
+     * <error>
420
+     *     <id>99</id>
421
+     *     <message>Full error message text</message>
422
+     *     <title>Short error label</title>
423
+     * </error>
424
+     *
425
+     * @param string|number $code
426
+     * @param string $message
427
+     * @param string $title
428
+     * @param array<string,string> $customInfo
429
+     * @return string
430
+     */
431 431
     public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
432 432
     {
433 433
         $xml = new DOMDocument('1.0', 'UTF-8');
@@ -460,31 +460,31 @@  discard block
 block discarded – undo
460 460
         return $this->dom->saveXML();
461 461
     }
462 462
     
463
-   /**
464
-    * Creates a new SimpleXML helper instance: this
465
-    * object is useful to work with loading XML strings
466
-    * and files with easy access to any errors that 
467
-    * may occurr, since the simplexml functions can be
468
-    * somewhat cryptic.
469
-    * 
470
-    * @return XMLHelper_SimpleXML
471
-    */
463
+    /**
464
+     * Creates a new SimpleXML helper instance: this
465
+     * object is useful to work with loading XML strings
466
+     * and files with easy access to any errors that 
467
+     * may occurr, since the simplexml functions can be
468
+     * somewhat cryptic.
469
+     * 
470
+     * @return XMLHelper_SimpleXML
471
+     */
472 472
     public static function createSimplexml() : XMLHelper_SimpleXML
473 473
     {
474 474
         return new XMLHelper_SimpleXML();
475 475
     }
476 476
     
477
-   /**
478
-    * Converts a string to valid XML: can be a text only string
479
-    * or an HTML string. Returns valid XML code.
480
-    * 
481
-    * NOTE: The string may contain custom tags, which are 
482
-    * preserved.
483
-    * 
484
-    * @param string $string
485
-    * @throws XMLHelper_Exception
486
-    * @return string
487
-    */
477
+    /**
478
+     * Converts a string to valid XML: can be a text only string
479
+     * or an HTML string. Returns valid XML code.
480
+     * 
481
+     * NOTE: The string may contain custom tags, which are 
482
+     * preserved.
483
+     * 
484
+     * @param string $string
485
+     * @throws XMLHelper_Exception
486
+     * @return string
487
+     */
488 488
     public static function string2xml(string $string) : string
489 489
     {
490 490
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();
Please login to merge, or discard this patch.
src/Highlighter.php 1 patch
Indentation   +70 added lines, -70 removed lines patch added patch discarded remove patch
@@ -41,71 +41,71 @@  discard block
 block discarded – undo
41 41
  */
42 42
 class Highlighter
43 43
 {
44
-   /**
45
-    * Creates a new GeSHi instance from a source code string.
46
-    * 
47
-    * @param string $sourceCode
48
-    * @param string $format
49
-    * @return GeSHi
50
-    */
44
+    /**
45
+     * Creates a new GeSHi instance from a source code string.
46
+     * 
47
+     * @param string $sourceCode
48
+     * @param string $format
49
+     * @return GeSHi
50
+     */
51 51
     public static function fromString(string $sourceCode, string $format) : GeSHi
52 52
     {
53 53
         return new GeSHi($sourceCode, $format);
54 54
     }
55 55
     
56
-   /**
57
-    * Creates a new GeSHi instance from the contents of a file.
58
-    * 
59
-    * @param string $path
60
-    * @param string $format
61
-    * @return GeSHi
62
-    */
56
+    /**
57
+     * Creates a new GeSHi instance from the contents of a file.
58
+     * 
59
+     * @param string $path
60
+     * @param string $format
61
+     * @return GeSHi
62
+     */
63 63
     public static function fromFile(string $path, string $format) : GeSHi
64 64
     {
65 65
         return self::fromString(FileHelper::readContents($path), $format);
66 66
     }
67 67
     
68
-   /**
69
-    * Parses and highlights the target string.
70
-    * 
71
-    * @param string $sourceCode
72
-    * @param string $format
73
-    * @return string
74
-    */
68
+    /**
69
+     * Parses and highlights the target string.
70
+     * 
71
+     * @param string $sourceCode
72
+     * @param string $format
73
+     * @return string
74
+     */
75 75
     public static function parseString(string $sourceCode, string $format) : string
76 76
     {
77 77
         return self::fromString($sourceCode, $format)->parse_code();
78 78
     }
79 79
     
80
-   /**
81
-    * Parses and highlights the contents of the target file.
82
-    * 
83
-    * @param string $path
84
-    * @param string $format
85
-    * @return string
86
-    */
80
+    /**
81
+     * Parses and highlights the contents of the target file.
82
+     * 
83
+     * @param string $path
84
+     * @param string $format
85
+     * @return string
86
+     */
87 87
     public static function parseFile(string $path, string $format) : string
88 88
     {
89 89
         return self::fromFile($path, $format)->parse_code();
90 90
     }
91 91
     
92
-   /**
93
-    * Adds HTML syntax highlighting to the specified SQL string.
94
-    *
95
-    * @param string $sql
96
-    * @return string
97
-    */
92
+    /**
93
+     * Adds HTML syntax highlighting to the specified SQL string.
94
+     *
95
+     * @param string $sql
96
+     * @return string
97
+     */
98 98
     public static function sql(string $sql) : string
99 99
     {
100 100
         return self::parseString($sql, 'sql');
101 101
     }
102 102
     
103
-   /**
104
-    * Adds HTML syntax highlighting to a JSON string, or a data array/object.
105
-    *
106
-    * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
107
-    * @return string
108
-    */
103
+    /**
104
+     * Adds HTML syntax highlighting to a JSON string, or a data array/object.
105
+     *
106
+     * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
107
+     * @return string
108
+     */
109 109
     public static function json($subject) : string
110 110
     {
111 111
         if(!is_string($subject))
@@ -118,13 +118,13 @@  discard block
 block discarded – undo
118 118
         return self::parseString($subject, 'javascript');
119 119
     }
120 120
     
121
-   /**
122
-    * Adds HTML syntax highlighting to the specified XML code.
123
-    *
124
-    * @param string $xml The XML to highlight.
125
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
126
-    * @return string
127
-    */
121
+    /**
122
+     * Adds HTML syntax highlighting to the specified XML code.
123
+     *
124
+     * @param string $xml The XML to highlight.
125
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
126
+     * @return string
127
+     */
128 128
     public static function xml(string $xml, bool $formatSource=false) : string
129 129
     {
130 130
         if($formatSource)
@@ -141,13 +141,13 @@  discard block
 block discarded – undo
141 141
         return self::parseString($xml, 'xml');
142 142
     }
143 143
     
144
-   /**
145
-    * Adds HTML syntax highlighting to the specified HTML code.
146
-    * 
147
-    * @param string $html
148
-    * @param bool $formatSource
149
-    * @return string
150
-    */
144
+    /**
145
+     * Adds HTML syntax highlighting to the specified HTML code.
146
+     * 
147
+     * @param string $html
148
+     * @param bool $formatSource
149
+     * @return string
150
+     */
151 151
     public static function html(string $html, bool $formatSource=false) : string
152 152
     {
153 153
         if($formatSource)
@@ -164,27 +164,27 @@  discard block
 block discarded – undo
164 164
         return self::parseString($html, 'xml');
165 165
     }
166 166
     
167
-   /**
168
-    * Adds HTML syntax highlighting to a bit of PHP code.
169
-    * 
170
-    * @param string $phpCode
171
-    * @return string
172
-    */
167
+    /**
168
+     * Adds HTML syntax highlighting to a bit of PHP code.
169
+     * 
170
+     * @param string $phpCode
171
+     * @return string
172
+     */
173 173
     public static function php(string $phpCode) : string
174 174
     {
175 175
         return self::parseString($phpCode, 'php');
176 176
     }
177 177
     
178
-   /**
179
-    * Adds HTML syntax highlighting to an URL.
180
-    *
181
-    * NOTE: Includes the necessary CSS styles. When
182
-    * highlighting several URLs in the same page,
183
-    * prefer using the `parseURL` function instead.
184
-    *
185
-    * @param string $url
186
-    * @return string
187
-    */
178
+    /**
179
+     * Adds HTML syntax highlighting to an URL.
180
+     *
181
+     * NOTE: Includes the necessary CSS styles. When
182
+     * highlighting several URLs in the same page,
183
+     * prefer using the `parseURL` function instead.
184
+     *
185
+     * @param string $url
186
+     * @return string
187
+     */
188 188
     public static function url(string $url) : string
189 189
     {
190 190
         $info = parseURL($url);
Please login to merge, or discard this patch.
src/ConvertHelper/TimeConverter.php 1 patch
Indentation   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -23,19 +23,19 @@  discard block
 block discarded – undo
23 23
  */
24 24
 class ConvertHelper_TimeConverter
25 25
 {
26
-   /**
27
-    * @var float
28
-    */
26
+    /**
27
+     * @var float
28
+     */
29 29
     private $seconds;
30 30
 
31
-   /**
32
-    * @var array<int,array<string,string|int>>
33
-    */
31
+    /**
32
+     * @var array<int,array<string,string|int>>
33
+     */
34 34
     private static $units;
35 35
     
36
-   /**
37
-    * @param float $seconds
38
-    */
36
+    /**
37
+     * @param float $seconds
38
+     */
39 39
     public function __construct($seconds)
40 40
     {
41 41
         $this->seconds = $seconds;   
@@ -43,9 +43,9 @@  discard block
 block discarded – undo
43 43
         $this->initUnits();
44 44
     }
45 45
     
46
-   /**
47
-    * Creates the list of units once per request as needed.
48
-    */
46
+    /**
47
+     * Creates the list of units once per request as needed.
48
+     */
49 49
     private function initUnits() : void
50 50
     {
51 51
         if(isset(self::$units))
@@ -112,11 +112,11 @@  discard block
 block discarded – undo
112 112
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
113 113
     }
114 114
     
115
-   /**
116
-    * Resolves the list of converted units.
117
-    * 
118
-    * @return string[]
119
-    */
115
+    /**
116
+     * Resolves the list of converted units.
117
+     * 
118
+     * @return string[]
119
+     */
120 120
     private function resolveTokens() : array
121 121
     {
122 122
         $seconds = $this->seconds;
Please login to merge, or discard this patch.
src/ConvertHelper.php 1 patch
Indentation   +528 added lines, -528 removed lines patch added patch discarded remove patch
@@ -55,13 +55,13 @@  discard block
 block discarded – undo
55 55
         return str_replace("\t", str_repeat(' ', $tabSize), $string);
56 56
     }
57 57
     
58
-   /**
59
-    * Converts spaces to tabs in the specified string.
60
-    * 
61
-    * @param string $string
62
-    * @param int $tabSize The amount of spaces per tab in the source string.
63
-    * @return string
64
-    */
58
+    /**
59
+     * Converts spaces to tabs in the specified string.
60
+     * 
61
+     * @param string $string
62
+     * @param int $tabSize The amount of spaces per tab in the source string.
63
+     * @return string
64
+     */
65 65
     public static function spaces2tabs(string $string, int $tabSize=4) : string
66 66
     {
67 67
         return str_replace(str_repeat(' ', $tabSize), "\t", $string);
@@ -74,133 +74,133 @@  discard block
 block discarded – undo
74 74
         return $converter->convert($string);
75 75
     }
76 76
     
77
-   /**
78
-    * Converts the specified amount of seconds into
79
-    * a human readable string split in months, weeks,
80
-    * days, hours, minutes and seconds.
81
-    *
82
-    * @param float $seconds
83
-    * @return string
84
-    */
77
+    /**
78
+     * Converts the specified amount of seconds into
79
+     * a human readable string split in months, weeks,
80
+     * days, hours, minutes and seconds.
81
+     *
82
+     * @param float $seconds
83
+     * @return string
84
+     */
85 85
     public static function time2string($seconds) : string
86 86
     {
87 87
         $converter = new ConvertHelper_TimeConverter($seconds);
88 88
         return $converter->toString();
89 89
     }
90 90
 
91
-   /**
92
-    * Converts a timestamp into an easily understandable
93
-    * format, e.g. "2 hours", "1 day", "3 months"
94
-    *
95
-    * If you set the date to parameter, the difference
96
-    * will be calculated between the two dates and not
97
-    * the current time.
98
-    *
99
-    * @param integer|\DateTime $datefrom
100
-    * @param integer|\DateTime $dateto
101
-    * @return string
102
-    */
91
+    /**
92
+     * Converts a timestamp into an easily understandable
93
+     * format, e.g. "2 hours", "1 day", "3 months"
94
+     *
95
+     * If you set the date to parameter, the difference
96
+     * will be calculated between the two dates and not
97
+     * the current time.
98
+     *
99
+     * @param integer|\DateTime $datefrom
100
+     * @param integer|\DateTime $dateto
101
+     * @return string
102
+     */
103 103
     public static function duration2string($datefrom, $dateto = -1) : string
104 104
     {
105
-         $converter = new ConvertHelper_DurationConverter();
105
+            $converter = new ConvertHelper_DurationConverter();
106 106
          
107
-         if($datefrom instanceof \DateTime)
108
-         {
109
-             $converter->setDateFrom($datefrom);
110
-         }
111
-         else
112
-         {
113
-             $converter->setDateFrom(self::timestamp2date($datefrom)); 
114
-         }
107
+            if($datefrom instanceof \DateTime)
108
+            {
109
+                $converter->setDateFrom($datefrom);
110
+            }
111
+            else
112
+            {
113
+                $converter->setDateFrom(self::timestamp2date($datefrom)); 
114
+            }
115 115
 
116
-         if($dateto instanceof \DateTime)
117
-         {
118
-             $converter->setDateTo($dateto);
119
-         }
120
-         else if($dateto > 0)
121
-         {
122
-             $converter->setDateTo(self::timestamp2date($dateto));
123
-         }
116
+            if($dateto instanceof \DateTime)
117
+            {
118
+                $converter->setDateTo($dateto);
119
+            }
120
+            else if($dateto > 0)
121
+            {
122
+                $converter->setDateTo(self::timestamp2date($dateto));
123
+            }
124 124
 
125
-         return $converter->convert();
125
+            return $converter->convert();
126 126
     }
127 127
 
128
-   /**
129
-    * Adds HTML syntax highlighting to the specified SQL string.
130
-    * 
131
-    * @param string $sql
132
-    * @return string
133
-    * @deprecated Use the Highlighter class directly instead.
134
-    * @see Highlighter::sql()
135
-    */
128
+    /**
129
+     * Adds HTML syntax highlighting to the specified SQL string.
130
+     * 
131
+     * @param string $sql
132
+     * @return string
133
+     * @deprecated Use the Highlighter class directly instead.
134
+     * @see Highlighter::sql()
135
+     */
136 136
     public static function highlight_sql(string $sql) : string
137 137
     {
138 138
         return Highlighter::sql($sql);
139 139
     }
140 140
 
141
-   /**
142
-    * Adds HTML syntax highlighting to the specified XML code.
143
-    * 
144
-    * @param string $xml The XML to highlight.
145
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
146
-    * @return string
147
-    * @deprecated Use the Highlighter class directly instead.
148
-    * @see Highlighter::xml()
149
-    */
141
+    /**
142
+     * Adds HTML syntax highlighting to the specified XML code.
143
+     * 
144
+     * @param string $xml The XML to highlight.
145
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
146
+     * @return string
147
+     * @deprecated Use the Highlighter class directly instead.
148
+     * @see Highlighter::xml()
149
+     */
150 150
     public static function highlight_xml(string $xml, bool $formatSource=false) : string
151 151
     {
152 152
         return Highlighter::xml($xml, $formatSource);
153 153
     }
154 154
 
155
-   /**
156
-    * @param string $phpCode
157
-    * @return string
158
-    * @deprecated Use the Highlighter class directly instead.
159
-    * @see Highlighter::php()
160
-    */
155
+    /**
156
+     * @param string $phpCode
157
+     * @return string
158
+     * @deprecated Use the Highlighter class directly instead.
159
+     * @see Highlighter::php()
160
+     */
161 161
     public static function highlight_php(string $phpCode) : string
162 162
     {
163 163
         return Highlighter::php($phpCode);
164 164
     }
165 165
     
166
-   /**
167
-    * Converts a number of bytes to a human readable form,
168
-    * e.g. xx Kb / xx Mb / xx Gb
169
-    *
170
-    * @param int $bytes The amount of bytes to convert.
171
-    * @param int $precision The amount of decimals
172
-    * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
173
-    * @return string
174
-    * 
175
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
176
-    */
166
+    /**
167
+     * Converts a number of bytes to a human readable form,
168
+     * e.g. xx Kb / xx Mb / xx Gb
169
+     *
170
+     * @param int $bytes The amount of bytes to convert.
171
+     * @param int $precision The amount of decimals
172
+     * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
173
+     * @return string
174
+     * 
175
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
176
+     */
177 177
     public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string
178 178
     {
179 179
         return self::parseBytes($bytes)->toString($precision, $base);
180 180
     }
181 181
     
182
-   /**
183
-    * Parses a number of bytes, and creates a converter instance which
184
-    * allows doing common operations with it.
185
-    * 
186
-    * @param int $bytes
187
-    * @return ConvertHelper_ByteConverter
188
-    */
182
+    /**
183
+     * Parses a number of bytes, and creates a converter instance which
184
+     * allows doing common operations with it.
185
+     * 
186
+     * @param int $bytes
187
+     * @return ConvertHelper_ByteConverter
188
+     */
189 189
     public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter
190 190
     {
191 191
         return new ConvertHelper_ByteConverter($bytes);
192 192
     }
193 193
 
194
-   /**
195
-    * Cuts a text to the specified length if it is longer than the
196
-    * target length. Appends a text to signify it has been cut at 
197
-    * the end of the string.
198
-    * 
199
-    * @param string $text
200
-    * @param int $targetLength
201
-    * @param string $append
202
-    * @return string
203
-    */
194
+    /**
195
+     * Cuts a text to the specified length if it is longer than the
196
+     * target length. Appends a text to signify it has been cut at 
197
+     * the end of the string.
198
+     * 
199
+     * @param string $text
200
+     * @param int $targetLength
201
+     * @param string $append
202
+     * @return string
203
+     */
204 204
     public static function text_cut(string $text, int $targetLength, string $append = '...') : string
205 205
     {
206 206
         $length = mb_strlen($text);
@@ -224,14 +224,14 @@  discard block
 block discarded – undo
224 224
         return $info->toString();
225 225
     }
226 226
     
227
-   /**
228
-    * Pretty print_r.
229
-    * 
230
-    * @param mixed $var The variable to dump.
231
-    * @param bool $return Whether to return the dumped code.
232
-    * @param bool $html Whether to style the dump as HTML.
233
-    * @return string
234
-    */
227
+    /**
228
+     * Pretty print_r.
229
+     * 
230
+     * @param mixed $var The variable to dump.
231
+     * @param bool $return Whether to return the dumped code.
232
+     * @param bool $html Whether to style the dump as HTML.
233
+     * @return string
234
+     */
235 235
     public static function print_r($var, bool $return=false, bool $html=true) : string
236 236
     {
237 237
         $result = parseVariable($var)->enableType()->toString();
@@ -252,9 +252,9 @@  discard block
 block discarded – undo
252 252
         return $result;
253 253
     }
254 254
     
255
-   /**
256
-    * @var array<mixed,bool>
257
-    */
255
+    /**
256
+     * @var array<mixed,bool>
257
+     */
258 258
     protected static $booleanStrings = array(
259 259
         1 => true,
260 260
         0 => false,
@@ -264,15 +264,15 @@  discard block
 block discarded – undo
264 264
         'no' => false
265 265
     );
266 266
 
267
-   /**
268
-    * Converts a string, number or boolean value to a boolean value.
269
-    * 
270
-    * @param mixed $string
271
-    * @throws ConvertHelper_Exception
272
-    * @return bool
273
-    * 
274
-    * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
275
-    */
267
+    /**
268
+     * Converts a string, number or boolean value to a boolean value.
269
+     * 
270
+     * @param mixed $string
271
+     * @throws ConvertHelper_Exception
272
+     * @return bool
273
+     * 
274
+     * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
275
+     */
276 276
     public static function string2bool($string) : bool
277 277
     {
278 278
         if($string === '' || $string === null || !is_scalar($string)) 
@@ -300,27 +300,27 @@  discard block
 block discarded – undo
300 300
         );
301 301
     }
302 302
     
303
-   /**
304
-    * Whether the specified string is a boolean string or boolean value.
305
-    * Alias for {@link ConvertHelper::isBoolean()}.
306
-    * 
307
-    * @param mixed $string
308
-    * @return bool
309
-    * @deprecated
310
-    * @see ConvertHelper::isBoolean()
311
-    */
303
+    /**
304
+     * Whether the specified string is a boolean string or boolean value.
305
+     * Alias for {@link ConvertHelper::isBoolean()}.
306
+     * 
307
+     * @param mixed $string
308
+     * @return bool
309
+     * @deprecated
310
+     * @see ConvertHelper::isBoolean()
311
+     */
312 312
     public static function isBooleanString($string) : bool
313 313
     {
314 314
         return self::isBoolean($string);
315 315
     }
316 316
 
317
-   /**
318
-    * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
319
-    * 
320
-    * @param string $text
321
-    * @return string
322
-    * @deprecated
323
-    */
317
+    /**
318
+     * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
319
+     * 
320
+     * @param string $text
321
+     * @return string
322
+     * @deprecated
323
+     */
324 324
     public static function text_makeXMLCompliant($text)
325 325
     {
326 326
         return XMLHelper::string2xml($text);
@@ -422,80 +422,80 @@  discard block
 block discarded – undo
422 422
         return $translit->convert($string);
423 423
     }
424 424
     
425
-   /**
426
-    * Retrieves the HEX character codes for all control
427
-    * characters that the {@link stripControlCharacters()} 
428
-    * method will remove.
429
-    * 
430
-    * @return string[]
431
-    */
425
+    /**
426
+     * Retrieves the HEX character codes for all control
427
+     * characters that the {@link stripControlCharacters()} 
428
+     * method will remove.
429
+     * 
430
+     * @return string[]
431
+     */
432 432
     public static function getControlCharactersAsHex()
433 433
     {
434 434
         return self::createControlCharacters()->getCharsAsHex();
435 435
     }
436 436
     
437
-   /**
438
-    * Retrieves an array of all control characters that
439
-    * the {@link stripControlCharacters()} method will 
440
-    * remove, as the actual UTF-8 characters.
441
-    * 
442
-    * @return string[]
443
-    */
437
+    /**
438
+     * Retrieves an array of all control characters that
439
+     * the {@link stripControlCharacters()} method will 
440
+     * remove, as the actual UTF-8 characters.
441
+     * 
442
+     * @return string[]
443
+     */
444 444
     public static function getControlCharactersAsUTF8()
445 445
     {
446 446
         return self::createControlCharacters()->getCharsAsUTF8();
447 447
     }
448 448
     
449
-   /**
450
-    * Retrieves all control characters as JSON encoded
451
-    * characters, e.g. "\u200b".
452
-    * 
453
-    * @return string[]
454
-    */
449
+    /**
450
+     * Retrieves all control characters as JSON encoded
451
+     * characters, e.g. "\u200b".
452
+     * 
453
+     * @return string[]
454
+     */
455 455
     public static function getControlCharactersAsJSON()
456 456
     {
457 457
         return self::createControlCharacters()->getCharsAsJSON();
458 458
     }
459 459
     
460
-   /**
461
-    * Removes all control characters from the specified string
462
-    * that can cause problems in some cases, like creating
463
-    * valid XML documents. This includes invisible non-breaking
464
-    * spaces.
465
-    *
466
-    * @param string $string
467
-    * @return string
468
-    */
460
+    /**
461
+     * Removes all control characters from the specified string
462
+     * that can cause problems in some cases, like creating
463
+     * valid XML documents. This includes invisible non-breaking
464
+     * spaces.
465
+     *
466
+     * @param string $string
467
+     * @return string
468
+     */
469 469
     public static function stripControlCharacters(string $string) : string
470 470
     {
471 471
         return self::createControlCharacters()->stripControlCharacters($string);
472 472
     }
473 473
     
474
-   /**
475
-    * Creates the control characters class, used to 
476
-    * work with control characters in strings.
477
-    * 
478
-    * @return ConvertHelper_ControlCharacters
479
-    */
474
+    /**
475
+     * Creates the control characters class, used to 
476
+     * work with control characters in strings.
477
+     * 
478
+     * @return ConvertHelper_ControlCharacters
479
+     */
480 480
     public static function createControlCharacters() : ConvertHelper_ControlCharacters
481 481
     {
482 482
         return new ConvertHelper_ControlCharacters();
483 483
     }
484 484
 
485
-   /**
486
-    * Converts a unicode character to the PHPO notation.
487
-    * 
488
-    * Example:
489
-    * 
490
-    * <pre>unicodeChar2php('"\u0000"')</pre>
491
-    * 
492
-    * Returns
493
-    * 
494
-    * <pre>\x0</pre>
495
-    * 
496
-    * @param string $unicodeChar
497
-    * @return string
498
-    */
485
+    /**
486
+     * Converts a unicode character to the PHPO notation.
487
+     * 
488
+     * Example:
489
+     * 
490
+     * <pre>unicodeChar2php('"\u0000"')</pre>
491
+     * 
492
+     * Returns
493
+     * 
494
+     * <pre>\x0</pre>
495
+     * 
496
+     * @param string $unicodeChar
497
+     * @return string
498
+     */
499 499
     public static function unicodeChar2php(string $unicodeChar) : string 
500 500
     {
501 501
         $unicodeChar = json_decode($unicodeChar);
@@ -621,25 +621,25 @@  discard block
 block discarded – undo
621 621
         return 'false';
622 622
     }
623 623
     
624
-   /**
625
-    * Converts an associative array with attribute name > value pairs
626
-    * to an attribute string that can be used in an HTML tag. Empty 
627
-    * attribute values are ignored.
628
-    * 
629
-    * Example:
630
-    * 
631
-    * array2attributeString(array(
632
-    *     'id' => 45,
633
-    *     'href' => 'http://www.mistralys.com'
634
-    * ));
635
-    * 
636
-    * Result:
637
-    * 
638
-    * id="45" href="http://www.mistralys.com"
639
-    * 
640
-    * @param array $array
641
-    * @return string
642
-    */
624
+    /**
625
+     * Converts an associative array with attribute name > value pairs
626
+     * to an attribute string that can be used in an HTML tag. Empty 
627
+     * attribute values are ignored.
628
+     * 
629
+     * Example:
630
+     * 
631
+     * array2attributeString(array(
632
+     *     'id' => 45,
633
+     *     'href' => 'http://www.mistralys.com'
634
+     * ));
635
+     * 
636
+     * Result:
637
+     * 
638
+     * id="45" href="http://www.mistralys.com"
639
+     * 
640
+     * @param array $array
641
+     * @return string
642
+     */
643 643
     public static function array2attributeString($array)
644 644
     {
645 645
         $tokens = array();
@@ -658,14 +658,14 @@  discard block
 block discarded – undo
658 658
         return ' '.implode(' ', $tokens);
659 659
     }
660 660
     
661
-   /**
662
-    * Converts a string so it can safely be used in a javascript
663
-    * statement in an HTML tag: uses single quotes around the string
664
-    * and encodes all special characters as needed.
665
-    * 
666
-    * @param string $string
667
-    * @return string
668
-    */
661
+    /**
662
+     * Converts a string so it can safely be used in a javascript
663
+     * statement in an HTML tag: uses single quotes around the string
664
+     * and encodes all special characters as needed.
665
+     * 
666
+     * @param string $string
667
+     * @return string
668
+     */
669 669
     public static function string2attributeJS($string, $quoted=true)
670 670
     {
671 671
         $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8'));
@@ -676,15 +676,15 @@  discard block
 block discarded – undo
676 676
         return $converted;
677 677
     }
678 678
     
679
-   /**
680
-    * Checks if the specified string is a boolean value, which
681
-    * includes string representations of boolean values, like 
682
-    * <code>yes</code> or <code>no</code>, and <code>true</code>
683
-    * or <code>false</code>.
684
-    * 
685
-    * @param mixed $value
686
-    * @return boolean
687
-    */
679
+    /**
680
+     * Checks if the specified string is a boolean value, which
681
+     * includes string representations of boolean values, like 
682
+     * <code>yes</code> or <code>no</code>, and <code>true</code>
683
+     * or <code>false</code>.
684
+     * 
685
+     * @param mixed $value
686
+     * @return boolean
687
+     */
688 688
     public static function isBoolean($value) : bool
689 689
     {
690 690
         if(is_bool($value)) {
@@ -698,12 +698,12 @@  discard block
 block discarded – undo
698 698
         return array_key_exists($value, self::$booleanStrings);
699 699
     }
700 700
     
701
-   /**
702
-    * Converts an associative array to an HTML style attribute value string.
703
-    * 
704
-    * @param array $subject
705
-    * @return string
706
-    */
701
+    /**
702
+     * Converts an associative array to an HTML style attribute value string.
703
+     * 
704
+     * @param array $subject
705
+     * @return string
706
+     */
707 707
     public static function array2styleString(array $subject) : string
708 708
     {
709 709
         $tokens = array();
@@ -714,23 +714,23 @@  discard block
 block discarded – undo
714 714
         return implode(';', $tokens);
715 715
     }
716 716
     
717
-   /**
718
-    * Converts a DateTime object to a timestamp, which
719
-    * is PHP 5.2 compatible.
720
-    * 
721
-    * @param \DateTime $date
722
-    * @return integer
723
-    */
717
+    /**
718
+     * Converts a DateTime object to a timestamp, which
719
+     * is PHP 5.2 compatible.
720
+     * 
721
+     * @param \DateTime $date
722
+     * @return integer
723
+     */
724 724
     public static function date2timestamp(\DateTime $date) : int
725 725
     {
726 726
         return (int)$date->format('U');
727 727
     }
728 728
     
729
-   /**
730
-    * Converts a timestamp into a DateTime instance.
731
-    * @param int $timestamp
732
-    * @return \DateTime
733
-    */
729
+    /**
730
+     * Converts a timestamp into a DateTime instance.
731
+     * @param int $timestamp
732
+     * @return \DateTime
733
+     */
734 734
     public static function timestamp2date(int $timestamp) : \DateTime
735 735
     {
736 736
         $date = new \DateTime();
@@ -738,50 +738,50 @@  discard block
 block discarded – undo
738 738
         return $date;
739 739
     }
740 740
     
741
-   /**
742
-    * Strips an absolute path to a file within the application
743
-    * to make the path relative to the application root path.
744
-    * 
745
-    * @param string $path
746
-    * @return string
747
-    * 
748
-    * @see FileHelper::relativizePath()
749
-    * @see FileHelper::relativizePathByDepth()
750
-    */
741
+    /**
742
+     * Strips an absolute path to a file within the application
743
+     * to make the path relative to the application root path.
744
+     * 
745
+     * @param string $path
746
+     * @return string
747
+     * 
748
+     * @see FileHelper::relativizePath()
749
+     * @see FileHelper::relativizePathByDepth()
750
+     */
751 751
     public static function fileRelativize(string $path) : string
752 752
     {
753 753
         return FileHelper::relativizePathByDepth($path);
754 754
     }
755 755
     
756 756
     /**
757
-    * Converts a PHP regex to a javascript RegExp object statement.
758
-    * 
759
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
760
-    * More details are available on its usage there.
761
-    *
762
-    * @param string $regex A PHP preg regex
763
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
764
-    * @return array|string Depending on the specified return type.
765
-    * 
766
-    * @see JSHelper::buildRegexStatement()
767
-    */
757
+     * Converts a PHP regex to a javascript RegExp object statement.
758
+     * 
759
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
760
+     * More details are available on its usage there.
761
+     *
762
+     * @param string $regex A PHP preg regex
763
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
764
+     * @return array|string Depending on the specified return type.
765
+     * 
766
+     * @see JSHelper::buildRegexStatement()
767
+     */
768 768
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
769 769
     {
770 770
         return JSHelper::buildRegexStatement($regex, $statementType);
771 771
     }
772 772
     
773
-   /**
774
-    * Converts the specified variable to JSON. Works just
775
-    * like the native `json_encode` method, except that it
776
-    * will trigger an exception on failure, which has the 
777
-    * json error details included in its developer details.
778
-    * 
779
-    * @param mixed $variable
780
-    * @param int $options JSON encode options.
781
-    * @param int $depth 
782
-    * @throws ConvertHelper_Exception
783
-    * @return string
784
-    */
773
+    /**
774
+     * Converts the specified variable to JSON. Works just
775
+     * like the native `json_encode` method, except that it
776
+     * will trigger an exception on failure, which has the 
777
+     * json error details included in its developer details.
778
+     * 
779
+     * @param mixed $variable
780
+     * @param int $options JSON encode options.
781
+     * @param int $depth 
782
+     * @throws ConvertHelper_Exception
783
+     * @return string
784
+     */
785 785
     public static function var2json($variable, int $options=0, int $depth=512) : string
786 786
     {
787 787
         $result = json_encode($variable, $options, $depth);
@@ -802,12 +802,12 @@  discard block
 block discarded – undo
802 802
         );
803 803
     }
804 804
     
805
-   /**
806
-    * Strips all known UTF byte order marks from the specified string.
807
-    * 
808
-    * @param string $string
809
-    * @return string
810
-    */
805
+    /**
806
+     * Strips all known UTF byte order marks from the specified string.
807
+     * 
808
+     * @param string $string
809
+     * @return string
810
+     */
811 811
     public static function stripUTFBom($string)
812 812
     {
813 813
         $boms = FileHelper::getUTFBOMs();
@@ -822,13 +822,13 @@  discard block
 block discarded – undo
822 822
         return $string;
823 823
     }
824 824
 
825
-   /**
826
-    * Converts a string to valid utf8, regardless
827
-    * of the string's encoding(s).
828
-    * 
829
-    * @param string $string
830
-    * @return string
831
-    */
825
+    /**
826
+     * Converts a string to valid utf8, regardless
827
+     * of the string's encoding(s).
828
+     * 
829
+     * @param string $string
830
+     * @return string
831
+     */
832 832
     public static function string2utf8($string)
833 833
     {
834 834
         if(!self::isStringASCII($string)) {
@@ -838,15 +838,15 @@  discard block
 block discarded – undo
838 838
         return $string;
839 839
     }
840 840
     
841
-   /**
842
-    * Checks whether the specified string is an ASCII
843
-    * string, without any special or UTF8 characters.
844
-    * Note: empty strings and NULL are considered ASCII.
845
-    * Any variable types other than strings are not.
846
-    * 
847
-    * @param mixed $string
848
-    * @return boolean
849
-    */
841
+    /**
842
+     * Checks whether the specified string is an ASCII
843
+     * string, without any special or UTF8 characters.
844
+     * Note: empty strings and NULL are considered ASCII.
845
+     * Any variable types other than strings are not.
846
+     * 
847
+     * @param mixed $string
848
+     * @return boolean
849
+     */
850 850
     public static function isStringASCII($string) : bool
851 851
     {
852 852
         if($string === '' || $string === NULL) {
@@ -860,39 +860,39 @@  discard block
 block discarded – undo
860 860
         return !preg_match('/[^\x00-\x7F]/', $string);
861 861
     }
862 862
     
863
-   /**
864
-    * Adds HTML syntax highlighting to an URL.
865
-    * 
866
-    * NOTE: Includes the necessary CSS styles. When
867
-    * highlighting several URLs in the same page,
868
-    * prefer using the `parseURL` function instead.
869
-    * 
870
-    * @param string $url
871
-    * @return string
872
-    * @deprecated Use the Highlighter class directly instead.
873
-    * @see Highlighter
874
-    */
863
+    /**
864
+     * Adds HTML syntax highlighting to an URL.
865
+     * 
866
+     * NOTE: Includes the necessary CSS styles. When
867
+     * highlighting several URLs in the same page,
868
+     * prefer using the `parseURL` function instead.
869
+     * 
870
+     * @param string $url
871
+     * @return string
872
+     * @deprecated Use the Highlighter class directly instead.
873
+     * @see Highlighter
874
+     */
875 875
     public static function highlight_url(string $url) : string
876 876
     {
877 877
         return Highlighter::url($url);
878 878
     }
879 879
 
880
-   /**
881
-    * Calculates a percentage match of the source string with the target string.
882
-    * 
883
-    * Options are:
884
-    * 
885
-    * - maxLevenshtein, default: 10
886
-    *   Any levenshtein results above this value are ignored.
887
-    *   
888
-    * - precision, default: 1
889
-    *   The precision of the percentage float value
890
-    * 
891
-    * @param string $source
892
-    * @param string $target
893
-    * @param array $options
894
-    * @return float
895
-    */
880
+    /**
881
+     * Calculates a percentage match of the source string with the target string.
882
+     * 
883
+     * Options are:
884
+     * 
885
+     * - maxLevenshtein, default: 10
886
+     *   Any levenshtein results above this value are ignored.
887
+     *   
888
+     * - precision, default: 1
889
+     *   The precision of the percentage float value
890
+     * 
891
+     * @param string $source
892
+     * @param string $target
893
+     * @param array $options
894
+     * @return float
895
+     */
896 896
     public static function matchString($source, $target, $options=array())
897 897
     {
898 898
         $defaults = array(
@@ -916,14 +916,14 @@  discard block
 block discarded – undo
916 916
         return round(100 - $percent, $options['precision']);
917 917
     }
918 918
     
919
-   /**
920
-    * Converts a date interval to a human readable string with
921
-    * all necessary time components, e.g. "1 year, 2 months and 4 days".
922
-    * 
923
-    * @param \DateInterval $interval
924
-    * @return string
925
-    * @see ConvertHelper_IntervalConverter
926
-    */
919
+    /**
920
+     * Converts a date interval to a human readable string with
921
+     * all necessary time components, e.g. "1 year, 2 months and 4 days".
922
+     * 
923
+     * @param \DateInterval $interval
924
+     * @return string
925
+     * @see ConvertHelper_IntervalConverter
926
+     */
927 927
     public static function interval2string(\DateInterval $interval) : string
928 928
     {
929 929
         $converter = new ConvertHelper_IntervalConverter();
@@ -938,60 +938,60 @@  discard block
 block discarded – undo
938 938
     
939 939
     const INTERVAL_SECONDS = 'seconds';
940 940
     
941
-   /**
942
-    * Converts an interval to its total amount of days.
943
-    * @param \DateInterval $interval
944
-    * @return int
945
-    */
941
+    /**
942
+     * Converts an interval to its total amount of days.
943
+     * @param \DateInterval $interval
944
+     * @return int
945
+     */
946 946
     public static function interval2days(\DateInterval $interval) : int
947 947
     {
948 948
         return self::interval2total($interval, self::INTERVAL_DAYS);
949 949
     }
950 950
 
951
-   /**
952
-    * Converts an interval to its total amount of hours.
953
-    * @param \DateInterval $interval
954
-    * @return int
955
-    */
951
+    /**
952
+     * Converts an interval to its total amount of hours.
953
+     * @param \DateInterval $interval
954
+     * @return int
955
+     */
956 956
     public static function interval2hours(\DateInterval $interval) : int
957 957
     {
958 958
         return self::interval2total($interval, self::INTERVAL_HOURS);
959 959
     }
960 960
     
961
-   /**
962
-    * Converts an interval to its total amount of minutes. 
963
-    * @param \DateInterval $interval
964
-    * @return int
965
-    */
961
+    /**
962
+     * Converts an interval to its total amount of minutes. 
963
+     * @param \DateInterval $interval
964
+     * @return int
965
+     */
966 966
     public static function interval2minutes(\DateInterval $interval) : int
967 967
     {
968 968
         return self::interval2total($interval, self::INTERVAL_MINUTES);
969 969
     }
970 970
     
971
-   /**
972
-    * Converts an interval to its total amount of seconds.
973
-    * @param \DateInterval $interval
974
-    * @return int
975
-    */    
971
+    /**
972
+     * Converts an interval to its total amount of seconds.
973
+     * @param \DateInterval $interval
974
+     * @return int
975
+     */    
976 976
     public static function interval2seconds(\DateInterval $interval) : int
977 977
     {
978 978
         return self::interval2total($interval, self::INTERVAL_SECONDS);
979 979
     }
980 980
     
981
-   /**
982
-    * Calculates the total amount of days / hours / minutes or seconds
983
-    * of a date interval object (depending in the specified units), and 
984
-    * returns the total amount.
985
-    * 
986
-    * @param \DateInterval $interval
987
-    * @param string $unit What total value to calculate.
988
-    * @return integer
989
-    * 
990
-    * @see ConvertHelper::INTERVAL_SECONDS
991
-    * @see ConvertHelper::INTERVAL_MINUTES
992
-    * @see ConvertHelper::INTERVAL_HOURS
993
-    * @see ConvertHelper::INTERVAL_DAYS
994
-    */
981
+    /**
982
+     * Calculates the total amount of days / hours / minutes or seconds
983
+     * of a date interval object (depending in the specified units), and 
984
+     * returns the total amount.
985
+     * 
986
+     * @param \DateInterval $interval
987
+     * @param string $unit What total value to calculate.
988
+     * @return integer
989
+     * 
990
+     * @see ConvertHelper::INTERVAL_SECONDS
991
+     * @see ConvertHelper::INTERVAL_MINUTES
992
+     * @see ConvertHelper::INTERVAL_HOURS
993
+     * @see ConvertHelper::INTERVAL_DAYS
994
+     */
995 995
     public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
996 996
     {
997 997
         $total = (int)$interval->format('%a');
@@ -1031,13 +1031,13 @@  discard block
 block discarded – undo
1031 1031
         'Sunday'
1032 1032
     );
1033 1033
     
1034
-   /**
1035
-    * Converts a date to the corresponding day name.
1036
-    * 
1037
-    * @param \DateTime $date
1038
-    * @param bool $short
1039
-    * @return string|NULL
1040
-    */
1034
+    /**
1035
+     * Converts a date to the corresponding day name.
1036
+     * 
1037
+     * @param \DateTime $date
1038
+     * @param bool $short
1039
+     * @return string|NULL
1040
+     */
1041 1041
     public static function date2dayName(\DateTime $date, bool $short=false)
1042 1042
     {
1043 1043
         $day = $date->format('l');
@@ -1052,21 +1052,21 @@  discard block
 block discarded – undo
1052 1052
         return null;
1053 1053
     }
1054 1054
     
1055
-   /**
1056
-    * Retrieves a list of english day names.
1057
-    * @return string[]
1058
-    */
1055
+    /**
1056
+     * Retrieves a list of english day names.
1057
+     * @return string[]
1058
+     */
1059 1059
     public static function getDayNamesInvariant()
1060 1060
     {
1061 1061
         return self::$daysInvariant;
1062 1062
     }
1063 1063
     
1064
-   /**
1065
-    * Retrieves the day names list for the current locale.
1066
-    * 
1067
-    * @param bool $short
1068
-    * @return array
1069
-    */
1064
+    /**
1065
+     * Retrieves the day names list for the current locale.
1066
+     * 
1067
+     * @param bool $short
1068
+     * @return array
1069
+     */
1070 1070
     public static function getDayNames(bool $short=false) : array
1071 1071
     {
1072 1072
         if($short) {
@@ -1126,16 +1126,16 @@  discard block
 block discarded – undo
1126 1126
         return $last;
1127 1127
     }
1128 1128
     
1129
-   /**
1130
-    * Splits a string into an array of all characters it is composed of.
1131
-    * Unicode character safe.
1132
-    * 
1133
-    * NOTE: Spaces and newlines (both \r and \n) are also considered single
1134
-    * characters.
1135
-    * 
1136
-    * @param string $string
1137
-    * @return array
1138
-    */
1129
+    /**
1130
+     * Splits a string into an array of all characters it is composed of.
1131
+     * Unicode character safe.
1132
+     * 
1133
+     * NOTE: Spaces and newlines (both \r and \n) are also considered single
1134
+     * characters.
1135
+     * 
1136
+     * @param string $string
1137
+     * @return array
1138
+     */
1139 1139
     public static function string2array(string $string) : array
1140 1140
     {
1141 1141
         $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY);
@@ -1146,12 +1146,12 @@  discard block
 block discarded – undo
1146 1146
         return array();
1147 1147
     }
1148 1148
     
1149
-   /**
1150
-    * Checks whether the specified string contains HTML code.
1151
-    * 
1152
-    * @param string $string
1153
-    * @return boolean
1154
-    */
1149
+    /**
1150
+     * Checks whether the specified string contains HTML code.
1151
+     * 
1152
+     * @param string $string
1153
+     * @return boolean
1154
+     */
1155 1155
     public static function isStringHTML(string $string) : bool
1156 1156
     {
1157 1157
         if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
@@ -1166,17 +1166,17 @@  discard block
 block discarded – undo
1166 1166
         return false;
1167 1167
     }
1168 1168
     
1169
-   /**
1170
-    * UTF8-safe wordwrap method: works like the regular wordwrap
1171
-    * PHP function but compatible with UTF8. Otherwise the lengths
1172
-    * are not calculated correctly.
1173
-    * 
1174
-    * @param string $str
1175
-    * @param int $width
1176
-    * @param string $break
1177
-    * @param bool $cut
1178
-    * @return string
1179
-    */
1169
+    /**
1170
+     * UTF8-safe wordwrap method: works like the regular wordwrap
1171
+     * PHP function but compatible with UTF8. Otherwise the lengths
1172
+     * are not calculated correctly.
1173
+     * 
1174
+     * @param string $str
1175
+     * @param int $width
1176
+     * @param string $break
1177
+     * @param bool $cut
1178
+     * @return string
1179
+     */
1180 1180
     public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string 
1181 1181
     {
1182 1182
         $wrapper = new ConvertHelper_WordWrapper();
@@ -1188,27 +1188,27 @@  discard block
 block discarded – undo
1188 1188
         ->wrapText($str);
1189 1189
     }
1190 1190
     
1191
-   /**
1192
-    * Calculates the byte length of a string, taking into 
1193
-    * account any unicode characters.
1194
-    * 
1195
-    * @param string $string
1196
-    * @return int
1197
-    * @see https://stackoverflow.com/a/9718273/2298192
1198
-    */
1191
+    /**
1192
+     * Calculates the byte length of a string, taking into 
1193
+     * account any unicode characters.
1194
+     * 
1195
+     * @param string $string
1196
+     * @return int
1197
+     * @see https://stackoverflow.com/a/9718273/2298192
1198
+     */
1199 1199
     public static function string2bytes($string)
1200 1200
     {
1201 1201
         return mb_strlen($string, '8bit');
1202 1202
     }
1203 1203
     
1204
-   /**
1205
-    * Creates a short, 8-character long hash for the specified string.
1206
-    * 
1207
-    * WARNING: Not cryptographically safe.
1208
-    * 
1209
-    * @param string $string
1210
-    * @return string
1211
-    */
1204
+    /**
1205
+     * Creates a short, 8-character long hash for the specified string.
1206
+     * 
1207
+     * WARNING: Not cryptographically safe.
1208
+     * 
1209
+     * @param string $string
1210
+     * @return string
1211
+     */
1212 1212
     public static function string2shortHash($string)
1213 1213
     {
1214 1214
         return hash('crc32', $string, false);
@@ -1234,40 +1234,40 @@  discard block
 block discarded – undo
1234 1234
         return ConvertHelper_ThrowableInfo::fromThrowable($e);
1235 1235
     }
1236 1236
     
1237
-   /**
1238
-    * Parses the specified query string like the native 
1239
-    * function <code>parse_str</code>, without the key
1240
-    * naming limitations.
1241
-    * 
1242
-    * Using parse_str, dots or spaces in key names are 
1243
-    * replaced by underscores. This method keeps all names
1244
-    * intact.
1245
-    * 
1246
-    * It still uses the parse_str implementation as it 
1247
-    * is tested and tried, but fixes the parameter names
1248
-    * after parsing, as needed.
1249
-    * 
1250
-    * @param string $queryString
1251
-    * @return array
1252
-    * @see ConvertHelper_QueryParser
1253
-    */
1237
+    /**
1238
+     * Parses the specified query string like the native 
1239
+     * function <code>parse_str</code>, without the key
1240
+     * naming limitations.
1241
+     * 
1242
+     * Using parse_str, dots or spaces in key names are 
1243
+     * replaced by underscores. This method keeps all names
1244
+     * intact.
1245
+     * 
1246
+     * It still uses the parse_str implementation as it 
1247
+     * is tested and tried, but fixes the parameter names
1248
+     * after parsing, as needed.
1249
+     * 
1250
+     * @param string $queryString
1251
+     * @return array
1252
+     * @see ConvertHelper_QueryParser
1253
+     */
1254 1254
     public static function parseQueryString(string $queryString) : array
1255 1255
     {
1256 1256
         $parser = new ConvertHelper_QueryParser();
1257 1257
         return $parser->parse($queryString);
1258 1258
     }
1259 1259
 
1260
-   /**
1261
-    * Searches for needle in the specified string, and returns a list
1262
-    * of all occurrences, including the matched string. The matched 
1263
-    * string is useful when doing a case insensitive search, as it 
1264
-    * shows the exact matched case of needle.
1265
-    *   
1266
-    * @param string $needle
1267
-    * @param string $haystack
1268
-    * @param bool $caseInsensitive
1269
-    * @return ConvertHelper_StringMatch[]
1270
-    */
1260
+    /**
1261
+     * Searches for needle in the specified string, and returns a list
1262
+     * of all occurrences, including the matched string. The matched 
1263
+     * string is useful when doing a case insensitive search, as it 
1264
+     * shows the exact matched case of needle.
1265
+     *   
1266
+     * @param string $needle
1267
+     * @param string $haystack
1268
+     * @param bool $caseInsensitive
1269
+     * @return ConvertHelper_StringMatch[]
1270
+     */
1271 1271
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
1272 1272
     {
1273 1273
         if($needle === '') {
@@ -1293,14 +1293,14 @@  discard block
 block discarded – undo
1293 1293
         return $positions;
1294 1294
     }
1295 1295
     
1296
-   /**
1297
-    * Like explode, but trims all entries, and removes 
1298
-    * empty entries from the resulting array.
1299
-    * 
1300
-    * @param string $delimiter
1301
-    * @param string $string
1302
-    * @return string[]
1303
-    */
1296
+    /**
1297
+     * Like explode, but trims all entries, and removes 
1298
+     * empty entries from the resulting array.
1299
+     * 
1300
+     * @param string $delimiter
1301
+     * @param string $string
1302
+     * @return string[]
1303
+     */
1304 1304
     public static function explodeTrim(string $delimiter, string $string) : array
1305 1305
     {
1306 1306
         if(empty($string) || empty($delimiter)) {
@@ -1322,12 +1322,12 @@  discard block
 block discarded – undo
1322 1322
     
1323 1323
     protected static $eolChars;
1324 1324
 
1325
-   /**
1326
-    * Detects the most used end-of-line character in the subject string.
1327
-    * 
1328
-    * @param string $subjectString The string to check.
1329
-    * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
1330
-    */
1325
+    /**
1326
+     * Detects the most used end-of-line character in the subject string.
1327
+     * 
1328
+     * @param string $subjectString The string to check.
1329
+     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
1330
+     */
1331 1331
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
1332 1332
     {
1333 1333
         if(empty($subjectString)) {
@@ -1339,27 +1339,27 @@  discard block
 block discarded – undo
1339 1339
             $cr = chr((int)hexdec('0d'));
1340 1340
             $lf = chr((int)hexdec('0a'));
1341 1341
             
1342
-           self::$eolChars = array(
1343
-               array(
1344
-                   'char' => $cr.$lf,
1345
-                   'type' => ConvertHelper_EOL::TYPE_CRLF,
1346
-                   'description' => t('Carriage return followed by a line feed'),
1347
-               ),
1348
-               array(
1349
-                   'char' => $lf.$cr,
1350
-                   'type' => ConvertHelper_EOL::TYPE_LFCR,
1351
-                   'description' => t('Line feed followed by a carriage return'),
1352
-               ),
1353
-               array(
1354
-                  'char' => $lf,
1355
-                  'type' => ConvertHelper_EOL::TYPE_LF,
1356
-                  'description' => t('Line feed'),
1357
-               ),
1358
-               array(
1359
-                  'char' => $cr,
1360
-                  'type' => ConvertHelper_EOL::TYPE_CR,
1361
-                  'description' => t('Carriage Return'),
1362
-               ),
1342
+            self::$eolChars = array(
1343
+                array(
1344
+                    'char' => $cr.$lf,
1345
+                    'type' => ConvertHelper_EOL::TYPE_CRLF,
1346
+                    'description' => t('Carriage return followed by a line feed'),
1347
+                ),
1348
+                array(
1349
+                    'char' => $lf.$cr,
1350
+                    'type' => ConvertHelper_EOL::TYPE_LFCR,
1351
+                    'description' => t('Line feed followed by a carriage return'),
1352
+                ),
1353
+                array(
1354
+                    'char' => $lf,
1355
+                    'type' => ConvertHelper_EOL::TYPE_LF,
1356
+                    'description' => t('Line feed'),
1357
+                ),
1358
+                array(
1359
+                    'char' => $cr,
1360
+                    'type' => ConvertHelper_EOL::TYPE_CR,
1361
+                    'description' => t('Carriage Return'),
1362
+                ),
1363 1363
             );
1364 1364
         }
1365 1365
         
@@ -1387,13 +1387,13 @@  discard block
 block discarded – undo
1387 1387
         );
1388 1388
     }
1389 1389
 
1390
-   /**
1391
-    * Removes the specified keys from the target array,
1392
-    * if they exist.
1393
-    * 
1394
-    * @param array $array
1395
-    * @param array $keys
1396
-    */
1390
+    /**
1391
+     * Removes the specified keys from the target array,
1392
+     * if they exist.
1393
+     * 
1394
+     * @param array $array
1395
+     * @param array $keys
1396
+     */
1397 1397
     public static function arrayRemoveKeys(array &$array, array $keys) : void
1398 1398
     {
1399 1399
         foreach($keys as $key) 
@@ -1404,13 +1404,13 @@  discard block
 block discarded – undo
1404 1404
         }
1405 1405
     }
1406 1406
     
1407
-   /**
1408
-    * Checks if the specified variable is an integer or a string containing an integer.
1409
-    * Accepts both positive and negative integers.
1410
-    * 
1411
-    * @param mixed $value
1412
-    * @return bool
1413
-    */
1407
+    /**
1408
+     * Checks if the specified variable is an integer or a string containing an integer.
1409
+     * Accepts both positive and negative integers.
1410
+     * 
1411
+     * @param mixed $value
1412
+     * @return bool
1413
+     */
1414 1414
     public static function isInteger($value) : bool
1415 1415
     {
1416 1416
         if(is_int($value)) {
@@ -1430,52 +1430,52 @@  discard block
 block discarded – undo
1430 1430
         return false;    
1431 1431
     }
1432 1432
     
1433
-   /**
1434
-    * Converts an amount of seconds to a DateInterval object.
1435
-    * 
1436
-    * @param int $seconds
1437
-    * @return \DateInterval
1438
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
1439
-    * 
1440
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
1441
-    */
1433
+    /**
1434
+     * Converts an amount of seconds to a DateInterval object.
1435
+     * 
1436
+     * @param int $seconds
1437
+     * @return \DateInterval
1438
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
1439
+     * 
1440
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
1441
+     */
1442 1442
     public static function seconds2interval(int $seconds) : \DateInterval
1443 1443
     {
1444 1444
         return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval();
1445 1445
     }
1446 1446
     
1447
-   /**
1448
-    * Converts a size string like "50 MB" to the corresponding byte size.
1449
-    * It is case insensitive, ignores spaces, and supports both traditional
1450
-    * "MB" and "MiB" notations.
1451
-    * 
1452
-    * @param string $size
1453
-    * @return int
1454
-    */
1447
+    /**
1448
+     * Converts a size string like "50 MB" to the corresponding byte size.
1449
+     * It is case insensitive, ignores spaces, and supports both traditional
1450
+     * "MB" and "MiB" notations.
1451
+     * 
1452
+     * @param string $size
1453
+     * @return int
1454
+     */
1455 1455
     public static function size2bytes(string $size) : int
1456 1456
     {
1457 1457
         return self::parseSize($size)->toBytes();
1458 1458
     }
1459 1459
     
1460
-   /**
1461
-    * Parses a size string like "50 MB" and returns a size notation instance
1462
-    * that has utility methods to access information on it, and convert it.
1463
-    * 
1464
-    * @param string $size
1465
-    * @return ConvertHelper_SizeNotation
1466
-    */
1460
+    /**
1461
+     * Parses a size string like "50 MB" and returns a size notation instance
1462
+     * that has utility methods to access information on it, and convert it.
1463
+     * 
1464
+     * @param string $size
1465
+     * @return ConvertHelper_SizeNotation
1466
+     */
1467 1467
     public static function parseSize(string $size) : ConvertHelper_SizeNotation
1468 1468
     {
1469 1469
         return new ConvertHelper_SizeNotation($size);
1470 1470
     }
1471 1471
     
1472
-   /**
1473
-    * Creates a URL finder instance, which can be used to find
1474
-    * URLs in a string - be it plain text, or HTML.
1475
-    * 
1476
-    * @param string $subject
1477
-    * @return ConvertHelper_URLFinder
1478
-    */
1472
+    /**
1473
+     * Creates a URL finder instance, which can be used to find
1474
+     * URLs in a string - be it plain text, or HTML.
1475
+     * 
1476
+     * @param string $subject
1477
+     * @return ConvertHelper_URLFinder
1478
+     */
1479 1479
     public static function createURLFinder(string $subject) : ConvertHelper_URLFinder
1480 1480
     {
1481 1481
         return new ConvertHelper_URLFinder($subject);
Please login to merge, or discard this patch.