@@ -33,19 +33,19 @@ |
||
33 | 33 | $this->match = $matchedString; |
34 | 34 | } |
35 | 35 | |
36 | - /** |
|
37 | - * The zero-based start position of the string in the haystack. |
|
38 | - * @return int |
|
39 | - */ |
|
36 | + /** |
|
37 | + * The zero-based start position of the string in the haystack. |
|
38 | + * @return int |
|
39 | + */ |
|
40 | 40 | public function getPosition() : int |
41 | 41 | { |
42 | 42 | return $this->position; |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * The exact string that was matched, respecting the case as found in needle. |
|
47 | - * @return string |
|
48 | - */ |
|
45 | + /** |
|
46 | + * The exact string that was matched, respecting the case as found in needle. |
|
47 | + * @return string |
|
48 | + */ |
|
49 | 49 | public function getMatchedString() : string |
50 | 50 | { |
51 | 51 | return $this->match; |
@@ -6,9 +6,9 @@ |
||
6 | 6 | { |
7 | 7 | protected $xml; |
8 | 8 | |
9 | - /** |
|
10 | - * @var \LibXMLError |
|
11 | - */ |
|
9 | + /** |
|
10 | + * @var \LibXMLError |
|
11 | + */ |
|
12 | 12 | protected $nativeError; |
13 | 13 | |
14 | 14 | public function __construct(XMLHelper_SimpleXML $xml, \LibXMLError $nativeError) |
@@ -41,14 +41,14 @@ discard block |
||
41 | 41 | { |
42 | 42 | const ERROR_FAILED_CONVERTING_TO_JSON = 37901; |
43 | 43 | |
44 | - /** |
|
45 | - * @var \SimpleXMLElement |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var \SimpleXMLElement |
|
46 | + */ |
|
47 | 47 | protected $xml; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string |
|
51 | + */ |
|
52 | 52 | protected $json; |
53 | 53 | |
54 | 54 | protected function __construct(\SimpleXMLElement $element) |
@@ -56,24 +56,24 @@ discard block |
||
56 | 56 | $this->xml = $element; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Factory method: creates a converter from an XML file on disk. |
|
61 | - * |
|
62 | - * @param string $path |
|
63 | - * @return \AppUtils\XMLHelper_Converter |
|
64 | - */ |
|
59 | + /** |
|
60 | + * Factory method: creates a converter from an XML file on disk. |
|
61 | + * |
|
62 | + * @param string $path |
|
63 | + * @return \AppUtils\XMLHelper_Converter |
|
64 | + */ |
|
65 | 65 | public static function fromFile(string $path) |
66 | 66 | { |
67 | 67 | $xmlString = file_get_contents($path); |
68 | 68 | return self::fromString($xmlString); |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Factory method: creates a converter from an XML string. |
|
73 | - * |
|
74 | - * @param string $xmlString |
|
75 | - * @return \AppUtils\XMLHelper_Converter |
|
76 | - */ |
|
71 | + /** |
|
72 | + * Factory method: creates a converter from an XML string. |
|
73 | + * |
|
74 | + * @param string $xmlString |
|
75 | + * @return \AppUtils\XMLHelper_Converter |
|
76 | + */ |
|
77 | 77 | public static function fromString(string $xmlString) |
78 | 78 | { |
79 | 79 | $element = new \SimpleXMLElement($xmlString); |
@@ -81,36 +81,36 @@ discard block |
||
81 | 81 | return self::fromElement($element); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Factory method: creates a converter from an existing SimpleXMLElement instance. |
|
86 | - * |
|
87 | - * @param \SimpleXMLElement $element |
|
88 | - * @return \AppUtils\XMLHelper_Converter |
|
89 | - */ |
|
84 | + /** |
|
85 | + * Factory method: creates a converter from an existing SimpleXMLElement instance. |
|
86 | + * |
|
87 | + * @param \SimpleXMLElement $element |
|
88 | + * @return \AppUtils\XMLHelper_Converter |
|
89 | + */ |
|
90 | 90 | public static function fromElement(\SimpleXMLElement $element) |
91 | 91 | { |
92 | 92 | $obj = new XMLHelper_Converter($element); |
93 | 93 | return $obj; |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Factory method: creates a converter from an existing SimpleXMLElement instance. |
|
98 | - * |
|
99 | - * @param \DOMElement $element |
|
100 | - * @return \AppUtils\XMLHelper_Converter |
|
101 | - */ |
|
96 | + /** |
|
97 | + * Factory method: creates a converter from an existing SimpleXMLElement instance. |
|
98 | + * |
|
99 | + * @param \DOMElement $element |
|
100 | + * @return \AppUtils\XMLHelper_Converter |
|
101 | + */ |
|
102 | 102 | public static function fromDOMElement(\DOMElement $element) |
103 | 103 | { |
104 | 104 | $obj = new XMLHelper_Converter(simplexml_import_dom($element)); |
105 | 105 | return $obj; |
106 | 106 | } |
107 | 107 | |
108 | - /** |
|
109 | - * Converts the XML to JSON. |
|
110 | - * |
|
111 | - * @throws XMLHelper_Exception |
|
112 | - * @return string |
|
113 | - */ |
|
108 | + /** |
|
109 | + * Converts the XML to JSON. |
|
110 | + * |
|
111 | + * @throws XMLHelper_Exception |
|
112 | + * @return string |
|
113 | + */ |
|
114 | 114 | public function toJSON() : string |
115 | 115 | { |
116 | 116 | if(isset($this->json)) { |
@@ -138,11 +138,11 @@ discard block |
||
138 | 138 | ); |
139 | 139 | } |
140 | 140 | |
141 | - /** |
|
142 | - * Converts the XML to an associative array. |
|
143 | - * @return array |
|
144 | - * @throws XMLHelper_Exception |
|
145 | - */ |
|
141 | + /** |
|
142 | + * Converts the XML to an associative array. |
|
143 | + * @return array |
|
144 | + * @throws XMLHelper_Exception |
|
145 | + */ |
|
146 | 146 | public function toArray() : array |
147 | 147 | { |
148 | 148 | $json = $this->toJSON(); |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | */ |
114 | 114 | public function toJSON() : string |
115 | 115 | { |
116 | - if(isset($this->json)) { |
|
116 | + if (isset($this->json)) { |
|
117 | 117 | return $this->json; |
118 | 118 | } |
119 | 119 | |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | |
124 | 124 | unset($this->xml); |
125 | 125 | |
126 | - if($this->json !== false) { |
|
126 | + if ($this->json !== false) { |
|
127 | 127 | return $this->json; |
128 | 128 | } |
129 | 129 |
@@ -11,27 +11,27 @@ |
||
11 | 11 | |
12 | 12 | protected $errors = array(); |
13 | 13 | |
14 | - /** |
|
15 | - * Creates a simplexml instance from an XML string. |
|
16 | - * |
|
17 | - * NOTE: returns false in case of a fatal error. |
|
18 | - * |
|
19 | - * @param string $string |
|
20 | - * @return \SimpleXMLElement|bool |
|
21 | - */ |
|
14 | + /** |
|
15 | + * Creates a simplexml instance from an XML string. |
|
16 | + * |
|
17 | + * NOTE: returns false in case of a fatal error. |
|
18 | + * |
|
19 | + * @param string $string |
|
20 | + * @return \SimpleXMLElement|bool |
|
21 | + */ |
|
22 | 22 | public function loadString($string) |
23 | 23 | { |
24 | 24 | return $this->load('string', $string); |
25 | 25 | } |
26 | 26 | |
27 | - /** |
|
28 | - * Creates a simplexml instance from an XML file. |
|
29 | - * |
|
30 | - * NOTE: returns false in case of a fatal error. |
|
31 | - * |
|
32 | - * @param string $file |
|
33 | - * @return \SimpleXMLElement|bool |
|
34 | - */ |
|
27 | + /** |
|
28 | + * Creates a simplexml instance from an XML file. |
|
29 | + * |
|
30 | + * NOTE: returns false in case of a fatal error. |
|
31 | + * |
|
32 | + * @param string $file |
|
33 | + * @return \SimpleXMLElement|bool |
|
34 | + */ |
|
35 | 35 | public function loadFile($file) |
36 | 36 | { |
37 | 37 | return $this->load('file', $file); |
@@ -52,7 +52,7 @@ |
||
52 | 52 | // add any errors that were triggered, using the |
53 | 53 | // error wrappers. |
54 | 54 | $errors = libxml_get_errors(); |
55 | - foreach($errors as $error) { |
|
55 | + foreach ($errors as $error) { |
|
56 | 56 | $this->errors[] = new XMLHelper_SimpleXML_Error($this, $error); |
57 | 57 | } |
58 | 58 |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | |
32 | 32 | public function addLimitParam(string $name) : Request_URLComparer |
33 | 33 | { |
34 | - if(!in_array($name, $this->limitParams)) { |
|
34 | + if (!in_array($name, $this->limitParams)) { |
|
35 | 35 | $this->limitParams[] = $name; |
36 | 36 | } |
37 | 37 | |
@@ -40,14 +40,14 @@ discard block |
||
40 | 40 | |
41 | 41 | public function addLimitParams(array $names) : Request_URLComparer |
42 | 42 | { |
43 | - foreach($names as $name) { |
|
43 | + foreach ($names as $name) { |
|
44 | 44 | $this->addLimitParam($name); |
45 | 45 | } |
46 | 46 | |
47 | 47 | return $this; |
48 | 48 | } |
49 | 49 | |
50 | - public function setIgnoreFragment(bool $ignore=true) : Request_URLComparer |
|
50 | + public function setIgnoreFragment(bool $ignore = true) : Request_URLComparer |
|
51 | 51 | { |
52 | 52 | $this->ignoreFragment = $ignore; |
53 | 53 | return $this; |
@@ -55,7 +55,7 @@ discard block |
||
55 | 55 | |
56 | 56 | protected function init() |
57 | 57 | { |
58 | - if(isset($this->isMatch)) { |
|
58 | + if (isset($this->isMatch)) { |
|
59 | 59 | return; |
60 | 60 | } |
61 | 61 | |
@@ -77,25 +77,25 @@ discard block |
||
77 | 77 | 'query' |
78 | 78 | ); |
79 | 79 | |
80 | - if(!$this->ignoreFragment) { |
|
80 | + if (!$this->ignoreFragment) { |
|
81 | 81 | $keys[] = 'fragment'; |
82 | 82 | } |
83 | 83 | |
84 | - foreach($keys as $key) |
|
84 | + foreach ($keys as $key) |
|
85 | 85 | { |
86 | 86 | $sVal = ''; |
87 | 87 | $tVal = ''; |
88 | 88 | |
89 | - if(isset($sInfo[$key])) { $sVal = $sInfo[$key]; } |
|
90 | - if(isset($tInfo[$key])) { $tVal = $tInfo[$key]; } |
|
89 | + if (isset($sInfo[$key])) { $sVal = $sInfo[$key]; } |
|
90 | + if (isset($tInfo[$key])) { $tVal = $tInfo[$key]; } |
|
91 | 91 | |
92 | 92 | $filter = 'filter_'.$key; |
93 | - if(method_exists($this, $filter)) { |
|
93 | + if (method_exists($this, $filter)) { |
|
94 | 94 | $sVal = $this->$filter($sVal); |
95 | 95 | $tVal = $this->$filter($tVal); |
96 | 96 | } |
97 | 97 | |
98 | - if($sVal !== $tVal) { |
|
98 | + if ($sVal !== $tVal) { |
|
99 | 99 | return false; |
100 | 100 | } |
101 | 101 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | protected function filter_path(string $path) : string |
107 | 107 | { |
108 | 108 | // fix double slashes in URLs |
109 | - while(stristr($path, '//')) { |
|
109 | + while (stristr($path, '//')) { |
|
110 | 110 | $path = str_replace('//', '/', $path); |
111 | 111 | } |
112 | 112 | |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | |
116 | 116 | protected function filter_query(string $query) : string |
117 | 117 | { |
118 | - if(empty($query)) { |
|
118 | + if (empty($query)) { |
|
119 | 119 | return ''; |
120 | 120 | } |
121 | 121 | |
@@ -123,13 +123,13 @@ discard block |
||
123 | 123 | |
124 | 124 | ksort($params); |
125 | 125 | |
126 | - if(!empty($this->limitParams)) |
|
126 | + if (!empty($this->limitParams)) |
|
127 | 127 | { |
128 | 128 | $keep = array(); |
129 | 129 | |
130 | - foreach($this->limitParams as $name) |
|
130 | + foreach ($this->limitParams as $name) |
|
131 | 131 | { |
132 | - if(isset($params[$name])) { |
|
132 | + if (isset($params[$name])) { |
|
133 | 133 | $keep[$name] = $params[$name]; |
134 | 134 | } |
135 | 135 | } |
@@ -711,8 +711,7 @@ |
||
711 | 711 | if(is_object(json_decode($value))) { |
712 | 712 | return $value; |
713 | 713 | } |
714 | - } |
|
715 | - else |
|
714 | + } else |
|
716 | 715 | { |
717 | 716 | if(is_array(json_decode($value, true))) { |
718 | 717 | return $value; |
@@ -111,18 +111,18 @@ discard block |
||
111 | 111 | } |
112 | 112 | } |
113 | 113 | |
114 | - /** |
|
115 | - * Adds a callback as a validation method. The callback gets the |
|
116 | - * value to validate as first parameter, and any additional |
|
117 | - * parameters passed here get appended to that. |
|
118 | - * |
|
119 | - * The callback must return boolean true or false depending on |
|
120 | - * whether the value is valid. |
|
121 | - * |
|
122 | - * @param mixed $callback |
|
123 | - * @param array $args |
|
124 | - * @return Request_Param |
|
125 | - */ |
|
114 | + /** |
|
115 | + * Adds a callback as a validation method. The callback gets the |
|
116 | + * value to validate as first parameter, and any additional |
|
117 | + * parameters passed here get appended to that. |
|
118 | + * |
|
119 | + * The callback must return boolean true or false depending on |
|
120 | + * whether the value is valid. |
|
121 | + * |
|
122 | + * @param mixed $callback |
|
123 | + * @param array $args |
|
124 | + * @return Request_Param |
|
125 | + */ |
|
126 | 126 | public function setCallback($callback, $args=array()) |
127 | 127 | { |
128 | 128 | if(!is_callable($callback)) { |
@@ -264,13 +264,13 @@ discard block |
||
264 | 264 | |
265 | 265 | protected $valueType = self::VALUE_TYPE_STRING; |
266 | 266 | |
267 | - /** |
|
268 | - * Sets the variable to contain a comma-separated list of integer IDs. |
|
269 | - * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
270 | - * <code>145</code>. |
|
271 | - * |
|
272 | - * @return Request_Param |
|
273 | - */ |
|
267 | + /** |
|
268 | + * Sets the variable to contain a comma-separated list of integer IDs. |
|
269 | + * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
270 | + * <code>145</code>. |
|
271 | + * |
|
272 | + * @return Request_Param |
|
273 | + */ |
|
274 | 274 | public function setIDList() |
275 | 275 | { |
276 | 276 | $this->valueType = self::VALUE_TYPE_ID_LIST; |
@@ -279,13 +279,13 @@ discard block |
||
279 | 279 | return $this; |
280 | 280 | } |
281 | 281 | |
282 | - /** |
|
283 | - * Sets the variable to be an alias, as defined by the |
|
284 | - * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
285 | - * |
|
286 | - * @return Request_Param |
|
287 | - * @see RegexHelper::REGEX_ALIAS |
|
288 | - */ |
|
282 | + /** |
|
283 | + * Sets the variable to be an alias, as defined by the |
|
284 | + * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
285 | + * |
|
286 | + * @return Request_Param |
|
287 | + * @see RegexHelper::REGEX_ALIAS |
|
288 | + */ |
|
289 | 289 | public function setAlias() |
290 | 290 | { |
291 | 291 | return $this->setRegex(RegexHelper::REGEX_ALIAS); |
@@ -326,12 +326,12 @@ discard block |
||
326 | 326 | return $this->setValidation(self::VALIDATION_TYPE_ALPHA); |
327 | 327 | } |
328 | 328 | |
329 | - /** |
|
330 | - * Sets the parameter value as a string containing lowercase |
|
331 | - * and/or uppercase letters, as well as numbers. |
|
332 | - * |
|
333 | - * @return Request_Param |
|
334 | - */ |
|
329 | + /** |
|
330 | + * Sets the parameter value as a string containing lowercase |
|
331 | + * and/or uppercase letters, as well as numbers. |
|
332 | + * |
|
333 | + * @return Request_Param |
|
334 | + */ |
|
335 | 335 | public function setAlnum() |
336 | 336 | { |
337 | 337 | return $this->setValidation(self::VALIDATION_TYPE_ALNUM); |
@@ -359,17 +359,17 @@ discard block |
||
359 | 359 | return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args); |
360 | 360 | } |
361 | 361 | |
362 | - /** |
|
363 | - * Only available for array values: the parameter must be |
|
364 | - * an array value, and the array may only contain values |
|
365 | - * specified in the values array. |
|
366 | - * |
|
367 | - * Submitted values that are not in the allowed list of |
|
368 | - * values are stripped from the value. |
|
369 | - * |
|
370 | - * @param array $values List of allowed values |
|
371 | - * @return \AppUtils\Request_Param |
|
372 | - */ |
|
362 | + /** |
|
363 | + * Only available for array values: the parameter must be |
|
364 | + * an array value, and the array may only contain values |
|
365 | + * specified in the values array. |
|
366 | + * |
|
367 | + * Submitted values that are not in the allowed list of |
|
368 | + * values are stripped from the value. |
|
369 | + * |
|
370 | + * @param array $values List of allowed values |
|
371 | + * @return \AppUtils\Request_Param |
|
372 | + */ |
|
373 | 373 | public function setValuesList(array $values) |
374 | 374 | { |
375 | 375 | $this->setArray(); |
@@ -382,39 +382,39 @@ discard block |
||
382 | 382 | return $this->setValidation(self::VALIDATION_TYPE_ARRAY); |
383 | 383 | } |
384 | 384 | |
385 | - /** |
|
386 | - * Specifies that a JSON-encoded string is expected. |
|
387 | - * |
|
388 | - * NOTE: Numbers or quoted strings are technically valid |
|
389 | - * JSON, but are not accepted, because it is assumed |
|
390 | - * at least an array or object are expected. |
|
391 | - * |
|
392 | - * @return \AppUtils\Request_Param |
|
393 | - */ |
|
385 | + /** |
|
386 | + * Specifies that a JSON-encoded string is expected. |
|
387 | + * |
|
388 | + * NOTE: Numbers or quoted strings are technically valid |
|
389 | + * JSON, but are not accepted, because it is assumed |
|
390 | + * at least an array or object are expected. |
|
391 | + * |
|
392 | + * @return \AppUtils\Request_Param |
|
393 | + */ |
|
394 | 394 | public function setJSON() : Request_Param |
395 | 395 | { |
396 | 396 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true)); |
397 | 397 | } |
398 | 398 | |
399 | - /** |
|
400 | - * Like {@link Request_Param::setJSON()}, but accepts |
|
401 | - * only JSON objects. Arrays will not be accepted. |
|
402 | - * |
|
403 | - * @return \AppUtils\Request_Param |
|
404 | - */ |
|
399 | + /** |
|
400 | + * Like {@link Request_Param::setJSON()}, but accepts |
|
401 | + * only JSON objects. Arrays will not be accepted. |
|
402 | + * |
|
403 | + * @return \AppUtils\Request_Param |
|
404 | + */ |
|
405 | 405 | public function setJSONObject() : Request_Param |
406 | 406 | { |
407 | 407 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false)); |
408 | 408 | } |
409 | 409 | |
410 | - /** |
|
411 | - * The parameter is a string boolean representation. This means |
|
412 | - * it can be any of the following: "yes", "true", "no", "false". |
|
413 | - * The value is automatically converted to a boolean when retrieving |
|
414 | - * the parameter. |
|
415 | - * |
|
416 | - * @return Request_Param |
|
417 | - */ |
|
410 | + /** |
|
411 | + * The parameter is a string boolean representation. This means |
|
412 | + * it can be any of the following: "yes", "true", "no", "false". |
|
413 | + * The value is automatically converted to a boolean when retrieving |
|
414 | + * the parameter. |
|
415 | + * |
|
416 | + * @return Request_Param |
|
417 | + */ |
|
418 | 418 | public function setBoolean() : Request_Param |
419 | 419 | { |
420 | 420 | $this->addCallbackFilter(array($this, 'applyFilter_boolean')); |
@@ -478,15 +478,15 @@ discard block |
||
478 | 478 | return $keep; |
479 | 479 | } |
480 | 480 | |
481 | - /** |
|
482 | - * Validates the request parameter as an MD5 string, |
|
483 | - * so that only values resembling md5 values are accepted. |
|
484 | - * |
|
485 | - * NOTE: This can only guarantee the format, not whether |
|
486 | - * it is an actual valid hash of something. |
|
487 | - * |
|
488 | - * @return \AppUtils\Request_Param |
|
489 | - */ |
|
481 | + /** |
|
482 | + * Validates the request parameter as an MD5 string, |
|
483 | + * so that only values resembling md5 values are accepted. |
|
484 | + * |
|
485 | + * NOTE: This can only guarantee the format, not whether |
|
486 | + * it is an actual valid hash of something. |
|
487 | + * |
|
488 | + * @return \AppUtils\Request_Param |
|
489 | + */ |
|
490 | 490 | public function setMD5() : Request_Param |
491 | 491 | { |
492 | 492 | return $this->setRegex(RegexHelper::REGEX_MD5); |
@@ -528,14 +528,14 @@ discard block |
||
528 | 528 | return $this; |
529 | 529 | } |
530 | 530 | |
531 | - /** |
|
532 | - * Retrieves the value of the request parameter, |
|
533 | - * applying all filters (if any) and validation |
|
534 | - * (if any). |
|
535 | - * |
|
536 | - * @param mixed $default |
|
537 | - * @return mixed |
|
538 | - */ |
|
531 | + /** |
|
532 | + * Retrieves the value of the request parameter, |
|
533 | + * applying all filters (if any) and validation |
|
534 | + * (if any). |
|
535 | + * |
|
536 | + * @param mixed $default |
|
537 | + * @return mixed |
|
538 | + */ |
|
539 | 539 | public function get($default=null) |
540 | 540 | { |
541 | 541 | $value = $this->request->getParam($this->paramName); |
@@ -565,12 +565,12 @@ discard block |
||
565 | 565 | return null; |
566 | 566 | } |
567 | 567 | |
568 | - /** |
|
569 | - * Validates the syntax of an URL, but not its actual validity. |
|
570 | - * |
|
571 | - * @param mixed $value |
|
572 | - * @return string |
|
573 | - */ |
|
568 | + /** |
|
569 | + * Validates the syntax of an URL, but not its actual validity. |
|
570 | + * |
|
571 | + * @param mixed $value |
|
572 | + * @return string |
|
573 | + */ |
|
574 | 574 | protected function validate_url($value) : string |
575 | 575 | { |
576 | 576 | if(!is_string($value)) { |
@@ -710,10 +710,10 @@ discard block |
||
710 | 710 | return null; |
711 | 711 | } |
712 | 712 | |
713 | - /** |
|
714 | - * Makes sure that the value is a JSON-encoded string. |
|
715 | - * @param mixed $value |
|
716 | - */ |
|
713 | + /** |
|
714 | + * Makes sure that the value is a JSON-encoded string. |
|
715 | + * @param mixed $value |
|
716 | + */ |
|
717 | 717 | protected function validate_json($value) : string |
718 | 718 | { |
719 | 719 | if(!is_string($value)) { |
@@ -730,7 +730,7 @@ discard block |
||
730 | 730 | if($this->validationParams['arrays'] === false) |
731 | 731 | { |
732 | 732 | if(is_object(json_decode($value))) { |
733 | - return $value; |
|
733 | + return $value; |
|
734 | 734 | } |
735 | 735 | } |
736 | 736 | else |
@@ -810,12 +810,12 @@ discard block |
||
810 | 810 | return $this; |
811 | 811 | } |
812 | 812 | |
813 | - /** |
|
814 | - * Adds a filter that trims whitespace from the request |
|
815 | - * parameter using the PHP <code>trim</code> function. |
|
816 | - * |
|
817 | - * @return \AppUtils\Request_Param |
|
818 | - */ |
|
813 | + /** |
|
814 | + * Adds a filter that trims whitespace from the request |
|
815 | + * parameter using the PHP <code>trim</code> function. |
|
816 | + * |
|
817 | + * @return \AppUtils\Request_Param |
|
818 | + */ |
|
819 | 819 | public function addFilterTrim() : Request_Param |
820 | 820 | { |
821 | 821 | // to guarantee we only work with strings |
@@ -824,13 +824,13 @@ discard block |
||
824 | 824 | return $this->addCallbackFilter('trim'); |
825 | 825 | } |
826 | 826 | |
827 | - /** |
|
828 | - * Converts the value to a string, even if it is not |
|
829 | - * a string value. Complex types like arrays and objects |
|
830 | - * are converted to an empty string. |
|
831 | - * |
|
832 | - * @return \AppUtils\Request_Param |
|
833 | - */ |
|
827 | + /** |
|
828 | + * Converts the value to a string, even if it is not |
|
829 | + * a string value. Complex types like arrays and objects |
|
830 | + * are converted to an empty string. |
|
831 | + * |
|
832 | + * @return \AppUtils\Request_Param |
|
833 | + */ |
|
834 | 834 | public function addStringFilter() : Request_Param |
835 | 835 | { |
836 | 836 | return $this->addCallbackFilter(array($this, 'applyFilter_string')); |
@@ -880,12 +880,12 @@ discard block |
||
880 | 880 | return $this->addCallbackFilter('strip_tags', array($allowedTags)); |
881 | 881 | } |
882 | 882 | |
883 | - /** |
|
884 | - * Adds a filter that strips all whitespace from the |
|
885 | - * request parameter, from spaces to tabs and newlines. |
|
886 | - * |
|
887 | - * @return \AppUtils\Request_Param |
|
888 | - */ |
|
883 | + /** |
|
884 | + * Adds a filter that strips all whitespace from the |
|
885 | + * request parameter, from spaces to tabs and newlines. |
|
886 | + * |
|
887 | + * @return \AppUtils\Request_Param |
|
888 | + */ |
|
889 | 889 | public function addStripWhitespaceFilter() : Request_Param |
890 | 890 | { |
891 | 891 | // to ensure we only work with strings. |
@@ -894,14 +894,14 @@ discard block |
||
894 | 894 | return $this->addCallbackFilter(array($this, 'applyFilter_stripWhitespace')); |
895 | 895 | } |
896 | 896 | |
897 | - /** |
|
898 | - * Adds a filter that transforms comma separated values |
|
899 | - * into an array of values. |
|
900 | - * |
|
901 | - * @param bool $trimEntries Trim whitespace from each entry? |
|
902 | - * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
903 | - * @return \AppUtils\Request_Param |
|
904 | - */ |
|
897 | + /** |
|
898 | + * Adds a filter that transforms comma separated values |
|
899 | + * into an array of values. |
|
900 | + * |
|
901 | + * @param bool $trimEntries Trim whitespace from each entry? |
|
902 | + * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
903 | + * @return \AppUtils\Request_Param |
|
904 | + */ |
|
905 | 905 | public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
906 | 906 | { |
907 | 907 | $this->setArray(); |
@@ -915,12 +915,12 @@ discard block |
||
915 | 915 | ); |
916 | 916 | } |
917 | 917 | |
918 | - /** |
|
919 | - * Adds a filter that encodes all HTML special characters |
|
920 | - * using the PHP <code>htmlspecialchars</code> function. |
|
921 | - * |
|
922 | - * @return \AppUtils\Request_Param |
|
923 | - */ |
|
918 | + /** |
|
919 | + * Adds a filter that encodes all HTML special characters |
|
920 | + * using the PHP <code>htmlspecialchars</code> function. |
|
921 | + * |
|
922 | + * @return \AppUtils\Request_Param |
|
923 | + */ |
|
924 | 924 | public function addHTMLSpecialcharsFilter() : Request_Param |
925 | 925 | { |
926 | 926 | return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8')); |
@@ -933,14 +933,14 @@ discard block |
||
933 | 933 | |
934 | 934 | protected $required = false; |
935 | 935 | |
936 | - /** |
|
937 | - * Marks this request parameter as required. To use this feature, |
|
938 | - * you have to call the request's {@link Request::validate()} |
|
939 | - * method. |
|
940 | - * |
|
941 | - * @return Request_Param |
|
942 | - * @see Request::validate() |
|
943 | - */ |
|
936 | + /** |
|
937 | + * Marks this request parameter as required. To use this feature, |
|
938 | + * you have to call the request's {@link Request::validate()} |
|
939 | + * method. |
|
940 | + * |
|
941 | + * @return Request_Param |
|
942 | + * @see Request::validate() |
|
943 | + */ |
|
944 | 944 | public function makeRequired() : Request_Param |
945 | 945 | { |
946 | 946 | $this->required = true; |
@@ -123,9 +123,9 @@ discard block |
||
123 | 123 | * @param array $args |
124 | 124 | * @return Request_Param |
125 | 125 | */ |
126 | - public function setCallback($callback, $args=array()) |
|
126 | + public function setCallback($callback, $args = array()) |
|
127 | 127 | { |
128 | - if(!is_callable($callback)) { |
|
128 | + if (!is_callable($callback)) { |
|
129 | 129 | throw new Request_Exception( |
130 | 130 | 'Not a valid callback', |
131 | 131 | 'The specified callback is not a valid callable entity.', |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | array_unshift($args, $value); |
149 | 149 | |
150 | 150 | $result = call_user_func_array($this->validationParams['callback'], $args); |
151 | - if($result !== false) { |
|
151 | + if ($result !== false) { |
|
152 | 152 | return $value; |
153 | 153 | } |
154 | 154 | |
@@ -175,13 +175,13 @@ discard block |
||
175 | 175 | |
176 | 176 | // go through all enqueued validations in turn, each time |
177 | 177 | // replacing the value with the adjusted, validated value. |
178 | - foreach($this->validations as $validateDef) |
|
178 | + foreach ($this->validations as $validateDef) |
|
179 | 179 | { |
180 | 180 | $this->validationType = $validateDef['type']; |
181 | 181 | $this->validationParams = $validateDef['params']; |
182 | 182 | |
183 | 183 | // and now, see if we have to validate the value as well |
184 | - $method = 'validate_' . $this->validationType; |
|
184 | + $method = 'validate_'.$this->validationType; |
|
185 | 185 | if (!method_exists($this, $method)) { |
186 | 186 | throw new Request_Exception( |
187 | 187 | 'Unknown validation type.', |
@@ -195,19 +195,19 @@ discard block |
||
195 | 195 | ); |
196 | 196 | } |
197 | 197 | |
198 | - if($this->valueType === self::VALUE_TYPE_ID_LIST) |
|
198 | + if ($this->valueType === self::VALUE_TYPE_ID_LIST) |
|
199 | 199 | { |
200 | - if(!is_array($value)) { |
|
200 | + if (!is_array($value)) { |
|
201 | 201 | $value = explode(',', $value); |
202 | 202 | } |
203 | 203 | |
204 | 204 | $keep = array(); |
205 | - foreach($value as $subval) |
|
205 | + foreach ($value as $subval) |
|
206 | 206 | { |
207 | 207 | $subval = trim($subval); |
208 | 208 | $subval = $this->$method($subval); |
209 | 209 | |
210 | - if($subval !== null) { |
|
210 | + if ($subval !== null) { |
|
211 | 211 | $keep[] = intval($subval); |
212 | 212 | } |
213 | 213 | } |
@@ -423,7 +423,7 @@ discard block |
||
423 | 423 | |
424 | 424 | protected function applyFilter_boolean($value) |
425 | 425 | { |
426 | - if($value == 'yes' || $value == 'true') { |
|
426 | + if ($value == 'yes' || $value == 'true') { |
|
427 | 427 | return true; |
428 | 428 | } |
429 | 429 | |
@@ -437,7 +437,7 @@ discard block |
||
437 | 437 | |
438 | 438 | protected function applyFilter_string($value) |
439 | 439 | { |
440 | - if(!is_scalar($value)) { |
|
440 | + if (!is_scalar($value)) { |
|
441 | 441 | return ''; |
442 | 442 | } |
443 | 443 | |
@@ -446,29 +446,29 @@ discard block |
||
446 | 446 | |
447 | 447 | protected function applyFilter_commaSeparated($value, bool $trimEntries, bool $stripEmptyEntries) |
448 | 448 | { |
449 | - if(is_array($value)) { |
|
449 | + if (is_array($value)) { |
|
450 | 450 | return $value; |
451 | 451 | } |
452 | 452 | |
453 | - if($value === '' || $value === null || !is_string($value)) { |
|
453 | + if ($value === '' || $value === null || !is_string($value)) { |
|
454 | 454 | return array(); |
455 | 455 | } |
456 | 456 | |
457 | 457 | $result = explode(',', $value); |
458 | 458 | |
459 | - if(!$trimEntries && !$stripEmptyEntries) { |
|
459 | + if (!$trimEntries && !$stripEmptyEntries) { |
|
460 | 460 | return $result; |
461 | 461 | } |
462 | 462 | |
463 | 463 | $keep = array(); |
464 | 464 | |
465 | - foreach($result as $entry) |
|
465 | + foreach ($result as $entry) |
|
466 | 466 | { |
467 | - if($trimEntries === true) { |
|
467 | + if ($trimEntries === true) { |
|
468 | 468 | $entry = trim($entry); |
469 | 469 | } |
470 | 470 | |
471 | - if($stripEmptyEntries === true && $entry === '') { |
|
471 | + if ($stripEmptyEntries === true && $entry === '') { |
|
472 | 472 | continue; |
473 | 473 | } |
474 | 474 | |
@@ -536,10 +536,10 @@ discard block |
||
536 | 536 | * @param mixed $default |
537 | 537 | * @return mixed |
538 | 538 | */ |
539 | - public function get($default=null) |
|
539 | + public function get($default = null) |
|
540 | 540 | { |
541 | 541 | $value = $this->request->getParam($this->paramName); |
542 | - if($value !== null && $value !== '') { |
|
542 | + if ($value !== null && $value !== '') { |
|
543 | 543 | return $value; |
544 | 544 | } |
545 | 545 | |
@@ -558,7 +558,7 @@ discard block |
||
558 | 558 | */ |
559 | 559 | protected function validate_integer($value) : ?int |
560 | 560 | { |
561 | - if(ConvertHelper::isInteger($value)) { |
|
561 | + if (ConvertHelper::isInteger($value)) { |
|
562 | 562 | return intval($value); |
563 | 563 | } |
564 | 564 | |
@@ -573,12 +573,12 @@ discard block |
||
573 | 573 | */ |
574 | 574 | protected function validate_url($value) : string |
575 | 575 | { |
576 | - if(!is_string($value)) { |
|
576 | + if (!is_string($value)) { |
|
577 | 577 | return ''; |
578 | 578 | } |
579 | 579 | |
580 | 580 | $info = parse_url($value); |
581 | - if(isset($info['host'])) { |
|
581 | + if (isset($info['host'])) { |
|
582 | 582 | return $value; |
583 | 583 | } |
584 | 584 | |
@@ -594,7 +594,7 @@ discard block |
||
594 | 594 | */ |
595 | 595 | protected function validate_numeric($value) : ?float |
596 | 596 | { |
597 | - if(is_numeric($value)) { |
|
597 | + if (is_numeric($value)) { |
|
598 | 598 | return $value * 1; |
599 | 599 | } |
600 | 600 | |
@@ -610,7 +610,7 @@ discard block |
||
610 | 610 | */ |
611 | 611 | protected function validate_regex($value) : ?string |
612 | 612 | { |
613 | - if(!is_scalar($value)) { |
|
613 | + if (!is_scalar($value)) { |
|
614 | 614 | return null; |
615 | 615 | } |
616 | 616 | |
@@ -618,13 +618,13 @@ discard block |
||
618 | 618 | // is a boolan, which is converted to an integer when |
619 | 619 | // converted to string, which in turn can be validated |
620 | 620 | // with a regex. |
621 | - if(is_bool($value)) { |
|
621 | + if (is_bool($value)) { |
|
622 | 622 | return null; |
623 | 623 | } |
624 | 624 | |
625 | 625 | $value = (string)$value; |
626 | 626 | |
627 | - if(preg_match($this->validationParams['regex'], $value)) { |
|
627 | + if (preg_match($this->validationParams['regex'], $value)) { |
|
628 | 628 | return $value; |
629 | 629 | } |
630 | 630 | |
@@ -640,11 +640,11 @@ discard block |
||
640 | 640 | */ |
641 | 641 | protected function validate_alpha($value) |
642 | 642 | { |
643 | - if(!is_scalar($value)) { |
|
643 | + if (!is_scalar($value)) { |
|
644 | 644 | return null; |
645 | 645 | } |
646 | 646 | |
647 | - if(preg_match('/\A[a-zA-Z]+\z/', $value)) { |
|
647 | + if (preg_match('/\A[a-zA-Z]+\z/', $value)) { |
|
648 | 648 | return $value; |
649 | 649 | } |
650 | 650 | |
@@ -653,13 +653,13 @@ discard block |
||
653 | 653 | |
654 | 654 | protected function validate_valueslist($value) |
655 | 655 | { |
656 | - if(!is_array($value)) { |
|
656 | + if (!is_array($value)) { |
|
657 | 657 | return array(); |
658 | 658 | } |
659 | 659 | |
660 | 660 | $keep = array(); |
661 | - foreach($value as $item) { |
|
662 | - if(in_array($item, $this->validationParams)) { |
|
661 | + foreach ($value as $item) { |
|
662 | + if (in_array($item, $this->validationParams)) { |
|
663 | 663 | $keep[] = $item; |
664 | 664 | } |
665 | 665 | } |
@@ -716,26 +716,26 @@ discard block |
||
716 | 716 | */ |
717 | 717 | protected function validate_json($value) : string |
718 | 718 | { |
719 | - if(!is_string($value)) { |
|
719 | + if (!is_string($value)) { |
|
720 | 720 | return ''; |
721 | 721 | } |
722 | 722 | |
723 | 723 | $value = trim($value); |
724 | 724 | |
725 | - if(empty($value)) { |
|
725 | + if (empty($value)) { |
|
726 | 726 | return ''; |
727 | 727 | } |
728 | 728 | |
729 | 729 | // strictly validate for objects? |
730 | - if($this->validationParams['arrays'] === false) |
|
730 | + if ($this->validationParams['arrays'] === false) |
|
731 | 731 | { |
732 | - if(is_object(json_decode($value))) { |
|
732 | + if (is_object(json_decode($value))) { |
|
733 | 733 | return $value; |
734 | 734 | } |
735 | 735 | } |
736 | 736 | else |
737 | 737 | { |
738 | - if(is_array(json_decode($value, true))) { |
|
738 | + if (is_array(json_decode($value, true))) { |
|
739 | 739 | return $value; |
740 | 740 | } |
741 | 741 | } |
@@ -755,7 +755,7 @@ discard block |
||
755 | 755 | { |
756 | 756 | $total = count($this->filters); |
757 | 757 | for ($i = 0; $i < $total; $i++) { |
758 | - $method = 'applyFilter_' . $this->filters[$i]['type']; |
|
758 | + $method = 'applyFilter_'.$this->filters[$i]['type']; |
|
759 | 759 | $value = $this->$method($value, $this->filters[$i]['params']); |
760 | 760 | } |
761 | 761 | |
@@ -902,7 +902,7 @@ discard block |
||
902 | 902 | * @param bool $stripEmptyEntries Remove empty entries from the array? |
903 | 903 | * @return \AppUtils\Request_Param |
904 | 904 | */ |
905 | - public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
|
905 | + public function addCommaSeparatedFilter(bool $trimEntries = true, bool $stripEmptyEntries = true) : Request_Param |
|
906 | 906 | { |
907 | 907 | $this->setArray(); |
908 | 908 |
@@ -42,10 +42,10 @@ discard block |
||
42 | 42 | |
43 | 43 | const REGEX_MD5 = '/^[a-f0-9]{32}$/i'; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | + */ |
|
49 | 49 | const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i'; |
50 | 50 | |
51 | 51 | const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m'; |
@@ -97,13 +97,13 @@ discard block |
||
97 | 97 | */ |
98 | 98 | const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i'; |
99 | 99 | |
100 | - /** |
|
101 | - * Hexadecimal color codes. Allows the following formats: |
|
102 | - * |
|
103 | - * FFFFFF |
|
104 | - * FFF |
|
105 | - * |
|
106 | - * @var string |
|
107 | - */ |
|
100 | + /** |
|
101 | + * Hexadecimal color codes. Allows the following formats: |
|
102 | + * |
|
103 | + * FFFFFF |
|
104 | + * FFF |
|
105 | + * |
|
106 | + * @var string |
|
107 | + */ |
|
108 | 108 | const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU'; |
109 | 109 | } |
@@ -55,8 +55,7 @@ |
||
55 | 55 | if(is_array($serialized)) |
56 | 56 | { |
57 | 57 | $this->parseSerialized($serialized); |
58 | - } |
|
59 | - else |
|
58 | + } else |
|
60 | 59 | { |
61 | 60 | $this->parseValue($value); |
62 | 61 | } |
@@ -32,25 +32,25 @@ discard block |
||
32 | 32 | self::TYPE_CALLABLE => 'cf5e20' |
33 | 33 | ); |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $string; |
39 | 39 | |
40 | - /** |
|
41 | - * @var mixed |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var mixed |
|
42 | + */ |
|
43 | 43 | protected $value; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $type; |
49 | 49 | |
50 | - /** |
|
51 | - * @param mixed $value |
|
52 | - * @param array|null $serialized |
|
53 | - */ |
|
50 | + /** |
|
51 | + * @param mixed $value |
|
52 | + * @param array|null $serialized |
|
53 | + */ |
|
54 | 54 | public function __construct($value, $serialized=null) |
55 | 55 | { |
56 | 56 | if(is_array($serialized)) |
@@ -63,26 +63,26 @@ discard block |
||
63 | 63 | } |
64 | 64 | } |
65 | 65 | |
66 | - /** |
|
67 | - * Creates a new variable info instance from a PHP variable |
|
68 | - * of any type. |
|
69 | - * |
|
70 | - * @param mixed $variable |
|
71 | - * @return VariableInfo |
|
72 | - */ |
|
66 | + /** |
|
67 | + * Creates a new variable info instance from a PHP variable |
|
68 | + * of any type. |
|
69 | + * |
|
70 | + * @param mixed $variable |
|
71 | + * @return VariableInfo |
|
72 | + */ |
|
73 | 73 | public static function fromVariable($variable) : VariableInfo |
74 | 74 | { |
75 | 75 | return new VariableInfo($variable); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Restores a variable info instance using a previously serialized |
|
80 | - * array using the serialize() method. |
|
81 | - * |
|
82 | - * @param array $serialized |
|
83 | - * @return VariableInfo |
|
84 | - * @see VariableInfo::serialize() |
|
85 | - */ |
|
78 | + /** |
|
79 | + * Restores a variable info instance using a previously serialized |
|
80 | + * array using the serialize() method. |
|
81 | + * |
|
82 | + * @param array $serialized |
|
83 | + * @return VariableInfo |
|
84 | + * @see VariableInfo::serialize() |
|
85 | + */ |
|
86 | 86 | public static function fromSerialized(array $serialized) : VariableInfo |
87 | 87 | { |
88 | 88 | return new VariableInfo(null, $serialized); |
@@ -108,12 +108,12 @@ discard block |
||
108 | 108 | $this->string = $this->_toString(); |
109 | 109 | } |
110 | 110 | |
111 | - /** |
|
112 | - * The variable type - this is the same string that |
|
113 | - * is returned by the PHP function `gettype`. |
|
114 | - * |
|
115 | - * @return string |
|
116 | - */ |
|
111 | + /** |
|
112 | + * The variable type - this is the same string that |
|
113 | + * is returned by the PHP function `gettype`. |
|
114 | + * |
|
115 | + * @return string |
|
116 | + */ |
|
117 | 117 | public function getType() : string |
118 | 118 | { |
119 | 119 | return $this->type; |
@@ -127,13 +127,13 @@ discard block |
||
127 | 127 | ); |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Whether to prepend the variable type before the value, |
|
132 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
133 | - * |
|
134 | - * @param bool $enable |
|
135 | - * @return VariableInfo |
|
136 | - */ |
|
130 | + /** |
|
131 | + * Whether to prepend the variable type before the value, |
|
132 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
133 | + * |
|
134 | + * @param bool $enable |
|
135 | + * @return VariableInfo |
|
136 | + */ |
|
137 | 137 | public function enableType(bool $enable=true) : VariableInfo |
138 | 138 | { |
139 | 139 | return $this->setOption('prepend-type', $enable); |
@@ -203,12 +203,12 @@ discard block |
||
203 | 203 | return $converted; |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Converts an array to a string. |
|
208 | - * @return string |
|
209 | - * |
|
210 | - * @todo Create custom dump implementation, using VariableInfo instances. |
|
211 | - */ |
|
206 | + /** |
|
207 | + * Converts an array to a string. |
|
208 | + * @return string |
|
209 | + * |
|
210 | + * @todo Create custom dump implementation, using VariableInfo instances. |
|
211 | + */ |
|
212 | 212 | protected function toString_array() : string |
213 | 213 | { |
214 | 214 | $result = json_encode($this->value, JSON_PRETTY_PRINT); |
@@ -51,9 +51,9 @@ discard block |
||
51 | 51 | * @param mixed $value |
52 | 52 | * @param array|null $serialized |
53 | 53 | */ |
54 | - public function __construct($value, $serialized=null) |
|
54 | + public function __construct($value, $serialized = null) |
|
55 | 55 | { |
56 | - if(is_array($serialized)) |
|
56 | + if (is_array($serialized)) |
|
57 | 57 | { |
58 | 58 | $this->parseSerialized($serialized); |
59 | 59 | } |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | $this->value = $value; |
102 | 102 | $this->type = strtolower(gettype($value)); |
103 | 103 | |
104 | - if(is_array($value) && is_callable($value)) { |
|
104 | + if (is_array($value) && is_callable($value)) { |
|
105 | 105 | $this->type = self::TYPE_CALLABLE; |
106 | 106 | } |
107 | 107 | |
@@ -134,7 +134,7 @@ discard block |
||
134 | 134 | * @param bool $enable |
135 | 135 | * @return VariableInfo |
136 | 136 | */ |
137 | - public function enableType(bool $enable=true) : VariableInfo |
|
137 | + public function enableType(bool $enable = true) : VariableInfo |
|
138 | 138 | { |
139 | 139 | return $this->setOption('prepend-type', $enable); |
140 | 140 | } |
@@ -143,9 +143,9 @@ discard block |
||
143 | 143 | { |
144 | 144 | $converted = $this->string; |
145 | 145 | |
146 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
146 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
147 | 147 | { |
148 | - if($this->isString()) |
|
148 | + if ($this->isString()) |
|
149 | 149 | { |
150 | 150 | $converted = '"'.$converted.'"'; |
151 | 151 | } |
@@ -177,16 +177,16 @@ discard block |
||
177 | 177 | |
178 | 178 | $converted = $this->$varMethod(); |
179 | 179 | |
180 | - if($format === 'HTML') |
|
180 | + if ($format === 'HTML') |
|
181 | 181 | { |
182 | 182 | $converted = '<span style="color:#'.self::$colors[$type].'" class="variable-value-'.$this->type.'">'.$converted.'</span>'; |
183 | 183 | } |
184 | 184 | |
185 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
185 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
186 | 186 | { |
187 | 187 | $typeLabel = $type; |
188 | 188 | |
189 | - switch($format) |
|
189 | + switch ($format) |
|
190 | 190 | { |
191 | 191 | case 'HTML': |
192 | 192 | $typeLabel = '<span style="color:#1c2eb1" class="variable-type">'.$type.'</span> '; |
@@ -215,7 +215,7 @@ discard block |
||
215 | 215 | |
216 | 216 | // the array may not be encodable - for example if it contains |
217 | 217 | // broken unicode characters. |
218 | - if(is_string($result) && $result !== '') { |
|
218 | + if (is_string($result) && $result !== '') { |
|
219 | 219 | return $result; |
220 | 220 | } |
221 | 221 | |
@@ -226,7 +226,7 @@ discard block |
||
226 | 226 | { |
227 | 227 | $string = ''; |
228 | 228 | |
229 | - if(is_string($this->value[0])) { |
|
229 | + if (is_string($this->value[0])) { |
|
230 | 230 | $string .= $this->value[0].'::'; |
231 | 231 | } else { |
232 | 232 | $string .= get_class($this->value[0]).'->'; |
@@ -353,7 +353,7 @@ discard block |
||
353 | 353 | str_replace(' ', '-', $this->type) |
354 | 354 | ); |
355 | 355 | |
356 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
356 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
357 | 357 | { |
358 | 358 | $typeLabel = '<span style="color:#1c2eb1" class="variable-type">'.$this->type.'</span> '; |
359 | 359 | $converted = $typeLabel.' '.$converted; |
@@ -59,8 +59,7 @@ discard block |
||
59 | 59 | try |
60 | 60 | { |
61 | 61 | throw new BaseException(''); |
62 | - } |
|
63 | - catch(BaseException $e) |
|
62 | + } catch(BaseException $e) |
|
64 | 63 | { |
65 | 64 | echo self::createInfo($e)->toString(); |
66 | 65 | } |
@@ -74,8 +73,7 @@ discard block |
||
74 | 73 | try |
75 | 74 | { |
76 | 75 | throw new BaseException(''); |
77 | - } |
|
78 | - catch(BaseException $e) |
|
76 | + } catch(BaseException $e) |
|
79 | 77 | { |
80 | 78 | echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">'; |
81 | 79 | echo self::createInfo($e)->toString(); |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | * @param int $code |
32 | 32 | * @param \Exception $previous |
33 | 33 | */ |
34 | - public function __construct(string $message, $details=null, $code=null, $previous=null) |
|
34 | + public function __construct(string $message, $details = null, $code = null, $previous = null) |
|
35 | 35 | { |
36 | 36 | parent::__construct($message, $code, $previous); |
37 | 37 | |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | */ |
45 | 45 | public function getDetails() : string |
46 | 46 | { |
47 | - if($this->details !== null) { |
|
47 | + if ($this->details !== null) { |
|
48 | 48 | return $this->details; |
49 | 49 | } |
50 | 50 | |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | */ |
58 | 58 | public function display() |
59 | 59 | { |
60 | - if(!headers_sent()) { |
|
60 | + if (!headers_sent()) { |
|
61 | 61 | header('Content-type:text/plain; charset=utf-8'); |
62 | 62 | } |
63 | 63 | |
@@ -85,7 +85,7 @@ discard block |
||
85 | 85 | { |
86 | 86 | throw new BaseException(''); |
87 | 87 | } |
88 | - catch(BaseException $e) |
|
88 | + catch (BaseException $e) |
|
89 | 89 | { |
90 | 90 | echo self::createInfo($e)->toString(); |
91 | 91 | } |
@@ -100,7 +100,7 @@ discard block |
||
100 | 100 | { |
101 | 101 | throw new BaseException(''); |
102 | 102 | } |
103 | - catch(BaseException $e) |
|
103 | + catch (BaseException $e) |
|
104 | 104 | { |
105 | 105 | echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">'; |
106 | 106 | echo self::createInfo($e)->toString(); |
@@ -20,17 +20,17 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class BaseException extends \Exception |
22 | 22 | { |
23 | - /** |
|
24 | - * @var string |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var string |
|
25 | + */ |
|
26 | 26 | protected $details; |
27 | 27 | |
28 | - /** |
|
29 | - * @param string $message |
|
30 | - * @param string $details |
|
31 | - * @param int $code |
|
32 | - * @param \Exception $previous |
|
33 | - */ |
|
28 | + /** |
|
29 | + * @param string $message |
|
30 | + * @param string $details |
|
31 | + * @param int $code |
|
32 | + * @param \Exception $previous |
|
33 | + */ |
|
34 | 34 | public function __construct(string $message, $details=null, $code=null, $previous=null) |
35 | 35 | { |
36 | 36 | parent::__construct($message, $code, $previous); |
@@ -38,10 +38,10 @@ discard block |
||
38 | 38 | $this->details = $details; |
39 | 39 | } |
40 | 40 | |
41 | - /** |
|
42 | - * Retrieves the detailed error description, if any. |
|
43 | - * @return string |
|
44 | - */ |
|
41 | + /** |
|
42 | + * Retrieves the detailed error description, if any. |
|
43 | + * @return string |
|
44 | + */ |
|
45 | 45 | public function getDetails() : string |
46 | 46 | { |
47 | 47 | if($this->details !== null) { |
@@ -51,9 +51,9 @@ discard block |
||
51 | 51 | return ''; |
52 | 52 | } |
53 | 53 | |
54 | - /** |
|
55 | - * Displays pertinent information on the exception. |
|
56 | - */ |
|
54 | + /** |
|
55 | + * Displays pertinent information on the exception. |
|
56 | + */ |
|
57 | 57 | public function display() |
58 | 58 | { |
59 | 59 | if(!headers_sent()) { |
@@ -63,20 +63,20 @@ discard block |
||
63 | 63 | echo $this->getInfo(); |
64 | 64 | } |
65 | 65 | |
66 | - /** |
|
67 | - * Retrieves information on the exception that can be |
|
68 | - * easily accessed. |
|
69 | - * |
|
70 | - * @return ConvertHelper_ThrowableInfo |
|
71 | - */ |
|
66 | + /** |
|
67 | + * Retrieves information on the exception that can be |
|
68 | + * easily accessed. |
|
69 | + * |
|
70 | + * @return ConvertHelper_ThrowableInfo |
|
71 | + */ |
|
72 | 72 | public function getInfo() : ConvertHelper_ThrowableInfo |
73 | 73 | { |
74 | 74 | return ConvertHelper::throwable2info($this); |
75 | 75 | } |
76 | 76 | |
77 | - /** |
|
78 | - * Dumps a current PHP function trace, as a textonly string. |
|
79 | - */ |
|
77 | + /** |
|
78 | + * Dumps a current PHP function trace, as a textonly string. |
|
79 | + */ |
|
80 | 80 | public static function dumpTraceAsString() |
81 | 81 | { |
82 | 82 | try |
@@ -89,9 +89,9 @@ discard block |
||
89 | 89 | } |
90 | 90 | } |
91 | 91 | |
92 | - /** |
|
93 | - * Dumps a current PHP function trace, with HTML styling. |
|
94 | - */ |
|
92 | + /** |
|
93 | + * Dumps a current PHP function trace, with HTML styling. |
|
94 | + */ |
|
95 | 95 | public static function dumpTraceAsHTML() |
96 | 96 | { |
97 | 97 | try |
@@ -106,13 +106,13 @@ discard block |
||
106 | 106 | } |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Creates an exception info instance from a throwable instance. |
|
111 | - * |
|
112 | - * @param \Throwable $e |
|
113 | - * @return ConvertHelper_ThrowableInfo |
|
114 | - * @see ConvertHelper::throwable2info() |
|
115 | - */ |
|
109 | + /** |
|
110 | + * Creates an exception info instance from a throwable instance. |
|
111 | + * |
|
112 | + * @param \Throwable $e |
|
113 | + * @return ConvertHelper_ThrowableInfo |
|
114 | + * @see ConvertHelper::throwable2info() |
|
115 | + */ |
|
116 | 116 | public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo |
117 | 117 | { |
118 | 118 | return ConvertHelper::throwable2info($e); |