@@ -43,44 +43,44 @@ discard block |
||
43 | 43 | |
44 | 44 | const META_URL_ENCODING = 'url_encoding'; |
45 | 45 | |
46 | - /** |
|
47 | - * @var string |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var string |
|
48 | + */ |
|
49 | 49 | protected $type = ''; |
50 | 50 | |
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | 54 | protected $paramsString = ''; |
55 | 55 | |
56 | - /** |
|
57 | - * @var string |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var string |
|
58 | + */ |
|
59 | 59 | protected $matchedText = ''; |
60 | 60 | |
61 | - /** |
|
62 | - * @var string |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var string |
|
63 | + */ |
|
64 | 64 | protected $hash = ''; |
65 | 65 | |
66 | - /** |
|
67 | - * @var OperationResult |
|
68 | - */ |
|
66 | + /** |
|
67 | + * @var OperationResult |
|
68 | + */ |
|
69 | 69 | protected $validationResult = null; |
70 | 70 | |
71 | - /** |
|
72 | - * @var \Mailcode\Mailcode |
|
73 | - */ |
|
71 | + /** |
|
72 | + * @var \Mailcode\Mailcode |
|
73 | + */ |
|
74 | 74 | protected $mailcode; |
75 | 75 | |
76 | - /** |
|
77 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
78 | - */ |
|
76 | + /** |
|
77 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
78 | + */ |
|
79 | 79 | protected $params; |
80 | 80 | |
81 | - /** |
|
82 | - * @var string[] |
|
83 | - */ |
|
81 | + /** |
|
82 | + * @var string[] |
|
83 | + */ |
|
84 | 84 | protected $validations = array( |
85 | 85 | 'params_empty', |
86 | 86 | 'params_keywords', |
@@ -89,24 +89,24 @@ discard block |
||
89 | 89 | 'type_unsupported' |
90 | 90 | ); |
91 | 91 | |
92 | - /** |
|
93 | - * @var string |
|
94 | - */ |
|
92 | + /** |
|
93 | + * @var string |
|
94 | + */ |
|
95 | 95 | protected $comment = ''; |
96 | 96 | |
97 | - /** |
|
98 | - * @var Mailcode_Commands_LogicKeywords|NULL |
|
99 | - */ |
|
97 | + /** |
|
98 | + * @var Mailcode_Commands_LogicKeywords|NULL |
|
99 | + */ |
|
100 | 100 | protected $logicKeywords; |
101 | 101 | |
102 | - /** |
|
103 | - * @var Mailcode_Parser_Statement_Validator |
|
104 | - */ |
|
102 | + /** |
|
103 | + * @var Mailcode_Parser_Statement_Validator |
|
104 | + */ |
|
105 | 105 | protected $validator; |
106 | 106 | |
107 | - /** |
|
108 | - * @var boolean |
|
109 | - */ |
|
107 | + /** |
|
108 | + * @var boolean |
|
109 | + */ |
|
110 | 110 | private $validated = false; |
111 | 111 | |
112 | 112 | /** |
@@ -146,13 +146,13 @@ discard block |
||
146 | 146 | |
147 | 147 | } |
148 | 148 | |
149 | - /** |
|
150 | - * Sets the command's parent opening command, if any. |
|
151 | - * NOTE: This is set automatically by the parser, and |
|
152 | - * should not be called manually. |
|
153 | - * |
|
154 | - * @param Mailcode_Commands_Command $command |
|
155 | - */ |
|
149 | + /** |
|
150 | + * Sets the command's parent opening command, if any. |
|
151 | + * NOTE: This is set automatically by the parser, and |
|
152 | + * should not be called manually. |
|
153 | + * |
|
154 | + * @param Mailcode_Commands_Command $command |
|
155 | + */ |
|
156 | 156 | public function setParent(Mailcode_Commands_Command $command) : void |
157 | 157 | { |
158 | 158 | $this->parent = $command; |
@@ -168,9 +168,9 @@ discard block |
||
168 | 168 | return $this->parent; |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * @return string The ID of the command = the name of the command class file. |
|
173 | - */ |
|
171 | + /** |
|
172 | + * @return string The ID of the command = the name of the command class file. |
|
173 | + */ |
|
174 | 174 | public function getID() : string |
175 | 175 | { |
176 | 176 | // account for commands with types: If_Variable should still return If. |
@@ -179,14 +179,14 @@ discard block |
||
179 | 179 | return array_shift($tokens); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Sets an optional comment that is not used anywhere, but |
|
184 | - * can be used by the application to track why a command is |
|
185 | - * used somewhere. |
|
186 | - * |
|
187 | - * @param string $comment |
|
188 | - * @return Mailcode_Commands_Command |
|
189 | - */ |
|
182 | + /** |
|
183 | + * Sets an optional comment that is not used anywhere, but |
|
184 | + * can be used by the application to track why a command is |
|
185 | + * used somewhere. |
|
186 | + * |
|
187 | + * @param string $comment |
|
188 | + * @return Mailcode_Commands_Command |
|
189 | + */ |
|
190 | 190 | public function setComment(string $comment) : Mailcode_Commands_Command |
191 | 191 | { |
192 | 192 | $this->comment = $comment; |
@@ -194,34 +194,34 @@ discard block |
||
194 | 194 | return $this; |
195 | 195 | } |
196 | 196 | |
197 | - /** |
|
198 | - * Retrieves the previously set comment, if any. |
|
199 | - * |
|
200 | - * @return string |
|
201 | - */ |
|
197 | + /** |
|
198 | + * Retrieves the previously set comment, if any. |
|
199 | + * |
|
200 | + * @return string |
|
201 | + */ |
|
202 | 202 | public function getComment() : string |
203 | 203 | { |
204 | 204 | return $this->comment; |
205 | 205 | } |
206 | 206 | |
207 | - /** |
|
208 | - * Checks whether this is a dummy command, which is only |
|
209 | - * used to access information on the command type. It cannot |
|
210 | - * be used as an actual live command. |
|
211 | - * |
|
212 | - * @return bool |
|
213 | - */ |
|
207 | + /** |
|
208 | + * Checks whether this is a dummy command, which is only |
|
209 | + * used to access information on the command type. It cannot |
|
210 | + * be used as an actual live command. |
|
211 | + * |
|
212 | + * @return bool |
|
213 | + */ |
|
214 | 214 | public function isDummy() : bool |
215 | 215 | { |
216 | 216 | return $this->type === '__dummy'; |
217 | 217 | } |
218 | 218 | |
219 | - /** |
|
220 | - * Retrieves a hash of the actual matched command string, |
|
221 | - * which is used in collections to detect duplicate commands. |
|
222 | - * |
|
223 | - * @return string |
|
224 | - */ |
|
219 | + /** |
|
220 | + * Retrieves a hash of the actual matched command string, |
|
221 | + * which is used in collections to detect duplicate commands. |
|
222 | + * |
|
223 | + * @return string |
|
224 | + */ |
|
225 | 225 | public function getHash() : string |
226 | 226 | { |
227 | 227 | $this->requireNonDummy(); |
@@ -323,9 +323,9 @@ discard block |
||
323 | 323 | return $this->validationResult->isValid(); |
324 | 324 | } |
325 | 325 | |
326 | - /** |
|
327 | - * @return string[] |
|
328 | - */ |
|
326 | + /** |
|
327 | + * @return string[] |
|
328 | + */ |
|
329 | 329 | abstract protected function getValidations() : array; |
330 | 330 | |
331 | 331 | protected function _validateNesting() : void |
@@ -413,12 +413,12 @@ discard block |
||
413 | 413 | |
414 | 414 | abstract public function supportsURLEncoding() : bool; |
415 | 415 | |
416 | - /** |
|
417 | - * Whether the command allows using logic keywords like "and:" or "or:" |
|
418 | - * in the command parameters. |
|
419 | - * |
|
420 | - * @return bool |
|
421 | - */ |
|
416 | + /** |
|
417 | + * Whether the command allows using logic keywords like "and:" or "or:" |
|
418 | + * in the command parameters. |
|
419 | + * |
|
420 | + * @return bool |
|
421 | + */ |
|
422 | 422 | abstract public function supportsLogicKeywords() : bool; |
423 | 423 | |
424 | 424 | abstract public function generatesContent() : bool; |
@@ -464,22 +464,22 @@ discard block |
||
464 | 464 | return $normalizer->normalize(); |
465 | 465 | } |
466 | 466 | |
467 | - /** |
|
468 | - * Retrieves the names of all the command's supported types: the part |
|
469 | - * between the command name and the colon. Example: {command type: params}. |
|
470 | - * |
|
471 | - * @return string[] |
|
472 | - */ |
|
467 | + /** |
|
468 | + * Retrieves the names of all the command's supported types: the part |
|
469 | + * between the command name and the colon. Example: {command type: params}. |
|
470 | + * |
|
471 | + * @return string[] |
|
472 | + */ |
|
473 | 473 | public function getSupportedTypes() : array |
474 | 474 | { |
475 | 475 | return array(); |
476 | 476 | } |
477 | 477 | |
478 | - /** |
|
479 | - * Retrieves all variable names used in the command. |
|
480 | - * |
|
481 | - * @return Mailcode_Variables_Collection_Regular |
|
482 | - */ |
|
478 | + /** |
|
479 | + * Retrieves all variable names used in the command. |
|
480 | + * |
|
481 | + * @return Mailcode_Variables_Collection_Regular |
|
482 | + */ |
|
483 | 483 | public function getVariables() : Mailcode_Variables_Collection_Regular |
484 | 484 | { |
485 | 485 | return Mailcode::create()->findVariables($this->paramsString); |
@@ -504,26 +504,26 @@ discard block |
||
504 | 504 | ); |
505 | 505 | } |
506 | 506 | |
507 | - /** |
|
508 | - * Sets a parameter for the translation backend. The backend can use |
|
509 | - * these to allow command-specific configurations. |
|
510 | - * |
|
511 | - * @param string $name |
|
512 | - * @param mixed $value |
|
513 | - * @return $this |
|
514 | - */ |
|
507 | + /** |
|
508 | + * Sets a parameter for the translation backend. The backend can use |
|
509 | + * these to allow command-specific configurations. |
|
510 | + * |
|
511 | + * @param string $name |
|
512 | + * @param mixed $value |
|
513 | + * @return $this |
|
514 | + */ |
|
515 | 515 | public function setTranslationParam(string $name, $value) |
516 | 516 | { |
517 | 517 | $this->translationParams[$name] = $value; |
518 | 518 | return $this; |
519 | 519 | } |
520 | 520 | |
521 | - /** |
|
522 | - * Retrieves a previously set translation parameter. |
|
523 | - * |
|
524 | - * @param string $name |
|
525 | - * @return mixed |
|
526 | - */ |
|
521 | + /** |
|
522 | + * Retrieves a previously set translation parameter. |
|
523 | + * |
|
524 | + * @param string $name |
|
525 | + * @return mixed |
|
526 | + */ |
|
527 | 527 | public function getTranslationParam(string $name) |
528 | 528 | { |
529 | 529 | if(isset($this->translationParams[$name])) |
@@ -165,13 +165,13 @@ |
||
165 | 165 | ); |
166 | 166 | } |
167 | 167 | |
168 | - /** |
|
169 | - * |
|
170 | - * @param Mailcode_Variables_Variable $variable |
|
171 | - * @param bool $caseSensitive |
|
172 | - * @param Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] $searchTerms |
|
173 | - * @return string |
|
174 | - */ |
|
168 | + /** |
|
169 | + * |
|
170 | + * @param Mailcode_Variables_Variable $variable |
|
171 | + * @param bool $caseSensitive |
|
172 | + * @param Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] $searchTerms |
|
173 | + * @return string |
|
174 | + */ |
|
175 | 175 | protected function _translateContains(Mailcode_Variables_Variable $variable, bool $caseSensitive, array $searchTerms, string $containsType) : string |
176 | 176 | { |
177 | 177 | $parts = array(); |
@@ -23,9 +23,9 @@ discard block |
||
23 | 23 | const ERROR_INVALID_COMMAND_CREATED = 50001; |
24 | 24 | const ERROR_UNEXPECTED_COMMAND_TYPE = 50002; |
25 | 25 | |
26 | - /** |
|
27 | - * @var Mailcode_Factory_CommandSets |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Mailcode_Factory_CommandSets |
|
28 | + */ |
|
29 | 29 | private static $commandSets; |
30 | 30 | |
31 | 31 | // region Show commands |
@@ -409,34 +409,34 @@ discard block |
||
409 | 409 | return self::$commandSets->if()->ifNotEmpty($variable); |
410 | 410 | } |
411 | 411 | |
412 | - /** |
|
413 | - * Creates a renderer instance, which can be used to easily |
|
414 | - * create and convert commands to strings. |
|
415 | - * |
|
416 | - * @return Mailcode_Renderer |
|
417 | - */ |
|
412 | + /** |
|
413 | + * Creates a renderer instance, which can be used to easily |
|
414 | + * create and convert commands to strings. |
|
415 | + * |
|
416 | + * @return Mailcode_Renderer |
|
417 | + */ |
|
418 | 418 | public static function createRenderer() : Mailcode_Renderer |
419 | 419 | { |
420 | 420 | return new Mailcode_Renderer(); |
421 | 421 | } |
422 | 422 | |
423 | - /** |
|
424 | - * Creates a printer instance, which works like the renderer, |
|
425 | - * but outputs the generated strings to standard output. |
|
426 | - * |
|
427 | - * @return Mailcode_Printer |
|
428 | - */ |
|
423 | + /** |
|
424 | + * Creates a printer instance, which works like the renderer, |
|
425 | + * but outputs the generated strings to standard output. |
|
426 | + * |
|
427 | + * @return Mailcode_Printer |
|
428 | + */ |
|
429 | 429 | public static function createPrinter() : Mailcode_Printer |
430 | 430 | { |
431 | 431 | return new Mailcode_Printer(); |
432 | 432 | } |
433 | 433 | |
434 | - /** |
|
435 | - * Gets/creates the global instance of the date format info |
|
436 | - * class, used to handle date formatting aspects. |
|
437 | - * |
|
438 | - * @return Mailcode_Date_FormatInfo |
|
439 | - */ |
|
434 | + /** |
|
435 | + * Gets/creates the global instance of the date format info |
|
436 | + * class, used to handle date formatting aspects. |
|
437 | + * |
|
438 | + * @return Mailcode_Date_FormatInfo |
|
439 | + */ |
|
440 | 440 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
441 | 441 | { |
442 | 442 | return Mailcode_Date_FormatInfo::getInstance(); |