@@ -20,19 +20,19 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Commands_Highlighter |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command |
|
25 | + */ |
|
26 | 26 | protected $command; |
27 | 27 | |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected $parts = array(); |
32 | 32 | |
33 | 33 | public function __construct(Mailcode_Commands_Command $command) |
34 | 34 | { |
35 | - $this->command = $command; |
|
35 | + $this->command = $command; |
|
36 | 36 | } |
37 | 37 | |
38 | 38 | public function highlight() : string |
@@ -121,11 +121,11 @@ discard block |
||
121 | 121 | $this->appendParams($keyword->getCommand()); |
122 | 122 | } |
123 | 123 | |
124 | - /** |
|
125 | - * @param string[] $classes |
|
126 | - * @param string $content |
|
127 | - * @return string |
|
128 | - */ |
|
124 | + /** |
|
125 | + * @param string[] $classes |
|
126 | + * @param string $content |
|
127 | + * @return string |
|
128 | + */ |
|
129 | 129 | protected function renderTag(array $classes, string $content) : string |
130 | 130 | { |
131 | 131 | $parts = array(); |
@@ -52,12 +52,12 @@ discard block |
||
52 | 52 | { |
53 | 53 | $this->parts[] = $this->renderTag(array('command-name'), $this->command->getName()); |
54 | 54 | |
55 | - if($this->command->hasType()) |
|
55 | + if ($this->command->hasType()) |
|
56 | 56 | { |
57 | 57 | $this->parts[] = ' '.$this->renderTag(array('command-type'), $this->command->getType()); |
58 | 58 | } |
59 | 59 | |
60 | - if($this->command->requiresParameters()) |
|
60 | + if ($this->command->requiresParameters()) |
|
61 | 61 | { |
62 | 62 | $this->parts[] = $this->renderTag(array('hyphen'), ':'); |
63 | 63 | $this->parts[] = '<wbr>'; |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | { |
69 | 69 | $params = $command->getParams(); |
70 | 70 | |
71 | - if($params === null) |
|
71 | + if ($params === null) |
|
72 | 72 | { |
73 | 73 | return; |
74 | 74 | } |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | |
78 | 78 | $this->parts[] = '<span class="mailcode-params">'; |
79 | 79 | |
80 | - foreach($tokens as $token) |
|
80 | + foreach ($tokens as $token) |
|
81 | 81 | { |
82 | 82 | $this->appendParamToken($token); |
83 | 83 | } |
@@ -92,14 +92,14 @@ discard block |
||
92 | 92 | |
93 | 93 | protected function appendLogicKeywords() : void |
94 | 94 | { |
95 | - if(!$this->command->supportsLogicKeywords()) |
|
95 | + if (!$this->command->supportsLogicKeywords()) |
|
96 | 96 | { |
97 | 97 | return; |
98 | 98 | } |
99 | 99 | |
100 | 100 | $keywords = $this->command->getLogicKeywords()->getKeywords(); |
101 | 101 | |
102 | - foreach($keywords as $keyword) |
|
102 | + foreach ($keywords as $keyword) |
|
103 | 103 | { |
104 | 104 | $this->appendLogicKeyword($keyword); |
105 | 105 | } |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | |
112 | 112 | $type = $keyword->getType(); |
113 | 113 | |
114 | - if(!empty($type)) |
|
114 | + if (!empty($type)) |
|
115 | 115 | { |
116 | 116 | $this->parts[] = ' '.$this->renderTag(array('command-type'), $type); |
117 | 117 | } |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | { |
131 | 131 | $parts = array(); |
132 | 132 | |
133 | - foreach($classes as $class) |
|
133 | + foreach ($classes as $class) |
|
134 | 134 | { |
135 | 135 | $parts[] = 'mailcode-'.$class; |
136 | 136 | } |
@@ -48,13 +48,13 @@ |
||
48 | 48 | <body> |
49 | 49 | <p> |
50 | 50 | <?php |
51 | - pts('This showcases the command\'s syntax highlighting.'); |
|
52 | - pts( |
|
53 | - 'It is based on the %1$s color scheme%2$s:', |
|
54 | - '<a href="https://ethanschoonover.com/solarized/">"Solarized"', |
|
55 | - '</a>' |
|
56 | - ); |
|
57 | - ?> |
|
51 | + pts('This showcases the command\'s syntax highlighting.'); |
|
52 | + pts( |
|
53 | + 'It is based on the %1$s color scheme%2$s:', |
|
54 | + '<a href="https://ethanschoonover.com/solarized/">"Solarized"', |
|
55 | + '</a>' |
|
56 | + ); |
|
57 | + ?> |
|
58 | 58 | </p> |
59 | 59 | <br> |
60 | 60 | <div class="commands"> |
@@ -17,7 +17,7 @@ discard block |
||
17 | 17 | $autoload = realpath($root.'/../vendor/autoload.php'); |
18 | 18 | |
19 | 19 | // we need the autoloader to be present |
20 | - if($autoload === false) |
|
20 | + if ($autoload === false) |
|
21 | 21 | { |
22 | 22 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
23 | 23 | } |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | Mailcode_Factory::comment('Some comments here'), |
66 | 66 | Mailcode_Factory::showSnippet('snippet_name'), |
67 | 67 | Mailcode_Factory::showDate('DATE.VARIABLE'), |
68 | - Mailcode_Factory::if('1 + 1 == 2'), |
|
68 | + Mailcode_Factory::if ('1 + 1 == 2'), |
|
69 | 69 | Mailcode_Factory::ifContains('CUSTOMER.NAME', 'John'), |
70 | 70 | Mailcode_Factory::ifVarEquals('NUMBER', 124), |
71 | 71 | ); |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | |
78 | 78 | $commands[] = Mailcode_Factory::end(); |
79 | 79 | |
80 | - foreach($commands as $command) |
|
80 | + foreach ($commands as $command) |
|
81 | 81 | { |
82 | 82 | ?> |
83 | 83 | <p> |
@@ -65,10 +65,12 @@ |
||
65 | 65 | Mailcode_Factory::comment('Some comments here'), |
66 | 66 | Mailcode_Factory::showSnippet('snippet_name'), |
67 | 67 | Mailcode_Factory::showDate('DATE.VARIABLE'), |
68 | - Mailcode_Factory::if('1 + 1 == 2'), |
|
68 | + Mailcode_Factory::if('1 + 1 == 2') { |
|
69 | + , |
|
69 | 70 | Mailcode_Factory::ifContains('CUSTOMER.NAME', 'John'), |
70 | 71 | Mailcode_Factory::ifVarEquals('NUMBER', 124), |
71 | 72 | ); |
73 | + } |
|
72 | 74 | |
73 | 75 | $and = Mailcode_Factory::elseIfVarEqualsString('STRINGVAR', 'John'); |
74 | 76 | $and->getLogicKeywords()->appendOR('$STRINGVAR == "Steve"', "variable"); |
@@ -61,50 +61,50 @@ discard block |
||
61 | 61 | |
62 | 62 | const ERROR_NOT_A_SINGLE_LINES_FORMATTER = 47806; |
63 | 63 | |
64 | - /** |
|
65 | - * @var Mailcode_Parser |
|
66 | - */ |
|
64 | + /** |
|
65 | + * @var Mailcode_Parser |
|
66 | + */ |
|
67 | 67 | protected $parser; |
68 | 68 | |
69 | - /** |
|
70 | - * @var Mailcode_Collection |
|
71 | - */ |
|
69 | + /** |
|
70 | + * @var Mailcode_Collection |
|
71 | + */ |
|
72 | 72 | protected $commands; |
73 | 73 | |
74 | - /** |
|
75 | - * @var string |
|
76 | - */ |
|
74 | + /** |
|
75 | + * @var string |
|
76 | + */ |
|
77 | 77 | protected $originalString; |
78 | 78 | |
79 | - /** |
|
80 | - * @var Mailcode_Collection |
|
81 | - */ |
|
79 | + /** |
|
80 | + * @var Mailcode_Collection |
|
81 | + */ |
|
82 | 82 | protected $collection; |
83 | 83 | |
84 | - /** |
|
85 | - * Counter for the placeholders, global for all placeholders. |
|
86 | - * @var integer |
|
87 | - */ |
|
84 | + /** |
|
85 | + * Counter for the placeholders, global for all placeholders. |
|
86 | + * @var integer |
|
87 | + */ |
|
88 | 88 | private static $counter = 0; |
89 | 89 | |
90 | - /** |
|
91 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
92 | - */ |
|
90 | + /** |
|
91 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
92 | + */ |
|
93 | 93 | protected $placeholders; |
94 | 94 | |
95 | - /** |
|
96 | - * @var string |
|
97 | - */ |
|
95 | + /** |
|
96 | + * @var string |
|
97 | + */ |
|
98 | 98 | protected $delimiter = '__'; |
99 | 99 | |
100 | - /** |
|
101 | - * @var string[]|NULL |
|
102 | - */ |
|
100 | + /** |
|
101 | + * @var string[]|NULL |
|
102 | + */ |
|
103 | 103 | protected $placeholderStrings; |
104 | 104 | |
105 | - /** |
|
106 | - * @var Mailcode_Parser_Safeguard_Formatter |
|
107 | - */ |
|
105 | + /** |
|
106 | + * @var Mailcode_Parser_Safeguard_Formatter |
|
107 | + */ |
|
108 | 108 | protected $formatter; |
109 | 109 | |
110 | 110 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -113,25 +113,25 @@ discard block |
||
113 | 113 | $this->originalString = $subject; |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Retrieves the string the safeguard was created for. |
|
118 | - * |
|
119 | - * @return string |
|
120 | - */ |
|
116 | + /** |
|
117 | + * Retrieves the string the safeguard was created for. |
|
118 | + * |
|
119 | + * @return string |
|
120 | + */ |
|
121 | 121 | public function getOriginalString() : string |
122 | 122 | { |
123 | 123 | return $this->originalString; |
124 | 124 | } |
125 | 125 | |
126 | - /** |
|
127 | - * Sets the delimiter character sequence used to prepend |
|
128 | - * and append to the placeholders. |
|
129 | - * |
|
130 | - * The delimiter's default is "__" (two underscores). |
|
131 | - * |
|
132 | - * @param string $delimiter |
|
133 | - * @return Mailcode_Parser_Safeguard |
|
134 | - */ |
|
126 | + /** |
|
127 | + * Sets the delimiter character sequence used to prepend |
|
128 | + * and append to the placeholders. |
|
129 | + * |
|
130 | + * The delimiter's default is "__" (two underscores). |
|
131 | + * |
|
132 | + * @param string $delimiter |
|
133 | + * @return Mailcode_Parser_Safeguard |
|
134 | + */ |
|
135 | 135 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
136 | 136 | { |
137 | 137 | if(empty($delimiter)) |
@@ -153,15 +153,15 @@ discard block |
||
153 | 153 | return $this->delimiter; |
154 | 154 | } |
155 | 155 | |
156 | - /** |
|
157 | - * Retrieves the safe string in which all commands have been replaced |
|
158 | - * by placeholder strings. |
|
159 | - * |
|
160 | - * @return string |
|
161 | - * @throws Mailcode_Exception |
|
162 | - * |
|
163 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
164 | - */ |
|
156 | + /** |
|
157 | + * Retrieves the safe string in which all commands have been replaced |
|
158 | + * by placeholder strings. |
|
159 | + * |
|
160 | + * @return string |
|
161 | + * @throws Mailcode_Exception |
|
162 | + * |
|
163 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
164 | + */ |
|
165 | 165 | public function makeSafe() : string |
166 | 166 | { |
167 | 167 | $this->requireValidCollection(); |
@@ -169,16 +169,16 @@ discard block |
||
169 | 169 | return $this->makeSafePartial(); |
170 | 170 | } |
171 | 171 | |
172 | - /** |
|
173 | - * Like makeSafe(), but allows partial (invalid) commands: use this |
|
174 | - * if the subject string may contain only part of the whole set of |
|
175 | - * commands. |
|
176 | - * |
|
177 | - * Example: parsing a text with an opening if statement, without the |
|
178 | - * matching end statement. |
|
179 | - * |
|
180 | - * @return string |
|
181 | - */ |
|
172 | + /** |
|
173 | + * Like makeSafe(), but allows partial (invalid) commands: use this |
|
174 | + * if the subject string may contain only part of the whole set of |
|
175 | + * commands. |
|
176 | + * |
|
177 | + * Example: parsing a text with an opening if statement, without the |
|
178 | + * matching end statement. |
|
179 | + * |
|
180 | + * @return string |
|
181 | + */ |
|
182 | 182 | public function makeSafePartial() : string |
183 | 183 | { |
184 | 184 | $replaces = $this->getReplaces(); |
@@ -216,10 +216,10 @@ discard block |
||
216 | 216 | ); |
217 | 217 | } |
218 | 218 | |
219 | - /** |
|
220 | - * Enables the formatter that ensures that all commands that |
|
221 | - * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
222 | - */ |
|
219 | + /** |
|
220 | + * Enables the formatter that ensures that all commands that |
|
221 | + * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
222 | + */ |
|
223 | 223 | public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines |
224 | 224 | { |
225 | 225 | $formatter = $this->selectFormatter('SingleLines'); |
@@ -239,13 +239,13 @@ discard block |
||
239 | 239 | ); |
240 | 240 | } |
241 | 241 | |
242 | - /** |
|
243 | - * Retrieves an associative array with pairs of |
|
244 | - * [placeholder string => replacement text]. |
|
245 | - * |
|
246 | - * @param bool $highlighted |
|
247 | - * @return string[]string |
|
248 | - */ |
|
242 | + /** |
|
243 | + * Retrieves an associative array with pairs of |
|
244 | + * [placeholder string => replacement text]. |
|
245 | + * |
|
246 | + * @param bool $highlighted |
|
247 | + * @return string[]string |
|
248 | + */ |
|
249 | 249 | protected function getReplaces(bool $highlighted=false, bool $normalize=false) : array |
250 | 250 | { |
251 | 251 | $placeholders = $this->getPlaceholders(); |
@@ -276,12 +276,12 @@ discard block |
||
276 | 276 | } |
277 | 277 | |
278 | 278 | |
279 | - /** |
|
280 | - * Retrieves all placeholders that have to be added to |
|
281 | - * the subject text. |
|
282 | - * |
|
283 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
284 | - */ |
|
279 | + /** |
|
280 | + * Retrieves all placeholders that have to be added to |
|
281 | + * the subject text. |
|
282 | + * |
|
283 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
284 | + */ |
|
285 | 285 | public function getPlaceholders() |
286 | 286 | { |
287 | 287 | if(isset($this->placeholders)) |
@@ -336,17 +336,17 @@ discard block |
||
336 | 336 | return str_replace($placeholderStrings, array_values($replaces), $string); |
337 | 337 | } |
338 | 338 | |
339 | - /** |
|
340 | - * Makes the string whole again after transforming or filtering it, |
|
341 | - * by replacing the command placeholders with the original commands. |
|
342 | - * |
|
343 | - * @param string $string |
|
344 | - * @return string |
|
345 | - * @throws Mailcode_Exception |
|
346 | - * |
|
347 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
348 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
349 | - */ |
|
339 | + /** |
|
340 | + * Makes the string whole again after transforming or filtering it, |
|
341 | + * by replacing the command placeholders with the original commands. |
|
342 | + * |
|
343 | + * @param string $string |
|
344 | + * @return string |
|
345 | + * @throws Mailcode_Exception |
|
346 | + * |
|
347 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
348 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
349 | + */ |
|
350 | 350 | public function makeWhole(string $string) : string |
351 | 351 | { |
352 | 352 | return $this->restore( |
@@ -356,15 +356,15 @@ discard block |
||
356 | 356 | ); |
357 | 357 | } |
358 | 358 | |
359 | - /** |
|
360 | - * Like `makeWhole()`, but ignores missing command placeholders. |
|
361 | - * |
|
362 | - * @param string $string |
|
363 | - * @return string |
|
364 | - * @throws Mailcode_Exception |
|
365 | - * |
|
366 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
367 | - */ |
|
359 | + /** |
|
360 | + * Like `makeWhole()`, but ignores missing command placeholders. |
|
361 | + * |
|
362 | + * @param string $string |
|
363 | + * @return string |
|
364 | + * @throws Mailcode_Exception |
|
365 | + * |
|
366 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
367 | + */ |
|
368 | 368 | public function makeWholePartial(string $string) : string |
369 | 369 | { |
370 | 370 | return $this->restore( |
@@ -374,20 +374,20 @@ discard block |
||
374 | 374 | ); |
375 | 375 | } |
376 | 376 | |
377 | - /** |
|
378 | - * Like `makeWhole()`, but replaces the commands with a syntax |
|
379 | - * highlighted version, meant for human readable texts only. |
|
380 | - * |
|
381 | - * Note: the commands lose their functionality (They cannot be |
|
382 | - * parsed from that string again). |
|
383 | - * |
|
384 | - * @param string $string |
|
385 | - * @return string |
|
386 | - * @throws Mailcode_Exception |
|
387 | - * |
|
388 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
389 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
390 | - */ |
|
377 | + /** |
|
378 | + * Like `makeWhole()`, but replaces the commands with a syntax |
|
379 | + * highlighted version, meant for human readable texts only. |
|
380 | + * |
|
381 | + * Note: the commands lose their functionality (They cannot be |
|
382 | + * parsed from that string again). |
|
383 | + * |
|
384 | + * @param string $string |
|
385 | + * @return string |
|
386 | + * @throws Mailcode_Exception |
|
387 | + * |
|
388 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
389 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
390 | + */ |
|
391 | 391 | public function makeHighlighted(string $string) : string |
392 | 392 | { |
393 | 393 | return $this->restore( |
@@ -397,15 +397,15 @@ discard block |
||
397 | 397 | ); |
398 | 398 | } |
399 | 399 | |
400 | - /** |
|
401 | - * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
402 | - * |
|
403 | - * @param string $string |
|
404 | - * @return string |
|
405 | - * @throws Mailcode_Exception |
|
406 | - * |
|
407 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
408 | - */ |
|
400 | + /** |
|
401 | + * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
402 | + * |
|
403 | + * @param string $string |
|
404 | + * @return string |
|
405 | + * @throws Mailcode_Exception |
|
406 | + * |
|
407 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
408 | + */ |
|
409 | 409 | public function makeHighlightedPartial(string $string) : string |
410 | 410 | { |
411 | 411 | return $this->restore( |
@@ -415,11 +415,11 @@ discard block |
||
415 | 415 | ); |
416 | 416 | } |
417 | 417 | |
418 | - /** |
|
419 | - * Retrieves the commands collection contained in the string. |
|
420 | - * |
|
421 | - * @return Mailcode_Collection |
|
422 | - */ |
|
418 | + /** |
|
419 | + * Retrieves the commands collection contained in the string. |
|
420 | + * |
|
421 | + * @return Mailcode_Collection |
|
422 | + */ |
|
423 | 423 | public function getCollection() : Mailcode_Collection |
424 | 424 | { |
425 | 425 | if(isset($this->collection)) |
@@ -437,11 +437,11 @@ discard block |
||
437 | 437 | return $this->getCollection()->isValid(); |
438 | 438 | } |
439 | 439 | |
440 | - /** |
|
441 | - * @throws Mailcode_Exception |
|
442 | - * |
|
443 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
444 | - */ |
|
440 | + /** |
|
441 | + * @throws Mailcode_Exception |
|
442 | + * |
|
443 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
444 | + */ |
|
445 | 445 | protected function requireValidCollection() : void |
446 | 446 | { |
447 | 447 | if($this->getCollection()->isValid()) |
@@ -460,11 +460,11 @@ discard block |
||
460 | 460 | ); |
461 | 461 | } |
462 | 462 | |
463 | - /** |
|
464 | - * Retrieves a list of all placeholder IDs used in the text. |
|
465 | - * |
|
466 | - * @return string[] |
|
467 | - */ |
|
463 | + /** |
|
464 | + * Retrieves a list of all placeholder IDs used in the text. |
|
465 | + * |
|
466 | + * @return string[] |
|
467 | + */ |
|
468 | 468 | public function getPlaceholderStrings() : array |
469 | 469 | { |
470 | 470 | if(is_array($this->placeholderStrings)) |
@@ -491,13 +491,13 @@ discard block |
||
491 | 491 | return in_array($subject, $ids); |
492 | 492 | } |
493 | 493 | |
494 | - /** |
|
495 | - * Retrieves a placeholder instance by its ID. |
|
496 | - * |
|
497 | - * @param int $id |
|
498 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
499 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
500 | - */ |
|
494 | + /** |
|
495 | + * Retrieves a placeholder instance by its ID. |
|
496 | + * |
|
497 | + * @param int $id |
|
498 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
499 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
500 | + */ |
|
501 | 501 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
502 | 502 | { |
503 | 503 | $placeholders = $this->getPlaceholders(); |
@@ -520,13 +520,13 @@ discard block |
||
520 | 520 | ); |
521 | 521 | } |
522 | 522 | |
523 | - /** |
|
524 | - * Retrieves a placeholder instance by its replacement text. |
|
525 | - * |
|
526 | - * @param string $string |
|
527 | - * @throws Mailcode_Exception |
|
528 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
529 | - */ |
|
523 | + /** |
|
524 | + * Retrieves a placeholder instance by its replacement text. |
|
525 | + * |
|
526 | + * @param string $string |
|
527 | + * @throws Mailcode_Exception |
|
528 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
529 | + */ |
|
530 | 530 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
531 | 531 | { |
532 | 532 | $placeholders = $this->getPlaceholders(); |
@@ -134,7 +134,7 @@ discard block |
||
134 | 134 | */ |
135 | 135 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
136 | 136 | { |
137 | - if(empty($delimiter)) |
|
137 | + if (empty($delimiter)) |
|
138 | 138 | { |
139 | 139 | throw new Mailcode_Exception( |
140 | 140 | 'Empty delimiter', |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | $safe = str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
187 | 187 | |
188 | 188 | // If a formatter has been selected, let it modify the string. |
189 | - if(isset($this->formatter)) |
|
189 | + if (isset($this->formatter)) |
|
190 | 190 | { |
191 | 191 | $safe = $this->formatter->format($safe); |
192 | 192 | } |
@@ -198,7 +198,7 @@ discard block |
||
198 | 198 | { |
199 | 199 | $class = 'Mailcode\Mailcode_Parser_Safeguard_Formatter_'.$formatterID; |
200 | 200 | |
201 | - if(class_exists($class)) |
|
201 | + if (class_exists($class)) |
|
202 | 202 | { |
203 | 203 | $this->formatter = new $class($this); |
204 | 204 | |
@@ -224,7 +224,7 @@ discard block |
||
224 | 224 | { |
225 | 225 | $formatter = $this->selectFormatter('SingleLines'); |
226 | 226 | |
227 | - if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines) |
|
227 | + if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines) |
|
228 | 228 | { |
229 | 229 | return $formatter; |
230 | 230 | } |
@@ -246,21 +246,21 @@ discard block |
||
246 | 246 | * @param bool $highlighted |
247 | 247 | * @return string[]string |
248 | 248 | */ |
249 | - protected function getReplaces(bool $highlighted=false, bool $normalize=false) : array |
|
249 | + protected function getReplaces(bool $highlighted = false, bool $normalize = false) : array |
|
250 | 250 | { |
251 | 251 | $placeholders = $this->getPlaceholders(); |
252 | 252 | |
253 | 253 | $replaces = array(); |
254 | 254 | |
255 | - foreach($placeholders as $placeholder) |
|
255 | + foreach ($placeholders as $placeholder) |
|
256 | 256 | { |
257 | 257 | $replace = ''; |
258 | 258 | |
259 | - if($highlighted) |
|
259 | + if ($highlighted) |
|
260 | 260 | { |
261 | 261 | $replace = $placeholder->getHighlightedText(); |
262 | 262 | } |
263 | - else if($normalize) |
|
263 | + else if ($normalize) |
|
264 | 264 | { |
265 | 265 | $replace = $placeholder->getNormalizedText(); |
266 | 266 | } |
@@ -284,7 +284,7 @@ discard block |
||
284 | 284 | */ |
285 | 285 | public function getPlaceholders() |
286 | 286 | { |
287 | - if(isset($this->placeholders)) |
|
287 | + if (isset($this->placeholders)) |
|
288 | 288 | { |
289 | 289 | return $this->placeholders; |
290 | 290 | } |
@@ -293,7 +293,7 @@ discard block |
||
293 | 293 | |
294 | 294 | $cmds = $this->getCollection()->getGroupedByHash(); |
295 | 295 | |
296 | - foreach($cmds as $command) |
|
296 | + foreach ($cmds as $command) |
|
297 | 297 | { |
298 | 298 | self::$counter++; |
299 | 299 | |
@@ -307,9 +307,9 @@ discard block |
||
307 | 307 | return $this->placeholders; |
308 | 308 | } |
309 | 309 | |
310 | - protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string |
|
310 | + protected function restore(string $string, bool $partial = false, bool $highlighted = false) : string |
|
311 | 311 | { |
312 | - if(!$partial) |
|
312 | + if (!$partial) |
|
313 | 313 | { |
314 | 314 | $this->requireValidCollection(); |
315 | 315 | } |
@@ -318,9 +318,9 @@ discard block |
||
318 | 318 | |
319 | 319 | $placeholderStrings = array_keys($replaces); |
320 | 320 | |
321 | - foreach($placeholderStrings as $search) |
|
321 | + foreach ($placeholderStrings as $search) |
|
322 | 322 | { |
323 | - if(!$partial && !strstr($string, $search)) |
|
323 | + if (!$partial && !strstr($string, $search)) |
|
324 | 324 | { |
325 | 325 | throw new Mailcode_Exception( |
326 | 326 | 'Command placeholder not found', |
@@ -422,7 +422,7 @@ discard block |
||
422 | 422 | */ |
423 | 423 | public function getCollection() : Mailcode_Collection |
424 | 424 | { |
425 | - if(isset($this->collection)) |
|
425 | + if (isset($this->collection)) |
|
426 | 426 | { |
427 | 427 | return $this->collection; |
428 | 428 | } |
@@ -444,7 +444,7 @@ discard block |
||
444 | 444 | */ |
445 | 445 | protected function requireValidCollection() : void |
446 | 446 | { |
447 | - if($this->getCollection()->isValid()) |
|
447 | + if ($this->getCollection()->isValid()) |
|
448 | 448 | { |
449 | 449 | return; |
450 | 450 | } |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | */ |
468 | 468 | public function getPlaceholderStrings() : array |
469 | 469 | { |
470 | - if(is_array($this->placeholderStrings)) |
|
470 | + if (is_array($this->placeholderStrings)) |
|
471 | 471 | { |
472 | 472 | return $this->placeholderStrings; |
473 | 473 | } |
@@ -476,7 +476,7 @@ discard block |
||
476 | 476 | |
477 | 477 | $this->placeholderStrings = array(); |
478 | 478 | |
479 | - foreach($placeholders as $placeholder) |
|
479 | + foreach ($placeholders as $placeholder) |
|
480 | 480 | { |
481 | 481 | $this->placeholderStrings[] = $placeholder->getReplacementText(); |
482 | 482 | } |
@@ -502,9 +502,9 @@ discard block |
||
502 | 502 | { |
503 | 503 | $placeholders = $this->getPlaceholders(); |
504 | 504 | |
505 | - foreach($placeholders as $placeholder) |
|
505 | + foreach ($placeholders as $placeholder) |
|
506 | 506 | { |
507 | - if($placeholder->getID() === $id) |
|
507 | + if ($placeholder->getID() === $id) |
|
508 | 508 | { |
509 | 509 | return $placeholder; |
510 | 510 | } |
@@ -531,9 +531,9 @@ discard block |
||
531 | 531 | { |
532 | 532 | $placeholders = $this->getPlaceholders(); |
533 | 533 | |
534 | - foreach($placeholders as $placeholder) |
|
534 | + foreach ($placeholders as $placeholder) |
|
535 | 535 | { |
536 | - if($placeholder->getReplacementText() === $string) |
|
536 | + if ($placeholder->getReplacementText() === $string) |
|
537 | 537 | { |
538 | 538 | return $placeholder; |
539 | 539 | } |
@@ -259,12 +259,10 @@ |
||
259 | 259 | if($highlighted) |
260 | 260 | { |
261 | 261 | $replace = $placeholder->getHighlightedText(); |
262 | - } |
|
263 | - else if($normalize) |
|
262 | + } else if($normalize) |
|
264 | 263 | { |
265 | 264 | $replace = $placeholder->getNormalizedText(); |
266 | - } |
|
267 | - else |
|
265 | + } else |
|
268 | 266 | { |
269 | 267 | $replace = $placeholder->getOriginalText(); |
270 | 268 | } |