@@ -64,8 +64,7 @@ |
||
| 64 | 64 | if(is_array($subject)) |
| 65 | 65 | { |
| 66 | 66 | $this->parseSerialized($subject); |
| 67 | - } |
|
| 68 | - else |
|
| 67 | + } else |
|
| 69 | 68 | { |
| 70 | 69 | $this->parseException($subject); |
| 71 | 70 | } |
@@ -14,49 +14,49 @@ discard block |
||
| 14 | 14 | const CONTEXT_COMMAND_LINE = 'cli'; |
| 15 | 15 | const CONTEXT_WEB = 'web'; |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var \Throwable |
|
| 19 | - */ |
|
| 17 | + /** |
|
| 18 | + * @var \Throwable |
|
| 19 | + */ |
|
| 20 | 20 | protected $exception; |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | + */ |
|
| 25 | 25 | protected $calls = array(); |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | 30 | protected $code; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $message; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var integer |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var integer |
|
| 39 | + */ |
|
| 40 | 40 | protected $callsCount = 0; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var ConvertHelper_ThrowableInfo |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var ConvertHelper_ThrowableInfo |
|
| 44 | + */ |
|
| 45 | 45 | protected $previous; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $referer = ''; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var \DateTime |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var \DateTime |
|
| 54 | + */ |
|
| 55 | 55 | protected $date; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var string |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var string |
|
| 59 | + */ |
|
| 60 | 60 | protected $context = self::CONTEXT_WEB; |
| 61 | 61 | |
| 62 | 62 | protected function __construct($subject) |
@@ -103,16 +103,16 @@ discard block |
||
| 103 | 103 | return isset($this->previous); |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Retrieves the information on the previous exception. |
|
| 108 | - * |
|
| 109 | - * NOTE: Throws an exception if there is no previous |
|
| 110 | - * exception. Use hasPrevious() first to avoid this. |
|
| 111 | - * |
|
| 112 | - * @throws ConvertHelper_Exception |
|
| 113 | - * @return ConvertHelper_ThrowableInfo |
|
| 114 | - * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | - */ |
|
| 106 | + /** |
|
| 107 | + * Retrieves the information on the previous exception. |
|
| 108 | + * |
|
| 109 | + * NOTE: Throws an exception if there is no previous |
|
| 110 | + * exception. Use hasPrevious() first to avoid this. |
|
| 111 | + * |
|
| 112 | + * @throws ConvertHelper_Exception |
|
| 113 | + * @return ConvertHelper_ThrowableInfo |
|
| 114 | + * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | + */ |
|
| 116 | 116 | public function getPrevious() : ConvertHelper_ThrowableInfo |
| 117 | 117 | { |
| 118 | 118 | if(isset($this->previous)) { |
@@ -131,9 +131,9 @@ discard block |
||
| 131 | 131 | return !empty($this->code); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Improved textonly exception trace. |
|
| 136 | - */ |
|
| 134 | + /** |
|
| 135 | + * Improved textonly exception trace. |
|
| 136 | + */ |
|
| 137 | 137 | public function toString() : string |
| 138 | 138 | { |
| 139 | 139 | $calls = $this->getCalls(); |
@@ -161,73 +161,73 @@ discard block |
||
| 161 | 161 | return $string; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Retrieves the URL of the page in which the exception |
|
| 166 | - * was thrown, if applicable: in CLI context, this will |
|
| 167 | - * return an empty string. |
|
| 168 | - * |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 164 | + /** |
|
| 165 | + * Retrieves the URL of the page in which the exception |
|
| 166 | + * was thrown, if applicable: in CLI context, this will |
|
| 167 | + * return an empty string. |
|
| 168 | + * |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | 171 | public function getReferer() : string |
| 172 | 172 | { |
| 173 | 173 | return $this->referer; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Whether the exception occurred in a command line context. |
|
| 178 | - * @return bool |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * Whether the exception occurred in a command line context. |
|
| 178 | + * @return bool |
|
| 179 | + */ |
|
| 180 | 180 | public function isCommandLine() : bool |
| 181 | 181 | { |
| 182 | 182 | return $this->getContext() === self::CONTEXT_COMMAND_LINE; |
| 183 | 183 | } |
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * Whether the exception occurred during an http request. |
|
| 187 | - * @return bool |
|
| 188 | - */ |
|
| 185 | + /** |
|
| 186 | + * Whether the exception occurred during an http request. |
|
| 187 | + * @return bool |
|
| 188 | + */ |
|
| 189 | 189 | public function isWebRequest() : bool |
| 190 | 190 | { |
| 191 | 191 | return $this->getContext() === self::CONTEXT_WEB; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Retrieves the context identifier, i.e. if the exception |
|
| 196 | - * occurred in a command line context or regular web request. |
|
| 197 | - * |
|
| 198 | - * @return string |
|
| 199 | - * |
|
| 200 | - * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | - * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | - */ |
|
| 194 | + /** |
|
| 195 | + * Retrieves the context identifier, i.e. if the exception |
|
| 196 | + * occurred in a command line context or regular web request. |
|
| 197 | + * |
|
| 198 | + * @return string |
|
| 199 | + * |
|
| 200 | + * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | + * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | + */ |
|
| 205 | 205 | public function getContext() : string |
| 206 | 206 | { |
| 207 | 207 | return $this->context; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves the date of the exception, and approximate time: |
|
| 212 | - * since exceptions do not store time, this is captured the |
|
| 213 | - * moment the ThrowableInfo is created. |
|
| 214 | - * |
|
| 215 | - * @return \DateTime |
|
| 216 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves the date of the exception, and approximate time: |
|
| 212 | + * since exceptions do not store time, this is captured the |
|
| 213 | + * moment the ThrowableInfo is created. |
|
| 214 | + * |
|
| 215 | + * @return \DateTime |
|
| 216 | + */ |
|
| 217 | 217 | public function getDate() : \DateTime |
| 218 | 218 | { |
| 219 | 219 | return $this->date; |
| 220 | 220 | } |
| 221 | 221 | |
| 222 | - /** |
|
| 223 | - * Serializes all information on the exception to an |
|
| 224 | - * associative array. This can be saved (file, database, |
|
| 225 | - * session...), and later be restored into a throwable |
|
| 226 | - * info instance using the fromSerialized() method. |
|
| 227 | - * |
|
| 228 | - * @return array |
|
| 229 | - * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
| 230 | - */ |
|
| 222 | + /** |
|
| 223 | + * Serializes all information on the exception to an |
|
| 224 | + * associative array. This can be saved (file, database, |
|
| 225 | + * session...), and later be restored into a throwable |
|
| 226 | + * info instance using the fromSerialized() method. |
|
| 227 | + * |
|
| 228 | + * @return array |
|
| 229 | + * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
| 230 | + */ |
|
| 231 | 231 | public function serialize() : array |
| 232 | 232 | { |
| 233 | 233 | $result = array( |
@@ -254,24 +254,24 @@ discard block |
||
| 254 | 254 | return $result; |
| 255 | 255 | } |
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Sets the maximum folder depth to show in the |
|
| 259 | - * file paths, to avoid them being too long. |
|
| 260 | - * |
|
| 261 | - * @param int $depth |
|
| 262 | - * @return ConvertHelper_ThrowableInfo |
|
| 263 | - */ |
|
| 257 | + /** |
|
| 258 | + * Sets the maximum folder depth to show in the |
|
| 259 | + * file paths, to avoid them being too long. |
|
| 260 | + * |
|
| 261 | + * @param int $depth |
|
| 262 | + * @return ConvertHelper_ThrowableInfo |
|
| 263 | + */ |
|
| 264 | 264 | public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo |
| 265 | 265 | { |
| 266 | 266 | return $this->setOption('folder-depth', $depth); |
| 267 | 267 | } |
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * Retrieves the current folder depth option value. |
|
| 271 | - * |
|
| 272 | - * @return int |
|
| 273 | - * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
| 274 | - */ |
|
| 269 | + /** |
|
| 270 | + * Retrieves the current folder depth option value. |
|
| 271 | + * |
|
| 272 | + * @return int |
|
| 273 | + * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
| 274 | + */ |
|
| 275 | 275 | public function getFolderDepth() : int |
| 276 | 276 | { |
| 277 | 277 | $depth = $this->getOption('folder-depth'); |
@@ -282,19 +282,19 @@ discard block |
||
| 282 | 282 | return 2; |
| 283 | 283 | } |
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * Retrieves all function calls that led to the error. |
|
| 287 | - * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 288 | - */ |
|
| 285 | + /** |
|
| 286 | + * Retrieves all function calls that led to the error. |
|
| 287 | + * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 288 | + */ |
|
| 289 | 289 | public function getCalls() |
| 290 | 290 | { |
| 291 | 291 | return $this->calls; |
| 292 | 292 | } |
| 293 | 293 | |
| 294 | - /** |
|
| 295 | - * Returns the amount of function and method calls in the stack trace. |
|
| 296 | - * @return int |
|
| 297 | - */ |
|
| 294 | + /** |
|
| 295 | + * Returns the amount of function and method calls in the stack trace. |
|
| 296 | + * @return int |
|
| 297 | + */ |
|
| 298 | 298 | public function countCalls() : int |
| 299 | 299 | { |
| 300 | 300 | return $this->callsCount; |
@@ -61,7 +61,7 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | protected function __construct($subject) |
| 63 | 63 | { |
| 64 | - if(is_array($subject)) |
|
| 64 | + if (is_array($subject)) |
|
| 65 | 65 | { |
| 66 | 66 | $this->parseSerialized($subject); |
| 67 | 67 | } |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | */ |
| 116 | 116 | public function getPrevious() : ConvertHelper_ThrowableInfo |
| 117 | 117 | { |
| 118 | - if(isset($this->previous)) { |
|
| 118 | + if (isset($this->previous)) { |
|
| 119 | 119 | return $this->previous; |
| 120 | 120 | } |
| 121 | 121 | |
@@ -140,18 +140,18 @@ discard block |
||
| 140 | 140 | |
| 141 | 141 | $string = 'Exception'; |
| 142 | 142 | |
| 143 | - if($this->hasCode()) { |
|
| 143 | + if ($this->hasCode()) { |
|
| 144 | 144 | $string .= ' #'.$this->code; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | $string .= ': '.$this->getMessage().PHP_EOL; |
| 148 | 148 | |
| 149 | - foreach($calls as $call) |
|
| 149 | + foreach ($calls as $call) |
|
| 150 | 150 | { |
| 151 | 151 | $string .= $call->toString().PHP_EOL; |
| 152 | 152 | } |
| 153 | 153 | |
| 154 | - if($this->hasPrevious()) |
|
| 154 | + if ($this->hasPrevious()) |
|
| 155 | 155 | { |
| 156 | 156 | $string .= PHP_EOL.PHP_EOL. |
| 157 | 157 | 'Previous error:'.PHP_EOL.PHP_EOL. |
@@ -242,11 +242,11 @@ discard block |
||
| 242 | 242 | 'previous' => null, |
| 243 | 243 | ); |
| 244 | 244 | |
| 245 | - if($this->hasPrevious()) { |
|
| 246 | - $result['previous'] = $this->previous->serialize(); |
|
| 245 | + if ($this->hasPrevious()) { |
|
| 246 | + $result['previous'] = $this->previous->serialize(); |
|
| 247 | 247 | } |
| 248 | 248 | |
| 249 | - foreach($this->calls as $call) |
|
| 249 | + foreach ($this->calls as $call) |
|
| 250 | 250 | { |
| 251 | 251 | $result['calls'][] = $call->serialize(); |
| 252 | 252 | } |
@@ -275,7 +275,7 @@ discard block |
||
| 275 | 275 | public function getFolderDepth() : int |
| 276 | 276 | { |
| 277 | 277 | $depth = $this->getOption('folder-depth'); |
| 278 | - if(!empty($depth)) { |
|
| 278 | + if (!empty($depth)) { |
|
| 279 | 279 | return $depth; |
| 280 | 280 | } |
| 281 | 281 | |
@@ -311,12 +311,12 @@ discard block |
||
| 311 | 311 | |
| 312 | 312 | $this->setOptions($serialized['options']); |
| 313 | 313 | |
| 314 | - if(!empty($serialized['previous'])) |
|
| 314 | + if (!empty($serialized['previous'])) |
|
| 315 | 315 | { |
| 316 | 316 | $this->previous = ConvertHelper_ThrowableInfo::fromSerialized($serialized['previous']); |
| 317 | 317 | } |
| 318 | 318 | |
| 319 | - foreach($serialized['calls'] as $def) |
|
| 319 | + foreach ($serialized['calls'] as $def) |
|
| 320 | 320 | { |
| 321 | 321 | $this->calls[] = ConvertHelper_ThrowableInfo_Call::fromSerialized($this, $def); |
| 322 | 322 | } |
@@ -328,16 +328,16 @@ discard block |
||
| 328 | 328 | $this->message = $e->getMessage(); |
| 329 | 329 | $this->code = intval($e->getCode()); |
| 330 | 330 | |
| 331 | - if(!isset($_REQUEST) || !isset($_REQUEST['REQUEST_URI'])) { |
|
| 331 | + if (!isset($_REQUEST) || !isset($_REQUEST['REQUEST_URI'])) { |
|
| 332 | 332 | $this->context = self::CONTEXT_COMMAND_LINE; |
| 333 | 333 | } |
| 334 | 334 | |
| 335 | 335 | $previous = $e->getPrevious(); |
| 336 | - if(!empty($previous)) { |
|
| 336 | + if (!empty($previous)) { |
|
| 337 | 337 | $this->previous = ConvertHelper::throwable2info($previous); |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | - if(isset($_SERVER) && isset($_SERVER['REQUEST_URI'])) { |
|
| 340 | + if (isset($_SERVER) && isset($_SERVER['REQUEST_URI'])) { |
|
| 341 | 341 | $this->referer = $_SERVER['REQUEST_URI']; |
| 342 | 342 | } |
| 343 | 343 | |
@@ -351,7 +351,7 @@ discard block |
||
| 351 | 351 | |
| 352 | 352 | $idx = 1; |
| 353 | 353 | |
| 354 | - foreach($trace as $entry) |
|
| 354 | + foreach ($trace as $entry) |
|
| 355 | 355 | { |
| 356 | 356 | $this->calls[] = ConvertHelper_ThrowableInfo_Call::fromTrace($this, $idx, $entry); |
| 357 | 357 | |
@@ -12,50 +12,50 @@ discard block |
||
| 12 | 12 | |
| 13 | 13 | const TYPE_SCRIPT_START = 'start'; |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var ConvertHelper_ThrowableInfo |
|
| 17 | - */ |
|
| 15 | + /** |
|
| 16 | + * @var ConvertHelper_ThrowableInfo |
|
| 17 | + */ |
|
| 18 | 18 | protected $info; |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var array |
|
| 22 | - */ |
|
| 20 | + /** |
|
| 21 | + * @var array |
|
| 22 | + */ |
|
| 23 | 23 | protected $trace; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var VariableInfo[] |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var VariableInfo[] |
|
| 27 | + */ |
|
| 28 | 28 | protected $args = array(); |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * The source file, if any |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 30 | + /** |
|
| 31 | + * The source file, if any |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected $file = ''; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $class = ''; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var integer |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var integer |
|
| 43 | + */ |
|
| 44 | 44 | protected $line = 0; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var int |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var int |
|
| 48 | + */ |
|
| 49 | 49 | protected $position = 1; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | 54 | protected $function = ''; |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | 59 | protected $type = self::TYPE_SCRIPT_START; |
| 60 | 60 | |
| 61 | 61 | protected function __construct(ConvertHelper_ThrowableInfo $info, array $data) |
@@ -82,10 +82,10 @@ discard block |
||
| 82 | 82 | } |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * 1-based position of the call in the calls list. |
|
| 87 | - * @return int |
|
| 88 | - */ |
|
| 85 | + /** |
|
| 86 | + * 1-based position of the call in the calls list. |
|
| 87 | + * @return int |
|
| 88 | + */ |
|
| 89 | 89 | public function getPosition() : int |
| 90 | 90 | { |
| 91 | 91 | return $this->position; |
@@ -96,18 +96,18 @@ discard block |
||
| 96 | 96 | return $this->line; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Whether the call had any arguments. |
|
| 101 | - * @return bool |
|
| 102 | - */ |
|
| 99 | + /** |
|
| 100 | + * Whether the call had any arguments. |
|
| 101 | + * @return bool |
|
| 102 | + */ |
|
| 103 | 103 | public function hasArguments() : bool |
| 104 | 104 | { |
| 105 | 105 | return !empty($this->args); |
| 106 | 106 | } |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * @return VariableInfo[] |
|
| 110 | - */ |
|
| 108 | + /** |
|
| 109 | + * @return VariableInfo[] |
|
| 110 | + */ |
|
| 111 | 111 | public function getArguments() |
| 112 | 112 | { |
| 113 | 113 | return $this->args; |
@@ -240,31 +240,31 @@ discard block |
||
| 240 | 240 | return implode(', ', $tokens); |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * Retrieves the type of call: typcially a function |
|
| 245 | - * call, or a method call of an object. Note that the |
|
| 246 | - * first call in a script does not have either. |
|
| 247 | - * |
|
| 248 | - * @return string |
|
| 249 | - * |
|
| 250 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
| 251 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
| 252 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
| 253 | - * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
| 254 | - * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
| 255 | - */ |
|
| 243 | + /** |
|
| 244 | + * Retrieves the type of call: typcially a function |
|
| 245 | + * call, or a method call of an object. Note that the |
|
| 246 | + * first call in a script does not have either. |
|
| 247 | + * |
|
| 248 | + * @return string |
|
| 249 | + * |
|
| 250 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
| 251 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
| 252 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
| 253 | + * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
| 254 | + * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
| 255 | + */ |
|
| 256 | 256 | public function getType() : string |
| 257 | 257 | { |
| 258 | 258 | return $this->type; |
| 259 | 259 | } |
| 260 | 260 | |
| 261 | - /** |
|
| 262 | - * Serializes the call to an array, with all |
|
| 263 | - * necessary information. Can be used to restore |
|
| 264 | - * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
| 265 | - * |
|
| 266 | - * @return array |
|
| 267 | - */ |
|
| 261 | + /** |
|
| 262 | + * Serializes the call to an array, with all |
|
| 263 | + * necessary information. Can be used to restore |
|
| 264 | + * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
| 265 | + * |
|
| 266 | + * @return array |
|
| 267 | + */ |
|
| 268 | 268 | public function serialize() : array |
| 269 | 269 | { |
| 270 | 270 | $result = array( |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | { |
| 63 | 63 | $this->info = $info; |
| 64 | 64 | |
| 65 | - if(isset($data['serialized'])) |
|
| 65 | + if (isset($data['serialized'])) |
|
| 66 | 66 | { |
| 67 | 67 | $this->parseSerialized($data['serialized']); |
| 68 | 68 | } |
@@ -72,11 +72,11 @@ discard block |
||
| 72 | 72 | $this->position = $data['position']; |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - if($this->hasClass()) |
|
| 75 | + if ($this->hasClass()) |
|
| 76 | 76 | { |
| 77 | 77 | $this->type = self::TYPE_METHOD_CALL; |
| 78 | 78 | } |
| 79 | - else if($this->hasFunction()) |
|
| 79 | + else if ($this->hasFunction()) |
|
| 80 | 80 | { |
| 81 | 81 | $this->type = self::TYPE_FUNCTION_CALL; |
| 82 | 82 | } |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | |
| 136 | 136 | public function getFileName() : string |
| 137 | 137 | { |
| 138 | - if($this->hasFile()) { |
|
| 138 | + if ($this->hasFile()) { |
|
| 139 | 139 | return basename($this->file); |
| 140 | 140 | } |
| 141 | 141 | |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | |
| 145 | 145 | public function getFileRelative() : string |
| 146 | 146 | { |
| 147 | - if($this->hasFile()) { |
|
| 147 | + if ($this->hasFile()) { |
|
| 148 | 148 | return FileHelper::relativizePathByDepth($this->file, $this->info->getFolderDepth()); |
| 149 | 149 | } |
| 150 | 150 | |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | $this->class = $data['class']; |
| 171 | 171 | $this->position = $data['position']; |
| 172 | 172 | |
| 173 | - foreach($data['arguments'] as $arg) |
|
| 173 | + foreach ($data['arguments'] as $arg) |
|
| 174 | 174 | { |
| 175 | 175 | $this->args[] = VariableInfo::fromSerialized($arg); |
| 176 | 176 | } |
@@ -178,29 +178,29 @@ discard block |
||
| 178 | 178 | |
| 179 | 179 | protected function parseTrace(array $trace) |
| 180 | 180 | { |
| 181 | - if(isset($trace['line'])) |
|
| 181 | + if (isset($trace['line'])) |
|
| 182 | 182 | { |
| 183 | 183 | $this->line = intval($trace['line']); |
| 184 | 184 | } |
| 185 | 185 | |
| 186 | - if(isset($trace['function'])) |
|
| 186 | + if (isset($trace['function'])) |
|
| 187 | 187 | { |
| 188 | 188 | $this->function = $trace['function']; |
| 189 | 189 | } |
| 190 | 190 | |
| 191 | - if(isset($trace['file'])) |
|
| 191 | + if (isset($trace['file'])) |
|
| 192 | 192 | { |
| 193 | 193 | $this->file = FileHelper::normalizePath($trace['file']); |
| 194 | 194 | } |
| 195 | 195 | |
| 196 | - if(isset($trace['class'])) |
|
| 196 | + if (isset($trace['class'])) |
|
| 197 | 197 | { |
| 198 | 198 | $this->class = $trace['class']; |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - if(isset($trace['args']) && !empty($trace['args'])) |
|
| 201 | + if (isset($trace['args']) && !empty($trace['args'])) |
|
| 202 | 202 | { |
| 203 | - foreach($trace['args'] as $arg) |
|
| 203 | + foreach ($trace['args'] as $arg) |
|
| 204 | 204 | { |
| 205 | 205 | $this->args[] = parseVariable($arg); |
| 206 | 206 | } |
@@ -215,13 +215,13 @@ discard block |
||
| 215 | 215 | |
| 216 | 216 | $tokens[] = '#'.sprintf('%0'.$padLength.'d', $this->getPosition()).' '; |
| 217 | 217 | |
| 218 | - if($this->hasFile()) { |
|
| 218 | + if ($this->hasFile()) { |
|
| 219 | 219 | $tokens[] = $this->getFileRelative().':'.$this->getLine(); |
| 220 | 220 | } |
| 221 | 221 | |
| 222 | - if($this->hasClass()) { |
|
| 222 | + if ($this->hasClass()) { |
|
| 223 | 223 | $tokens[] = $this->getClass().'::'.$this->getFunction().'('.$this->argumentsToString().')'; |
| 224 | - } else if($this->hasFunction()) { |
|
| 224 | + } else if ($this->hasFunction()) { |
|
| 225 | 225 | $tokens[] = $this->getFunction().'('.$this->argumentsToString().')'; |
| 226 | 226 | } |
| 227 | 227 | |
@@ -232,7 +232,7 @@ discard block |
||
| 232 | 232 | { |
| 233 | 233 | $tokens = array(); |
| 234 | 234 | |
| 235 | - foreach($this->args as $arg) |
|
| 235 | + foreach ($this->args as $arg) |
|
| 236 | 236 | { |
| 237 | 237 | $tokens[] = $arg->toString(); |
| 238 | 238 | } |
@@ -277,7 +277,7 @@ discard block |
||
| 277 | 277 | 'arguments' => array() |
| 278 | 278 | ); |
| 279 | 279 | |
| 280 | - foreach($this->args as $argument) |
|
| 280 | + foreach ($this->args as $argument) |
|
| 281 | 281 | { |
| 282 | 282 | $result['arguments'][] = $argument->serialize(); |
| 283 | 283 | } |
@@ -65,8 +65,7 @@ discard block |
||
| 65 | 65 | if(isset($data['serialized'])) |
| 66 | 66 | { |
| 67 | 67 | $this->parseSerialized($data['serialized']); |
| 68 | - } |
|
| 69 | - else |
|
| 68 | + } else |
|
| 70 | 69 | { |
| 71 | 70 | $this->parseTrace($data['trace']); |
| 72 | 71 | $this->position = $data['position']; |
@@ -75,8 +74,7 @@ discard block |
||
| 75 | 74 | if($this->hasClass()) |
| 76 | 75 | { |
| 77 | 76 | $this->type = self::TYPE_METHOD_CALL; |
| 78 | - } |
|
| 79 | - else if($this->hasFunction()) |
|
| 77 | + } else if($this->hasFunction()) |
|
| 80 | 78 | { |
| 81 | 79 | $this->type = self::TYPE_FUNCTION_CALL; |
| 82 | 80 | } |
@@ -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; |
@@ -279,8 +279,7 @@ |
||
| 279 | 279 | $entry['quality'] = (double)$params['q']; |
| 280 | 280 | } |
| 281 | 281 | } |
| 282 | - } |
|
| 283 | - else |
|
| 282 | + } else |
|
| 284 | 283 | { |
| 285 | 284 | $entry['type'] = $term; |
| 286 | 285 | } |
@@ -39,9 +39,9 @@ discard block |
||
| 39 | 39 | */ |
| 40 | 40 | protected static $instance; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $baseURL = ''; |
| 46 | 46 | |
| 47 | 47 | public function __construct() |
@@ -51,10 +51,10 @@ discard block |
||
| 51 | 51 | $this->init(); |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Can be extended in a subclass, to avoid |
|
| 56 | - * redefining the constructor. |
|
| 57 | - */ |
|
| 54 | + /** |
|
| 55 | + * Can be extended in a subclass, to avoid |
|
| 56 | + * redefining the constructor. |
|
| 57 | + */ |
|
| 58 | 58 | protected function init() |
| 59 | 59 | { |
| 60 | 60 | |
@@ -124,12 +124,12 @@ discard block |
||
| 124 | 124 | return $this->buildURL($params, $dispatcher); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * Retrieves the name of the current dispatcher script / page. |
|
| 129 | - * This is made to be extended and implemented in a subclass. |
|
| 130 | - * |
|
| 131 | - * @return string |
|
| 132 | - */ |
|
| 127 | + /** |
|
| 128 | + * Retrieves the name of the current dispatcher script / page. |
|
| 129 | + * This is made to be extended and implemented in a subclass. |
|
| 130 | + * |
|
| 131 | + * @return string |
|
| 132 | + */ |
|
| 133 | 133 | public function getDispatcher() : string |
| 134 | 134 | { |
| 135 | 135 | return ''; |
@@ -198,10 +198,10 @@ discard block |
||
| 198 | 198 | return $url; |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - /** |
|
| 202 | - * Retrieves the base URL of the application. |
|
| 203 | - * @return string |
|
| 204 | - */ |
|
| 201 | + /** |
|
| 202 | + * Retrieves the base URL of the application. |
|
| 203 | + * @return string |
|
| 204 | + */ |
|
| 205 | 205 | public function getBaseURL() : string |
| 206 | 206 | { |
| 207 | 207 | return $this->baseURL; |
@@ -231,13 +231,13 @@ discard block |
||
| 231 | 231 | return $this->knownParams[$name]; |
| 232 | 232 | } |
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Retrieves a previously registered parameter instance. |
|
| 236 | - * |
|
| 237 | - * @param string $name |
|
| 238 | - * @throws Request_Exception |
|
| 239 | - * @return Request_Param |
|
| 240 | - */ |
|
| 234 | + /** |
|
| 235 | + * Retrieves a previously registered parameter instance. |
|
| 236 | + * |
|
| 237 | + * @param string $name |
|
| 238 | + * @throws Request_Exception |
|
| 239 | + * @return Request_Param |
|
| 240 | + */ |
|
| 241 | 241 | public function getRegisteredParam(string $name) : Request_Param |
| 242 | 242 | { |
| 243 | 243 | if(isset($this->knownParams[$name])) { |
@@ -254,13 +254,13 @@ discard block |
||
| 254 | 254 | ); |
| 255 | 255 | } |
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Checks whether a parameter with the specified name |
|
| 259 | - * has been registered. |
|
| 260 | - * |
|
| 261 | - * @param string $name |
|
| 262 | - * @return bool |
|
| 263 | - */ |
|
| 257 | + /** |
|
| 258 | + * Checks whether a parameter with the specified name |
|
| 259 | + * has been registered. |
|
| 260 | + * |
|
| 261 | + * @param string $name |
|
| 262 | + * @return bool |
|
| 263 | + */ |
|
| 264 | 264 | public function hasRegisteredParam(string $name) : bool |
| 265 | 265 | { |
| 266 | 266 | return isset($this->knownParams[$name]); |
@@ -389,14 +389,14 @@ discard block |
||
| 389 | 389 | return false; |
| 390 | 390 | } |
| 391 | 391 | |
| 392 | - /** |
|
| 393 | - * Removes a single parameter from the request. |
|
| 394 | - * If the parameter has been registered, also |
|
| 395 | - * removes the registration info. |
|
| 396 | - * |
|
| 397 | - * @param string $name |
|
| 398 | - * @return Request |
|
| 399 | - */ |
|
| 392 | + /** |
|
| 393 | + * Removes a single parameter from the request. |
|
| 394 | + * If the parameter has been registered, also |
|
| 395 | + * removes the registration info. |
|
| 396 | + * |
|
| 397 | + * @param string $name |
|
| 398 | + * @return Request |
|
| 399 | + */ |
|
| 400 | 400 | public function removeParam(string $name) : Request |
| 401 | 401 | { |
| 402 | 402 | if(isset($_REQUEST[$name])) { |
@@ -410,12 +410,12 @@ discard block |
||
| 410 | 410 | return $this; |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | - /** |
|
| 414 | - * Removes several parameters from the request. |
|
| 415 | - * |
|
| 416 | - * @param string[] $names |
|
| 417 | - * @return Request |
|
| 418 | - */ |
|
| 413 | + /** |
|
| 414 | + * Removes several parameters from the request. |
|
| 415 | + * |
|
| 416 | + * @param string[] $names |
|
| 417 | + * @return Request |
|
| 418 | + */ |
|
| 419 | 419 | public function removeParams(array $names) : Request |
| 420 | 420 | { |
| 421 | 421 | foreach($names as $name) { |
@@ -480,18 +480,18 @@ discard block |
||
| 480 | 480 | return $val; |
| 481 | 481 | } |
| 482 | 482 | |
| 483 | - /** |
|
| 484 | - * Treats the request parameter as a JSON string, and |
|
| 485 | - * if it exists and contains valid JSON, returns the |
|
| 486 | - * decoded JSON value as an array (default). |
|
| 487 | - * |
|
| 488 | - * @param string $name |
|
| 489 | - * @param bool $assoc |
|
| 490 | - * @return array|object |
|
| 491 | - * |
|
| 492 | - * @see Request::getJSONAssoc() |
|
| 493 | - * @see Request::getJSONObject() |
|
| 494 | - */ |
|
| 483 | + /** |
|
| 484 | + * Treats the request parameter as a JSON string, and |
|
| 485 | + * if it exists and contains valid JSON, returns the |
|
| 486 | + * decoded JSON value as an array (default). |
|
| 487 | + * |
|
| 488 | + * @param string $name |
|
| 489 | + * @param bool $assoc |
|
| 490 | + * @return array|object |
|
| 491 | + * |
|
| 492 | + * @see Request::getJSONAssoc() |
|
| 493 | + * @see Request::getJSONObject() |
|
| 494 | + */ |
|
| 495 | 495 | public function getJSON(string $name, bool $assoc=true) |
| 496 | 496 | { |
| 497 | 497 | $value = $this->getParam($name); |
@@ -516,13 +516,13 @@ discard block |
||
| 516 | 516 | return new \stdClass(); |
| 517 | 517 | } |
| 518 | 518 | |
| 519 | - /** |
|
| 520 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 521 | - * parameter. Use this for more readable code. |
|
| 522 | - * |
|
| 523 | - * @param string $name |
|
| 524 | - * @return array |
|
| 525 | - */ |
|
| 519 | + /** |
|
| 520 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 521 | + * parameter. Use this for more readable code. |
|
| 522 | + * |
|
| 523 | + * @param string $name |
|
| 524 | + * @return array |
|
| 525 | + */ |
|
| 526 | 526 | public function getJSONAssoc(string $name) : array |
| 527 | 527 | { |
| 528 | 528 | $result = $this->getJSON($name); |
@@ -533,13 +533,13 @@ discard block |
||
| 533 | 533 | return array(); |
| 534 | 534 | } |
| 535 | 535 | |
| 536 | - /** |
|
| 537 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 538 | - * parameter. Use this for more readable code. |
|
| 539 | - * |
|
| 540 | - * @param string $name |
|
| 541 | - * @return object |
|
| 542 | - */ |
|
| 536 | + /** |
|
| 537 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 538 | + * parameter. Use this for more readable code. |
|
| 539 | + * |
|
| 540 | + * @param string $name |
|
| 541 | + * @return object |
|
| 542 | + */ |
|
| 543 | 543 | public function getJSONObject(string $name) : object |
| 544 | 544 | { |
| 545 | 545 | $result = $this->getJSON($name, false); |
@@ -550,12 +550,12 @@ discard block |
||
| 550 | 550 | return new \stdClass(); |
| 551 | 551 | } |
| 552 | 552 | |
| 553 | - /** |
|
| 554 | - * Sends a JSON response with the correct headers. |
|
| 555 | - * |
|
| 556 | - * @param array|string $data |
|
| 557 | - * @param bool $exit Whether to exit the script afterwards. |
|
| 558 | - */ |
|
| 553 | + /** |
|
| 554 | + * Sends a JSON response with the correct headers. |
|
| 555 | + * |
|
| 556 | + * @param array|string $data |
|
| 557 | + * @param bool $exit Whether to exit the script afterwards. |
|
| 558 | + */ |
|
| 559 | 559 | public static function sendJSON($data, bool $exit=true) |
| 560 | 560 | { |
| 561 | 561 | $payload = $data; |
@@ -575,12 +575,12 @@ discard block |
||
| 575 | 575 | } |
| 576 | 576 | } |
| 577 | 577 | |
| 578 | - /** |
|
| 579 | - * Sends HTML to the browser with the correct headers. |
|
| 580 | - * |
|
| 581 | - * @param string $html |
|
| 582 | - * @param bool $exit Whether to exit the script afterwards. |
|
| 583 | - */ |
|
| 578 | + /** |
|
| 579 | + * Sends HTML to the browser with the correct headers. |
|
| 580 | + * |
|
| 581 | + * @param string $html |
|
| 582 | + * @param bool $exit Whether to exit the script afterwards. |
|
| 583 | + */ |
|
| 584 | 584 | public static function sendHTML(string $html, bool $exit=true) |
| 585 | 585 | { |
| 586 | 586 | header('Cache-Control: no-cache, must-revalidate'); |
@@ -595,16 +595,16 @@ discard block |
||
| 595 | 595 | } |
| 596 | 596 | } |
| 597 | 597 | |
| 598 | - /** |
|
| 599 | - * Creates a new instance of the URL comparer, which can check |
|
| 600 | - * whether the specified URLs match, regardless of the order in |
|
| 601 | - * which the query parameters are, if any. |
|
| 602 | - * |
|
| 603 | - * @param string $sourceURL |
|
| 604 | - * @param string $targetURL |
|
| 605 | - * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 606 | - * @return Request_URLComparer |
|
| 607 | - */ |
|
| 598 | + /** |
|
| 599 | + * Creates a new instance of the URL comparer, which can check |
|
| 600 | + * whether the specified URLs match, regardless of the order in |
|
| 601 | + * which the query parameters are, if any. |
|
| 602 | + * |
|
| 603 | + * @param string $sourceURL |
|
| 604 | + * @param string $targetURL |
|
| 605 | + * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 606 | + * @return Request_URLComparer |
|
| 607 | + */ |
|
| 608 | 608 | public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer |
| 609 | 609 | { |
| 610 | 610 | $comparer = new Request_URLComparer($this, $sourceURL, $targetURL); |
@@ -613,10 +613,10 @@ discard block |
||
| 613 | 613 | return $comparer; |
| 614 | 614 | } |
| 615 | 615 | |
| 616 | - /** |
|
| 617 | - * Retrieves the full URL that was used to access the current page. |
|
| 618 | - * @return string |
|
| 619 | - */ |
|
| 616 | + /** |
|
| 617 | + * Retrieves the full URL that was used to access the current page. |
|
| 618 | + * @return string |
|
| 619 | + */ |
|
| 620 | 620 | public function getCurrentURL() : string |
| 621 | 621 | { |
| 622 | 622 | return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']; |
@@ -90,11 +90,11 @@ discard block |
||
| 90 | 90 | public function getParam($name, $default = null) |
| 91 | 91 | { |
| 92 | 92 | $value = $default; |
| 93 | - if(isset($_REQUEST[$name])) { |
|
| 93 | + if (isset($_REQUEST[$name])) { |
|
| 94 | 94 | $value = $_REQUEST[$name]; |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - if(isset($this->knownParams[$name])) { |
|
| 97 | + if (isset($this->knownParams[$name])) { |
|
| 98 | 98 | $value = $this->knownParams[$name]->validate($value); |
| 99 | 99 | } |
| 100 | 100 | |
@@ -137,8 +137,8 @@ discard block |
||
| 137 | 137 | |
| 138 | 138 | public function getRefreshParams($params = array(), $exclude = array()) |
| 139 | 139 | { |
| 140 | - if(empty($params)) { $params = array(); } |
|
| 141 | - if(empty($exclude)) { $exclude = array(); } |
|
| 140 | + if (empty($params)) { $params = array(); } |
|
| 141 | + if (empty($exclude)) { $exclude = array(); } |
|
| 142 | 142 | |
| 143 | 143 | $vars = $_REQUEST; |
| 144 | 144 | |
@@ -158,8 +158,8 @@ discard block |
||
| 158 | 158 | // remove the quickform form variable if present, to |
| 159 | 159 | // avoid redirect loops when using the refresh URL in |
| 160 | 160 | // a page in which a form has been submitted. |
| 161 | - foreach($names as $name) { |
|
| 162 | - if(strstr($name, '_qf__')) { |
|
| 161 | + foreach ($names as $name) { |
|
| 162 | + if (strstr($name, '_qf__')) { |
|
| 163 | 163 | unset($vars[$name]); |
| 164 | 164 | break; |
| 165 | 165 | } |
@@ -186,13 +186,13 @@ discard block |
||
| 186 | 186 | * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed. |
| 187 | 187 | * @return string |
| 188 | 188 | */ |
| 189 | - public function buildURL($params = array(), string $dispatcher='') |
|
| 189 | + public function buildURL($params = array(), string $dispatcher = '') |
|
| 190 | 190 | { |
| 191 | - $url = rtrim($this->getBaseURL(), '/') . '/' . $dispatcher; |
|
| 191 | + $url = rtrim($this->getBaseURL(), '/').'/'.$dispatcher; |
|
| 192 | 192 | |
| 193 | 193 | // append any leftover parameters to the end of the URL |
| 194 | 194 | if (!empty($params)) { |
| 195 | - $url .= '?' . http_build_query($params, null, '&'); |
|
| 195 | + $url .= '?'.http_build_query($params, null, '&'); |
|
| 196 | 196 | } |
| 197 | 197 | |
| 198 | 198 | return $url; |
@@ -223,7 +223,7 @@ discard block |
||
| 223 | 223 | */ |
| 224 | 224 | public function registerParam($name) |
| 225 | 225 | { |
| 226 | - if(!isset($this->knownParams[$name])) { |
|
| 226 | + if (!isset($this->knownParams[$name])) { |
|
| 227 | 227 | $param = new Request_Param($this, $name); |
| 228 | 228 | $this->knownParams[$name] = $param; |
| 229 | 229 | } |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | */ |
| 241 | 241 | public function getRegisteredParam(string $name) : Request_Param |
| 242 | 242 | { |
| 243 | - if(isset($this->knownParams[$name])) { |
|
| 243 | + if (isset($this->knownParams[$name])) { |
|
| 244 | 244 | return $this->knownParams[$name]; |
| 245 | 245 | } |
| 246 | 246 | |
@@ -307,12 +307,12 @@ discard block |
||
| 307 | 307 | { |
| 308 | 308 | $entry['type'] = $matches[1]; |
| 309 | 309 | |
| 310 | - if(isset($matches[2]) && !empty($matches[2])) |
|
| 310 | + if (isset($matches[2]) && !empty($matches[2])) |
|
| 311 | 311 | { |
| 312 | 312 | $params = ConvertHelper::parseQueryString($matches[2]); |
| 313 | 313 | $entry['params'] = $params; |
| 314 | 314 | |
| 315 | - if(isset($params['q'])) { |
|
| 315 | + if (isset($params['q'])) { |
|
| 316 | 316 | $entry['quality'] = (double)$params['q']; |
| 317 | 317 | } |
| 318 | 318 | } |
@@ -365,7 +365,7 @@ discard block |
||
| 365 | 365 | { |
| 366 | 366 | $_REQUEST[$name] = $value; |
| 367 | 367 | |
| 368 | - if(isset($this->knownParams[$name])) { |
|
| 368 | + if (isset($this->knownParams[$name])) { |
|
| 369 | 369 | unset($this->knownParams[$name]); |
| 370 | 370 | } |
| 371 | 371 | |
@@ -399,11 +399,11 @@ discard block |
||
| 399 | 399 | */ |
| 400 | 400 | public function removeParam(string $name) : Request |
| 401 | 401 | { |
| 402 | - if(isset($_REQUEST[$name])) { |
|
| 402 | + if (isset($_REQUEST[$name])) { |
|
| 403 | 403 | unset($_REQUEST[$name]); |
| 404 | 404 | } |
| 405 | 405 | |
| 406 | - if(isset($this->knownParams[$name])) { |
|
| 406 | + if (isset($this->knownParams[$name])) { |
|
| 407 | 407 | unset($this->knownParams[$name]); |
| 408 | 408 | } |
| 409 | 409 | |
@@ -418,7 +418,7 @@ discard block |
||
| 418 | 418 | */ |
| 419 | 419 | public function removeParams(array $names) : Request |
| 420 | 420 | { |
| 421 | - foreach($names as $name) { |
|
| 421 | + foreach ($names as $name) { |
|
| 422 | 422 | $this->removeParam($name); |
| 423 | 423 | } |
| 424 | 424 | |
@@ -434,10 +434,10 @@ discard block |
||
| 434 | 434 | * @param string $name |
| 435 | 435 | * @return bool |
| 436 | 436 | */ |
| 437 | - public function getBool($name, $default=false) |
|
| 437 | + public function getBool($name, $default = false) |
|
| 438 | 438 | { |
| 439 | 439 | $value = $this->getParam($name, $default); |
| 440 | - if(ConvertHelper::isBoolean($value)) { |
|
| 440 | + if (ConvertHelper::isBoolean($value)) { |
|
| 441 | 441 | return ConvertHelper::string2bool($value); |
| 442 | 442 | } |
| 443 | 443 | |
@@ -446,9 +446,9 @@ discard block |
||
| 446 | 446 | |
| 447 | 447 | public function validate() |
| 448 | 448 | { |
| 449 | - foreach($this->knownParams as $param) { |
|
| 449 | + foreach ($this->knownParams as $param) { |
|
| 450 | 450 | $name = $param->getName(); |
| 451 | - if($param->isRequired() && !$this->hasParam($name)) { |
|
| 451 | + if ($param->isRequired() && !$this->hasParam($name)) { |
|
| 452 | 452 | throw new Request_Exception( |
| 453 | 453 | 'Missing request parameter '.$name, |
| 454 | 454 | sprintf( |
@@ -470,10 +470,10 @@ discard block |
||
| 470 | 470 | * @param mixed $default |
| 471 | 471 | * @return string |
| 472 | 472 | */ |
| 473 | - public function getFilteredParam($name, $default=null) |
|
| 473 | + public function getFilteredParam($name, $default = null) |
|
| 474 | 474 | { |
| 475 | 475 | $val = $this->getParam($name, $default); |
| 476 | - if(is_string($val)) { |
|
| 476 | + if (is_string($val)) { |
|
| 477 | 477 | $val = htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8'); |
| 478 | 478 | } |
| 479 | 479 | |
@@ -492,24 +492,24 @@ discard block |
||
| 492 | 492 | * @see Request::getJSONAssoc() |
| 493 | 493 | * @see Request::getJSONObject() |
| 494 | 494 | */ |
| 495 | - public function getJSON(string $name, bool $assoc=true) |
|
| 495 | + public function getJSON(string $name, bool $assoc = true) |
|
| 496 | 496 | { |
| 497 | 497 | $value = $this->getParam($name); |
| 498 | 498 | |
| 499 | - if(!empty($value) && is_string($value)) |
|
| 499 | + if (!empty($value) && is_string($value)) |
|
| 500 | 500 | { |
| 501 | 501 | $data = json_decode($value, $assoc); |
| 502 | 502 | |
| 503 | - if($assoc && is_array($data)) { |
|
| 503 | + if ($assoc && is_array($data)) { |
|
| 504 | 504 | return $data; |
| 505 | 505 | } |
| 506 | 506 | |
| 507 | - if(is_object($data)) { |
|
| 507 | + if (is_object($data)) { |
|
| 508 | 508 | return $data; |
| 509 | 509 | } |
| 510 | 510 | } |
| 511 | 511 | |
| 512 | - if($assoc) { |
|
| 512 | + if ($assoc) { |
|
| 513 | 513 | return array(); |
| 514 | 514 | } |
| 515 | 515 | |
@@ -526,7 +526,7 @@ discard block |
||
| 526 | 526 | public function getJSONAssoc(string $name) : array |
| 527 | 527 | { |
| 528 | 528 | $result = $this->getJSON($name); |
| 529 | - if(is_array($result)) { |
|
| 529 | + if (is_array($result)) { |
|
| 530 | 530 | return $result; |
| 531 | 531 | } |
| 532 | 532 | |
@@ -543,7 +543,7 @@ discard block |
||
| 543 | 543 | public function getJSONObject(string $name) : object |
| 544 | 544 | { |
| 545 | 545 | $result = $this->getJSON($name, false); |
| 546 | - if(is_object($result)) { |
|
| 546 | + if (is_object($result)) { |
|
| 547 | 547 | return $result; |
| 548 | 548 | } |
| 549 | 549 | |
@@ -556,10 +556,10 @@ discard block |
||
| 556 | 556 | * @param array|string $data |
| 557 | 557 | * @param bool $exit Whether to exit the script afterwards. |
| 558 | 558 | */ |
| 559 | - public static function sendJSON($data, bool $exit=true) |
|
| 559 | + public static function sendJSON($data, bool $exit = true) |
|
| 560 | 560 | { |
| 561 | 561 | $payload = $data; |
| 562 | - if(!is_string($payload)) { |
|
| 562 | + if (!is_string($payload)) { |
|
| 563 | 563 | $payload = json_encode($payload); |
| 564 | 564 | } |
| 565 | 565 | |
@@ -569,7 +569,7 @@ discard block |
||
| 569 | 569 | |
| 570 | 570 | echo $payload; |
| 571 | 571 | |
| 572 | - if($exit) |
|
| 572 | + if ($exit) |
|
| 573 | 573 | { |
| 574 | 574 | exit; |
| 575 | 575 | } |
@@ -581,7 +581,7 @@ discard block |
||
| 581 | 581 | * @param string $html |
| 582 | 582 | * @param bool $exit Whether to exit the script afterwards. |
| 583 | 583 | */ |
| 584 | - public static function sendHTML(string $html, bool $exit=true) |
|
| 584 | + public static function sendHTML(string $html, bool $exit = true) |
|
| 585 | 585 | { |
| 586 | 586 | header('Cache-Control: no-cache, must-revalidate'); |
| 587 | 587 | header('Expires: Mon, 26 Jul 1997 05:00:00 GMT'); |
@@ -589,7 +589,7 @@ discard block |
||
| 589 | 589 | |
| 590 | 590 | echo $html; |
| 591 | 591 | |
| 592 | - if($exit) |
|
| 592 | + if ($exit) |
|
| 593 | 593 | { |
| 594 | 594 | exit; |
| 595 | 595 | } |
@@ -605,7 +605,7 @@ discard block |
||
| 605 | 605 | * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
| 606 | 606 | * @return Request_URLComparer |
| 607 | 607 | */ |
| 608 | - public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer |
|
| 608 | + public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams = array()) : Request_URLComparer |
|
| 609 | 609 | { |
| 610 | 610 | $comparer = new Request_URLComparer($this, $sourceURL, $targetURL); |
| 611 | 611 | $comparer->addLimitParams($limitParams); |
@@ -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 | |