@@ -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 |
@@ -56,15 +56,15 @@ discard block |
||
56 | 56 | return true; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Retrieves the variable to show. |
|
61 | - * |
|
62 | - * NOTE: Only available once the command has been |
|
63 | - * validated. Always use isValid() first. |
|
64 | - * |
|
65 | - * @throws Mailcode_Exception |
|
66 | - * @return Mailcode_Variables_Variable |
|
67 | - */ |
|
59 | + /** |
|
60 | + * Retrieves the variable to show. |
|
61 | + * |
|
62 | + * NOTE: Only available once the command has been |
|
63 | + * validated. Always use isValid() first. |
|
64 | + * |
|
65 | + * @throws Mailcode_Exception |
|
66 | + * @return Mailcode_Variables_Variable |
|
67 | + */ |
|
68 | 68 | public function getVariable() : Mailcode_Variables_Variable |
69 | 69 | { |
70 | 70 | $this->validate(); |
@@ -81,15 +81,15 @@ discard block |
||
81 | 81 | ); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Retrieves the full name of the variable to show. |
|
86 | - * |
|
87 | - * NOTE: Only available once the command has been |
|
88 | - * validated. Always use isValid() first. |
|
89 | - * |
|
90 | - * @throws Mailcode_Exception |
|
91 | - * @return string |
|
92 | - */ |
|
84 | + /** |
|
85 | + * Retrieves the full name of the variable to show. |
|
86 | + * |
|
87 | + * NOTE: Only available once the command has been |
|
88 | + * validated. Always use isValid() first. |
|
89 | + * |
|
90 | + * @throws Mailcode_Exception |
|
91 | + * @return string |
|
92 | + */ |
|
93 | 93 | public function getVariableName() : string |
94 | 94 | { |
95 | 95 | return $this->getVariable()->getFullName(); |
@@ -97,19 +97,19 @@ discard block |
||
97 | 97 | |
98 | 98 | protected function validateSyntax_require_variable() : void |
99 | 99 | { |
100 | - $vars = $this->getVariables()->getGroupedByName(); |
|
101 | - $amount = count($vars); |
|
100 | + $vars = $this->getVariables()->getGroupedByName(); |
|
101 | + $amount = count($vars); |
|
102 | 102 | |
103 | - if($amount === 1) |
|
104 | - { |
|
105 | - $this->variable = array_pop($vars); |
|
106 | - return; |
|
107 | - } |
|
103 | + if($amount === 1) |
|
104 | + { |
|
105 | + $this->variable = array_pop($vars); |
|
106 | + return; |
|
107 | + } |
|
108 | 108 | |
109 | - $this->validationResult->makeError( |
|
109 | + $this->validationResult->makeError( |
|
110 | 110 | t('Command has %1$s variables, %2$s expected.', $amount, 1), |
111 | 111 | self::VALIDATION_VARIABLE_COUNT_MISMATCH |
112 | - ); |
|
112 | + ); |
|
113 | 113 | } |
114 | 114 | |
115 | 115 | protected function getValidations() : array |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | { |
70 | 70 | $this->validate(); |
71 | 71 | |
72 | - if($this->variable instanceof Mailcode_Variables_Variable) |
|
72 | + if ($this->variable instanceof Mailcode_Variables_Variable) |
|
73 | 73 | { |
74 | 74 | return $this->variable; |
75 | 75 | } |
@@ -100,7 +100,7 @@ discard block |
||
100 | 100 | $vars = $this->getVariables()->getGroupedByName(); |
101 | 101 | $amount = count($vars); |
102 | 102 | |
103 | - if($amount === 1) |
|
103 | + if ($amount === 1) |
|
104 | 104 | { |
105 | 105 | $this->variable = array_pop($vars); |
106 | 106 | return; |
@@ -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(); |
@@ -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,13 +54,13 @@ discard block |
||
54 | 54 | return true; |
55 | 55 | } |
56 | 56 | |
57 | - /** |
|
58 | - * Retrieves the variable to show, provided the command |
|
59 | - * is valid. |
|
60 | - * |
|
61 | - * @throws Mailcode_Exception |
|
62 | - * @return Mailcode_Variables_Variable |
|
63 | - */ |
|
57 | + /** |
|
58 | + * Retrieves the variable to show, provided the command |
|
59 | + * is valid. |
|
60 | + * |
|
61 | + * @throws Mailcode_Exception |
|
62 | + * @return Mailcode_Variables_Variable |
|
63 | + */ |
|
64 | 64 | public function getVariable() : Mailcode_Variables_Variable |
65 | 65 | { |
66 | 66 | $this->validate(); |
@@ -77,13 +77,13 @@ discard block |
||
77 | 77 | ); |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Retrieves the full name of the variable to show, |
|
82 | - * provided the command is valid. |
|
83 | - * |
|
84 | - * @throws Mailcode_Exception |
|
85 | - * @return string |
|
86 | - */ |
|
80 | + /** |
|
81 | + * Retrieves the full name of the variable to show, |
|
82 | + * provided the command is valid. |
|
83 | + * |
|
84 | + * @throws Mailcode_Exception |
|
85 | + * @return string |
|
86 | + */ |
|
87 | 87 | public function getVariableName() : string |
88 | 88 | { |
89 | 89 | return $this->getVariable()->getFullName(); |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | { |
66 | 66 | $this->validate(); |
67 | 67 | |
68 | - if($this->variable instanceof Mailcode_Variables_Variable) |
|
68 | + if ($this->variable instanceof Mailcode_Variables_Variable) |
|
69 | 69 | { |
70 | 70 | return $this->variable; |
71 | 71 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | |
96 | 96 | $var = $info->getVariableByIndex(0); |
97 | 97 | |
98 | - if($var) |
|
98 | + if ($var) |
|
99 | 99 | { |
100 | 100 | $this->variable = $var->getVariable(); |
101 | 101 | return; |
@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | */ |
25 | 25 | abstract class Mailcode_Parser_Safeguard_Formatter |
26 | 26 | { |
27 | - /** |
|
28 | - * @var Mailcode_Parser_Safeguard |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Parser_Safeguard |
|
29 | + */ |
|
30 | 30 | protected $safeguard; |
31 | 31 | |
32 | 32 | public function __construct(Mailcode_Parser_Safeguard $safeguard) |
@@ -36,13 +36,13 @@ discard block |
||
36 | 36 | |
37 | 37 | abstract public function format(string $subject) : string; |
38 | 38 | |
39 | - /** |
|
40 | - * Resolves a list of positions of needle in the haystack. |
|
41 | - * |
|
42 | - * @param string $needle |
|
43 | - * @param string $haystack |
|
44 | - * @return int[] |
|
45 | - */ |
|
39 | + /** |
|
40 | + * Resolves a list of positions of needle in the haystack. |
|
41 | + * |
|
42 | + * @param string $needle |
|
43 | + * @param string $haystack |
|
44 | + * @return int[] |
|
45 | + */ |
|
46 | 46 | protected function resolvePositions(string $needle, string $haystack) : array |
47 | 47 | { |
48 | 48 | $lastPos = 0; |
@@ -57,12 +57,12 @@ discard block |
||
57 | 57 | return $positions; |
58 | 58 | } |
59 | 59 | |
60 | - /** |
|
61 | - * Resolves the newline character used in the string. |
|
62 | - * |
|
63 | - * @param string $subject |
|
64 | - * @return string |
|
65 | - */ |
|
60 | + /** |
|
61 | + * Resolves the newline character used in the string. |
|
62 | + * |
|
63 | + * @param string $subject |
|
64 | + * @return string |
|
65 | + */ |
|
66 | 66 | protected function resolveNewlineChar(string $subject) : string |
67 | 67 | { |
68 | 68 | $eol = ConvertHelper::detectEOLCharacter($subject); |
@@ -75,13 +75,13 @@ discard block |
||
75 | 75 | return PHP_EOL; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Resolves the list of placeholder strings that need |
|
80 | - * to be formatted. This includes only commands that |
|
81 | - * do not generate content. |
|
82 | - * |
|
83 | - * @return string[] |
|
84 | - */ |
|
78 | + /** |
|
79 | + * Resolves the list of placeholder strings that need |
|
80 | + * to be formatted. This includes only commands that |
|
81 | + * do not generate content. |
|
82 | + * |
|
83 | + * @return string[] |
|
84 | + */ |
|
85 | 85 | protected function resolvePlaceholderStrings() : array |
86 | 86 | { |
87 | 87 | $placeholders = $this->filterPlaceholders(); |
@@ -96,9 +96,9 @@ discard block |
||
96 | 96 | return $result; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
101 | - */ |
|
99 | + /** |
|
100 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
101 | + */ |
|
102 | 102 | protected function filterPlaceholders() |
103 | 103 | { |
104 | 104 | return $this->safeguard->getPlaceholders(); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | $lastPos = 0; |
49 | 49 | $positions = array(); |
50 | 50 | |
51 | - while (($lastPos = mb_strpos($haystack, $needle, $lastPos))!== false) |
|
51 | + while (($lastPos = mb_strpos($haystack, $needle, $lastPos)) !== false) |
|
52 | 52 | { |
53 | 53 | $positions[] = $lastPos; |
54 | 54 | $lastPos = $lastPos + mb_strlen($needle); |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | { |
68 | 68 | $eol = ConvertHelper::detectEOLCharacter($subject); |
69 | 69 | |
70 | - if($eol) |
|
70 | + if ($eol) |
|
71 | 71 | { |
72 | 72 | return $eol->getCharacter(); |
73 | 73 | } |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | |
89 | 89 | $result = array(); |
90 | 90 | |
91 | - foreach($placeholders as $placeholder) |
|
91 | + foreach ($placeholders as $placeholder) |
|
92 | 92 | { |
93 | 93 | $result[] = $placeholder->getReplacementText(); |
94 | 94 | } |
@@ -21,39 +21,39 @@ discard block |
||
21 | 21 | */ |
22 | 22 | class Mailcode_Parser_Safeguard_Formatter_SingleLines_Placeholder |
23 | 23 | { |
24 | - /** |
|
25 | - * @var int |
|
26 | - */ |
|
24 | + /** |
|
25 | + * @var int |
|
26 | + */ |
|
27 | 27 | protected $eolLength; |
28 | 28 | |
29 | - /** |
|
30 | - * @var int |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var int |
|
31 | + */ |
|
32 | 32 | protected $position; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | protected $subject; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
41 | + */ |
|
42 | 42 | protected $formatter; |
43 | 43 | |
44 | - /** |
|
45 | - * @var boolean |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var boolean |
|
46 | + */ |
|
47 | 47 | protected $prepend = false; |
48 | 48 | |
49 | - /** |
|
50 | - * @var boolean |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var boolean |
|
51 | + */ |
|
52 | 52 | protected $append = false; |
53 | 53 | |
54 | - /** |
|
55 | - * @var int |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var int |
|
56 | + */ |
|
57 | 57 | protected $placeholderLength; |
58 | 58 | |
59 | 59 | public function __construct(Mailcode_Parser_Safeguard_Formatter_SingleLines $formatter, string $subject, int $placeholderLength, int $position) |
@@ -67,11 +67,11 @@ discard block |
||
67 | 67 | $this->analyzeAppend($subject); |
68 | 68 | } |
69 | 69 | |
70 | - /** |
|
71 | - * Whether an EOL character needs to be appended or prepended. |
|
72 | - * |
|
73 | - * @return bool |
|
74 | - */ |
|
70 | + /** |
|
71 | + * Whether an EOL character needs to be appended or prepended. |
|
72 | + * |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | 75 | public function requiresAdjustment() : bool |
76 | 76 | { |
77 | 77 | return $this->requiresAppend() || $this->requiresPrepend(); |
@@ -90,21 +90,21 @@ discard block |
||
90 | 90 | protected function analyzePrepend(string $subject) : void |
91 | 91 | { |
92 | 92 | // we're at the beginning of the string |
93 | - if($this->position == 0) |
|
93 | + if ($this->position == 0) |
|
94 | 94 | { |
95 | 95 | return; |
96 | 96 | } |
97 | 97 | |
98 | 98 | $prevPos = $this->position - $this->eolLength; |
99 | 99 | |
100 | - if($prevPos < 0) |
|
100 | + if ($prevPos < 0) |
|
101 | 101 | { |
102 | 102 | $prevPos = 0; |
103 | 103 | } |
104 | 104 | |
105 | 105 | $prev = mb_substr($subject, $prevPos, $this->eolLength); |
106 | 106 | |
107 | - if($prev !== $this->formatter->getEOLChar()) |
|
107 | + if ($prev !== $this->formatter->getEOLChar()) |
|
108 | 108 | { |
109 | 109 | $this->prepend = true; |
110 | 110 | } |
@@ -117,21 +117,21 @@ discard block |
||
117 | 117 | $position = $this->position + $this->placeholderLength; |
118 | 118 | |
119 | 119 | // we're at the end of the string |
120 | - if($position >= $subjectLength) |
|
120 | + if ($position >= $subjectLength) |
|
121 | 121 | { |
122 | 122 | return; |
123 | 123 | } |
124 | 124 | |
125 | 125 | $nextPos = $position + $this->eolLength; |
126 | 126 | |
127 | - if($nextPos > $subjectLength) |
|
127 | + if ($nextPos > $subjectLength) |
|
128 | 128 | { |
129 | 129 | $nextPos = $subjectLength - $this->eolLength; |
130 | 130 | } |
131 | 131 | |
132 | 132 | $next = mb_substr($subject, $nextPos, $this->eolLength); |
133 | 133 | |
134 | - if($next !== $this->formatter->getEOLChar()) |
|
134 | + if ($next !== $this->formatter->getEOLChar()) |
|
135 | 135 | { |
136 | 136 | $this->append = true; |
137 | 137 | } |
@@ -23,14 +23,14 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected $eol; |
30 | 30 | |
31 | - /** |
|
32 | - * @var int |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var int |
|
33 | + */ |
|
34 | 34 | protected $eolLength; |
35 | 35 | |
36 | 36 | public function format(string $subject) : string |
@@ -119,13 +119,13 @@ discard block |
||
119 | 119 | return $prepend.$placeholder.$append; |
120 | 120 | } |
121 | 121 | |
122 | - /** |
|
123 | - * We only use placeholders that contain commands that do |
|
124 | - * not generate contents, since these are the only ones |
|
125 | - * that may need adjusting. |
|
126 | - * |
|
127 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
128 | - */ |
|
122 | + /** |
|
123 | + * We only use placeholders that contain commands that do |
|
124 | + * not generate contents, since these are the only ones |
|
125 | + * that may need adjusting. |
|
126 | + * |
|
127 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
128 | + */ |
|
129 | 129 | protected function filterPlaceholders() |
130 | 130 | { |
131 | 131 | $placeholders = $this->safeguard->getPlaceholders(); |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | |
43 | 43 | $total = count($placeholders); |
44 | 44 | |
45 | - for($i=0; $i < $total; $i++) |
|
45 | + for ($i = 0; $i < $total; $i++) |
|
46 | 46 | { |
47 | 47 | $subject = $this->process($placeholders[$i], $subject); |
48 | 48 | } |
@@ -66,7 +66,7 @@ discard block |
||
66 | 66 | $phLength = mb_strlen($placeholder); |
67 | 67 | $offset = 0; |
68 | 68 | |
69 | - foreach($positions as $position) |
|
69 | + foreach ($positions as $position) |
|
70 | 70 | { |
71 | 71 | // adjust the position if previous changes made the subject longer |
72 | 72 | $position += $offset; |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | $position |
79 | 79 | ); |
80 | 80 | |
81 | - if(!$info->requiresAdjustment()) |
|
81 | + if (!$info->requiresAdjustment()) |
|
82 | 82 | { |
83 | 83 | continue; |
84 | 84 | } |
@@ -106,12 +106,12 @@ discard block |
||
106 | 106 | $prepend = ''; |
107 | 107 | $append = ''; |
108 | 108 | |
109 | - if($info->requiresPrepend()) |
|
109 | + if ($info->requiresPrepend()) |
|
110 | 110 | { |
111 | 111 | $prepend = $this->eol; |
112 | 112 | } |
113 | 113 | |
114 | - if($info->requiresAppend()) |
|
114 | + if ($info->requiresAppend()) |
|
115 | 115 | { |
116 | 116 | $append = $this->eol; |
117 | 117 | } |
@@ -132,9 +132,9 @@ discard block |
||
132 | 132 | |
133 | 133 | $result = array(); |
134 | 134 | |
135 | - foreach($placeholders as $placeholder) |
|
135 | + foreach ($placeholders as $placeholder) |
|
136 | 136 | { |
137 | - if(!$placeholder->getCommand()->generatesContent()) |
|
137 | + if (!$placeholder->getCommand()->generatesContent()) |
|
138 | 138 | { |
139 | 139 | $result[] = $placeholder; |
140 | 140 | } |
@@ -24,9 +24,9 @@ |
||
24 | 24 | { |
25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
26 | 26 | |
27 | - /** |
|
28 | - * @var string[]string |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var string[]string |
|
29 | + */ |
|
30 | 30 | private $charTable = array( |
31 | 31 | 'd' => 'd', |
32 | 32 | 'm' => 'M', |
@@ -56,9 +56,9 @@ |
||
56 | 56 | $chars = ConvertHelper::string2array($formatString); |
57 | 57 | $result = array(); |
58 | 58 | |
59 | - foreach($chars as $char) |
|
59 | + foreach ($chars as $char) |
|
60 | 60 | { |
61 | - if(!isset($this->charTable[$char])) |
|
61 | + if (!isset($this->charTable[$char])) |
|
62 | 62 | { |
63 | 63 | throw new Mailcode_Translator_Exception( |
64 | 64 | 'Unknown date format string character', |
@@ -23,19 +23,19 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_UNHANDLED_CHARTYPE = 55601; |
25 | 25 | |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | private $type; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | private $char; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | private $description; |
40 | 40 | |
41 | 41 | public function __construct(string $type, string $char, string $description) |
@@ -45,46 +45,46 @@ discard block |
||
45 | 45 | $this->description = $description; |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Retrieves the format character (PHP date format). |
|
50 | - * |
|
51 | - * @return string |
|
52 | - */ |
|
48 | + /** |
|
49 | + * Retrieves the format character (PHP date format). |
|
50 | + * |
|
51 | + * @return string |
|
52 | + */ |
|
53 | 53 | public function getChar() : string |
54 | 54 | { |
55 | 55 | return $this->char; |
56 | 56 | } |
57 | 57 | |
58 | - /** |
|
59 | - * Retrieves a human readable description of the character's role. |
|
60 | - * |
|
61 | - * @return string |
|
62 | - */ |
|
58 | + /** |
|
59 | + * Retrieves a human readable description of the character's role. |
|
60 | + * |
|
61 | + * @return string |
|
62 | + */ |
|
63 | 63 | public function getDescription() : string |
64 | 64 | { |
65 | 65 | return $this->description; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves the character type ID. |
|
70 | - * |
|
71 | - * @return string |
|
72 | - * |
|
73 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
74 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
75 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
76 | - */ |
|
68 | + /** |
|
69 | + * Retrieves the character type ID. |
|
70 | + * |
|
71 | + * @return string |
|
72 | + * |
|
73 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
74 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
75 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
76 | + */ |
|
77 | 77 | public function getTypeID() : string |
78 | 78 | { |
79 | 79 | return $this->type; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
84 | - * |
|
85 | - * @throws Mailcode_Exception If the character type is unknown. |
|
86 | - * @return string |
|
87 | - */ |
|
82 | + /** |
|
83 | + * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
84 | + * |
|
85 | + * @throws Mailcode_Exception If the character type is unknown. |
|
86 | + * @return string |
|
87 | + */ |
|
88 | 88 | public function getTypeLabel() : string |
89 | 89 | { |
90 | 90 | switch($this->type) |
@@ -87,7 +87,7 @@ |
||
87 | 87 | */ |
88 | 88 | public function getTypeLabel() : string |
89 | 89 | { |
90 | - switch($this->type) |
|
90 | + switch ($this->type) |
|
91 | 91 | { |
92 | 92 | case Mailcode_Date_FormatInfo::CHARTYPE_DATE: |
93 | 93 | return t('Date'); |
@@ -31,24 +31,24 @@ discard block |
||
31 | 31 | const CHARTYPE_TIME = 'time'; |
32 | 32 | const CHARTYPE_PUNCTUATION = 'punctuation'; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | private $defaultFormat = "Y/m/d"; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Date_FormatInfo_Character[] |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Date_FormatInfo_Character[] |
|
41 | + */ |
|
42 | 42 | private $formatChars = array(); |
43 | 43 | |
44 | - /** |
|
45 | - * @var string[] |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string[] |
|
46 | + */ |
|
47 | 47 | private $allowedChars = array(); |
48 | 48 | |
49 | - /** |
|
50 | - * @var Mailcode_Date_FormatInfo|NULL |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var Mailcode_Date_FormatInfo|NULL |
|
51 | + */ |
|
52 | 52 | private static $instance; |
53 | 53 | |
54 | 54 | private function __construct() |
@@ -66,11 +66,11 @@ discard block |
||
66 | 66 | return self::$instance; |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Initialized the list of allowed date formatting |
|
71 | - * characters. This is done only once per request |
|
72 | - * by storing them statically for performance reasons. |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Initialized the list of allowed date formatting |
|
71 | + * characters. This is done only once per request |
|
72 | + * by storing them statically for performance reasons. |
|
73 | + */ |
|
74 | 74 | private function initCharacters() : void |
75 | 75 | { |
76 | 76 | $chars = array( |
@@ -113,16 +113,16 @@ discard block |
||
113 | 113 | $this->defaultFormat = $formatString; |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Validates the date format string, by ensuring that |
|
118 | - * all the characters it is composed of are known. |
|
119 | - * |
|
120 | - * @param string $formatString |
|
121 | - * @return OperationResult |
|
122 | - * |
|
123 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
124 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
125 | - */ |
|
116 | + /** |
|
117 | + * Validates the date format string, by ensuring that |
|
118 | + * all the characters it is composed of are known. |
|
119 | + * |
|
120 | + * @param string $formatString |
|
121 | + * @return OperationResult |
|
122 | + * |
|
123 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
124 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
125 | + */ |
|
126 | 126 | public function validateFormat(string $formatString) : OperationResult |
127 | 127 | { |
128 | 128 | $result = new OperationResult($this); |
@@ -161,23 +161,23 @@ discard block |
||
161 | 161 | return $result; |
162 | 162 | } |
163 | 163 | |
164 | - /** |
|
165 | - * Retrieves all characters that are allowed to |
|
166 | - * be used in a date format string, with information |
|
167 | - * on each. |
|
168 | - * |
|
169 | - * @return Mailcode_Date_FormatInfo_Character[] |
|
170 | - */ |
|
164 | + /** |
|
165 | + * Retrieves all characters that are allowed to |
|
166 | + * be used in a date format string, with information |
|
167 | + * on each. |
|
168 | + * |
|
169 | + * @return Mailcode_Date_FormatInfo_Character[] |
|
170 | + */ |
|
171 | 171 | public function getCharactersList() : array |
172 | 172 | { |
173 | 173 | return $this->formatChars; |
174 | 174 | } |
175 | 175 | |
176 | - /** |
|
177 | - * Retrieves the characters list, grouped by type label. |
|
178 | - * |
|
179 | - * @return array<string, array> |
|
180 | - */ |
|
176 | + /** |
|
177 | + * Retrieves the characters list, grouped by type label. |
|
178 | + * |
|
179 | + * @return array<string, array> |
|
180 | + */ |
|
181 | 181 | public function getCharactersGrouped() : array |
182 | 182 | { |
183 | 183 | $grouped = array(); |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | |
59 | 59 | public static function getInstance() : Mailcode_Date_FormatInfo |
60 | 60 | { |
61 | - if(!isset(self::$instance)) |
|
61 | + if (!isset(self::$instance)) |
|
62 | 62 | { |
63 | 63 | self::$instance = new Mailcode_Date_FormatInfo(); |
64 | 64 | } |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | array(self::CHARTYPE_PUNCTUATION, ' ', t('Space')) |
91 | 91 | ); |
92 | 92 | |
93 | - foreach($chars as $def) |
|
93 | + foreach ($chars as $def) |
|
94 | 94 | { |
95 | 95 | $char = new Mailcode_Date_FormatInfo_Character( |
96 | 96 | $def[0], |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | |
130 | 130 | $trimmed = trim($formatString); |
131 | 131 | |
132 | - if(empty($trimmed)) |
|
132 | + if (empty($trimmed)) |
|
133 | 133 | { |
134 | 134 | $result->makeError( |
135 | 135 | t('Empty date format.'), |
@@ -142,15 +142,15 @@ discard block |
||
142 | 142 | $chars = ConvertHelper::string2array($formatString); |
143 | 143 | $total = count($chars); |
144 | 144 | |
145 | - for($i=0; $i < $total; $i++) |
|
145 | + for ($i = 0; $i < $total; $i++) |
|
146 | 146 | { |
147 | 147 | $char = $chars[$i]; |
148 | 148 | |
149 | - if(!in_array($char, $this->allowedChars)) |
|
149 | + if (!in_array($char, $this->allowedChars)) |
|
150 | 150 | { |
151 | 151 | $result->makeError( |
152 | 152 | t('Invalid character in date format:').' '. |
153 | - t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1), |
|
153 | + t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i + 1), |
|
154 | 154 | self::VALIDATION_INVALID_FORMAT_CHARACTER |
155 | 155 | ); |
156 | 156 | |
@@ -182,11 +182,11 @@ discard block |
||
182 | 182 | { |
183 | 183 | $grouped = array(); |
184 | 184 | |
185 | - foreach($this->formatChars as $char) |
|
185 | + foreach ($this->formatChars as $char) |
|
186 | 186 | { |
187 | 187 | $type = $char->getTypeLabel(); |
188 | 188 | |
189 | - if(!isset($grouped[$type])) |
|
189 | + if (!isset($grouped[$type])) |
|
190 | 190 | { |
191 | 191 | $grouped[$type] = array(); |
192 | 192 | } |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | |
197 | 197 | $groups = array_keys($grouped); |
198 | 198 | |
199 | - foreach($groups as $group) |
|
199 | + foreach ($groups as $group) |
|
200 | 200 | { |
201 | 201 | usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b) |
202 | 202 | { |