@@ -24,17 +24,17 @@ discard block |
||
| 24 | 24 | |
| 25 | 25 | const ERROR_UNEXPECTED_COMMAND_TYPE = 50002; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var Mailcode_Renderer |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var Mailcode_Renderer |
|
| 29 | + */ |
|
| 30 | 30 | protected static $renderer; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Creates a ShowVariable command. |
|
| 34 | - * |
|
| 35 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 36 | - * @return Mailcode_Commands_Command_ShowVariable |
|
| 37 | - */ |
|
| 32 | + /** |
|
| 33 | + * Creates a ShowVariable command. |
|
| 34 | + * |
|
| 35 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 36 | + * @return Mailcode_Commands_Command_ShowVariable |
|
| 37 | + */ |
|
| 38 | 38 | public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable |
| 39 | 39 | { |
| 40 | 40 | $variableName = self::_filterVariableName($variableName); |
@@ -56,12 +56,12 @@ discard block |
||
| 56 | 56 | throw self::_exceptionUnexpectedType('ShowVariable', $cmd); |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Creates a ShowSnippet command. |
|
| 61 | - * |
|
| 62 | - * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 63 | - * @return Mailcode_Commands_Command_ShowSnippet |
|
| 64 | - */ |
|
| 59 | + /** |
|
| 60 | + * Creates a ShowSnippet command. |
|
| 61 | + * |
|
| 62 | + * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 63 | + * @return Mailcode_Commands_Command_ShowSnippet |
|
| 64 | + */ |
|
| 65 | 65 | public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet |
| 66 | 66 | { |
| 67 | 67 | $snippetName = self::_filterVariableName($snippetName); |
@@ -83,17 +83,17 @@ discard block |
||
| 83 | 83 | throw self::_exceptionUnexpectedType('ShowSnippet', $cmd); |
| 84 | 84 | } |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Creates a SetVariable command. |
|
| 88 | - * |
|
| 89 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 90 | - * @param string $value |
|
| 91 | - * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 92 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 93 | - * @throws Mailcode_Factory_Exception |
|
| 94 | - * |
|
| 95 | - * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 96 | - */ |
|
| 86 | + /** |
|
| 87 | + * Creates a SetVariable command. |
|
| 88 | + * |
|
| 89 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 90 | + * @param string $value |
|
| 91 | + * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 92 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 93 | + * @throws Mailcode_Factory_Exception |
|
| 94 | + * |
|
| 95 | + * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 96 | + */ |
|
| 97 | 97 | public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
| 98 | 98 | { |
| 99 | 99 | $variableName = self::_filterVariableName($variableName); |
@@ -122,14 +122,14 @@ discard block |
||
| 122 | 122 | throw self::_exceptionUnexpectedType('SetVariable', $cmd); |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Like setVar(), but treats the value as a string literal |
|
| 127 | - * and automatically adds quotes to it. |
|
| 128 | - * |
|
| 129 | - * @param string $variableName |
|
| 130 | - * @param string $value |
|
| 131 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 132 | - */ |
|
| 125 | + /** |
|
| 126 | + * Like setVar(), but treats the value as a string literal |
|
| 127 | + * and automatically adds quotes to it. |
|
| 128 | + * |
|
| 129 | + * @param string $variableName |
|
| 130 | + * @param string $value |
|
| 131 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 132 | + */ |
|
| 133 | 133 | public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable |
| 134 | 134 | { |
| 135 | 135 | return self::setVar($variableName, $value, true); |
@@ -461,12 +461,12 @@ discard block |
||
| 461 | 461 | return '$'.ltrim($name, '$'); |
| 462 | 462 | } |
| 463 | 463 | |
| 464 | - /** |
|
| 465 | - * Quotes a string literal: adds the quotes, and escapes any quotes already present in it. |
|
| 466 | - * |
|
| 467 | - * @param string $string |
|
| 468 | - * @return string |
|
| 469 | - */ |
|
| 464 | + /** |
|
| 465 | + * Quotes a string literal: adds the quotes, and escapes any quotes already present in it. |
|
| 466 | + * |
|
| 467 | + * @param string $string |
|
| 468 | + * @return string |
|
| 469 | + */ |
|
| 470 | 470 | protected static function _quoteString(string $string) : string |
| 471 | 471 | { |
| 472 | 472 | return '"'.str_replace('"', '\"', $string).'"'; |
@@ -499,23 +499,23 @@ discard block |
||
| 499 | 499 | ); |
| 500 | 500 | } |
| 501 | 501 | |
| 502 | - /** |
|
| 503 | - * Creates a renderer instance, which can be used to easily |
|
| 504 | - * create and convert commands to strings. |
|
| 505 | - * |
|
| 506 | - * @return Mailcode_Renderer |
|
| 507 | - */ |
|
| 502 | + /** |
|
| 503 | + * Creates a renderer instance, which can be used to easily |
|
| 504 | + * create and convert commands to strings. |
|
| 505 | + * |
|
| 506 | + * @return Mailcode_Renderer |
|
| 507 | + */ |
|
| 508 | 508 | public static function createRenderer() : Mailcode_Renderer |
| 509 | 509 | { |
| 510 | 510 | return new Mailcode_Renderer(); |
| 511 | 511 | } |
| 512 | 512 | |
| 513 | - /** |
|
| 514 | - * Creates a printer instance, which works like the renderer, |
|
| 515 | - * but outputs the generated strings to standard output. |
|
| 516 | - * |
|
| 517 | - * @return Mailcode_Printer |
|
| 518 | - */ |
|
| 513 | + /** |
|
| 514 | + * Creates a printer instance, which works like the renderer, |
|
| 515 | + * but outputs the generated strings to standard output. |
|
| 516 | + * |
|
| 517 | + * @return Mailcode_Printer |
|
| 518 | + */ |
|
| 519 | 519 | public static function createPrinter() : Mailcode_Printer |
| 520 | 520 | { |
| 521 | 521 | return new Mailcode_Printer(); |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | |
| 49 | 49 | self::_checkCommand($cmd); |
| 50 | 50 | |
| 51 | - if($cmd instanceof Mailcode_Commands_Command_ShowVariable) |
|
| 51 | + if ($cmd instanceof Mailcode_Commands_Command_ShowVariable) |
|
| 52 | 52 | { |
| 53 | 53 | return $cmd; |
| 54 | 54 | } |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | |
| 76 | 76 | self::_checkCommand($cmd); |
| 77 | 77 | |
| 78 | - if($cmd instanceof Mailcode_Commands_Command_ShowSnippet) |
|
| 78 | + if ($cmd instanceof Mailcode_Commands_Command_ShowSnippet) |
|
| 79 | 79 | { |
| 80 | 80 | return $cmd; |
| 81 | 81 | } |
@@ -94,11 +94,11 @@ discard block |
||
| 94 | 94 | * |
| 95 | 95 | * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
| 96 | 96 | */ |
| 97 | - public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
|
| 97 | + public static function setVar(string $variableName, string $value, bool $quoteValue = true) : Mailcode_Commands_Command_SetVariable |
|
| 98 | 98 | { |
| 99 | 99 | $variableName = self::_filterVariableName($variableName); |
| 100 | 100 | |
| 101 | - if($quoteValue) |
|
| 101 | + if ($quoteValue) |
|
| 102 | 102 | { |
| 103 | 103 | $value = self::_quoteString($value); |
| 104 | 104 | } |
@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | |
| 115 | 115 | self::_checkCommand($cmd); |
| 116 | 116 | |
| 117 | - if($cmd instanceof Mailcode_Commands_Command_SetVariable) |
|
| 117 | + if ($cmd instanceof Mailcode_Commands_Command_SetVariable) |
|
| 118 | 118 | { |
| 119 | 119 | return $cmd; |
| 120 | 120 | } |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | |
| 150 | 150 | self::_checkCommand($cmd); |
| 151 | 151 | |
| 152 | - if($cmd instanceof Mailcode_Commands_Command_Comment) |
|
| 152 | + if ($cmd instanceof Mailcode_Commands_Command_Comment) |
|
| 153 | 153 | { |
| 154 | 154 | return $cmd; |
| 155 | 155 | } |
@@ -168,7 +168,7 @@ discard block |
||
| 168 | 168 | |
| 169 | 169 | self::_checkCommand($cmd); |
| 170 | 170 | |
| 171 | - if($cmd instanceof Mailcode_Commands_Command_Else) |
|
| 171 | + if ($cmd instanceof Mailcode_Commands_Command_Else) |
|
| 172 | 172 | { |
| 173 | 173 | return $cmd; |
| 174 | 174 | } |
@@ -187,7 +187,7 @@ discard block |
||
| 187 | 187 | |
| 188 | 188 | self::_checkCommand($cmd); |
| 189 | 189 | |
| 190 | - if($cmd instanceof Mailcode_Commands_Command_End) |
|
| 190 | + if ($cmd instanceof Mailcode_Commands_Command_End) |
|
| 191 | 191 | { |
| 192 | 192 | return $cmd; |
| 193 | 193 | } |
@@ -195,11 +195,11 @@ discard block |
||
| 195 | 195 | throw self::_exceptionUnexpectedType('End', $cmd); |
| 196 | 196 | } |
| 197 | 197 | |
| 198 | - protected static function _buildIf(string $ifType, string $params, string $type='') : Mailcode_Commands_IfBase |
|
| 198 | + protected static function _buildIf(string $ifType, string $params, string $type = '') : Mailcode_Commands_IfBase |
|
| 199 | 199 | { |
| 200 | 200 | $stringType = $type; |
| 201 | 201 | |
| 202 | - if(!empty($type)) |
|
| 202 | + if (!empty($type)) |
|
| 203 | 203 | { |
| 204 | 204 | $stringType = ' '.$type; |
| 205 | 205 | } |
@@ -218,7 +218,7 @@ discard block |
||
| 218 | 218 | |
| 219 | 219 | self::_checkCommand($command); |
| 220 | 220 | |
| 221 | - if($command instanceof Mailcode_Commands_IfBase) |
|
| 221 | + if ($command instanceof Mailcode_Commands_IfBase) |
|
| 222 | 222 | { |
| 223 | 223 | return $command; |
| 224 | 224 | } |
@@ -226,9 +226,9 @@ discard block |
||
| 226 | 226 | throw self::_exceptionUnexpectedType('IfBase', $command); |
| 227 | 227 | } |
| 228 | 228 | |
| 229 | - protected static function _buildIfVar(string $ifType, string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_IfBase |
|
| 229 | + protected static function _buildIfVar(string $ifType, string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_IfBase |
|
| 230 | 230 | { |
| 231 | - if($quoteValue) |
|
| 231 | + if ($quoteValue) |
|
| 232 | 232 | { |
| 233 | 233 | $value = self::_quoteString($value); |
| 234 | 234 | } |
@@ -243,11 +243,11 @@ discard block |
||
| 243 | 243 | return self::_buildIf($ifType, $condition, 'variable'); |
| 244 | 244 | } |
| 245 | 245 | |
| 246 | - public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If |
|
| 246 | + public static function if (string $condition, string $type = '') : Mailcode_Commands_Command_If |
|
| 247 | 247 | { |
| 248 | 248 | $command = self::_buildIf('If', $condition, $type); |
| 249 | 249 | |
| 250 | - if($command instanceof Mailcode_Commands_Command_If) |
|
| 250 | + if ($command instanceof Mailcode_Commands_Command_If) |
|
| 251 | 251 | { |
| 252 | 252 | return $command; |
| 253 | 253 | } |
@@ -255,11 +255,11 @@ discard block |
||
| 255 | 255 | throw self::_exceptionUnexpectedType('If', $command); |
| 256 | 256 | } |
| 257 | 257 | |
| 258 | - public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 258 | + public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 259 | 259 | { |
| 260 | 260 | $command = self::_buildIfVar('If', $variable, $operand, $value, $quoteValue); |
| 261 | 261 | |
| 262 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 262 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 263 | 263 | { |
| 264 | 264 | return $command; |
| 265 | 265 | } |
@@ -271,7 +271,7 @@ discard block |
||
| 271 | 271 | { |
| 272 | 272 | $command = self::_buildIfVar('If', $variable, $operand, $value, true); |
| 273 | 273 | |
| 274 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 274 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 275 | 275 | { |
| 276 | 276 | return $command; |
| 277 | 277 | } |
@@ -279,11 +279,11 @@ discard block |
||
| 279 | 279 | throw self::_exceptionUnexpectedType('IfVarString', $command); |
| 280 | 280 | } |
| 281 | 281 | |
| 282 | - public static function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 282 | + public static function ifVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 283 | 283 | { |
| 284 | 284 | $command = self::_buildIfVar('If', $variable, '==', $value, $quoteValue); |
| 285 | 285 | |
| 286 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 286 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 287 | 287 | { |
| 288 | 288 | return $command; |
| 289 | 289 | } |
@@ -295,7 +295,7 @@ discard block |
||
| 295 | 295 | { |
| 296 | 296 | $command = self::_buildIfVar('If', $variable, '==', $value, true); |
| 297 | 297 | |
| 298 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 298 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 299 | 299 | { |
| 300 | 300 | return $command; |
| 301 | 301 | } |
@@ -303,11 +303,11 @@ discard block |
||
| 303 | 303 | throw self::_exceptionUnexpectedType('IfarEqualsString', $command); |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | - public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable |
|
| 306 | + public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If_Variable |
|
| 307 | 307 | { |
| 308 | 308 | $command = self::_buildIfVar('If', $variable, '!=', $value, $quoteValue); |
| 309 | 309 | |
| 310 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 310 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 311 | 311 | { |
| 312 | 312 | return $command; |
| 313 | 313 | } |
@@ -319,7 +319,7 @@ discard block |
||
| 319 | 319 | { |
| 320 | 320 | $command = self::_buildIfVar('If', $variable, '!=', $value, true); |
| 321 | 321 | |
| 322 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 322 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 323 | 323 | { |
| 324 | 324 | return $command; |
| 325 | 325 | } |
@@ -327,11 +327,11 @@ discard block |
||
| 327 | 327 | throw self::_exceptionUnexpectedType('IfVarNotEqualsString', $command); |
| 328 | 328 | } |
| 329 | 329 | |
| 330 | - public static function elseIf(string $condition, string $type='') : Mailcode_Commands_Command_ElseIf |
|
| 330 | + public static function elseIf (string $condition, string $type = '') : Mailcode_Commands_Command_ElseIf |
|
| 331 | 331 | { |
| 332 | 332 | $command = self::_buildIf('ElseIf', $condition, $type); |
| 333 | 333 | |
| 334 | - if($command instanceof Mailcode_Commands_Command_ElseIf) |
|
| 334 | + if ($command instanceof Mailcode_Commands_Command_ElseIf) |
|
| 335 | 335 | { |
| 336 | 336 | return $command; |
| 337 | 337 | } |
@@ -339,11 +339,11 @@ discard block |
||
| 339 | 339 | throw self::_exceptionUnexpectedType('ElseIf', $command); |
| 340 | 340 | } |
| 341 | 341 | |
| 342 | - public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 342 | + public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 343 | 343 | { |
| 344 | 344 | $command = self::_buildIfVar('ElseIf', $variable, $operand, $value, $quoteValue); |
| 345 | 345 | |
| 346 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 346 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 347 | 347 | { |
| 348 | 348 | return $command; |
| 349 | 349 | } |
@@ -355,7 +355,7 @@ discard block |
||
| 355 | 355 | { |
| 356 | 356 | $command = self::_buildIfVar('ElseIf', $variable, $operand, $value, true); |
| 357 | 357 | |
| 358 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 358 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 359 | 359 | { |
| 360 | 360 | return $command; |
| 361 | 361 | } |
@@ -363,11 +363,11 @@ discard block |
||
| 363 | 363 | throw self::_exceptionUnexpectedType('ElseIfVarString', $command); |
| 364 | 364 | } |
| 365 | 365 | |
| 366 | - public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 366 | + public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 367 | 367 | { |
| 368 | 368 | $command = self::_buildIfVar('ElseIf', $variable, '==', $value, $quoteValue); |
| 369 | 369 | |
| 370 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 370 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 371 | 371 | { |
| 372 | 372 | return $command; |
| 373 | 373 | } |
@@ -379,7 +379,7 @@ discard block |
||
| 379 | 379 | { |
| 380 | 380 | $command = self::_buildIfVar('ElseIf', $variable, '==', $value, true); |
| 381 | 381 | |
| 382 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 382 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 383 | 383 | { |
| 384 | 384 | return $command; |
| 385 | 385 | } |
@@ -387,11 +387,11 @@ discard block |
||
| 387 | 387 | throw self::_exceptionUnexpectedType('ElseIfVarEqualsString', $command); |
| 388 | 388 | } |
| 389 | 389 | |
| 390 | - public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 390 | + public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf_Variable |
|
| 391 | 391 | { |
| 392 | 392 | $command = self::_buildIfVar('ElseIf', $variable, '!=', $value, $quoteValue); |
| 393 | 393 | |
| 394 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 394 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 395 | 395 | { |
| 396 | 396 | return $command; |
| 397 | 397 | } |
@@ -403,7 +403,7 @@ discard block |
||
| 403 | 403 | { |
| 404 | 404 | $command = self::_buildIfVar('ElseIf', $variable, '!=', $value, true); |
| 405 | 405 | |
| 406 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 406 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 407 | 407 | { |
| 408 | 408 | return $command; |
| 409 | 409 | } |
@@ -411,11 +411,11 @@ discard block |
||
| 411 | 411 | throw self::_exceptionUnexpectedType('ElseIfVarNotEqualsString', $command); |
| 412 | 412 | } |
| 413 | 413 | |
| 414 | - public static function ifContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains |
|
| 414 | + public static function ifContains(string $variable, string $search, bool $caseInsensitive = false) : Mailcode_Commands_Command_If_Contains |
|
| 415 | 415 | { |
| 416 | 416 | $command = self::_buildIfContains('If', $variable, $search, $caseInsensitive); |
| 417 | 417 | |
| 418 | - if($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 418 | + if ($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 419 | 419 | { |
| 420 | 420 | return $command; |
| 421 | 421 | } |
@@ -423,11 +423,11 @@ discard block |
||
| 423 | 423 | throw self::_exceptionUnexpectedType('ElseIfContains', $command); |
| 424 | 424 | } |
| 425 | 425 | |
| 426 | - public static function elseIfContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains |
|
| 426 | + public static function elseIfContains(string $variable, string $search, bool $caseInsensitive = false) : Mailcode_Commands_Command_ElseIf_Contains |
|
| 427 | 427 | { |
| 428 | 428 | $command = self::_buildIfContains('ElseIf', $variable, $search, $caseInsensitive); |
| 429 | 429 | |
| 430 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 430 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 431 | 431 | { |
| 432 | 432 | return $command; |
| 433 | 433 | } |
@@ -435,11 +435,11 @@ discard block |
||
| 435 | 435 | throw self::_exceptionUnexpectedType('ElseIfContains', $command); |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | - protected static function _buildIfContains(string $ifType, string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_IfBase |
|
| 438 | + protected static function _buildIfContains(string $ifType, string $variable, string $search, bool $caseInsensitive = false) : Mailcode_Commands_IfBase |
|
| 439 | 439 | { |
| 440 | 440 | $keyword = ' '; |
| 441 | 441 | |
| 442 | - if($caseInsensitive) |
|
| 442 | + if ($caseInsensitive) |
|
| 443 | 443 | { |
| 444 | 444 | $keyword = ' insensitive: '; |
| 445 | 445 | } |
@@ -474,7 +474,7 @@ discard block |
||
| 474 | 474 | |
| 475 | 475 | protected static function _checkCommand(Mailcode_Commands_Command $command) : void |
| 476 | 476 | { |
| 477 | - if($command->isValid()) |
|
| 477 | + if ($command->isValid()) |
|
| 478 | 478 | { |
| 479 | 479 | return; |
| 480 | 480 | } |
@@ -157,7 +157,8 @@ discard block |
||
| 157 | 157 | throw self::_exceptionUnexpectedType('Comment', $cmd); |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | - public static function else() : Mailcode_Commands_Command_Else |
|
| 160 | + public static function else { |
|
| 161 | + () : Mailcode_Commands_Command_Else |
|
| 161 | 162 | { |
| 162 | 163 | $cmd = Mailcode::create()->getCommands()->createCommand( |
| 163 | 164 | 'Else', |
@@ -165,6 +166,7 @@ discard block |
||
| 165 | 166 | '', |
| 166 | 167 | '{else}' |
| 167 | 168 | ); |
| 169 | + } |
|
| 168 | 170 | |
| 169 | 171 | self::_checkCommand($cmd); |
| 170 | 172 | |
@@ -20,13 +20,13 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * Filters the string for use in an Apache Velocity (Java) |
|
| 25 | - * regex string: escapes all special characters. |
|
| 26 | - * |
|
| 27 | - * @param string $string |
|
| 28 | - * @return string |
|
| 29 | - */ |
|
| 23 | + /** |
|
| 24 | + * Filters the string for use in an Apache Velocity (Java) |
|
| 25 | + * regex string: escapes all special characters. |
|
| 26 | + * |
|
| 27 | + * @param string $string |
|
| 28 | + * @return string |
|
| 29 | + */ |
|
| 30 | 30 | protected function filterRegexString(string $string) : string |
| 31 | 31 | { |
| 32 | 32 | $escape = array( |
@@ -48,7 +48,7 @@ |
||
| 48 | 48 | ')' |
| 49 | 49 | ); |
| 50 | 50 | |
| 51 | - foreach($escape as $char) |
|
| 51 | + foreach ($escape as $char) |
|
| 52 | 52 | { |
| 53 | 53 | $string = str_replace($char, '\\'.$char, $string); |
| 54 | 54 | } |
@@ -22,17 +22,17 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | public function translate(Mailcode_Commands_Command_If $command): string |
| 24 | 24 | { |
| 25 | - if($command instanceof Mailcode_Commands_Command_If_Command) |
|
| 25 | + if ($command instanceof Mailcode_Commands_Command_If_Command) |
|
| 26 | 26 | { |
| 27 | 27 | return $this->translateCommand($command); |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 30 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
| 31 | 31 | { |
| 32 | 32 | return $this->translateVariable($command); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - if($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 35 | + if ($command instanceof Mailcode_Commands_Command_If_Contains) |
|
| 36 | 36 | { |
| 37 | 37 | return $this->translateContains($command); |
| 38 | 38 | } |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | { |
| 45 | 45 | $params = $command->getParams(); |
| 46 | 46 | |
| 47 | - if(!$params) |
|
| 47 | + if (!$params) |
|
| 48 | 48 | { |
| 49 | 49 | return ''; |
| 50 | 50 | } |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | protected function translateContains(Mailcode_Commands_Command_If_Contains $command) : string |
| 69 | 69 | { |
| 70 | 70 | $opts = 's'; |
| 71 | - if($command->isCaseInsensitive()) |
|
| 71 | + if ($command->isCaseInsensitive()) |
|
| 72 | 72 | { |
| 73 | 73 | $opts = 'is'; |
| 74 | 74 | } |
@@ -22,17 +22,17 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | public function translate(Mailcode_Commands_Command_ElseIf $command): string |
| 24 | 24 | { |
| 25 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
| 25 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
| 26 | 26 | { |
| 27 | 27 | return $this->translateCommand($command); |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 30 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
| 31 | 31 | { |
| 32 | 32 | return $this->translateVariable($command); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 35 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
| 36 | 36 | { |
| 37 | 37 | return $this->translateContains($command); |
| 38 | 38 | } |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | { |
| 45 | 45 | $params = $command->getParams(); |
| 46 | 46 | |
| 47 | - if(!$params) |
|
| 47 | + if (!$params) |
|
| 48 | 48 | { |
| 49 | 49 | return ''; |
| 50 | 50 | } |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | protected function translateContains(Mailcode_Commands_Command_ElseIf_Contains $command) : string |
| 69 | 69 | { |
| 70 | 70 | $opts = 's'; |
| 71 | - if($command->isCaseInsensitive()) |
|
| 71 | + if ($command->isCaseInsensitive()) |
|
| 72 | 72 | { |
| 73 | 73 | $opts = 'is'; |
| 74 | 74 | } |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | { |
| 24 | 24 | const ERROR_UNKNOWN_COMMAND_TYPE = 50401; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | protected $typeID; |
| 30 | 30 | |
| 31 | 31 | public function __construct(string $typeID) |
@@ -33,22 +33,22 @@ discard block |
||
| 33 | 33 | $this->typeID = $typeID; |
| 34 | 34 | } |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Retrieves the syntax' type ID, e.g. "ApacheVelocity". |
|
| 38 | - * @return string |
|
| 39 | - */ |
|
| 36 | + /** |
|
| 37 | + * Retrieves the syntax' type ID, e.g. "ApacheVelocity". |
|
| 38 | + * @return string |
|
| 39 | + */ |
|
| 40 | 40 | public function getTypeID() : string |
| 41 | 41 | { |
| 42 | 42 | return $this->typeID; |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Translates a single command to the target syntax. |
|
| 47 | - * |
|
| 48 | - * @param Mailcode_Commands_Command $command |
|
| 49 | - * @throws Mailcode_Translator_Exception |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 45 | + /** |
|
| 46 | + * Translates a single command to the target syntax. |
|
| 47 | + * |
|
| 48 | + * @param Mailcode_Commands_Command $command |
|
| 49 | + * @throws Mailcode_Translator_Exception |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | 52 | public function translateCommand(Mailcode_Commands_Command $command) : string |
| 53 | 53 | { |
| 54 | 54 | $translator = $this->createTranslator($command); |
@@ -81,13 +81,13 @@ discard block |
||
| 81 | 81 | return $translator; |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Translates all safeguarded commands in the subject string to the |
|
| 86 | - * target syntax in one go. |
|
| 87 | - * |
|
| 88 | - * @param Mailcode_Parser_Safeguard $safeguard |
|
| 89 | - * @return string |
|
| 90 | - */ |
|
| 84 | + /** |
|
| 85 | + * Translates all safeguarded commands in the subject string to the |
|
| 86 | + * target syntax in one go. |
|
| 87 | + * |
|
| 88 | + * @param Mailcode_Parser_Safeguard $safeguard |
|
| 89 | + * @return string |
|
| 90 | + */ |
|
| 91 | 91 | public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string |
| 92 | 92 | { |
| 93 | 93 | $subject = $safeguard->makeSafe(); |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | $command->getID() |
| 65 | 65 | ); |
| 66 | 66 | |
| 67 | - if(!class_exists($class)) |
|
| 67 | + if (!class_exists($class)) |
|
| 68 | 68 | { |
| 69 | 69 | throw new Mailcode_Translator_Exception( |
| 70 | 70 | sprintf('Unknown command %s in translator', $command->getID()), |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | { |
| 93 | 93 | $subject = $safeguard->makeSafe(); |
| 94 | 94 | |
| 95 | - if(!$safeguard->hasPlaceholders()) |
|
| 95 | + if (!$safeguard->hasPlaceholders()) |
|
| 96 | 96 | { |
| 97 | 97 | return $subject; |
| 98 | 98 | } |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | |
| 102 | 102 | $replaces = array(); |
| 103 | 103 | |
| 104 | - foreach($placeholders as $placeholder) |
|
| 104 | + foreach ($placeholders as $placeholder) |
|
| 105 | 105 | { |
| 106 | 106 | $replaces[$placeholder->getReplacementText()] = $this->translateCommand($placeholder->getCommand()); |
| 107 | 107 | } |
@@ -25,9 +25,9 @@ |
||
| 25 | 25 | |
| 26 | 26 | const VALIDATION_NOT_ASSIGNMENT_STATEMENT = 48501; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var Mailcode_Parser_Statement_Tokenizer_Type_Value |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var Mailcode_Parser_Statement_Tokenizer_Type_Value |
|
| 30 | + */ |
|
| 31 | 31 | protected $value; |
| 32 | 32 | |
| 33 | 33 | public function getName() : string |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | { |
| 69 | 69 | $variable = $this->params->getInfo()->getVariableByIndex(0); |
| 70 | 70 | |
| 71 | - if($variable) |
|
| 71 | + if ($variable) |
|
| 72 | 72 | { |
| 73 | 73 | return $variable->getVariable(); |
| 74 | 74 | } |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | |
| 97 | 97 | protected function validateSyntax_assignment() : void |
| 98 | 98 | { |
| 99 | - if($this->params->getInfo()->isVariableAssignment()) |
|
| 99 | + if ($this->params->getInfo()->isVariableAssignment()) |
|
| 100 | 100 | { |
| 101 | 101 | return; |
| 102 | 102 | } |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | |
| 114 | 114 | $value = $info->getTokenByIndex(2); |
| 115 | 115 | |
| 116 | - if($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 116 | + if ($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 117 | 117 | { |
| 118 | 118 | $this->value = $value; |
| 119 | 119 | return; |
@@ -24,9 +24,9 @@ discard block |
||
| 24 | 24 | |
| 25 | 25 | const VALIDATION_VARIABLE_MISSING = 52001; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var Mailcode_Variables_Variable|NULL |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var Mailcode_Variables_Variable|NULL |
|
| 29 | + */ |
|
| 30 | 30 | protected $variable; |
| 31 | 31 | |
| 32 | 32 | public function getName() : string |
@@ -54,15 +54,15 @@ discard block |
||
| 54 | 54 | return true; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves the variable to show. |
|
| 59 | - * |
|
| 60 | - * NOTE: Only available once the command has been |
|
| 61 | - * validated. Always use isValid() first. |
|
| 62 | - * |
|
| 63 | - * @throws Mailcode_Exception |
|
| 64 | - * @return Mailcode_Variables_Variable |
|
| 65 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves the variable to show. |
|
| 59 | + * |
|
| 60 | + * NOTE: Only available once the command has been |
|
| 61 | + * validated. Always use isValid() first. |
|
| 62 | + * |
|
| 63 | + * @throws Mailcode_Exception |
|
| 64 | + * @return Mailcode_Variables_Variable |
|
| 65 | + */ |
|
| 66 | 66 | public function getVariable() : Mailcode_Variables_Variable |
| 67 | 67 | { |
| 68 | 68 | $this->validate(); |
@@ -79,15 +79,15 @@ discard block |
||
| 79 | 79 | ); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Retrieves the full name of the variable to show. |
|
| 84 | - * |
|
| 85 | - * NOTE: Only available once the command has been |
|
| 86 | - * validated. Always use isValid() first. |
|
| 87 | - * |
|
| 88 | - * @throws Mailcode_Exception |
|
| 89 | - * @return string |
|
| 90 | - */ |
|
| 82 | + /** |
|
| 83 | + * Retrieves the full name of the variable to show. |
|
| 84 | + * |
|
| 85 | + * NOTE: Only available once the command has been |
|
| 86 | + * validated. Always use isValid() first. |
|
| 87 | + * |
|
| 88 | + * @throws Mailcode_Exception |
|
| 89 | + * @return string |
|
| 90 | + */ |
|
| 91 | 91 | public function getVariableName() : string |
| 92 | 92 | { |
| 93 | 93 | return $this->getVariable()->getFullName(); |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | { |
| 68 | 68 | $this->validate(); |
| 69 | 69 | |
| 70 | - if(isset($this->variable)) |
|
| 70 | + if (isset($this->variable)) |
|
| 71 | 71 | { |
| 72 | 72 | return $this->variable; |
| 73 | 73 | } |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | |
| 100 | 100 | $var = $info->getVariableByIndex(0); |
| 101 | 101 | |
| 102 | - if($var) |
|
| 102 | + if ($var) |
|
| 103 | 103 | { |
| 104 | 104 | return; |
| 105 | 105 | } |
@@ -31,53 +31,53 @@ discard block |
||
| 31 | 31 | const VALIDATION_UNKNOWN_COMMAND_NAME = 48304; |
| 32 | 32 | const VALIDATION_INVALID_PARAMS_STATEMENT = 48305; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | 37 | protected $type = ''; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var string |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var string |
|
| 41 | + */ |
|
| 42 | 42 | protected $paramsString = ''; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var string |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var string |
|
| 46 | + */ |
|
| 47 | 47 | protected $matchedText = ''; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | 52 | protected $hash = ''; |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var \AppUtils\OperationResult |
|
| 56 | - */ |
|
| 54 | + /** |
|
| 55 | + * @var \AppUtils\OperationResult |
|
| 56 | + */ |
|
| 57 | 57 | protected $validationResult = null; |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @var \Mailcode\Mailcode |
|
| 61 | - */ |
|
| 59 | + /** |
|
| 60 | + * @var \Mailcode\Mailcode |
|
| 61 | + */ |
|
| 62 | 62 | protected $mailcode; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
| 66 | + */ |
|
| 67 | 67 | protected $params; |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var string[] |
|
| 71 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var string[] |
|
| 71 | + */ |
|
| 72 | 72 | protected $validations = array( |
| 73 | 73 | 'params', |
| 74 | 74 | 'type_supported', |
| 75 | 75 | 'type_unsupported' |
| 76 | 76 | ); |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * @var string |
|
| 80 | - */ |
|
| 78 | + /** |
|
| 79 | + * @var string |
|
| 80 | + */ |
|
| 81 | 81 | protected $comment = ''; |
| 82 | 82 | |
| 83 | 83 | public function __construct(string $type='', string $paramsString='', string $matchedText='') |
@@ -95,9 +95,9 @@ discard block |
||
| 95 | 95 | |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * @return string The ID of the command = the name of the command class file. |
|
| 100 | - */ |
|
| 98 | + /** |
|
| 99 | + * @return string The ID of the command = the name of the command class file. |
|
| 100 | + */ |
|
| 101 | 101 | public function getID() : string |
| 102 | 102 | { |
| 103 | 103 | // account for commands with types: If_Variable should still return If. |
@@ -106,14 +106,14 @@ discard block |
||
| 106 | 106 | return array_shift($tokens); |
| 107 | 107 | } |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Sets an optional comment that is not used anywhere, but |
|
| 111 | - * can be used by the application to track why a command is |
|
| 112 | - * used somewhere. |
|
| 113 | - * |
|
| 114 | - * @param string $comment |
|
| 115 | - * @return Mailcode_Commands_Command |
|
| 116 | - */ |
|
| 109 | + /** |
|
| 110 | + * Sets an optional comment that is not used anywhere, but |
|
| 111 | + * can be used by the application to track why a command is |
|
| 112 | + * used somewhere. |
|
| 113 | + * |
|
| 114 | + * @param string $comment |
|
| 115 | + * @return Mailcode_Commands_Command |
|
| 116 | + */ |
|
| 117 | 117 | public function setComment(string $comment) : Mailcode_Commands_Command |
| 118 | 118 | { |
| 119 | 119 | $this->comment = $comment; |
@@ -121,34 +121,34 @@ discard block |
||
| 121 | 121 | return $this; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Retrieves the previously set comment, if any. |
|
| 126 | - * |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 124 | + /** |
|
| 125 | + * Retrieves the previously set comment, if any. |
|
| 126 | + * |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | 129 | public function getComment() : string |
| 130 | 130 | { |
| 131 | 131 | return $this->comment; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Checks whether this is a dummy command, which is only |
|
| 136 | - * used to access information on the command type. It cannot |
|
| 137 | - * be used as an actual live command. |
|
| 138 | - * |
|
| 139 | - * @return bool |
|
| 140 | - */ |
|
| 134 | + /** |
|
| 135 | + * Checks whether this is a dummy command, which is only |
|
| 136 | + * used to access information on the command type. It cannot |
|
| 137 | + * be used as an actual live command. |
|
| 138 | + * |
|
| 139 | + * @return bool |
|
| 140 | + */ |
|
| 141 | 141 | public function isDummy() : bool |
| 142 | 142 | { |
| 143 | 143 | return $this->type === '__dummy'; |
| 144 | 144 | } |
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Retrieves a hash of the actual matched command string, |
|
| 148 | - * which is used in collections to detect duplicate commands. |
|
| 149 | - * |
|
| 150 | - * @return string |
|
| 151 | - */ |
|
| 146 | + /** |
|
| 147 | + * Retrieves a hash of the actual matched command string, |
|
| 148 | + * which is used in collections to detect duplicate commands. |
|
| 149 | + * |
|
| 150 | + * @return string |
|
| 151 | + */ |
|
| 152 | 152 | public function getHash() : string |
| 153 | 153 | { |
| 154 | 154 | $this->requireNonDummy(); |
@@ -240,9 +240,9 @@ discard block |
||
| 240 | 240 | } |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * @return string[] |
|
| 245 | - */ |
|
| 243 | + /** |
|
| 244 | + * @return string[] |
|
| 245 | + */ |
|
| 246 | 246 | abstract protected function getValidations() : array; |
| 247 | 247 | |
| 248 | 248 | protected function validateSyntax_params() : void |
@@ -429,22 +429,22 @@ discard block |
||
| 429 | 429 | return implode('', $parts); |
| 430 | 430 | } |
| 431 | 431 | |
| 432 | - /** |
|
| 433 | - * Retrieves the names of all the command's supported types: the part |
|
| 434 | - * between the command name and the colon. Example: {command type: params}. |
|
| 435 | - * |
|
| 436 | - * @return string[] |
|
| 437 | - */ |
|
| 432 | + /** |
|
| 433 | + * Retrieves the names of all the command's supported types: the part |
|
| 434 | + * between the command name and the colon. Example: {command type: params}. |
|
| 435 | + * |
|
| 436 | + * @return string[] |
|
| 437 | + */ |
|
| 438 | 438 | public function getSupportedTypes() : array |
| 439 | 439 | { |
| 440 | 440 | return array(); |
| 441 | 441 | } |
| 442 | 442 | |
| 443 | - /** |
|
| 444 | - * Retrieves all variable names used in the command. |
|
| 445 | - * |
|
| 446 | - * @return Mailcode_Variables_Collection_Regular |
|
| 447 | - */ |
|
| 443 | + /** |
|
| 444 | + * Retrieves all variable names used in the command. |
|
| 445 | + * |
|
| 446 | + * @return Mailcode_Variables_Collection_Regular |
|
| 447 | + */ |
|
| 448 | 448 | public function getVariables() : Mailcode_Variables_Collection_Regular |
| 449 | 449 | { |
| 450 | 450 | return Mailcode::create()->findVariables($this->paramsString); |
@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | */ |
| 81 | 81 | protected $comment = ''; |
| 82 | 82 | |
| 83 | - public function __construct(string $type='', string $paramsString='', string $matchedText='') |
|
| 83 | + public function __construct(string $type = '', string $paramsString = '', string $matchedText = '') |
|
| 84 | 84 | { |
| 85 | 85 | $this->type = $type; |
| 86 | 86 | $this->paramsString = html_entity_decode($paramsString); |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | { |
| 154 | 154 | $this->requireNonDummy(); |
| 155 | 155 | |
| 156 | - if($this->hash === '') { |
|
| 156 | + if ($this->hash === '') { |
|
| 157 | 157 | $this->hash = md5($this->matchedText); |
| 158 | 158 | } |
| 159 | 159 | |
@@ -162,7 +162,7 @@ discard block |
||
| 162 | 162 | |
| 163 | 163 | protected function requireNonDummy() : void |
| 164 | 164 | { |
| 165 | - if(!$this->isDummy()) |
|
| 165 | + if (!$this->isDummy()) |
|
| 166 | 166 | { |
| 167 | 167 | return; |
| 168 | 168 | } |
@@ -183,7 +183,7 @@ discard block |
||
| 183 | 183 | { |
| 184 | 184 | $this->requireNonDummy(); |
| 185 | 185 | |
| 186 | - if(isset($this->validationResult)) |
|
| 186 | + if (isset($this->validationResult)) |
|
| 187 | 187 | { |
| 188 | 188 | return $this->validationResult; |
| 189 | 189 | } |
@@ -197,7 +197,7 @@ discard block |
||
| 197 | 197 | |
| 198 | 198 | public function getValidationResult() : \AppUtils\OperationResult |
| 199 | 199 | { |
| 200 | - if(isset($this->validationResult)) |
|
| 200 | + if (isset($this->validationResult)) |
|
| 201 | 201 | { |
| 202 | 202 | return $this->validationResult; |
| 203 | 203 | } |
@@ -213,11 +213,11 @@ discard block |
||
| 213 | 213 | { |
| 214 | 214 | $validations = array_merge($this->validations, $this->getValidations()); |
| 215 | 215 | |
| 216 | - foreach($validations as $validation) |
|
| 216 | + foreach ($validations as $validation) |
|
| 217 | 217 | { |
| 218 | 218 | $method = 'validateSyntax_'.$validation; |
| 219 | 219 | |
| 220 | - if(!method_exists($this, $method)) |
|
| 220 | + if (!method_exists($this, $method)) |
|
| 221 | 221 | { |
| 222 | 222 | throw new Mailcode_Exception( |
| 223 | 223 | 'Missing validation method', |
@@ -233,7 +233,7 @@ discard block |
||
| 233 | 233 | $this->$method(); |
| 234 | 234 | |
| 235 | 235 | // break off at the first validation issue |
| 236 | - if(!$this->validationResult->isValid()) |
|
| 236 | + if (!$this->validationResult->isValid()) |
|
| 237 | 237 | { |
| 238 | 238 | return; |
| 239 | 239 | } |
@@ -247,12 +247,12 @@ discard block |
||
| 247 | 247 | |
| 248 | 248 | protected function validateSyntax_params() : void |
| 249 | 249 | { |
| 250 | - if(!$this->requiresParameters()) |
|
| 250 | + if (!$this->requiresParameters()) |
|
| 251 | 251 | { |
| 252 | 252 | return; |
| 253 | 253 | } |
| 254 | 254 | |
| 255 | - if(empty($this->paramsString)) |
|
| 255 | + if (empty($this->paramsString)) |
|
| 256 | 256 | { |
| 257 | 257 | $this->validationResult->makeError( |
| 258 | 258 | t('Parameters have to be specified.'), |
@@ -263,7 +263,7 @@ discard block |
||
| 263 | 263 | |
| 264 | 264 | $this->params = $this->mailcode->getParser()->createStatement($this->paramsString); |
| 265 | 265 | |
| 266 | - if(!$this->params->isValid()) |
|
| 266 | + if (!$this->params->isValid()) |
|
| 267 | 267 | { |
| 268 | 268 | $error = $this->params->getValidationResult(); |
| 269 | 269 | |
@@ -276,14 +276,14 @@ discard block |
||
| 276 | 276 | |
| 277 | 277 | protected function validateSyntax_type_supported() : void |
| 278 | 278 | { |
| 279 | - if(!$this->supportsType() || empty($this->type)) |
|
| 279 | + if (!$this->supportsType() || empty($this->type)) |
|
| 280 | 280 | { |
| 281 | 281 | return; |
| 282 | 282 | } |
| 283 | 283 | |
| 284 | 284 | $types = $this->getSupportedTypes(); |
| 285 | 285 | |
| 286 | - if(!in_array($this->type, $types)) |
|
| 286 | + if (!in_array($this->type, $types)) |
|
| 287 | 287 | { |
| 288 | 288 | $this->validationResult->makeError( |
| 289 | 289 | t('The command addon %1$s is not supported.', $this->type).' '. |
@@ -297,7 +297,7 @@ discard block |
||
| 297 | 297 | |
| 298 | 298 | protected function validateSyntax_type_unsupported() : void |
| 299 | 299 | { |
| 300 | - if($this->supportsType() || empty($this->type)) |
|
| 300 | + if ($this->supportsType() || empty($this->type)) |
|
| 301 | 301 | { |
| 302 | 302 | return; |
| 303 | 303 | } |
@@ -315,7 +315,7 @@ discard block |
||
| 315 | 315 | |
| 316 | 316 | public function getType() : string |
| 317 | 317 | { |
| 318 | - if($this->supportsType()) |
|
| 318 | + if ($this->supportsType()) |
|
| 319 | 319 | { |
| 320 | 320 | return $this->type; |
| 321 | 321 | } |
@@ -335,7 +335,7 @@ discard block |
||
| 335 | 335 | |
| 336 | 336 | public function getHighlighted() : string |
| 337 | 337 | { |
| 338 | - if(!$this->isValid()) |
|
| 338 | + if (!$this->isValid()) |
|
| 339 | 339 | { |
| 340 | 340 | return ''; |
| 341 | 341 | } |
@@ -346,7 +346,7 @@ discard block |
||
| 346 | 346 | |
| 347 | 347 | public function getParamsString() : string |
| 348 | 348 | { |
| 349 | - if($this->requiresParameters()) |
|
| 349 | + if ($this->requiresParameters()) |
|
| 350 | 350 | { |
| 351 | 351 | return $this->paramsString; |
| 352 | 352 | } |
@@ -373,22 +373,22 @@ discard block |
||
| 373 | 373 | |
| 374 | 374 | public final function getCommandType() : string |
| 375 | 375 | { |
| 376 | - if($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
| 376 | + if ($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
| 377 | 377 | { |
| 378 | 378 | return 'Closing'; |
| 379 | 379 | } |
| 380 | 380 | |
| 381 | - if($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
| 381 | + if ($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
| 382 | 382 | { |
| 383 | 383 | return 'Opening'; |
| 384 | 384 | } |
| 385 | 385 | |
| 386 | - if($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
| 386 | + if ($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
| 387 | 387 | { |
| 388 | 388 | return 'Sibling'; |
| 389 | 389 | } |
| 390 | 390 | |
| 391 | - if($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
| 391 | + if ($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
| 392 | 392 | { |
| 393 | 393 | return 'Standalone'; |
| 394 | 394 | } |
@@ -405,7 +405,7 @@ discard block |
||
| 405 | 405 | |
| 406 | 406 | public function getNormalized() : string |
| 407 | 407 | { |
| 408 | - if(!$this->isValid()) |
|
| 408 | + if (!$this->isValid()) |
|
| 409 | 409 | { |
| 410 | 410 | return ''; |
| 411 | 411 | } |
@@ -413,12 +413,12 @@ discard block |
||
| 413 | 413 | $parts = array(); |
| 414 | 414 | $parts[] = '{'.$this->getName(); |
| 415 | 415 | |
| 416 | - if($this->supportsType() && $this->hasType()) |
|
| 416 | + if ($this->supportsType() && $this->hasType()) |
|
| 417 | 417 | { |
| 418 | 418 | $parts[] = ' '.$this->getType(); |
| 419 | 419 | } |
| 420 | 420 | |
| 421 | - if($this->requiresParameters() && isset($this->params)) |
|
| 421 | + if ($this->requiresParameters() && isset($this->params)) |
|
| 422 | 422 | { |
| 423 | 423 | $parts[] = ': '; |
| 424 | 424 | $parts[] = $this->params->getNormalized(); |