@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | |
33 | 33 | $keywords = $command->getLogicKeywords()->getKeywords(); |
34 | 34 | |
35 | - foreach($keywords as $keyword) |
|
35 | + foreach ($keywords as $keyword) |
|
36 | 36 | { |
37 | 37 | $body .= ' '.$this->getSign($keyword).' '.$this->translateBody($keyword->getCommand()); |
38 | 38 | } |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | |
43 | 43 | protected function getSign(Mailcode_Commands_LogicKeywords_Keyword $keyword) : string |
44 | 44 | { |
45 | - switch($keyword->getName()) |
|
45 | + switch ($keyword->getName()) |
|
46 | 46 | { |
47 | 47 | case 'and': |
48 | 48 | return '&&'; |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | { |
66 | 66 | $sign = ''; |
67 | 67 | |
68 | - if($notEmpty) |
|
68 | + if ($notEmpty) |
|
69 | 69 | { |
70 | 70 | $sign = '!'; |
71 | 71 | } |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | { |
82 | 82 | $params = $command->getParams(); |
83 | 83 | |
84 | - if(!$params) |
|
84 | + if (!$params) |
|
85 | 85 | { |
86 | 86 | return ''; |
87 | 87 | } |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | protected function _translateContains(Mailcode_Variables_Variable $variable, bool $caseSensitive, string $searchTerm) : string |
103 | 103 | { |
104 | 104 | $opts = 's'; |
105 | - if($caseSensitive) |
|
105 | + if ($caseSensitive) |
|
106 | 106 | { |
107 | 107 | $opts = 'is'; |
108 | 108 | } |
@@ -32,27 +32,27 @@ |
||
32 | 32 | |
33 | 33 | protected function translateBody(Mailcode_Commands_IfBase $command) : string |
34 | 34 | { |
35 | - if($command instanceof Mailcode_Commands_Command_If_Command) |
|
35 | + if ($command instanceof Mailcode_Commands_Command_If_Command) |
|
36 | 36 | { |
37 | 37 | return $this->translateCommand($command); |
38 | 38 | } |
39 | 39 | |
40 | - if($command instanceof Mailcode_Commands_Command_If_Variable) |
|
40 | + if ($command instanceof Mailcode_Commands_Command_If_Variable) |
|
41 | 41 | { |
42 | 42 | return $this->translateVariable($command); |
43 | 43 | } |
44 | 44 | |
45 | - if($command instanceof Mailcode_Commands_Command_If_Contains) |
|
45 | + if ($command instanceof Mailcode_Commands_Command_If_Contains) |
|
46 | 46 | { |
47 | 47 | return $this->translateContains($command); |
48 | 48 | } |
49 | 49 | |
50 | - if($command instanceof Mailcode_Commands_Command_If_Empty) |
|
50 | + if ($command instanceof Mailcode_Commands_Command_If_Empty) |
|
51 | 51 | { |
52 | 52 | return $this->translateEmpty($command); |
53 | 53 | } |
54 | 54 | |
55 | - if($command instanceof Mailcode_Commands_Command_If_NotEmpty) |
|
55 | + if ($command instanceof Mailcode_Commands_Command_If_NotEmpty) |
|
56 | 56 | { |
57 | 57 | return $this->translateNotEmpty($command); |
58 | 58 | } |
@@ -32,27 +32,27 @@ |
||
32 | 32 | |
33 | 33 | protected function translateBody(Mailcode_Commands_IfBase $command) : string |
34 | 34 | { |
35 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
35 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Command) |
|
36 | 36 | { |
37 | 37 | return $this->translateCommand($command); |
38 | 38 | } |
39 | 39 | |
40 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
40 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Variable) |
|
41 | 41 | { |
42 | 42 | return $this->translateVariable($command); |
43 | 43 | } |
44 | 44 | |
45 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
45 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Contains) |
|
46 | 46 | { |
47 | 47 | return $this->translateContains($command); |
48 | 48 | } |
49 | 49 | |
50 | - if($command instanceof Mailcode_Commands_Command_ElseIf_Empty) |
|
50 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_Empty) |
|
51 | 51 | { |
52 | 52 | return $this->translateEmpty($command); |
53 | 53 | } |
54 | 54 | |
55 | - if($command instanceof Mailcode_Commands_Command_ElseIf_NotEmpty) |
|
55 | + if ($command instanceof Mailcode_Commands_Command_ElseIf_NotEmpty) |
|
56 | 56 | { |
57 | 57 | return $this->translateNotEmpty($command); |
58 | 58 | } |
@@ -32,44 +32,44 @@ discard block |
||
32 | 32 | const VALIDATION_UNKNOWN_COMMAND_NAME = 48304; |
33 | 33 | const VALIDATION_INVALID_PARAMS_STATEMENT = 48305; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $type = ''; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $paramsString = ''; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $matchedText = ''; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $hash = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var \AppUtils\OperationResult |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var \AppUtils\OperationResult |
|
57 | + */ |
|
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | - /** |
|
61 | - * @var \Mailcode\Mailcode |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var \Mailcode\Mailcode |
|
62 | + */ |
|
63 | 63 | protected $mailcode; |
64 | 64 | |
65 | - /** |
|
66 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
67 | + */ |
|
68 | 68 | protected $params; |
69 | 69 | |
70 | - /** |
|
71 | - * @var string[] |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @var string[] |
|
72 | + */ |
|
73 | 73 | protected $validations = array( |
74 | 74 | 'params_empty', |
75 | 75 | 'params_keywords', |
@@ -78,14 +78,14 @@ discard block |
||
78 | 78 | 'type_unsupported' |
79 | 79 | ); |
80 | 80 | |
81 | - /** |
|
82 | - * @var string |
|
83 | - */ |
|
81 | + /** |
|
82 | + * @var string |
|
83 | + */ |
|
84 | 84 | protected $comment = ''; |
85 | 85 | |
86 | - /** |
|
87 | - * @var Mailcode_Commands_LogicKeywords|NULL |
|
88 | - */ |
|
86 | + /** |
|
87 | + * @var Mailcode_Commands_LogicKeywords|NULL |
|
88 | + */ |
|
89 | 89 | protected $logicKeywords; |
90 | 90 | |
91 | 91 | public function __construct(string $type='', string $paramsString='', string $matchedText='') |
@@ -103,9 +103,9 @@ discard block |
||
103 | 103 | |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * @return string The ID of the command = the name of the command class file. |
|
108 | - */ |
|
106 | + /** |
|
107 | + * @return string The ID of the command = the name of the command class file. |
|
108 | + */ |
|
109 | 109 | public function getID() : string |
110 | 110 | { |
111 | 111 | // account for commands with types: If_Variable should still return If. |
@@ -114,14 +114,14 @@ discard block |
||
114 | 114 | return array_shift($tokens); |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Sets an optional comment that is not used anywhere, but |
|
119 | - * can be used by the application to track why a command is |
|
120 | - * used somewhere. |
|
121 | - * |
|
122 | - * @param string $comment |
|
123 | - * @return Mailcode_Commands_Command |
|
124 | - */ |
|
117 | + /** |
|
118 | + * Sets an optional comment that is not used anywhere, but |
|
119 | + * can be used by the application to track why a command is |
|
120 | + * used somewhere. |
|
121 | + * |
|
122 | + * @param string $comment |
|
123 | + * @return Mailcode_Commands_Command |
|
124 | + */ |
|
125 | 125 | public function setComment(string $comment) : Mailcode_Commands_Command |
126 | 126 | { |
127 | 127 | $this->comment = $comment; |
@@ -129,34 +129,34 @@ discard block |
||
129 | 129 | return $this; |
130 | 130 | } |
131 | 131 | |
132 | - /** |
|
133 | - * Retrieves the previously set comment, if any. |
|
134 | - * |
|
135 | - * @return string |
|
136 | - */ |
|
132 | + /** |
|
133 | + * Retrieves the previously set comment, if any. |
|
134 | + * |
|
135 | + * @return string |
|
136 | + */ |
|
137 | 137 | public function getComment() : string |
138 | 138 | { |
139 | 139 | return $this->comment; |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Checks whether this is a dummy command, which is only |
|
144 | - * used to access information on the command type. It cannot |
|
145 | - * be used as an actual live command. |
|
146 | - * |
|
147 | - * @return bool |
|
148 | - */ |
|
142 | + /** |
|
143 | + * Checks whether this is a dummy command, which is only |
|
144 | + * used to access information on the command type. It cannot |
|
145 | + * be used as an actual live command. |
|
146 | + * |
|
147 | + * @return bool |
|
148 | + */ |
|
149 | 149 | public function isDummy() : bool |
150 | 150 | { |
151 | 151 | return $this->type === '__dummy'; |
152 | 152 | } |
153 | 153 | |
154 | - /** |
|
155 | - * Retrieves a hash of the actual matched command string, |
|
156 | - * which is used in collections to detect duplicate commands. |
|
157 | - * |
|
158 | - * @return string |
|
159 | - */ |
|
154 | + /** |
|
155 | + * Retrieves a hash of the actual matched command string, |
|
156 | + * which is used in collections to detect duplicate commands. |
|
157 | + * |
|
158 | + * @return string |
|
159 | + */ |
|
160 | 160 | public function getHash() : string |
161 | 161 | { |
162 | 162 | $this->requireNonDummy(); |
@@ -253,9 +253,9 @@ discard block |
||
253 | 253 | return $this->validationResult->isValid(); |
254 | 254 | } |
255 | 255 | |
256 | - /** |
|
257 | - * @return string[] |
|
258 | - */ |
|
256 | + /** |
|
257 | + * @return string[] |
|
258 | + */ |
|
259 | 259 | abstract protected function getValidations() : array; |
260 | 260 | |
261 | 261 | protected function validateSyntax_params_empty() : void |
@@ -410,12 +410,12 @@ discard block |
||
410 | 410 | |
411 | 411 | abstract public function supportsType() : bool; |
412 | 412 | |
413 | - /** |
|
414 | - * Whether the command allows using logic keywords like "and:" or "or:" |
|
415 | - * in the command parameters. |
|
416 | - * |
|
417 | - * @return bool |
|
418 | - */ |
|
413 | + /** |
|
414 | + * Whether the command allows using logic keywords like "and:" or "or:" |
|
415 | + * in the command parameters. |
|
416 | + * |
|
417 | + * @return bool |
|
418 | + */ |
|
419 | 419 | abstract public function supportsLogicKeywords() : bool; |
420 | 420 | |
421 | 421 | abstract public function generatesContent() : bool; |
@@ -461,22 +461,22 @@ discard block |
||
461 | 461 | return $normalizer->normalize(); |
462 | 462 | } |
463 | 463 | |
464 | - /** |
|
465 | - * Retrieves the names of all the command's supported types: the part |
|
466 | - * between the command name and the colon. Example: {command type: params}. |
|
467 | - * |
|
468 | - * @return string[] |
|
469 | - */ |
|
464 | + /** |
|
465 | + * Retrieves the names of all the command's supported types: the part |
|
466 | + * between the command name and the colon. Example: {command type: params}. |
|
467 | + * |
|
468 | + * @return string[] |
|
469 | + */ |
|
470 | 470 | public function getSupportedTypes() : array |
471 | 471 | { |
472 | 472 | return array(); |
473 | 473 | } |
474 | 474 | |
475 | - /** |
|
476 | - * Retrieves all variable names used in the command. |
|
477 | - * |
|
478 | - * @return Mailcode_Variables_Collection_Regular |
|
479 | - */ |
|
475 | + /** |
|
476 | + * Retrieves all variable names used in the command. |
|
477 | + * |
|
478 | + * @return Mailcode_Variables_Collection_Regular |
|
479 | + */ |
|
480 | 480 | public function getVariables() : Mailcode_Variables_Collection_Regular |
481 | 481 | { |
482 | 482 | return Mailcode::create()->findVariables($this->paramsString); |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | */ |
89 | 89 | protected $logicKeywords; |
90 | 90 | |
91 | - public function __construct(string $type='', string $paramsString='', string $matchedText='') |
|
91 | + public function __construct(string $type = '', string $paramsString = '', string $matchedText = '') |
|
92 | 92 | { |
93 | 93 | $this->type = $type; |
94 | 94 | $this->paramsString = html_entity_decode($paramsString); |
@@ -161,7 +161,7 @@ discard block |
||
161 | 161 | { |
162 | 162 | $this->requireNonDummy(); |
163 | 163 | |
164 | - if($this->hash === '') { |
|
164 | + if ($this->hash === '') { |
|
165 | 165 | $this->hash = md5($this->matchedText); |
166 | 166 | } |
167 | 167 | |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | |
171 | 171 | protected function requireNonDummy() : void |
172 | 172 | { |
173 | - if(!$this->isDummy()) |
|
173 | + if (!$this->isDummy()) |
|
174 | 174 | { |
175 | 175 | return; |
176 | 176 | } |
@@ -191,7 +191,7 @@ discard block |
||
191 | 191 | { |
192 | 192 | $this->requireNonDummy(); |
193 | 193 | |
194 | - if(isset($this->validationResult)) |
|
194 | + if (isset($this->validationResult)) |
|
195 | 195 | { |
196 | 196 | return $this->validationResult; |
197 | 197 | } |
@@ -205,7 +205,7 @@ discard block |
||
205 | 205 | |
206 | 206 | public function getValidationResult() : \AppUtils\OperationResult |
207 | 207 | { |
208 | - if(isset($this->validationResult)) |
|
208 | + if (isset($this->validationResult)) |
|
209 | 209 | { |
210 | 210 | return $this->validationResult; |
211 | 211 | } |
@@ -221,10 +221,10 @@ discard block |
||
221 | 221 | { |
222 | 222 | $validations = array_merge($this->validations, $this->getValidations()); |
223 | 223 | |
224 | - foreach($validations as $validation) |
|
224 | + foreach ($validations as $validation) |
|
225 | 225 | { |
226 | 226 | // break off at the first validation issue |
227 | - if(!$this->validateSyntaxMethod($validation)) |
|
227 | + if (!$this->validateSyntaxMethod($validation)) |
|
228 | 228 | { |
229 | 229 | return; |
230 | 230 | } |
@@ -235,7 +235,7 @@ discard block |
||
235 | 235 | { |
236 | 236 | $method = 'validateSyntax_'.$validation; |
237 | 237 | |
238 | - if(!method_exists($this, $method)) |
|
238 | + if (!method_exists($this, $method)) |
|
239 | 239 | { |
240 | 240 | throw new Mailcode_Exception( |
241 | 241 | 'Missing validation method', |
@@ -260,12 +260,12 @@ discard block |
||
260 | 260 | |
261 | 261 | protected function validateSyntax_params_empty() : void |
262 | 262 | { |
263 | - if(!$this->requiresParameters()) |
|
263 | + if (!$this->requiresParameters()) |
|
264 | 264 | { |
265 | 265 | return; |
266 | 266 | } |
267 | 267 | |
268 | - if(empty($this->paramsString)) |
|
268 | + if (empty($this->paramsString)) |
|
269 | 269 | { |
270 | 270 | $this->validationResult->makeError( |
271 | 271 | t('Parameters have to be specified.'), |
@@ -277,14 +277,14 @@ discard block |
||
277 | 277 | |
278 | 278 | protected function validateSyntax_params_keywords() : void |
279 | 279 | { |
280 | - if(!$this->supportsLogicKeywords()) |
|
280 | + if (!$this->supportsLogicKeywords()) |
|
281 | 281 | { |
282 | 282 | return; |
283 | 283 | } |
284 | 284 | |
285 | 285 | $this->logicKeywords = new Mailcode_Commands_LogicKeywords($this, $this->paramsString); |
286 | 286 | |
287 | - if(!$this->logicKeywords->isValid()) |
|
287 | + if (!$this->logicKeywords->isValid()) |
|
288 | 288 | { |
289 | 289 | $this->validationResult->makeError( |
290 | 290 | t('Invalid parameters:').' '.$this->logicKeywords->getErrorMessage(), |
@@ -299,14 +299,14 @@ discard block |
||
299 | 299 | |
300 | 300 | protected function validateSyntax_params_parse() : void |
301 | 301 | { |
302 | - if(!$this->requiresParameters()) |
|
302 | + if (!$this->requiresParameters()) |
|
303 | 303 | { |
304 | 304 | return; |
305 | 305 | } |
306 | 306 | |
307 | 307 | $this->params = $this->mailcode->getParser()->createStatement($this->paramsString); |
308 | 308 | |
309 | - if(!$this->params->isValid()) |
|
309 | + if (!$this->params->isValid()) |
|
310 | 310 | { |
311 | 311 | $error = $this->params->getValidationResult(); |
312 | 312 | |
@@ -319,14 +319,14 @@ discard block |
||
319 | 319 | |
320 | 320 | protected function validateSyntax_type_supported() : void |
321 | 321 | { |
322 | - if(!$this->supportsType() || empty($this->type)) |
|
322 | + if (!$this->supportsType() || empty($this->type)) |
|
323 | 323 | { |
324 | 324 | return; |
325 | 325 | } |
326 | 326 | |
327 | 327 | $types = $this->getSupportedTypes(); |
328 | 328 | |
329 | - if(!in_array($this->type, $types)) |
|
329 | + if (!in_array($this->type, $types)) |
|
330 | 330 | { |
331 | 331 | $this->validationResult->makeError( |
332 | 332 | t('The command addon %1$s is not supported.', $this->type).' '. |
@@ -340,7 +340,7 @@ discard block |
||
340 | 340 | |
341 | 341 | protected function validateSyntax_type_unsupported() : void |
342 | 342 | { |
343 | - if($this->supportsType() || empty($this->type)) |
|
343 | + if ($this->supportsType() || empty($this->type)) |
|
344 | 344 | { |
345 | 345 | return; |
346 | 346 | } |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | |
359 | 359 | public function getType() : string |
360 | 360 | { |
361 | - if($this->supportsType()) |
|
361 | + if ($this->supportsType()) |
|
362 | 362 | { |
363 | 363 | return $this->type; |
364 | 364 | } |
@@ -378,7 +378,7 @@ discard block |
||
378 | 378 | |
379 | 379 | public function getHighlighted() : string |
380 | 380 | { |
381 | - if(!$this->isValid()) |
|
381 | + if (!$this->isValid()) |
|
382 | 382 | { |
383 | 383 | return ''; |
384 | 384 | } |
@@ -389,7 +389,7 @@ discard block |
||
389 | 389 | |
390 | 390 | public function getParamsString() : string |
391 | 391 | { |
392 | - if($this->requiresParameters()) |
|
392 | + if ($this->requiresParameters()) |
|
393 | 393 | { |
394 | 394 | return $this->paramsString; |
395 | 395 | } |
@@ -424,22 +424,22 @@ discard block |
||
424 | 424 | |
425 | 425 | public final function getCommandType() : string |
426 | 426 | { |
427 | - if($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
427 | + if ($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
428 | 428 | { |
429 | 429 | return 'Closing'; |
430 | 430 | } |
431 | 431 | |
432 | - if($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
432 | + if ($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
433 | 433 | { |
434 | 434 | return 'Opening'; |
435 | 435 | } |
436 | 436 | |
437 | - if($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
437 | + if ($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
438 | 438 | { |
439 | 439 | return 'Sibling'; |
440 | 440 | } |
441 | 441 | |
442 | - if($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
442 | + if ($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
443 | 443 | { |
444 | 444 | return 'Standalone'; |
445 | 445 | } |
@@ -489,7 +489,7 @@ discard block |
||
489 | 489 | |
490 | 490 | public function getLogicKeywords() : Mailcode_Commands_LogicKeywords |
491 | 491 | { |
492 | - if($this->supportsLogicKeywords() && isset($this->logicKeywords)) |
|
492 | + if ($this->supportsLogicKeywords() && isset($this->logicKeywords)) |
|
493 | 493 | { |
494 | 494 | return $this->logicKeywords; |
495 | 495 | } |
@@ -26,39 +26,39 @@ discard block |
||
26 | 26 | const ERROR_CANNOT_GET_INVALID_COMMAND = 60601; |
27 | 27 | const ERROR_CANNOT_OVERWRITE_PARAMETERS = 60602; |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode_Commands_LogicKeywords |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Commands_LogicKeywords |
|
31 | + */ |
|
32 | 32 | private $keywords; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | private $name; |
38 | 38 | |
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | 42 | private $type; |
43 | 43 | |
44 | - /** |
|
45 | - * @var string |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string |
|
46 | + */ |
|
47 | 47 | private $matchedString; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string |
|
51 | + */ |
|
52 | 52 | private $params = ''; |
53 | 53 | |
54 | - /** |
|
55 | - * @var boolean |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var boolean |
|
56 | + */ |
|
57 | 57 | private $paramsSet = false; |
58 | 58 | |
59 | - /** |
|
60 | - * @var Mailcode_Collection |
|
61 | - */ |
|
59 | + /** |
|
60 | + * @var Mailcode_Collection |
|
61 | + */ |
|
62 | 62 | private $collection; |
63 | 63 | |
64 | 64 | public function __construct(Mailcode_Commands_LogicKeywords $keywords, string $name, string $matchedString, string $type) |
@@ -69,10 +69,10 @@ discard block |
||
69 | 69 | $this->matchedString = $matchedString; |
70 | 70 | } |
71 | 71 | |
72 | - /** |
|
73 | - * The keyword name, e.g. "and". Always lowercase. |
|
74 | - * @return string |
|
75 | - */ |
|
72 | + /** |
|
73 | + * The keyword name, e.g. "and". Always lowercase. |
|
74 | + * @return string |
|
75 | + */ |
|
76 | 76 | public function getName() : string |
77 | 77 | { |
78 | 78 | return $this->name; |
@@ -95,24 +95,24 @@ discard block |
||
95 | 95 | return $string; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * The full string that was matched in the command's parameters |
|
100 | - * string. Examples: "and:", "and variable:"... |
|
101 | - * |
|
102 | - * @return string |
|
103 | - */ |
|
98 | + /** |
|
99 | + * The full string that was matched in the command's parameters |
|
100 | + * string. Examples: "and:", "and variable:"... |
|
101 | + * |
|
102 | + * @return string |
|
103 | + */ |
|
104 | 104 | public function getMatchedString() : string |
105 | 105 | { |
106 | 106 | return $this->matchedString; |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Sets the parameters string matching this logic keyword, |
|
111 | - * which is used to build the actual sub-command. Set by |
|
112 | - * the LogicKeywords class instance. |
|
113 | - * |
|
114 | - * @param string $params |
|
115 | - */ |
|
109 | + /** |
|
110 | + * Sets the parameters string matching this logic keyword, |
|
111 | + * which is used to build the actual sub-command. Set by |
|
112 | + * the LogicKeywords class instance. |
|
113 | + * |
|
114 | + * @param string $params |
|
115 | + */ |
|
116 | 116 | public function setParamsString(string $params) : void |
117 | 117 | { |
118 | 118 | if($this->paramsSet) |
@@ -130,13 +130,13 @@ discard block |
||
130 | 130 | $this->createCommand(); |
131 | 131 | } |
132 | 132 | |
133 | - /** |
|
134 | - * Retrieves the full command string used to create |
|
135 | - * the actual command. For opening commands like IF, |
|
136 | - * this includes the closing {end} command. |
|
137 | - * |
|
138 | - * @return string |
|
139 | - */ |
|
133 | + /** |
|
134 | + * Retrieves the full command string used to create |
|
135 | + * the actual command. For opening commands like IF, |
|
136 | + * this includes the closing {end} command. |
|
137 | + * |
|
138 | + * @return string |
|
139 | + */ |
|
140 | 140 | public function getCommandString() : string |
141 | 141 | { |
142 | 142 | $command = $this->keywords->getCommand(); |
@@ -169,12 +169,12 @@ discard block |
||
169 | 169 | } |
170 | 170 | } |
171 | 171 | |
172 | - /** |
|
173 | - * Retrieves the command for the keyword. |
|
174 | - * |
|
175 | - * @throws Mailcode_Exception |
|
176 | - * @return Mailcode_Commands_Command |
|
177 | - */ |
|
172 | + /** |
|
173 | + * Retrieves the command for the keyword. |
|
174 | + * |
|
175 | + * @throws Mailcode_Exception |
|
176 | + * @return Mailcode_Commands_Command |
|
177 | + */ |
|
178 | 178 | public function getCommand() : Mailcode_Commands_Command |
179 | 179 | { |
180 | 180 | $command = $this->collection->getFirstCommand(); |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | { |
88 | 88 | $string = $this->name; |
89 | 89 | |
90 | - if(!empty($this->type)) |
|
90 | + if (!empty($this->type)) |
|
91 | 91 | { |
92 | 92 | $string .= ' '.$this->type; |
93 | 93 | } |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | */ |
116 | 116 | public function setParamsString(string $params) : void |
117 | 117 | { |
118 | - if($this->paramsSet) |
|
118 | + if ($this->paramsSet) |
|
119 | 119 | { |
120 | 120 | throw new Mailcode_Exception( |
121 | 121 | 'Cannot set parameters twice', |
@@ -149,7 +149,7 @@ discard block |
||
149 | 149 | ); |
150 | 150 | |
151 | 151 | // automatically close opening commands to be able to parse valid strings. |
152 | - if($command instanceof Mailcode_Commands_Command_Type_Opening) |
|
152 | + if ($command instanceof Mailcode_Commands_Command_Type_Opening) |
|
153 | 153 | { |
154 | 154 | $string .= '{end}'; |
155 | 155 | } |
@@ -161,7 +161,7 @@ discard block |
||
161 | 161 | { |
162 | 162 | $this->collection = Mailcode::create()->parseString($this->getCommandString()); |
163 | 163 | |
164 | - if(!$this->collection->isValid()) |
|
164 | + if (!$this->collection->isValid()) |
|
165 | 165 | { |
166 | 166 | $error = $this->collection->getFirstError(); |
167 | 167 | |
@@ -179,7 +179,7 @@ discard block |
||
179 | 179 | { |
180 | 180 | $command = $this->collection->getFirstCommand(); |
181 | 181 | |
182 | - if($this->collection->isValid() && $command !== null) |
|
182 | + if ($this->collection->isValid() && $command !== null) |
|
183 | 183 | { |
184 | 184 | return $command; |
185 | 185 | } |
@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | |
27 | 27 | const VALIDATION_VARIABLE_COUNT_MISMATCH = 48402; |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode_Variables_Variable|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Variables_Variable|NULL |
|
31 | + */ |
|
32 | 32 | protected $variable; |
33 | 33 | |
34 | 34 | public function getName() : string |
@@ -61,15 +61,15 @@ discard block |
||
61 | 61 | return false; |
62 | 62 | } |
63 | 63 | |
64 | - /** |
|
65 | - * Retrieves the variable to show. |
|
66 | - * |
|
67 | - * NOTE: Only available once the command has been |
|
68 | - * validated. Always use isValid() first. |
|
69 | - * |
|
70 | - * @throws Mailcode_Exception |
|
71 | - * @return Mailcode_Variables_Variable |
|
72 | - */ |
|
64 | + /** |
|
65 | + * Retrieves the variable to show. |
|
66 | + * |
|
67 | + * NOTE: Only available once the command has been |
|
68 | + * validated. Always use isValid() first. |
|
69 | + * |
|
70 | + * @throws Mailcode_Exception |
|
71 | + * @return Mailcode_Variables_Variable |
|
72 | + */ |
|
73 | 73 | public function getVariable() : Mailcode_Variables_Variable |
74 | 74 | { |
75 | 75 | $this->validate(); |
@@ -86,15 +86,15 @@ discard block |
||
86 | 86 | ); |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Retrieves the full name of the variable to show. |
|
91 | - * |
|
92 | - * NOTE: Only available once the command has been |
|
93 | - * validated. Always use isValid() first. |
|
94 | - * |
|
95 | - * @throws Mailcode_Exception |
|
96 | - * @return string |
|
97 | - */ |
|
89 | + /** |
|
90 | + * Retrieves the full name of the variable to show. |
|
91 | + * |
|
92 | + * NOTE: Only available once the command has been |
|
93 | + * validated. Always use isValid() first. |
|
94 | + * |
|
95 | + * @throws Mailcode_Exception |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public function getVariableName() : string |
99 | 99 | { |
100 | 100 | return $this->getVariable()->getFullName(); |
@@ -102,19 +102,19 @@ discard block |
||
102 | 102 | |
103 | 103 | protected function validateSyntax_require_variable() : void |
104 | 104 | { |
105 | - $vars = $this->getVariables()->getGroupedByName(); |
|
106 | - $amount = count($vars); |
|
105 | + $vars = $this->getVariables()->getGroupedByName(); |
|
106 | + $amount = count($vars); |
|
107 | 107 | |
108 | - if($amount === 1) |
|
109 | - { |
|
110 | - $this->variable = array_pop($vars); |
|
111 | - return; |
|
112 | - } |
|
108 | + if($amount === 1) |
|
109 | + { |
|
110 | + $this->variable = array_pop($vars); |
|
111 | + return; |
|
112 | + } |
|
113 | 113 | |
114 | - $this->validationResult->makeError( |
|
114 | + $this->validationResult->makeError( |
|
115 | 115 | t('Command has %1$s variables, %2$s expected.', $amount, 1), |
116 | 116 | self::VALIDATION_VARIABLE_COUNT_MISMATCH |
117 | - ); |
|
117 | + ); |
|
118 | 118 | } |
119 | 119 | |
120 | 120 | protected function getValidations() : array |
@@ -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 |
@@ -59,13 +59,13 @@ discard block |
||
59 | 59 | return false; |
60 | 60 | } |
61 | 61 | |
62 | - /** |
|
63 | - * Retrieves the variable to show, provided the command |
|
64 | - * is valid. |
|
65 | - * |
|
66 | - * @throws Mailcode_Exception |
|
67 | - * @return Mailcode_Variables_Variable |
|
68 | - */ |
|
62 | + /** |
|
63 | + * Retrieves the variable to show, provided the command |
|
64 | + * is valid. |
|
65 | + * |
|
66 | + * @throws Mailcode_Exception |
|
67 | + * @return Mailcode_Variables_Variable |
|
68 | + */ |
|
69 | 69 | public function getVariable() : Mailcode_Variables_Variable |
70 | 70 | { |
71 | 71 | $this->validate(); |
@@ -82,13 +82,13 @@ discard block |
||
82 | 82 | ); |
83 | 83 | } |
84 | 84 | |
85 | - /** |
|
86 | - * Retrieves the full name of the variable to show, |
|
87 | - * provided the command is valid. |
|
88 | - * |
|
89 | - * @throws Mailcode_Exception |
|
90 | - * @return string |
|
91 | - */ |
|
85 | + /** |
|
86 | + * Retrieves the full name of the variable to show, |
|
87 | + * provided the command is valid. |
|
88 | + * |
|
89 | + * @throws Mailcode_Exception |
|
90 | + * @return string |
|
91 | + */ |
|
92 | 92 | public function getVariableName() : string |
93 | 93 | { |
94 | 94 | return $this->getVariable()->getFullName(); |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | |
38 | 38 | public function normalize() : string |
39 | 39 | { |
40 | - if(!$this->command->isValid()) |
|
40 | + if (!$this->command->isValid()) |
|
41 | 41 | { |
42 | 42 | return ''; |
43 | 43 | } |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | |
58 | 58 | private function addType() : void |
59 | 59 | { |
60 | - if(!$this->command->supportsType() || !$this->command->hasType()) |
|
60 | + if (!$this->command->supportsType() || !$this->command->hasType()) |
|
61 | 61 | { |
62 | 62 | return; |
63 | 63 | } |
@@ -67,14 +67,14 @@ discard block |
||
67 | 67 | |
68 | 68 | private function addParams(Mailcode_Commands_Command $command) : void |
69 | 69 | { |
70 | - if(!$command->requiresParameters()) |
|
70 | + if (!$command->requiresParameters()) |
|
71 | 71 | { |
72 | 72 | return; |
73 | 73 | } |
74 | 74 | |
75 | 75 | $params = $command->getParams(); |
76 | 76 | |
77 | - if($params === null) |
|
77 | + if ($params === null) |
|
78 | 78 | { |
79 | 79 | return; |
80 | 80 | } |
@@ -85,14 +85,14 @@ discard block |
||
85 | 85 | |
86 | 86 | private function addLogicKeywords() : void |
87 | 87 | { |
88 | - if(!$this->command->supportsLogicKeywords()) |
|
88 | + if (!$this->command->supportsLogicKeywords()) |
|
89 | 89 | { |
90 | 90 | return; |
91 | 91 | } |
92 | 92 | |
93 | 93 | $keywords = $this->command->getLogicKeywords()->getKeywords(); |
94 | 94 | |
95 | - foreach($keywords as $keyword) |
|
95 | + foreach ($keywords as $keyword) |
|
96 | 96 | { |
97 | 97 | $this->parts[] = ' '; |
98 | 98 | $this->parts[] = $keyword->getKeywordString(); // e.g. "if variable" |
@@ -30,27 +30,27 @@ discard block |
||
30 | 30 | const VALIDATION_CANNOT_MIX_LOGIC_KEYWORDS = 60701; |
31 | 31 | const VALIDATION_INVALID_SUB_COMMAND = 60702; |
32 | 32 | |
33 | - /** |
|
34 | - * @var string |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var string |
|
35 | + */ |
|
36 | 36 | private $paramsString; |
37 | 37 | |
38 | - /** |
|
39 | - * @var string[] |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var string[] |
|
40 | + */ |
|
41 | 41 | private $names = array( |
42 | 42 | 'and', |
43 | 43 | 'or' |
44 | 44 | ); |
45 | 45 | |
46 | - /** |
|
47 | - * @var Mailcode_Commands_LogicKeywords_Keyword[] |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var Mailcode_Commands_LogicKeywords_Keyword[] |
|
48 | + */ |
|
49 | 49 | private $keywords = array(); |
50 | 50 | |
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | 54 | private $mainParams = ''; |
55 | 55 | |
56 | 56 | public function __construct(Mailcode_Commands_Command $command, string $paramsString) |
@@ -159,22 +159,22 @@ discard block |
||
159 | 159 | return $stack; |
160 | 160 | } |
161 | 161 | |
162 | - /** |
|
163 | - * Extracts the parameters string to use for the |
|
164 | - * original command itself, omitting all the logic |
|
165 | - * keywords for the sub-commands. |
|
166 | - * |
|
167 | - * @return string |
|
168 | - */ |
|
162 | + /** |
|
163 | + * Extracts the parameters string to use for the |
|
164 | + * original command itself, omitting all the logic |
|
165 | + * keywords for the sub-commands. |
|
166 | + * |
|
167 | + * @return string |
|
168 | + */ |
|
169 | 169 | public function getMainParamsString() : string |
170 | 170 | { |
171 | 171 | return $this->mainParams; |
172 | 172 | } |
173 | 173 | |
174 | - /** |
|
175 | - * Retrieves the detected keyword names. |
|
176 | - * @return string[] |
|
177 | - */ |
|
174 | + /** |
|
175 | + * Retrieves the detected keyword names. |
|
176 | + * @return string[] |
|
177 | + */ |
|
178 | 178 | public function getDetectedNames() : array |
179 | 179 | { |
180 | 180 | $names = array(); |
@@ -192,23 +192,23 @@ discard block |
||
192 | 192 | return $names; |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Retrieves all keywords that were detected in the |
|
197 | - * command's parameters string, if any. |
|
198 | - * |
|
199 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
200 | - */ |
|
195 | + /** |
|
196 | + * Retrieves all keywords that were detected in the |
|
197 | + * command's parameters string, if any. |
|
198 | + * |
|
199 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
200 | + */ |
|
201 | 201 | public function getKeywords() : array |
202 | 202 | { |
203 | 203 | return $this->keywords; |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Detects any keyword statements in the parameters by keyword name. |
|
208 | - * |
|
209 | - * @param string $name |
|
210 | - * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
211 | - */ |
|
206 | + /** |
|
207 | + * Detects any keyword statements in the parameters by keyword name. |
|
208 | + * |
|
209 | + * @param string $name |
|
210 | + * @return Mailcode_Commands_LogicKeywords_Keyword[] |
|
211 | + */ |
|
212 | 212 | private function detectKeywords(string $name) : array |
213 | 213 | { |
214 | 214 | $regex = sprintf('/%1$s\s+([a-z\-0-9]+):|%1$s:/x', $name); |
@@ -70,9 +70,9 @@ discard block |
||
70 | 70 | |
71 | 71 | private function parse() : void |
72 | 72 | { |
73 | - foreach($this->names as $name) |
|
73 | + foreach ($this->names as $name) |
|
74 | 74 | { |
75 | - if(!stristr($this->paramsString, $name)) |
|
75 | + if (!stristr($this->paramsString, $name)) |
|
76 | 76 | { |
77 | 77 | continue; |
78 | 78 | } |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | $names = $this->getDetectedNames(); |
90 | 90 | $amount = count($names); |
91 | 91 | |
92 | - if($amount > 1) |
|
92 | + if ($amount > 1) |
|
93 | 93 | { |
94 | 94 | $this->makeError( |
95 | 95 | t( |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | |
109 | 109 | private function splitParams() : void |
110 | 110 | { |
111 | - if(empty($this->keywords)) |
|
111 | + if (empty($this->keywords)) |
|
112 | 112 | { |
113 | 113 | $this->mainParams = $this->paramsString; |
114 | 114 | |
@@ -117,13 +117,13 @@ discard block |
||
117 | 117 | |
118 | 118 | $params = $this->detectParameters(); |
119 | 119 | |
120 | - foreach($this->keywords as $keyword) |
|
120 | + foreach ($this->keywords as $keyword) |
|
121 | 121 | { |
122 | 122 | $kParams = array_shift($params); |
123 | 123 | |
124 | 124 | $keyword->setParamsString($kParams); |
125 | 125 | |
126 | - if(!$keyword->isValid()) |
|
126 | + if (!$keyword->isValid()) |
|
127 | 127 | { |
128 | 128 | $this->makeError( |
129 | 129 | t('Error #%1$s:', $keyword->getCode()).' '.$keyword->getErrorMessage(), |
@@ -140,14 +140,14 @@ discard block |
||
140 | 140 | $params = $this->paramsString; |
141 | 141 | $stack = array(); |
142 | 142 | |
143 | - foreach($this->keywords as $keyword) |
|
143 | + foreach ($this->keywords as $keyword) |
|
144 | 144 | { |
145 | 145 | $search = $keyword->getMatchedString(); |
146 | 146 | $pos = strpos($params, $search); |
147 | 147 | $length = strlen($search); |
148 | 148 | |
149 | 149 | $store = substr($params, 0, $pos); |
150 | - $params = trim(substr($params, $pos+$length)); |
|
150 | + $params = trim(substr($params, $pos + $length)); |
|
151 | 151 | |
152 | 152 | $stack[] = $store; |
153 | 153 | } |
@@ -179,11 +179,11 @@ discard block |
||
179 | 179 | { |
180 | 180 | $names = array(); |
181 | 181 | |
182 | - foreach($this->keywords as $keyword) |
|
182 | + foreach ($this->keywords as $keyword) |
|
183 | 183 | { |
184 | 184 | $name = $keyword->getName(); |
185 | 185 | |
186 | - if(!in_array($name, $names)) |
|
186 | + if (!in_array($name, $names)) |
|
187 | 187 | { |
188 | 188 | $names[] = $name; |
189 | 189 | } |
@@ -216,14 +216,14 @@ discard block |
||
216 | 216 | $matches = array(); |
217 | 217 | preg_match_all($regex, $this->paramsString, $matches, PREG_PATTERN_ORDER); |
218 | 218 | |
219 | - if(!isset($matches[0][0]) || empty($matches[0][0])) |
|
219 | + if (!isset($matches[0][0]) || empty($matches[0][0])) |
|
220 | 220 | { |
221 | 221 | return array(); |
222 | 222 | } |
223 | 223 | |
224 | 224 | $amount = count($matches[0]); |
225 | 225 | |
226 | - for($i=0; $i < $amount; $i++) |
|
226 | + for ($i = 0; $i < $amount; $i++) |
|
227 | 227 | { |
228 | 228 | $result[] = $this->createKeyword( |
229 | 229 | $name, |
@@ -240,22 +240,22 @@ discard block |
||
240 | 240 | return !empty($this->keywords); |
241 | 241 | } |
242 | 242 | |
243 | - public function appendAND(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
243 | + public function appendAND(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
244 | 244 | { |
245 | 245 | return $this->appendKeyword('and', $paramsString, $type); |
246 | 246 | } |
247 | 247 | |
248 | - public function appendOR(string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
248 | + public function appendOR(string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
249 | 249 | { |
250 | 250 | return $this->appendKeyword('or', $paramsString, $type); |
251 | 251 | } |
252 | 252 | |
253 | - public function appendKeyword(string $name, string $paramsString, string $type='') : Mailcode_Commands_LogicKeywords_Keyword |
|
253 | + public function appendKeyword(string $name, string $paramsString, string $type = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
254 | 254 | { |
255 | 255 | $keyword = $this->createKeyword($name, $type); |
256 | 256 | $keyword->setParamsString($paramsString); |
257 | 257 | |
258 | - if(!$keyword->isValid()) |
|
258 | + if (!$keyword->isValid()) |
|
259 | 259 | { |
260 | 260 | throw new Mailcode_Exception( |
261 | 261 | 'Cannot append invalid logic keyword', |
@@ -276,13 +276,13 @@ discard block |
||
276 | 276 | return $keyword; |
277 | 277 | } |
278 | 278 | |
279 | - private function createKeyword(string $name, string $type='', string $matchedString='') : Mailcode_Commands_LogicKeywords_Keyword |
|
279 | + private function createKeyword(string $name, string $type = '', string $matchedString = '') : Mailcode_Commands_LogicKeywords_Keyword |
|
280 | 280 | { |
281 | - if(empty($matchedString)) |
|
281 | + if (empty($matchedString)) |
|
282 | 282 | { |
283 | 283 | $matchedString = $name; |
284 | 284 | |
285 | - if(!empty($type)) |
|
285 | + if (!empty($type)) |
|
286 | 286 | { |
287 | 287 | $matchedString .= ' '.$type; |
288 | 288 | } |