@@ -29,24 +29,24 @@ discard block |
||
29 | 29 | |
30 | 30 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $statement; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $result; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
44 | + */ |
|
45 | 45 | protected $tokenizer; |
46 | 46 | |
47 | - /** |
|
48 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
49 | + */ |
|
50 | 50 | protected $info; |
51 | 51 | |
52 | 52 | public function __construct(string $statement) |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | if($unknown) |
103 | 103 | { |
104 | 104 | $this->result->makeError( |
105 | - t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
105 | + t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
106 | 106 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
107 | 107 | ); |
108 | 108 | } |
@@ -75,7 +75,7 @@ discard block |
||
75 | 75 | |
76 | 76 | public function getInfo() : Mailcode_Parser_Statement_Info |
77 | 77 | { |
78 | - if(isset($this->info)) |
|
78 | + if (isset($this->info)) |
|
79 | 79 | { |
80 | 80 | return $this->info; |
81 | 81 | } |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | |
88 | 88 | protected function validate() : void |
89 | 89 | { |
90 | - if(!$this->tokenizer->hasTokens()) |
|
90 | + if (!$this->tokenizer->hasTokens()) |
|
91 | 91 | { |
92 | 92 | $this->result->makeError( |
93 | 93 | t('Empty statement'), |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | |
100 | 100 | $unknown = $this->tokenizer->getFirstUnknown(); |
101 | 101 | |
102 | - if($unknown) |
|
102 | + if ($unknown) |
|
103 | 103 | { |
104 | 104 | $this->result->makeError( |
105 | 105 | t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
@@ -57,45 +57,45 @@ discard block |
||
57 | 57 | |
58 | 58 | const ERROR_PLACEHOLDER_NOT_FOUND = 47804; |
59 | 59 | |
60 | - /** |
|
61 | - * @var Mailcode_Parser |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var Mailcode_Parser |
|
62 | + */ |
|
63 | 63 | protected $parser; |
64 | 64 | |
65 | - /** |
|
66 | - * @var Mailcode_Collection |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var Mailcode_Collection |
|
67 | + */ |
|
68 | 68 | protected $commands; |
69 | 69 | |
70 | - /** |
|
71 | - * @var string |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @var string |
|
72 | + */ |
|
73 | 73 | protected $originalString; |
74 | 74 | |
75 | - /** |
|
76 | - * @var Mailcode_Collection |
|
77 | - */ |
|
75 | + /** |
|
76 | + * @var Mailcode_Collection |
|
77 | + */ |
|
78 | 78 | protected $collection; |
79 | 79 | |
80 | - /** |
|
81 | - * Counter for the placeholders, global for all placeholders. |
|
82 | - * @var integer |
|
83 | - */ |
|
80 | + /** |
|
81 | + * Counter for the placeholders, global for all placeholders. |
|
82 | + * @var integer |
|
83 | + */ |
|
84 | 84 | private static $counter = 0; |
85 | 85 | |
86 | - /** |
|
87 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
88 | - */ |
|
86 | + /** |
|
87 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
88 | + */ |
|
89 | 89 | protected $placeholders; |
90 | 90 | |
91 | - /** |
|
92 | - * @var string |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @var string |
|
93 | + */ |
|
94 | 94 | protected $delimiter = '__'; |
95 | 95 | |
96 | - /** |
|
97 | - * @var string[]|NULL |
|
98 | - */ |
|
96 | + /** |
|
97 | + * @var string[]|NULL |
|
98 | + */ |
|
99 | 99 | protected $placeholderStrings; |
100 | 100 | |
101 | 101 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -104,25 +104,25 @@ discard block |
||
104 | 104 | $this->originalString = $subject; |
105 | 105 | } |
106 | 106 | |
107 | - /** |
|
108 | - * Retrieves the string the safeguard was created for. |
|
109 | - * |
|
110 | - * @return string |
|
111 | - */ |
|
107 | + /** |
|
108 | + * Retrieves the string the safeguard was created for. |
|
109 | + * |
|
110 | + * @return string |
|
111 | + */ |
|
112 | 112 | public function getOriginalString() : string |
113 | 113 | { |
114 | 114 | return $this->originalString; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Sets the delimiter character sequence used to prepend |
|
119 | - * and append to the placeholders. |
|
120 | - * |
|
121 | - * The delimiter's default is "__" (two underscores). |
|
122 | - * |
|
123 | - * @param string $delimiter |
|
124 | - * @return Mailcode_Parser_Safeguard |
|
125 | - */ |
|
117 | + /** |
|
118 | + * Sets the delimiter character sequence used to prepend |
|
119 | + * and append to the placeholders. |
|
120 | + * |
|
121 | + * The delimiter's default is "__" (two underscores). |
|
122 | + * |
|
123 | + * @param string $delimiter |
|
124 | + * @return Mailcode_Parser_Safeguard |
|
125 | + */ |
|
126 | 126 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
127 | 127 | { |
128 | 128 | if(empty($delimiter)) |
@@ -144,15 +144,15 @@ discard block |
||
144 | 144 | return $this->delimiter; |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Retrieves the safe string in which all commands have been replaced |
|
149 | - * by placeholder strings. |
|
150 | - * |
|
151 | - * @return string |
|
152 | - * @throws Mailcode_Exception |
|
153 | - * |
|
154 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
155 | - */ |
|
147 | + /** |
|
148 | + * Retrieves the safe string in which all commands have been replaced |
|
149 | + * by placeholder strings. |
|
150 | + * |
|
151 | + * @return string |
|
152 | + * @throws Mailcode_Exception |
|
153 | + * |
|
154 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
155 | + */ |
|
156 | 156 | public function makeSafe() : string |
157 | 157 | { |
158 | 158 | $this->requireValidCollection(); |
@@ -162,10 +162,10 @@ discard block |
||
162 | 162 | return str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * @param bool $highlighted |
|
167 | - * @return string[]string |
|
168 | - */ |
|
165 | + /** |
|
166 | + * @param bool $highlighted |
|
167 | + * @return string[]string |
|
168 | + */ |
|
169 | 169 | protected function getReplaces(bool $highlighted=false) : array |
170 | 170 | { |
171 | 171 | $placeholders = $this->getPlaceholders(); |
@@ -192,12 +192,12 @@ discard block |
||
192 | 192 | } |
193 | 193 | |
194 | 194 | |
195 | - /** |
|
196 | - * Retrieves all placeholders that have to be added to |
|
197 | - * the subject text. |
|
198 | - * |
|
199 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
200 | - */ |
|
195 | + /** |
|
196 | + * Retrieves all placeholders that have to be added to |
|
197 | + * the subject text. |
|
198 | + * |
|
199 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
200 | + */ |
|
201 | 201 | public function getPlaceholders() |
202 | 202 | { |
203 | 203 | if(isset($this->placeholders)) |
@@ -249,46 +249,46 @@ discard block |
||
249 | 249 | return str_replace($placeholderStrings, array_values($replaces), $string); |
250 | 250 | } |
251 | 251 | |
252 | - /** |
|
253 | - * Makes the string whole again after transforming or filtering it, |
|
254 | - * by replacing the command placeholders with the original commands. |
|
255 | - * |
|
256 | - * @param string $string |
|
257 | - * @return string |
|
258 | - * @throws Mailcode_Exception |
|
259 | - * |
|
260 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
261 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
262 | - */ |
|
252 | + /** |
|
253 | + * Makes the string whole again after transforming or filtering it, |
|
254 | + * by replacing the command placeholders with the original commands. |
|
255 | + * |
|
256 | + * @param string $string |
|
257 | + * @return string |
|
258 | + * @throws Mailcode_Exception |
|
259 | + * |
|
260 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
261 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
262 | + */ |
|
263 | 263 | public function makeWhole(string $string) : string |
264 | 264 | { |
265 | 265 | return $this->restore($string, false); |
266 | 266 | } |
267 | 267 | |
268 | - /** |
|
269 | - * Like makeWhole(), but replaces the commands with a syntax |
|
270 | - * highlighted version, meant for human readable texts only. |
|
271 | - * |
|
272 | - * Note: the commands lose their functionality (They cannot be |
|
273 | - * parsed from that string again). |
|
274 | - * |
|
275 | - * @param string $string |
|
276 | - * @return string |
|
277 | - * @throws Mailcode_Exception |
|
278 | - * |
|
279 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
280 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
281 | - */ |
|
268 | + /** |
|
269 | + * Like makeWhole(), but replaces the commands with a syntax |
|
270 | + * highlighted version, meant for human readable texts only. |
|
271 | + * |
|
272 | + * Note: the commands lose their functionality (They cannot be |
|
273 | + * parsed from that string again). |
|
274 | + * |
|
275 | + * @param string $string |
|
276 | + * @return string |
|
277 | + * @throws Mailcode_Exception |
|
278 | + * |
|
279 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
280 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
281 | + */ |
|
282 | 282 | public function makeHighlighted(string $string) : string |
283 | 283 | { |
284 | 284 | return $this->restore($string, true); |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * Retrieves the commands collection contained in the string. |
|
289 | - * |
|
290 | - * @return Mailcode_Collection |
|
291 | - */ |
|
287 | + /** |
|
288 | + * Retrieves the commands collection contained in the string. |
|
289 | + * |
|
290 | + * @return Mailcode_Collection |
|
291 | + */ |
|
292 | 292 | public function getCollection() : Mailcode_Collection |
293 | 293 | { |
294 | 294 | if(isset($this->collection)) |
@@ -306,11 +306,11 @@ discard block |
||
306 | 306 | return $this->getCollection()->isValid(); |
307 | 307 | } |
308 | 308 | |
309 | - /** |
|
310 | - * @throws Mailcode_Exception |
|
311 | - * |
|
312 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
313 | - */ |
|
309 | + /** |
|
310 | + * @throws Mailcode_Exception |
|
311 | + * |
|
312 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
313 | + */ |
|
314 | 314 | protected function requireValidCollection() : void |
315 | 315 | { |
316 | 316 | if($this->getCollection()->isValid()) |
@@ -329,11 +329,11 @@ discard block |
||
329 | 329 | ); |
330 | 330 | } |
331 | 331 | |
332 | - /** |
|
333 | - * Retrieves a list of all placeholder IDs used in the text. |
|
334 | - * |
|
335 | - * @return string[] |
|
336 | - */ |
|
332 | + /** |
|
333 | + * Retrieves a list of all placeholder IDs used in the text. |
|
334 | + * |
|
335 | + * @return string[] |
|
336 | + */ |
|
337 | 337 | public function getPlaceholderStrings() : array |
338 | 338 | { |
339 | 339 | if(isset($this->placeholderStrings)) |
@@ -360,13 +360,13 @@ discard block |
||
360 | 360 | return in_array($subject, $ids); |
361 | 361 | } |
362 | 362 | |
363 | - /** |
|
364 | - * Retrieves a placeholder instance by its ID. |
|
365 | - * |
|
366 | - * @param int $id |
|
367 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
368 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
369 | - */ |
|
363 | + /** |
|
364 | + * Retrieves a placeholder instance by its ID. |
|
365 | + * |
|
366 | + * @param int $id |
|
367 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
368 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
369 | + */ |
|
370 | 370 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
371 | 371 | { |
372 | 372 | $placeholders = $this->getPlaceholders(); |
@@ -389,13 +389,13 @@ discard block |
||
389 | 389 | ); |
390 | 390 | } |
391 | 391 | |
392 | - /** |
|
393 | - * Retrieves a placeholder instance by its replacement text. |
|
394 | - * |
|
395 | - * @param string $string |
|
396 | - * @throws Mailcode_Exception |
|
397 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
398 | - */ |
|
392 | + /** |
|
393 | + * Retrieves a placeholder instance by its replacement text. |
|
394 | + * |
|
395 | + * @param string $string |
|
396 | + * @throws Mailcode_Exception |
|
397 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
398 | + */ |
|
399 | 399 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
400 | 400 | { |
401 | 401 | $placeholders = $this->getPlaceholders(); |