@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | { |
25 | 25 | const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301; |
26 | 26 | |
27 | - /** |
|
28 | - * @var Mailcode_Commands_Command[] |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Commands_Command[] |
|
29 | + */ |
|
30 | 30 | protected $commands = array(); |
31 | 31 | |
32 | 32 | /** |
@@ -34,17 +34,17 @@ discard block |
||
34 | 34 | */ |
35 | 35 | protected $errors = array(); |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult|NULL |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult|NULL |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * Adds a command to the collection. |
|
44 | - * |
|
45 | - * @param Mailcode_Commands_Command $command |
|
46 | - * @return Mailcode_Collection |
|
47 | - */ |
|
42 | + /** |
|
43 | + * Adds a command to the collection. |
|
44 | + * |
|
45 | + * @param Mailcode_Commands_Command $command |
|
46 | + * @return Mailcode_Collection |
|
47 | + */ |
|
48 | 48 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
49 | 49 | { |
50 | 50 | $this->commands[] = $command; |
@@ -56,21 +56,21 @@ discard block |
||
56 | 56 | return $this; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Whether there are any commands in the collection. |
|
61 | - * |
|
62 | - * @return bool |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Whether there are any commands in the collection. |
|
61 | + * |
|
62 | + * @return bool |
|
63 | + */ |
|
64 | 64 | public function hasCommands() : bool |
65 | 65 | { |
66 | 66 | return !empty($this->commands); |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Counts the amount of commands in the collection. |
|
71 | - * |
|
72 | - * @return int |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Counts the amount of commands in the collection. |
|
71 | + * |
|
72 | + * @return int |
|
73 | + */ |
|
74 | 74 | public function countCommands() : int |
75 | 75 | { |
76 | 76 | return count($this->commands); |
@@ -90,9 +90,9 @@ discard block |
||
90 | 90 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * @return Mailcode_Collection_Error[] |
|
95 | - */ |
|
93 | + /** |
|
94 | + * @return Mailcode_Collection_Error[] |
|
95 | + */ |
|
96 | 96 | public function getErrors() |
97 | 97 | { |
98 | 98 | $result = $this->getValidationResult(); |
@@ -134,25 +134,25 @@ discard block |
||
134 | 134 | return empty($errors); |
135 | 135 | } |
136 | 136 | |
137 | - /** |
|
138 | - * Retrieves all commands that were detected, in the exact order |
|
139 | - * they were found. |
|
140 | - * |
|
141 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | - */ |
|
137 | + /** |
|
138 | + * Retrieves all commands that were detected, in the exact order |
|
139 | + * they were found. |
|
140 | + * |
|
141 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | + */ |
|
143 | 143 | public function getCommands() |
144 | 144 | { |
145 | - return $this->commands; |
|
145 | + return $this->commands; |
|
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Retrieves all unique commands by their matched |
|
150 | - * string hash: this ensures only commands that were |
|
151 | - * written the exact same way (including spacing) |
|
152 | - * are returned. |
|
153 | - * |
|
154 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Retrieves all unique commands by their matched |
|
150 | + * string hash: this ensures only commands that were |
|
151 | + * written the exact same way (including spacing) |
|
152 | + * are returned. |
|
153 | + * |
|
154 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | + */ |
|
156 | 156 | public function getGroupedByHash() |
157 | 157 | { |
158 | 158 | $hashes = array(); |
@@ -170,12 +170,12 @@ discard block |
||
170 | 170 | return array_values($hashes); |
171 | 171 | } |
172 | 172 | |
173 | - /** |
|
174 | - * Adds several commands at once. |
|
175 | - * |
|
176 | - * @param Mailcode_Commands_Command[] $commands |
|
177 | - * @return Mailcode_Collection |
|
178 | - */ |
|
173 | + /** |
|
174 | + * Adds several commands at once. |
|
175 | + * |
|
176 | + * @param Mailcode_Commands_Command[] $commands |
|
177 | + * @return Mailcode_Collection |
|
178 | + */ |
|
179 | 179 | public function addCommands(array $commands) : Mailcode_Collection |
180 | 180 | { |
181 | 181 | foreach($commands as $command) |
@@ -234,21 +234,21 @@ discard block |
||
234 | 234 | return false; |
235 | 235 | } |
236 | 236 | |
237 | - /** |
|
238 | - * Retrieves only show variable commands in the collection, if any. |
|
239 | - * |
|
240 | - * @return Mailcode_Commands_Command_ShowVariable[] |
|
241 | - */ |
|
237 | + /** |
|
238 | + * Retrieves only show variable commands in the collection, if any. |
|
239 | + * |
|
240 | + * @return Mailcode_Commands_Command_ShowVariable[] |
|
241 | + */ |
|
242 | 242 | public function getShowVariableCommands() |
243 | 243 | { |
244 | 244 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Retrieves only show date commands in the collection, if any. |
|
249 | - * |
|
250 | - * @return Mailcode_Commands_Command_ShowDate[] |
|
251 | - */ |
|
247 | + /** |
|
248 | + * Retrieves only show date commands in the collection, if any. |
|
249 | + * |
|
250 | + * @return Mailcode_Commands_Command_ShowDate[] |
|
251 | + */ |
|
252 | 252 | public function getShowDateCommands() : array |
253 | 253 | { |
254 | 254 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class); |
@@ -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,24 +78,24 @@ 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 | - /** |
|
92 | - * @var Mailcode_Parser_Statement_Validator |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @var Mailcode_Parser_Statement_Validator |
|
93 | + */ |
|
94 | 94 | protected $validator; |
95 | 95 | |
96 | - /** |
|
97 | - * @var boolean |
|
98 | - */ |
|
96 | + /** |
|
97 | + * @var boolean |
|
98 | + */ |
|
99 | 99 | private $validated = false; |
100 | 100 | |
101 | 101 | /** |
@@ -120,9 +120,9 @@ discard block |
||
120 | 120 | |
121 | 121 | } |
122 | 122 | |
123 | - /** |
|
124 | - * @return string The ID of the command = the name of the command class file. |
|
125 | - */ |
|
123 | + /** |
|
124 | + * @return string The ID of the command = the name of the command class file. |
|
125 | + */ |
|
126 | 126 | public function getID() : string |
127 | 127 | { |
128 | 128 | // account for commands with types: If_Variable should still return If. |
@@ -131,14 +131,14 @@ discard block |
||
131 | 131 | return array_shift($tokens); |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Sets an optional comment that is not used anywhere, but |
|
136 | - * can be used by the application to track why a command is |
|
137 | - * used somewhere. |
|
138 | - * |
|
139 | - * @param string $comment |
|
140 | - * @return Mailcode_Commands_Command |
|
141 | - */ |
|
134 | + /** |
|
135 | + * Sets an optional comment that is not used anywhere, but |
|
136 | + * can be used by the application to track why a command is |
|
137 | + * used somewhere. |
|
138 | + * |
|
139 | + * @param string $comment |
|
140 | + * @return Mailcode_Commands_Command |
|
141 | + */ |
|
142 | 142 | public function setComment(string $comment) : Mailcode_Commands_Command |
143 | 143 | { |
144 | 144 | $this->comment = $comment; |
@@ -146,34 +146,34 @@ discard block |
||
146 | 146 | return $this; |
147 | 147 | } |
148 | 148 | |
149 | - /** |
|
150 | - * Retrieves the previously set comment, if any. |
|
151 | - * |
|
152 | - * @return string |
|
153 | - */ |
|
149 | + /** |
|
150 | + * Retrieves the previously set comment, if any. |
|
151 | + * |
|
152 | + * @return string |
|
153 | + */ |
|
154 | 154 | public function getComment() : string |
155 | 155 | { |
156 | 156 | return $this->comment; |
157 | 157 | } |
158 | 158 | |
159 | - /** |
|
160 | - * Checks whether this is a dummy command, which is only |
|
161 | - * used to access information on the command type. It cannot |
|
162 | - * be used as an actual live command. |
|
163 | - * |
|
164 | - * @return bool |
|
165 | - */ |
|
159 | + /** |
|
160 | + * Checks whether this is a dummy command, which is only |
|
161 | + * used to access information on the command type. It cannot |
|
162 | + * be used as an actual live command. |
|
163 | + * |
|
164 | + * @return bool |
|
165 | + */ |
|
166 | 166 | public function isDummy() : bool |
167 | 167 | { |
168 | 168 | return $this->type === '__dummy'; |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Retrieves a hash of the actual matched command string, |
|
173 | - * which is used in collections to detect duplicate commands. |
|
174 | - * |
|
175 | - * @return string |
|
176 | - */ |
|
171 | + /** |
|
172 | + * Retrieves a hash of the actual matched command string, |
|
173 | + * which is used in collections to detect duplicate commands. |
|
174 | + * |
|
175 | + * @return string |
|
176 | + */ |
|
177 | 177 | public function getHash() : string |
178 | 178 | { |
179 | 179 | $this->requireNonDummy(); |
@@ -267,9 +267,9 @@ discard block |
||
267 | 267 | return $this->validationResult->isValid(); |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * @return string[] |
|
272 | - */ |
|
270 | + /** |
|
271 | + * @return string[] |
|
272 | + */ |
|
273 | 273 | abstract protected function getValidations() : array; |
274 | 274 | |
275 | 275 | protected function validateSyntax_params_empty() : void |
@@ -428,12 +428,12 @@ discard block |
||
428 | 428 | |
429 | 429 | abstract public function supportsType() : bool; |
430 | 430 | |
431 | - /** |
|
432 | - * Whether the command allows using logic keywords like "and:" or "or:" |
|
433 | - * in the command parameters. |
|
434 | - * |
|
435 | - * @return bool |
|
436 | - */ |
|
431 | + /** |
|
432 | + * Whether the command allows using logic keywords like "and:" or "or:" |
|
433 | + * in the command parameters. |
|
434 | + * |
|
435 | + * @return bool |
|
436 | + */ |
|
437 | 437 | abstract public function supportsLogicKeywords() : bool; |
438 | 438 | |
439 | 439 | abstract public function generatesContent() : bool; |
@@ -479,22 +479,22 @@ discard block |
||
479 | 479 | return $normalizer->normalize(); |
480 | 480 | } |
481 | 481 | |
482 | - /** |
|
483 | - * Retrieves the names of all the command's supported types: the part |
|
484 | - * between the command name and the colon. Example: {command type: params}. |
|
485 | - * |
|
486 | - * @return string[] |
|
487 | - */ |
|
482 | + /** |
|
483 | + * Retrieves the names of all the command's supported types: the part |
|
484 | + * between the command name and the colon. Example: {command type: params}. |
|
485 | + * |
|
486 | + * @return string[] |
|
487 | + */ |
|
488 | 488 | public function getSupportedTypes() : array |
489 | 489 | { |
490 | 490 | return array(); |
491 | 491 | } |
492 | 492 | |
493 | - /** |
|
494 | - * Retrieves all variable names used in the command. |
|
495 | - * |
|
496 | - * @return Mailcode_Variables_Collection_Regular |
|
497 | - */ |
|
493 | + /** |
|
494 | + * Retrieves all variable names used in the command. |
|
495 | + * |
|
496 | + * @return Mailcode_Variables_Collection_Regular |
|
497 | + */ |
|
498 | 498 | public function getVariables() : Mailcode_Variables_Collection_Regular |
499 | 499 | { |
500 | 500 | return Mailcode::create()->findVariables($this->paramsString); |
@@ -519,26 +519,26 @@ discard block |
||
519 | 519 | ); |
520 | 520 | } |
521 | 521 | |
522 | - /** |
|
523 | - * Sets a parameter for the translation backend. The backend can use |
|
524 | - * these to allow command-specific configurations. |
|
525 | - * |
|
526 | - * @param string $name |
|
527 | - * @param mixed $value |
|
528 | - * @return $this |
|
529 | - */ |
|
522 | + /** |
|
523 | + * Sets a parameter for the translation backend. The backend can use |
|
524 | + * these to allow command-specific configurations. |
|
525 | + * |
|
526 | + * @param string $name |
|
527 | + * @param mixed $value |
|
528 | + * @return $this |
|
529 | + */ |
|
530 | 530 | public function setTranslationParam(string $name, $value) |
531 | 531 | { |
532 | 532 | $this->translationParams[$name] = $value; |
533 | 533 | return $this; |
534 | 534 | } |
535 | 535 | |
536 | - /** |
|
537 | - * Retrieves a previously set translation parameter. |
|
538 | - * |
|
539 | - * @param string $name |
|
540 | - * @return mixed |
|
541 | - */ |
|
536 | + /** |
|
537 | + * Retrieves a previously set translation parameter. |
|
538 | + * |
|
539 | + * @param string $name |
|
540 | + * @return mixed |
|
541 | + */ |
|
542 | 542 | public function getTranslationParam(string $name) |
543 | 543 | { |
544 | 544 | if(isset($this->translationParams[$name])) |
@@ -24,15 +24,15 @@ |
||
24 | 24 | { |
25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
26 | 26 | |
27 | - /** |
|
28 | - * The date format used in the date variable. This is used to convert |
|
29 | - * the native date to the format specified in the variable command. |
|
30 | - */ |
|
27 | + /** |
|
28 | + * The date format used in the date variable. This is used to convert |
|
29 | + * the native date to the format specified in the variable command. |
|
30 | + */ |
|
31 | 31 | const DEFAULT_INTERNAL_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"; |
32 | 32 | |
33 | - /** |
|
34 | - * @var string[]string |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var string[]string |
|
35 | + */ |
|
36 | 36 | private $charTable = array( |
37 | 37 | 'd' => 'd', |
38 | 38 | 'm' => 'M', |