@@ -29,9 +29,9 @@ |
||
29 | 29 | |
30 | 30 | const ERROR_INVALID_TAG_TEMPLATE = 66101; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | private $tagTemplate = '<span class="mailcode-marked-variable">%s</span>'; |
36 | 36 | |
37 | 37 | protected function initFormatting() : void |
@@ -40,7 +40,7 @@ |
||
40 | 40 | |
41 | 41 | public function setTemplate(string $template) : void |
42 | 42 | { |
43 | - if(substr_count($template, '%s') !== 1) |
|
43 | + if (substr_count($template, '%s') !== 1) |
|
44 | 44 | { |
45 | 45 | throw new Mailcode_Exception( |
46 | 46 | 'Invalid tag template', |
@@ -25,11 +25,11 @@ |
||
25 | 25 | return PHP_INT_MAX; |
26 | 26 | } |
27 | 27 | |
28 | - /** |
|
29 | - * Formats the specified string according to the formatter. |
|
30 | - * Retrieve the updated string from the string container used |
|
31 | - * to create the formatter, or use `getSubjectString()`. |
|
32 | - */ |
|
28 | + /** |
|
29 | + * Formats the specified string according to the formatter. |
|
30 | + * Retrieve the updated string from the string container used |
|
31 | + * to create the formatter, or use `getSubjectString()`. |
|
32 | + */ |
|
33 | 33 | public function format() : void |
34 | 34 | { |
35 | 35 | $locations = $this->resolveLocations(); |
@@ -34,7 +34,7 @@ |
||
34 | 34 | { |
35 | 35 | $locations = $this->resolveLocations(); |
36 | 36 | |
37 | - foreach($locations as $location) |
|
37 | + foreach ($locations as $location) |
|
38 | 38 | { |
39 | 39 | $location->format(); |
40 | 40 |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | |
132 | 132 | public function applyFormatting() : void |
133 | 133 | { |
134 | - if($this->applied) |
|
134 | + if ($this->applied) |
|
135 | 135 | { |
136 | 136 | return; |
137 | 137 | } |
@@ -146,9 +146,9 @@ discard block |
||
146 | 146 | |
147 | 147 | private function applyFormatTypes() : void |
148 | 148 | { |
149 | - foreach($this->formatters as $formatter) |
|
149 | + foreach ($this->formatters as $formatter) |
|
150 | 150 | { |
151 | - if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType) |
|
151 | + if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType) |
|
152 | 152 | { |
153 | 153 | $formatter->format(); |
154 | 154 | } |
@@ -157,9 +157,9 @@ discard block |
||
157 | 157 | |
158 | 158 | private function applyReplaceTypes() : void |
159 | 159 | { |
160 | - foreach($this->formatters as $formatter) |
|
160 | + foreach ($this->formatters as $formatter) |
|
161 | 161 | { |
162 | - if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType) |
|
162 | + if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType) |
|
163 | 163 | { |
164 | 164 | $formatter->replace(); |
165 | 165 | } |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | |
169 | 169 | private function validateFormatters() : void |
170 | 170 | { |
171 | - if(empty($this->formatters)) |
|
171 | + if (empty($this->formatters)) |
|
172 | 172 | { |
173 | 173 | throw new Mailcode_Exception( |
174 | 174 | 'No formatters selected', |
@@ -179,7 +179,7 @@ discard block |
||
179 | 179 | |
180 | 180 | $amount = $this->countReplacers(); |
181 | 181 | |
182 | - if($amount > 1) |
|
182 | + if ($amount > 1) |
|
183 | 183 | { |
184 | 184 | throw new Mailcode_Exception( |
185 | 185 | 'More than one replacer formatter selected', |
@@ -189,7 +189,7 @@ discard block |
||
189 | 189 | } |
190 | 190 | |
191 | 191 | // by default, at minimum the normalized formatter must be selected. |
192 | - if($amount === 0) |
|
192 | + if ($amount === 0) |
|
193 | 193 | { |
194 | 194 | $this->replaceWithNormalized(); |
195 | 195 | } |
@@ -204,9 +204,9 @@ discard block |
||
204 | 204 | { |
205 | 205 | $count = 0; |
206 | 206 | |
207 | - foreach($this->formatters as $formatter) |
|
207 | + foreach ($this->formatters as $formatter) |
|
208 | 208 | { |
209 | - if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType) |
|
209 | + if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType) |
|
210 | 210 | { |
211 | 211 | $count++; |
212 | 212 | } |
@@ -32,29 +32,29 @@ discard block |
||
32 | 32 | const ERROR_TOO_MANY_REPLACERS = 65902; |
33 | 33 | const ERROR_NO_FORMATTERS_ADDED = 65903; |
34 | 34 | |
35 | - /** |
|
36 | - * @var Mailcode_Parser_Safeguard |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var Mailcode_Parser_Safeguard |
|
37 | + */ |
|
38 | 38 | private $safeguard; |
39 | 39 | |
40 | - /** |
|
41 | - * @var Mailcode_Parser_Safeguard_Formatter[] |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var Mailcode_Parser_Safeguard_Formatter[] |
|
42 | + */ |
|
43 | 43 | private $formatters = array(); |
44 | 44 | |
45 | - /** |
|
46 | - * @var Mailcode_StringContainer |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var Mailcode_StringContainer |
|
47 | + */ |
|
48 | 48 | private $subject; |
49 | 49 | |
50 | - /** |
|
51 | - * @var boolean |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var boolean |
|
52 | + */ |
|
53 | 53 | private $applied = false; |
54 | 54 | |
55 | - /** |
|
56 | - * @var boolean |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var boolean |
|
57 | + */ |
|
58 | 58 | private $partial = false; |
59 | 59 | |
60 | 60 | public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject) |
@@ -96,17 +96,17 @@ discard block |
||
96 | 96 | return $formatter; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * Adds a formatter that will surround all variables with |
|
101 | - * markup to highlight them independently of command syntax |
|
102 | - * highlighting. |
|
103 | - * |
|
104 | - * This is used to mark variables visually even after commands |
|
105 | - * have been replaced by the target system's post processing. |
|
106 | - * Can be combined with a replacer and other formats. |
|
107 | - * |
|
108 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
|
109 | - */ |
|
99 | + /** |
|
100 | + * Adds a formatter that will surround all variables with |
|
101 | + * markup to highlight them independently of command syntax |
|
102 | + * highlighting. |
|
103 | + * |
|
104 | + * This is used to mark variables visually even after commands |
|
105 | + * have been replaced by the target system's post processing. |
|
106 | + * Can be combined with a replacer and other formats. |
|
107 | + * |
|
108 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
|
109 | + */ |
|
110 | 110 | public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables |
111 | 111 | { |
112 | 112 | $formatter = $this->createMarkVariables(); |
@@ -200,11 +200,11 @@ discard block |
||
200 | 200 | } |
201 | 201 | } |
202 | 202 | |
203 | - /** |
|
204 | - * Counts the amount of replacer formatters that have been added. |
|
205 | - * |
|
206 | - * @return int |
|
207 | - */ |
|
203 | + /** |
|
204 | + * Counts the amount of replacer formatters that have been added. |
|
205 | + * |
|
206 | + * @return int |
|
207 | + */ |
|
208 | 208 | private function countReplacers() : int |
209 | 209 | { |
210 | 210 | $count = 0; |
@@ -220,37 +220,37 @@ discard block |
||
220 | 220 | return $count; |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Creates a formatter that adds HTML syntax highlighting |
|
225 | - * for all commands in the specified string, intelligently |
|
226 | - * checking the location of the commands to ensure that they |
|
227 | - * can be syntax highlighted. |
|
228 | - * |
|
229 | - * For example, commands in HTML attributes will not be |
|
230 | - * highlighted, as this would break the HTML. |
|
231 | - * |
|
232 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
|
233 | - */ |
|
223 | + /** |
|
224 | + * Creates a formatter that adds HTML syntax highlighting |
|
225 | + * for all commands in the specified string, intelligently |
|
226 | + * checking the location of the commands to ensure that they |
|
227 | + * can be syntax highlighted. |
|
228 | + * |
|
229 | + * For example, commands in HTML attributes will not be |
|
230 | + * highlighted, as this would break the HTML. |
|
231 | + * |
|
232 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
|
233 | + */ |
|
234 | 234 | public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting |
235 | 235 | { |
236 | 236 | return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this); |
237 | 237 | } |
238 | 238 | |
239 | - /** |
|
240 | - * Creates the formatter that ensures that all commands |
|
241 | - * are placed on a separate line in the subject string. |
|
242 | - */ |
|
239 | + /** |
|
240 | + * Creates the formatter that ensures that all commands |
|
241 | + * are placed on a separate line in the subject string. |
|
242 | + */ |
|
243 | 243 | public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines |
244 | 244 | { |
245 | 245 | return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this); |
246 | 246 | } |
247 | 247 | |
248 | - /** |
|
249 | - * Creates the formatter that replaces all commands by |
|
250 | - * their normalized variants. |
|
251 | - * |
|
252 | - * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
|
253 | - */ |
|
248 | + /** |
|
249 | + * Creates the formatter that replaces all commands by |
|
250 | + * their normalized variants. |
|
251 | + * |
|
252 | + * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
|
253 | + */ |
|
254 | 254 | public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized |
255 | 255 | { |
256 | 256 | return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this); |
@@ -273,26 +273,26 @@ discard block |
||
273 | 273 | return $this->subject->getString(); |
274 | 274 | } |
275 | 275 | |
276 | - /** |
|
277 | - * Whether the formatting is done partially: missing placeholders |
|
278 | - * will simply be ignored. |
|
279 | - * |
|
280 | - * @return bool |
|
281 | - */ |
|
276 | + /** |
|
277 | + * Whether the formatting is done partially: missing placeholders |
|
278 | + * will simply be ignored. |
|
279 | + * |
|
280 | + * @return bool |
|
281 | + */ |
|
282 | 282 | public function isPartial() : bool |
283 | 283 | { |
284 | 284 | return $this->partial; |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * The formatting will ignore missing placeholders. Use this if the |
|
289 | - * formatting will be done on a text that may not contain all of the |
|
290 | - * initial placeholders anymore. |
|
291 | - * |
|
292 | - * This is like the safeguard's makeWholePartial() method. |
|
293 | - * |
|
294 | - * @return Mailcode_Parser_Safeguard_Formatting |
|
295 | - */ |
|
287 | + /** |
|
288 | + * The formatting will ignore missing placeholders. Use this if the |
|
289 | + * formatting will be done on a text that may not contain all of the |
|
290 | + * initial placeholders anymore. |
|
291 | + * |
|
292 | + * This is like the safeguard's makeWholePartial() method. |
|
293 | + * |
|
294 | + * @return Mailcode_Parser_Safeguard_Formatting |
|
295 | + */ |
|
296 | 296 | public function makePartial() : Mailcode_Parser_Safeguard_Formatting |
297 | 297 | { |
298 | 298 | $this->partial = true; |
@@ -53,50 +53,50 @@ discard block |
||
53 | 53 | const ERROR_EMPTY_DELIMITER = 47803; |
54 | 54 | const ERROR_PLACEHOLDER_NOT_FOUND = 47804; |
55 | 55 | |
56 | - /** |
|
57 | - * @var Mailcode_Parser |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var Mailcode_Parser |
|
58 | + */ |
|
59 | 59 | protected $parser; |
60 | 60 | |
61 | - /** |
|
62 | - * @var Mailcode_Collection |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var Mailcode_Collection |
|
63 | + */ |
|
64 | 64 | protected $commands; |
65 | 65 | |
66 | - /** |
|
67 | - * @var string |
|
68 | - */ |
|
66 | + /** |
|
67 | + * @var string |
|
68 | + */ |
|
69 | 69 | protected $originalString; |
70 | 70 | |
71 | - /** |
|
72 | - * @var Mailcode_Collection |
|
73 | - */ |
|
71 | + /** |
|
72 | + * @var Mailcode_Collection |
|
73 | + */ |
|
74 | 74 | protected $collection; |
75 | 75 | |
76 | - /** |
|
77 | - * Counter for the placeholders, global for all placeholders. |
|
78 | - * @var integer |
|
79 | - */ |
|
76 | + /** |
|
77 | + * Counter for the placeholders, global for all placeholders. |
|
78 | + * @var integer |
|
79 | + */ |
|
80 | 80 | private static $counter = 0; |
81 | 81 | |
82 | - /** |
|
83 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
84 | - */ |
|
82 | + /** |
|
83 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
84 | + */ |
|
85 | 85 | protected $placeholders; |
86 | 86 | |
87 | - /** |
|
88 | - * @var string |
|
89 | - */ |
|
87 | + /** |
|
88 | + * @var string |
|
89 | + */ |
|
90 | 90 | protected $delimiter = '__'; |
91 | 91 | |
92 | - /** |
|
93 | - * @var string[]|NULL |
|
94 | - */ |
|
92 | + /** |
|
93 | + * @var string[]|NULL |
|
94 | + */ |
|
95 | 95 | protected $placeholderStrings; |
96 | 96 | |
97 | - /** |
|
98 | - * @var Mailcode_Parser_Safeguard_Formatting|NULL |
|
99 | - */ |
|
97 | + /** |
|
98 | + * @var Mailcode_Parser_Safeguard_Formatting|NULL |
|
99 | + */ |
|
100 | 100 | private $formatting = null; |
101 | 101 | |
102 | 102 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -105,25 +105,25 @@ discard block |
||
105 | 105 | $this->originalString = $subject; |
106 | 106 | } |
107 | 107 | |
108 | - /** |
|
109 | - * Retrieves the string the safeguard was created for. |
|
110 | - * |
|
111 | - * @return string |
|
112 | - */ |
|
108 | + /** |
|
109 | + * Retrieves the string the safeguard was created for. |
|
110 | + * |
|
111 | + * @return string |
|
112 | + */ |
|
113 | 113 | public function getOriginalString() : string |
114 | 114 | { |
115 | 115 | return $this->originalString; |
116 | 116 | } |
117 | 117 | |
118 | - /** |
|
119 | - * Sets the delimiter character sequence used to prepend |
|
120 | - * and append to the placeholders. |
|
121 | - * |
|
122 | - * The delimiter's default is "__" (two underscores). |
|
123 | - * |
|
124 | - * @param string $delimiter |
|
125 | - * @return Mailcode_Parser_Safeguard |
|
126 | - */ |
|
118 | + /** |
|
119 | + * Sets the delimiter character sequence used to prepend |
|
120 | + * and append to the placeholders. |
|
121 | + * |
|
122 | + * The delimiter's default is "__" (two underscores). |
|
123 | + * |
|
124 | + * @param string $delimiter |
|
125 | + * @return Mailcode_Parser_Safeguard |
|
126 | + */ |
|
127 | 127 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
128 | 128 | { |
129 | 129 | if(empty($delimiter)) |
@@ -145,15 +145,15 @@ discard block |
||
145 | 145 | return $this->delimiter; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Retrieves the safe string in which all commands have been replaced |
|
150 | - * by placeholder strings. |
|
151 | - * |
|
152 | - * @return string |
|
153 | - * @throws Mailcode_Exception |
|
154 | - * |
|
155 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
156 | - */ |
|
148 | + /** |
|
149 | + * Retrieves the safe string in which all commands have been replaced |
|
150 | + * by placeholder strings. |
|
151 | + * |
|
152 | + * @return string |
|
153 | + * @throws Mailcode_Exception |
|
154 | + * |
|
155 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
156 | + */ |
|
157 | 157 | public function makeSafe() : string |
158 | 158 | { |
159 | 159 | $this->requireValidCollection(); |
@@ -161,16 +161,16 @@ discard block |
||
161 | 161 | return $this->makeSafePartial(); |
162 | 162 | } |
163 | 163 | |
164 | - /** |
|
165 | - * Like makeSafe(), but allows partial (invalid) commands: use this |
|
166 | - * if the subject string may contain only part of the whole set of |
|
167 | - * commands. |
|
168 | - * |
|
169 | - * Example: parsing a text with an opening if statement, without the |
|
170 | - * matching end statement. |
|
171 | - * |
|
172 | - * @return string |
|
173 | - */ |
|
164 | + /** |
|
165 | + * Like makeSafe(), but allows partial (invalid) commands: use this |
|
166 | + * if the subject string may contain only part of the whole set of |
|
167 | + * commands. |
|
168 | + * |
|
169 | + * Example: parsing a text with an opening if statement, without the |
|
170 | + * matching end statement. |
|
171 | + * |
|
172 | + * @return string |
|
173 | + */ |
|
174 | 174 | public function makeSafePartial() : string |
175 | 175 | { |
176 | 176 | $placeholders = $this->getPlaceholders(); |
@@ -200,13 +200,13 @@ discard block |
||
200 | 200 | return $string; |
201 | 201 | } |
202 | 202 | |
203 | - /** |
|
204 | - * Creates a formatting handler, which can be used to specify |
|
205 | - * which formattings to use for the commands in the subject string. |
|
206 | - * |
|
207 | - * @param Mailcode_StringContainer|string $subject |
|
208 | - * @return Mailcode_Parser_Safeguard_Formatting |
|
209 | - */ |
|
203 | + /** |
|
204 | + * Creates a formatting handler, which can be used to specify |
|
205 | + * which formattings to use for the commands in the subject string. |
|
206 | + * |
|
207 | + * @param Mailcode_StringContainer|string $subject |
|
208 | + * @return Mailcode_Parser_Safeguard_Formatting |
|
209 | + */ |
|
210 | 210 | public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting |
211 | 211 | { |
212 | 212 | if(is_string($subject)) |
@@ -217,12 +217,12 @@ discard block |
||
217 | 217 | return new Mailcode_Parser_Safeguard_Formatting($this, $subject); |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * Retrieves all placeholders that have to be added to |
|
222 | - * the subject text. |
|
223 | - * |
|
224 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
225 | - */ |
|
220 | + /** |
|
221 | + * Retrieves all placeholders that have to be added to |
|
222 | + * the subject text. |
|
223 | + * |
|
224 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
225 | + */ |
|
226 | 226 | public function getPlaceholders() |
227 | 227 | { |
228 | 228 | if(isset($this->placeholders)) |
@@ -269,16 +269,16 @@ discard block |
||
269 | 269 | return $formatting->toString(); |
270 | 270 | } |
271 | 271 | |
272 | - /** |
|
273 | - * Makes the string whole again after transforming or filtering it, |
|
274 | - * by replacing the command placeholders with the original commands. |
|
275 | - * |
|
276 | - * @param string $string |
|
277 | - * @return string |
|
278 | - * @throws Mailcode_Exception |
|
279 | - * |
|
280 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
281 | - */ |
|
272 | + /** |
|
273 | + * Makes the string whole again after transforming or filtering it, |
|
274 | + * by replacing the command placeholders with the original commands. |
|
275 | + * |
|
276 | + * @param string $string |
|
277 | + * @return string |
|
278 | + * @throws Mailcode_Exception |
|
279 | + * |
|
280 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
281 | + */ |
|
282 | 282 | public function makeWhole(string $string) : string |
283 | 283 | { |
284 | 284 | return $this->restore( |
@@ -288,15 +288,15 @@ discard block |
||
288 | 288 | ); |
289 | 289 | } |
290 | 290 | |
291 | - /** |
|
292 | - * Like `makeWhole()`, but ignores missing command placeholders. |
|
293 | - * |
|
294 | - * @param string $string |
|
295 | - * @return string |
|
296 | - * @throws Mailcode_Exception |
|
297 | - * |
|
298 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
299 | - */ |
|
291 | + /** |
|
292 | + * Like `makeWhole()`, but ignores missing command placeholders. |
|
293 | + * |
|
294 | + * @param string $string |
|
295 | + * @return string |
|
296 | + * @throws Mailcode_Exception |
|
297 | + * |
|
298 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
299 | + */ |
|
300 | 300 | public function makeWholePartial(string $string) : string |
301 | 301 | { |
302 | 302 | return $this->restore( |
@@ -306,19 +306,19 @@ discard block |
||
306 | 306 | ); |
307 | 307 | } |
308 | 308 | |
309 | - /** |
|
310 | - * Like `makeWhole()`, but replaces the commands with a syntax |
|
311 | - * highlighted version, meant for human readable texts only. |
|
312 | - * |
|
313 | - * Note: the commands lose their functionality (They cannot be |
|
314 | - * parsed from that string again). |
|
315 | - * |
|
316 | - * @param string $string |
|
317 | - * @return string |
|
318 | - * @throws Mailcode_Exception |
|
319 | - * |
|
320 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
321 | - */ |
|
309 | + /** |
|
310 | + * Like `makeWhole()`, but replaces the commands with a syntax |
|
311 | + * highlighted version, meant for human readable texts only. |
|
312 | + * |
|
313 | + * Note: the commands lose their functionality (They cannot be |
|
314 | + * parsed from that string again). |
|
315 | + * |
|
316 | + * @param string $string |
|
317 | + * @return string |
|
318 | + * @throws Mailcode_Exception |
|
319 | + * |
|
320 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
321 | + */ |
|
322 | 322 | public function makeHighlighted(string $string) : string |
323 | 323 | { |
324 | 324 | return $this->restore( |
@@ -328,15 +328,15 @@ discard block |
||
328 | 328 | ); |
329 | 329 | } |
330 | 330 | |
331 | - /** |
|
332 | - * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
333 | - * |
|
334 | - * @param string $string |
|
335 | - * @return string |
|
336 | - * @throws Mailcode_Exception |
|
337 | - * |
|
338 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
339 | - */ |
|
331 | + /** |
|
332 | + * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
333 | + * |
|
334 | + * @param string $string |
|
335 | + * @return string |
|
336 | + * @throws Mailcode_Exception |
|
337 | + * |
|
338 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
339 | + */ |
|
340 | 340 | public function makeHighlightedPartial(string $string) : string |
341 | 341 | { |
342 | 342 | return $this->restore( |
@@ -346,11 +346,11 @@ discard block |
||
346 | 346 | ); |
347 | 347 | } |
348 | 348 | |
349 | - /** |
|
350 | - * Retrieves the commands collection contained in the string. |
|
351 | - * |
|
352 | - * @return Mailcode_Collection |
|
353 | - */ |
|
349 | + /** |
|
350 | + * Retrieves the commands collection contained in the string. |
|
351 | + * |
|
352 | + * @return Mailcode_Collection |
|
353 | + */ |
|
354 | 354 | public function getCollection() : Mailcode_Collection |
355 | 355 | { |
356 | 356 | if(isset($this->collection)) |
@@ -368,11 +368,11 @@ discard block |
||
368 | 368 | return $this->getCollection()->isValid(); |
369 | 369 | } |
370 | 370 | |
371 | - /** |
|
372 | - * @throws Mailcode_Exception |
|
373 | - * |
|
374 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
375 | - */ |
|
371 | + /** |
|
372 | + * @throws Mailcode_Exception |
|
373 | + * |
|
374 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
375 | + */ |
|
376 | 376 | protected function requireValidCollection() : void |
377 | 377 | { |
378 | 378 | if($this->getCollection()->isValid()) |
@@ -391,11 +391,11 @@ discard block |
||
391 | 391 | ); |
392 | 392 | } |
393 | 393 | |
394 | - /** |
|
395 | - * Retrieves a list of all placeholder IDs used in the text. |
|
396 | - * |
|
397 | - * @return string[] |
|
398 | - */ |
|
394 | + /** |
|
395 | + * Retrieves a list of all placeholder IDs used in the text. |
|
396 | + * |
|
397 | + * @return string[] |
|
398 | + */ |
|
399 | 399 | public function getPlaceholderStrings() : array |
400 | 400 | { |
401 | 401 | if(is_array($this->placeholderStrings)) |
@@ -422,13 +422,13 @@ discard block |
||
422 | 422 | return in_array($subject, $ids); |
423 | 423 | } |
424 | 424 | |
425 | - /** |
|
426 | - * Retrieves a placeholder instance by its ID. |
|
427 | - * |
|
428 | - * @param int $id |
|
429 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
430 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
431 | - */ |
|
425 | + /** |
|
426 | + * Retrieves a placeholder instance by its ID. |
|
427 | + * |
|
428 | + * @param int $id |
|
429 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
430 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
431 | + */ |
|
432 | 432 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
433 | 433 | { |
434 | 434 | $placeholders = $this->getPlaceholders(); |
@@ -451,13 +451,13 @@ discard block |
||
451 | 451 | ); |
452 | 452 | } |
453 | 453 | |
454 | - /** |
|
455 | - * Retrieves a placeholder instance by its replacement text. |
|
456 | - * |
|
457 | - * @param string $string |
|
458 | - * @throws Mailcode_Exception |
|
459 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
460 | - */ |
|
454 | + /** |
|
455 | + * Retrieves a placeholder instance by its replacement text. |
|
456 | + * |
|
457 | + * @param string $string |
|
458 | + * @throws Mailcode_Exception |
|
459 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
460 | + */ |
|
461 | 461 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
462 | 462 | { |
463 | 463 | $placeholders = $this->getPlaceholders(); |
@@ -260,8 +260,7 @@ |
||
260 | 260 | if($highlighted) |
261 | 261 | { |
262 | 262 | $formatting->replaceWithHTMLHighlighting(); |
263 | - } |
|
264 | - else |
|
263 | + } else |
|
265 | 264 | { |
266 | 265 | $formatting->replaceWithNormalized(); |
267 | 266 | } |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | */ |
127 | 127 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
128 | 128 | { |
129 | - if(empty($delimiter)) |
|
129 | + if (empty($delimiter)) |
|
130 | 130 | { |
131 | 131 | throw new Mailcode_Exception( |
132 | 132 | 'Empty delimiter', |
@@ -176,11 +176,11 @@ discard block |
||
176 | 176 | $placeholders = $this->getPlaceholders(); |
177 | 177 | $string = $this->originalString; |
178 | 178 | |
179 | - foreach($placeholders as $placeholder) |
|
179 | + foreach ($placeholders as $placeholder) |
|
180 | 180 | { |
181 | 181 | $pos = mb_strpos($string, $placeholder->getOriginalText()); |
182 | 182 | |
183 | - if($pos === false) |
|
183 | + if ($pos === false) |
|
184 | 184 | { |
185 | 185 | throw new Mailcode_Exception( |
186 | 186 | 'Placeholder original text not found', |
@@ -209,7 +209,7 @@ discard block |
||
209 | 209 | */ |
210 | 210 | public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting |
211 | 211 | { |
212 | - if(is_string($subject)) |
|
212 | + if (is_string($subject)) |
|
213 | 213 | { |
214 | 214 | $subject = Mailcode::create()->createString($subject); |
215 | 215 | } |
@@ -225,7 +225,7 @@ discard block |
||
225 | 225 | */ |
226 | 226 | public function getPlaceholders() |
227 | 227 | { |
228 | - if(isset($this->placeholders)) |
|
228 | + if (isset($this->placeholders)) |
|
229 | 229 | { |
230 | 230 | return $this->placeholders; |
231 | 231 | } |
@@ -234,7 +234,7 @@ discard block |
||
234 | 234 | |
235 | 235 | $cmds = $this->getCollection()->getCommands(); |
236 | 236 | |
237 | - foreach($cmds as $command) |
|
237 | + foreach ($cmds as $command) |
|
238 | 238 | { |
239 | 239 | self::$counter++; |
240 | 240 | |
@@ -248,21 +248,21 @@ discard block |
||
248 | 248 | return $this->placeholders; |
249 | 249 | } |
250 | 250 | |
251 | - protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string |
|
251 | + protected function restore(string $string, bool $partial = false, bool $highlighted = false) : string |
|
252 | 252 | { |
253 | - if(!$partial) |
|
253 | + if (!$partial) |
|
254 | 254 | { |
255 | 255 | $this->requireValidCollection(); |
256 | 256 | } |
257 | 257 | |
258 | 258 | $formatting = $this->createFormatting($string); |
259 | 259 | |
260 | - if($partial) |
|
260 | + if ($partial) |
|
261 | 261 | { |
262 | 262 | $formatting->makePartial(); |
263 | 263 | } |
264 | 264 | |
265 | - if($highlighted) |
|
265 | + if ($highlighted) |
|
266 | 266 | { |
267 | 267 | $formatting->replaceWithHTMLHighlighting(); |
268 | 268 | } |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | */ |
359 | 359 | public function getCollection() : Mailcode_Collection |
360 | 360 | { |
361 | - if(isset($this->collection)) |
|
361 | + if (isset($this->collection)) |
|
362 | 362 | { |
363 | 363 | return $this->collection; |
364 | 364 | } |
@@ -380,7 +380,7 @@ discard block |
||
380 | 380 | */ |
381 | 381 | protected function requireValidCollection() : void |
382 | 382 | { |
383 | - if($this->getCollection()->isValid()) |
|
383 | + if ($this->getCollection()->isValid()) |
|
384 | 384 | { |
385 | 385 | return; |
386 | 386 | } |
@@ -403,7 +403,7 @@ discard block |
||
403 | 403 | */ |
404 | 404 | public function getPlaceholderStrings() : array |
405 | 405 | { |
406 | - if(is_array($this->placeholderStrings)) |
|
406 | + if (is_array($this->placeholderStrings)) |
|
407 | 407 | { |
408 | 408 | return $this->placeholderStrings; |
409 | 409 | } |
@@ -412,7 +412,7 @@ discard block |
||
412 | 412 | |
413 | 413 | $this->placeholderStrings = array(); |
414 | 414 | |
415 | - foreach($placeholders as $placeholder) |
|
415 | + foreach ($placeholders as $placeholder) |
|
416 | 416 | { |
417 | 417 | $this->placeholderStrings[] = $placeholder->getReplacementText(); |
418 | 418 | } |
@@ -438,9 +438,9 @@ discard block |
||
438 | 438 | { |
439 | 439 | $placeholders = $this->getPlaceholders(); |
440 | 440 | |
441 | - foreach($placeholders as $placeholder) |
|
441 | + foreach ($placeholders as $placeholder) |
|
442 | 442 | { |
443 | - if($placeholder->getID() === $id) |
|
443 | + if ($placeholder->getID() === $id) |
|
444 | 444 | { |
445 | 445 | return $placeholder; |
446 | 446 | } |
@@ -467,9 +467,9 @@ discard block |
||
467 | 467 | { |
468 | 468 | $placeholders = $this->getPlaceholders(); |
469 | 469 | |
470 | - foreach($placeholders as $placeholder) |
|
470 | + foreach ($placeholders as $placeholder) |
|
471 | 471 | { |
472 | - if($placeholder->getReplacementText() === $string) |
|
472 | + if ($placeholder->getReplacementText() === $string) |
|
473 | 473 | { |
474 | 474 | return $placeholder; |
475 | 475 | } |
@@ -26,39 +26,39 @@ discard block |
||
26 | 26 | const ERROR_INVALID_CALLABLE = 65701; |
27 | 27 | const ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION = 65702; |
28 | 28 | |
29 | - /** |
|
30 | - * @var string |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var string |
|
31 | + */ |
|
32 | 32 | private $subject; |
33 | 33 | |
34 | - /** |
|
35 | - * @var integer |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var integer |
|
36 | + */ |
|
37 | 37 | private static $listenerCounter = 0; |
38 | 38 | |
39 | - /** |
|
40 | - * @var callable[] |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var callable[] |
|
41 | + */ |
|
42 | 42 | private $listeners = array(); |
43 | 43 | |
44 | - /** |
|
45 | - * @var boolean |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var boolean |
|
46 | + */ |
|
47 | 47 | private $updating = false; |
48 | 48 | |
49 | - /** |
|
50 | - * @var integer |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var integer |
|
51 | + */ |
|
52 | 52 | private static $idCounter = 0; |
53 | 53 | |
54 | - /** |
|
55 | - * @var integer |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var integer |
|
56 | + */ |
|
57 | 57 | private $id; |
58 | 58 | |
59 | - /** |
|
60 | - * @var integer |
|
61 | - */ |
|
59 | + /** |
|
60 | + * @var integer |
|
61 | + */ |
|
62 | 62 | private $length; |
63 | 63 | |
64 | 64 | public function __construct(string $subject) |
@@ -75,16 +75,16 @@ discard block |
||
75 | 75 | return $this->id; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Updates the string with the specified string. |
|
80 | - * Notifies all listeners of the change. |
|
81 | - * |
|
82 | - * @param string $subject |
|
83 | - * @throws Mailcode_Exception |
|
84 | - * @return bool Whether the string had modifications. |
|
85 | - * |
|
86 | - * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION |
|
87 | - */ |
|
78 | + /** |
|
79 | + * Updates the string with the specified string. |
|
80 | + * Notifies all listeners of the change. |
|
81 | + * |
|
82 | + * @param string $subject |
|
83 | + * @throws Mailcode_Exception |
|
84 | + * @return bool Whether the string had modifications. |
|
85 | + * |
|
86 | + * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION |
|
87 | + */ |
|
88 | 88 | public function updateString(string $subject) : bool |
89 | 89 | { |
90 | 90 | // avoid triggering an update if there are no changes in the string |
@@ -117,27 +117,27 @@ discard block |
||
117 | 117 | return true; |
118 | 118 | } |
119 | 119 | |
120 | - /** |
|
121 | - * Retrieves the stored string. |
|
122 | - * |
|
123 | - * @return string |
|
124 | - */ |
|
120 | + /** |
|
121 | + * Retrieves the stored string. |
|
122 | + * |
|
123 | + * @return string |
|
124 | + */ |
|
125 | 125 | public function getString() : string |
126 | 126 | { |
127 | 127 | return $this->subject; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Adds a listener that will be informed every time the string is modified. |
|
132 | - * The callback gets the string container instance as parameter. |
|
133 | - * |
|
134 | - * @param callable $callback |
|
135 | - * @throws Mailcode_Exception If it is not a valid callable. |
|
136 | - * @return int The listener number, to be able to remove it using `removeListener()`. |
|
137 | - * |
|
138 | - * @see Mailcode_StringContainer::removeListener() |
|
139 | - * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE |
|
140 | - */ |
|
130 | + /** |
|
131 | + * Adds a listener that will be informed every time the string is modified. |
|
132 | + * The callback gets the string container instance as parameter. |
|
133 | + * |
|
134 | + * @param callable $callback |
|
135 | + * @throws Mailcode_Exception If it is not a valid callable. |
|
136 | + * @return int The listener number, to be able to remove it using `removeListener()`. |
|
137 | + * |
|
138 | + * @see Mailcode_StringContainer::removeListener() |
|
139 | + * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE |
|
140 | + */ |
|
141 | 141 | public function addListener($callback) : int |
142 | 142 | { |
143 | 143 | self::$listenerCounter++; |
@@ -164,12 +164,12 @@ discard block |
||
164 | 164 | return $this->length; |
165 | 165 | } |
166 | 166 | |
167 | - /** |
|
168 | - * Removes an existing listener by its ID. |
|
169 | - * Has no effect if it does not exist, or has already been removed. |
|
170 | - * |
|
171 | - * @param int $listenerID |
|
172 | - */ |
|
167 | + /** |
|
168 | + * Removes an existing listener by its ID. |
|
169 | + * Has no effect if it does not exist, or has already been removed. |
|
170 | + * |
|
171 | + * @param int $listenerID |
|
172 | + */ |
|
173 | 173 | public function removeListener(int $listenerID) : void |
174 | 174 | { |
175 | 175 | if(isset($this->listeners[$listenerID])) |
@@ -178,13 +178,13 @@ discard block |
||
178 | 178 | } |
179 | 179 | } |
180 | 180 | |
181 | - /** |
|
182 | - * Replaces all substrings matching needle with the replacement text. |
|
183 | - * |
|
184 | - * @param string $needle |
|
185 | - * @param string $replacement |
|
186 | - * @return bool |
|
187 | - */ |
|
181 | + /** |
|
182 | + * Replaces all substrings matching needle with the replacement text. |
|
183 | + * |
|
184 | + * @param string $needle |
|
185 | + * @param string $replacement |
|
186 | + * @return bool |
|
187 | + */ |
|
188 | 188 | public function replaceSubstrings(string $needle, string $replacement) : bool |
189 | 189 | { |
190 | 190 | $string = str_replace($needle, $replacement, $this->subject); |
@@ -192,12 +192,12 @@ discard block |
||
192 | 192 | return $this->updateString($string); |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Get the position of a substring in the string. |
|
197 | - * |
|
198 | - * @param string $needle |
|
199 | - * @return int|bool The zero-based position, or false if not found. |
|
200 | - */ |
|
195 | + /** |
|
196 | + * Get the position of a substring in the string. |
|
197 | + * |
|
198 | + * @param string $needle |
|
199 | + * @return int|bool The zero-based position, or false if not found. |
|
200 | + */ |
|
201 | 201 | public function getSubstrPosition(string $needle) |
202 | 202 | { |
203 | 203 | return mb_strpos($this->subject, $needle); |
@@ -88,12 +88,12 @@ discard block |
||
88 | 88 | public function updateString(string $subject) : bool |
89 | 89 | { |
90 | 90 | // avoid triggering an update if there are no changes in the string |
91 | - if($subject === $this->subject) |
|
91 | + if ($subject === $this->subject) |
|
92 | 92 | { |
93 | 93 | return false; |
94 | 94 | } |
95 | 95 | |
96 | - if($this->updating) |
|
96 | + if ($this->updating) |
|
97 | 97 | { |
98 | 98 | throw new Mailcode_Exception( |
99 | 99 | 'Cannot modify subject string during update', |
@@ -107,7 +107,7 @@ discard block |
||
107 | 107 | $this->subject = $subject; |
108 | 108 | $this->length = mb_strlen($this->subject); |
109 | 109 | |
110 | - foreach($this->listeners as $listener) |
|
110 | + foreach ($this->listeners as $listener) |
|
111 | 111 | { |
112 | 112 | $listener($this); |
113 | 113 | } |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | { |
143 | 143 | self::$listenerCounter++; |
144 | 144 | |
145 | - if(!is_callable($callback)) |
|
145 | + if (!is_callable($callback)) |
|
146 | 146 | { |
147 | 147 | throw new Mailcode_Exception( |
148 | 148 | 'Not a valid callable', |
@@ -172,7 +172,7 @@ discard block |
||
172 | 172 | */ |
173 | 173 | public function removeListener(int $listenerID) : void |
174 | 174 | { |
175 | - if(isset($this->listeners[$listenerID])) |
|
175 | + if (isset($this->listeners[$listenerID])) |
|
176 | 176 | { |
177 | 177 | unset($this->listeners[$listenerID]); |
178 | 178 | } |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | return mb_strpos($this->subject, $needle); |
204 | 204 | } |
205 | 205 | |
206 | - public function getSubstr(int $start, ?int $length=null) : string |
|
206 | + public function getSubstr(int $start, ?int $length = null) : string |
|
207 | 207 | { |
208 | 208 | return mb_substr($this->subject, $start, $length); |
209 | 209 | } |
@@ -24,34 +24,34 @@ discard block |
||
24 | 24 | { |
25 | 25 | const ERROR_PLACEHOLDER_NOT_FOUND = 66001; |
26 | 26 | |
27 | - /** |
|
28 | - * @var Mailcode_Parser_Safeguard_Formatter |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Parser_Safeguard_Formatter |
|
29 | + */ |
|
30 | 30 | protected $formatter; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $append = ''; |
36 | 36 | |
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | 40 | protected $prepend = ''; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Parser_Safeguard_Placeholder |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Parser_Safeguard_Placeholder |
|
44 | + */ |
|
45 | 45 | protected $placeholder; |
46 | 46 | |
47 | - /** |
|
48 | - * @var Mailcode_StringContainer |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var Mailcode_StringContainer |
|
49 | + */ |
|
50 | 50 | protected $subject; |
51 | 51 | |
52 | - /** |
|
53 | - * @var string[] |
|
54 | - */ |
|
52 | + /** |
|
53 | + * @var string[] |
|
54 | + */ |
|
55 | 55 | protected $log = array(); |
56 | 56 | |
57 | 57 | public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder $placeholder) |
@@ -67,22 +67,22 @@ discard block |
||
67 | 67 | |
68 | 68 | abstract public function requiresAdjustment() : bool; |
69 | 69 | |
70 | - /** |
|
71 | - * @return int|boolean |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @return int|boolean |
|
72 | + */ |
|
73 | 73 | public function getStartPosition() |
74 | 74 | { |
75 | 75 | return $this->subject->getSubstrPosition($this->placeholder->getReplacementText()); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Checks whether the specified position within the string |
|
80 | - * is within another command's placeholder (excluding this |
|
81 | - * location's placeholder). |
|
82 | - * |
|
83 | - * @param int $position |
|
84 | - * @return bool |
|
85 | - */ |
|
78 | + /** |
|
79 | + * Checks whether the specified position within the string |
|
80 | + * is within another command's placeholder (excluding this |
|
81 | + * location's placeholder). |
|
82 | + * |
|
83 | + * @param int $position |
|
84 | + * @return bool |
|
85 | + */ |
|
86 | 86 | public function isWithinCommand(int $position) : bool |
87 | 87 | { |
88 | 88 | $placeholders = $this->formatter->getSafeguard()->getPlaceholders(); |
@@ -114,9 +114,9 @@ discard block |
||
114 | 114 | return false; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * @return int|boolean |
|
119 | - */ |
|
117 | + /** |
|
118 | + * @return int|boolean |
|
119 | + */ |
|
120 | 120 | public function getEndPosition() |
121 | 121 | { |
122 | 122 | $start = $this->getStartPosition(); |
@@ -139,14 +139,14 @@ discard block |
||
139 | 139 | return $this->placeholder; |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Replaces the placeholder with the specified replacement text. |
|
144 | - * |
|
145 | - * @param string $replacementText |
|
146 | - * @throws Mailcode_Exception |
|
147 | - * |
|
148 | - * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND |
|
149 | - */ |
|
142 | + /** |
|
143 | + * Replaces the placeholder with the specified replacement text. |
|
144 | + * |
|
145 | + * @param string $replacementText |
|
146 | + * @throws Mailcode_Exception |
|
147 | + * |
|
148 | + * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND |
|
149 | + */ |
|
150 | 150 | public function replaceWith(string $replacementText) : void |
151 | 151 | { |
152 | 152 | $needle = $this->placeholder->getReplacementText(); |
@@ -189,10 +189,10 @@ discard block |
||
189 | 189 | ); |
190 | 190 | } |
191 | 191 | |
192 | - /** |
|
193 | - * Retrieves the location's log messages, if any. |
|
194 | - * @return string[] |
|
195 | - */ |
|
192 | + /** |
|
193 | + * Retrieves the location's log messages, if any. |
|
194 | + * @return string[] |
|
195 | + */ |
|
196 | 196 | public function getLog() : array |
197 | 197 | { |
198 | 198 | return $this->log; |
@@ -89,23 +89,23 @@ discard block |
||
89 | 89 | |
90 | 90 | $placeholderID = $this->placeholder->getID(); |
91 | 91 | |
92 | - foreach($placeholders as $placeholder) |
|
92 | + foreach ($placeholders as $placeholder) |
|
93 | 93 | { |
94 | - if($placeholder->getID() === $placeholderID) |
|
94 | + if ($placeholder->getID() === $placeholderID) |
|
95 | 95 | { |
96 | 96 | continue; |
97 | 97 | } |
98 | 98 | |
99 | 99 | $start = $this->subject->getSubstrPosition($placeholder->getReplacementText()); |
100 | 100 | |
101 | - if($start === false) |
|
101 | + if ($start === false) |
|
102 | 102 | { |
103 | 103 | continue; |
104 | 104 | } |
105 | 105 | |
106 | 106 | $end = $start + $placeholder->getReplacementLength(); |
107 | 107 | |
108 | - if($position >= $start && $position <= $end) |
|
108 | + if ($position >= $start && $position <= $end) |
|
109 | 109 | { |
110 | 110 | return true; |
111 | 111 | } |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | { |
122 | 122 | $start = $this->getStartPosition(); |
123 | 123 | |
124 | - if($start !== false) |
|
124 | + if ($start !== false) |
|
125 | 125 | { |
126 | 126 | return $start + $this->placeholder->getReplacementLength(); |
127 | 127 | } |
@@ -151,14 +151,14 @@ discard block |
||
151 | 151 | { |
152 | 152 | $needle = $this->placeholder->getReplacementText(); |
153 | 153 | |
154 | - if($this->subject->replaceSubstrings($needle, $replacementText)) |
|
154 | + if ($this->subject->replaceSubstrings($needle, $replacementText)) |
|
155 | 155 | { |
156 | 156 | return; |
157 | 157 | } |
158 | 158 | |
159 | 159 | // Complain about missing placeholders only if we |
160 | 160 | // are not in partial mode. |
161 | - if(!$this->formatter->getFormatting()->isPartial()) |
|
161 | + if (!$this->formatter->getFormatting()->isPartial()) |
|
162 | 162 | { |
163 | 163 | throw new Mailcode_Exception( |
164 | 164 | 'Could not find the placeholder to replace', |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | |
174 | 174 | public function format() : void |
175 | 175 | { |
176 | - if($this->requiresAdjustment() && (!empty($this->prepend) || !empty($this->append))) |
|
176 | + if ($this->requiresAdjustment() && (!empty($this->prepend) || !empty($this->append))) |
|
177 | 177 | { |
178 | 178 | $this->replaceWith(sprintf( |
179 | 179 | '%s%s%s', |
@@ -27,19 +27,19 @@ discard block |
||
27 | 27 | { |
28 | 28 | const ERROR_INVALID_LOCATION_INSTANCE = 65601; |
29 | 29 | |
30 | - /** |
|
31 | - * @var Mailcode_Parser_Safeguard_Formatting |
|
32 | - */ |
|
30 | + /** |
|
31 | + * @var Mailcode_Parser_Safeguard_Formatting |
|
32 | + */ |
|
33 | 33 | protected $formatting; |
34 | 34 | |
35 | - /** |
|
36 | - * @var Mailcode_StringContainer |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var Mailcode_StringContainer |
|
37 | + */ |
|
38 | 38 | protected $subject; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string[] |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string[] |
|
42 | + */ |
|
43 | 43 | protected $log = array(); |
44 | 44 | |
45 | 45 | public function __construct(Mailcode_Parser_Safeguard_Formatting $formatting) |
@@ -93,12 +93,12 @@ discard block |
||
93 | 93 | ); |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Retrieves all formatter-specific placeholder locations |
|
98 | - * in the subject string. |
|
99 | - * |
|
100 | - * @return Mailcode_Parser_Safeguard_Formatter_Location[] |
|
101 | - */ |
|
96 | + /** |
|
97 | + * Retrieves all formatter-specific placeholder locations |
|
98 | + * in the subject string. |
|
99 | + * |
|
100 | + * @return Mailcode_Parser_Safeguard_Formatter_Location[] |
|
101 | + */ |
|
102 | 102 | protected function resolveLocations() : array |
103 | 103 | { |
104 | 104 | $placeholders = $this->formatting->getSafeguard()->getPlaceholders(); |
@@ -113,12 +113,12 @@ discard block |
||
113 | 113 | return $result; |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Resolves the newline character used in the string. |
|
118 | - * |
|
119 | - * @param string $subject |
|
120 | - * @return string |
|
121 | - */ |
|
116 | + /** |
|
117 | + * Resolves the newline character used in the string. |
|
118 | + * |
|
119 | + * @param string $subject |
|
120 | + * @return string |
|
121 | + */ |
|
122 | 122 | protected function resolveNewlineChar(string $subject) : string |
123 | 123 | { |
124 | 124 | $eol = ConvertHelper::detectEOLCharacter($subject); |
@@ -150,9 +150,9 @@ discard block |
||
150 | 150 | ); |
151 | 151 | } |
152 | 152 | |
153 | - /** |
|
154 | - * @return string[] |
|
155 | - */ |
|
153 | + /** |
|
154 | + * @return string[] |
|
155 | + */ |
|
156 | 156 | public function getLog() : array |
157 | 157 | { |
158 | 158 | return $this->log; |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | |
78 | 78 | $instance = new $class($this, $placeholder); |
79 | 79 | |
80 | - if($instance instanceof Mailcode_Parser_Safeguard_Formatter_Location) |
|
80 | + if ($instance instanceof Mailcode_Parser_Safeguard_Formatter_Location) |
|
81 | 81 | { |
82 | 82 | return $instance; |
83 | 83 | } |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | |
106 | 106 | $result = array(); |
107 | 107 | |
108 | - foreach($placeholders as $placeholder) |
|
108 | + foreach ($placeholders as $placeholder) |
|
109 | 109 | { |
110 | 110 | $result[] = $this->createLocation($placeholder); |
111 | 111 | } |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | { |
124 | 124 | $eol = ConvertHelper::detectEOLCharacter($subject); |
125 | 125 | |
126 | - if($eol) |
|
126 | + if ($eol) |
|
127 | 127 | { |
128 | 128 | $this->log(sprintf( |
129 | 129 | 'Detected EOL character: %s.', |
@@ -23,21 +23,21 @@ discard block |
||
23 | 23 | */ |
24 | 24 | trait Mailcode_Traits_Formatting_HTMLHighlighting |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string[] |
|
28 | + */ |
|
29 | 29 | private $excludeTags = array( |
30 | 30 | 'style', // NOTE: style tags are excluded natively on the parser level. |
31 | 31 | 'script' |
32 | 32 | ); |
33 | 33 | |
34 | - /** |
|
35 | - * Adds an HTML tag name to the list of tags within which |
|
36 | - * commands may not be highlighted. |
|
37 | - * |
|
38 | - * @param string $tagName Case insensitive. |
|
39 | - * @return $this |
|
40 | - */ |
|
34 | + /** |
|
35 | + * Adds an HTML tag name to the list of tags within which |
|
36 | + * commands may not be highlighted. |
|
37 | + * |
|
38 | + * @param string $tagName Case insensitive. |
|
39 | + * @return $this |
|
40 | + */ |
|
41 | 41 | public function excludeTag(string $tagName) |
42 | 42 | { |
43 | 43 | $tagName = strtolower($tagName); |
@@ -50,12 +50,12 @@ discard block |
||
50 | 50 | return $this; |
51 | 51 | } |
52 | 52 | |
53 | - /** |
|
54 | - * Adds several exluded tag names at once. |
|
55 | - * |
|
56 | - * @param string[] $tagNames |
|
57 | - * @return $this |
|
58 | - */ |
|
53 | + /** |
|
54 | + * Adds several exluded tag names at once. |
|
55 | + * |
|
56 | + * @param string[] $tagNames |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function excludeTags(array $tagNames) |
60 | 60 | { |
61 | 61 | foreach($tagNames as $tagName) |
@@ -66,12 +66,12 @@ discard block |
||
66 | 66 | return $this; |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Whether the specified tag name is in the exlusion list. |
|
71 | - * |
|
72 | - * @param string $tagName |
|
73 | - * @return bool |
|
74 | - */ |
|
69 | + /** |
|
70 | + * Whether the specified tag name is in the exlusion list. |
|
71 | + * |
|
72 | + * @param string $tagName |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | 75 | public function isTagExcluded(string $tagName) : bool |
76 | 76 | { |
77 | 77 | $tagName = strtolower($tagName); |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | { |
43 | 43 | $tagName = strtolower($tagName); |
44 | 44 | |
45 | - if(!in_array($tagName, $this->excludeTags)) |
|
45 | + if (!in_array($tagName, $this->excludeTags)) |
|
46 | 46 | { |
47 | 47 | $this->excludeTags[] = $tagName; |
48 | 48 | } |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | */ |
59 | 59 | public function excludeTags(array $tagNames) |
60 | 60 | { |
61 | - foreach($tagNames as $tagName) |
|
61 | + foreach ($tagNames as $tagName) |
|
62 | 62 | { |
63 | 63 | $this->excludeTag((string)$tagName); |
64 | 64 | } |
@@ -71,7 +71,7 @@ |
||
71 | 71 | { |
72 | 72 | $tokens = $this->params->getInfo()->getTokens(); |
73 | 73 | |
74 | - if(count($tokens) > 1) |
|
74 | + if (count($tokens) > 1) |
|
75 | 75 | { |
76 | 76 | $this->validationResult->makeError( |
77 | 77 | t('Unknown parameters found:').' '. |