Passed
Push — master ( 707ba4...19aa6f )
by Sebastian
02:43
created
src/Mailcode/Parser/Safeguard/Formatter/FormatType.php 2 patches
Indentation   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -25,11 +25,11 @@
 block discarded – undo
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();
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@
 block discarded – undo
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
             
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatting.php 2 patches
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
             }
Please login to merge, or discard this patch.
Indentation   +67 added lines, -67 removed lines patch added patch discarded remove patch
@@ -32,29 +32,29 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard.php 3 patches
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -260,8 +260,7 @@
 block discarded – undo
260 260
         if($highlighted)
261 261
         {
262 262
             $formatting->replaceWithHTMLHighlighting();
263
-        }
264
-        else 
263
+        } else 
265 264
         {
266 265
             $formatting->replaceWithNormalized();
267 266
         }
Please login to merge, or discard this patch.
Spacing   +21 added lines, -21 removed lines patch added patch discarded remove patch
@@ -180,7 +180,7 @@  discard block
 block discarded – undo
180 180
         $placeholders = $this->getPlaceholders();
181 181
         $string = $this->originalString;
182 182
         
183
-        foreach($placeholders as $placeholder)
183
+        foreach ($placeholders as $placeholder)
184 184
         {
185 185
             $string = $this->makePlaceholderSafe($string, $placeholder);
186 186
         }
@@ -210,14 +210,14 @@  discard block
 block discarded – undo
210 210
         $placeholders = $this->getPlaceholders();
211 211
         $total = count($placeholders);
212 212
 
213
-        for($i=0; $i < $total; $i++)
213
+        for ($i = 0; $i < $total; $i++)
214 214
         {
215 215
             $placeholder = $placeholders[$i];
216 216
             $command = $placeholder->getCommand();
217 217
 
218
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
218
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
219 219
             {
220
-                $string = $command->protectContent($string, $placeholder, $placeholders[$i+1]);
220
+                $string = $command->protectContent($string, $placeholder, $placeholders[$i + 1]);
221 221
             }
222 222
         }
223 223
 
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
     {
229 229
         $pos = mb_strpos($string, $placeholder->getOriginalText());
230 230
 
231
-        if($pos === false)
231
+        if ($pos === false)
232 232
         {
233 233
             throw new Mailcode_Exception(
234 234
                 'Placeholder original text not found',
@@ -267,7 +267,7 @@  discard block
 block discarded – undo
267 267
     */
268 268
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
269 269
     {
270
-        if(is_string($subject))
270
+        if (is_string($subject))
271 271
         {
272 272
             $subject = Mailcode::create()->createString($subject);
273 273
         }
@@ -283,7 +283,7 @@  discard block
 block discarded – undo
283 283
     */
284 284
     public function getPlaceholders()
285 285
     {
286
-        if(isset($this->placeholders))
286
+        if (isset($this->placeholders))
287 287
         {
288 288
             return $this->placeholders;
289 289
         }
@@ -292,7 +292,7 @@  discard block
 block discarded – undo
292 292
         
293 293
         $cmds = $this->getCollection()->getCommands();
294 294
         
295
-        foreach($cmds as $command)
295
+        foreach ($cmds as $command)
296 296
         {
297 297
             self::$counter++;
298 298
             
@@ -313,21 +313,21 @@  discard block
 block discarded – undo
313 313
      * @return string
314 314
      * @throws Mailcode_Exception
315 315
      */
316
-    protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string
316
+    protected function restore(string $string, bool $partial = false, bool $highlighted = false) : string
317 317
     {
318
-        if(!$partial)
318
+        if (!$partial)
319 319
         {
320 320
             $this->requireValidCollection();
321 321
         }
322 322
         
323 323
         $formatting = $this->createFormatting($string);
324 324
 
325
-        if($partial)
325
+        if ($partial)
326 326
         {
327 327
             $formatting->makePartial();
328 328
         }
329 329
         
330
-        if($highlighted)
330
+        if ($highlighted)
331 331
         {
332 332
             $formatting->replaceWithHTMLHighlighting();
333 333
         }
@@ -347,7 +347,7 @@  discard block
 block discarded – undo
347 347
         {
348 348
             $command = $placeholder->getCommand();
349 349
 
350
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
350
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
351 351
             {
352 352
                 $string = $command->restoreContent($string);
353 353
             }
@@ -440,7 +440,7 @@  discard block
 block discarded – undo
440 440
     */
441 441
     public function getCollection() : Mailcode_Collection
442 442
     {
443
-        if(isset($this->collection))
443
+        if (isset($this->collection))
444 444
         {
445 445
             return $this->collection;
446 446
         }
@@ -462,7 +462,7 @@  discard block
 block discarded – undo
462 462
     */
463 463
     protected function requireValidCollection() : void
464 464
     {
465
-        if($this->getCollection()->isValid())
465
+        if ($this->getCollection()->isValid())
466 466
         {
467 467
             return;
468 468
         }
@@ -485,7 +485,7 @@  discard block
 block discarded – undo
485 485
     */
486 486
     public function getPlaceholderStrings() : array
487 487
     {
488
-        if(is_array($this->placeholderStrings))
488
+        if (is_array($this->placeholderStrings))
489 489
         {
490 490
             return $this->placeholderStrings;
491 491
         }
@@ -494,7 +494,7 @@  discard block
 block discarded – undo
494 494
         
495 495
         $this->placeholderStrings = array();
496 496
         
497
-        foreach($placeholders as $placeholder)
497
+        foreach ($placeholders as $placeholder)
498 498
         {
499 499
             $this->placeholderStrings[] = $placeholder->getReplacementText();
500 500
         }
@@ -520,9 +520,9 @@  discard block
 block discarded – undo
520 520
     {
521 521
         $placeholders = $this->getPlaceholders();
522 522
         
523
-        foreach($placeholders as $placeholder)
523
+        foreach ($placeholders as $placeholder)
524 524
         {
525
-            if($placeholder->getID() === $id)
525
+            if ($placeholder->getID() === $id)
526 526
             {
527 527
                 return $placeholder;
528 528
             }
@@ -549,9 +549,9 @@  discard block
 block discarded – undo
549 549
     {
550 550
         $placeholders = $this->getPlaceholders();
551 551
         
552
-        foreach($placeholders as $placeholder)
552
+        foreach ($placeholders as $placeholder)
553 553
         {
554
-            if($placeholder->getReplacementText() === $string)
554
+            if ($placeholder->getReplacementText() === $string)
555 555
             {
556 556
                 return $placeholder;
557 557
             }
Please login to merge, or discard this patch.
Indentation   +144 added lines, -144 removed lines patch added patch discarded remove patch
@@ -54,45 +54,45 @@  discard block
 block discarded – undo
54 54
     const ERROR_INVALID_COMMANDS = 47801;
55 55
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
56 56
 
57
-   /**
58
-    * @var Mailcode_Parser
59
-    */
57
+    /**
58
+     * @var Mailcode_Parser
59
+     */
60 60
     protected $parser;
61 61
     
62
-   /**
63
-    * @var Mailcode_Collection
64
-    */
62
+    /**
63
+     * @var Mailcode_Collection
64
+     */
65 65
     protected $commands;
66 66
     
67
-   /**
68
-    * @var string
69
-    */
67
+    /**
68
+     * @var string
69
+     */
70 70
     protected $originalString;
71 71
     
72
-   /**
73
-    * @var Mailcode_Collection
74
-    */
72
+    /**
73
+     * @var Mailcode_Collection
74
+     */
75 75
     protected $collection;
76 76
     
77
-   /**
78
-    * Counter for the placeholders, global for all placeholders.
79
-    * @var integer
80
-    */
77
+    /**
78
+     * Counter for the placeholders, global for all placeholders.
79
+     * @var integer
80
+     */
81 81
     private static $counter = 0;
82 82
     
83
-   /**
84
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
85
-    */
83
+    /**
84
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
85
+     */
86 86
     protected $placeholders;
87 87
     
88
-   /**
89
-    * @var string
90
-    */
88
+    /**
89
+     * @var string
90
+     */
91 91
     protected $delimiter = '999';
92 92
     
93
-   /**
94
-    * @var string[]|NULL
95
-    */
93
+    /**
94
+     * @var string[]|NULL
95
+     */
96 96
     protected $placeholderStrings;
97 97
 
98 98
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -111,28 +111,28 @@  discard block
 block discarded – undo
111 111
         self::$counter = 0;
112 112
     }
113 113
     
114
-   /**
115
-    * Retrieves the string the safeguard was created for.
116
-    * 
117
-    * @return string
118
-    */
114
+    /**
115
+     * Retrieves the string the safeguard was created for.
116
+     * 
117
+     * @return string
118
+     */
119 119
     public function getOriginalString() : string
120 120
     {
121 121
         return $this->originalString;
122 122
     }
123 123
     
124
-   /**
125
-    * Sets the delimiter character sequence used to prepend
126
-    * and append to the placeholders.
127
-    * 
128
-    * The delimiter's default is "999".
129
-    *
130
-    * Minimum characters: 2
131
-    * Invalid characters: Any characters that get URL encoded
132
-    *
133
-    * @param string $delimiter
134
-    * @return Mailcode_Parser_Safeguard
135
-    */
124
+    /**
125
+     * Sets the delimiter character sequence used to prepend
126
+     * and append to the placeholders.
127
+     * 
128
+     * The delimiter's default is "999".
129
+     *
130
+     * Minimum characters: 2
131
+     * Invalid characters: Any characters that get URL encoded
132
+     *
133
+     * @param string $delimiter
134
+     * @return Mailcode_Parser_Safeguard
135
+     */
136 136
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
137 137
     {
138 138
         $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter);
@@ -148,15 +148,15 @@  discard block
 block discarded – undo
148 148
         return $this->delimiter;
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves the safe string in which all commands have been replaced
153
-    * by placeholder strings.
154
-    *
155
-    * @return string
156
-    * @throws Mailcode_Exception 
157
-    *
158
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
-    */
151
+    /**
152
+     * Retrieves the safe string in which all commands have been replaced
153
+     * by placeholder strings.
154
+     *
155
+     * @return string
156
+     * @throws Mailcode_Exception 
157
+     *
158
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
+     */
160 160
     public function makeSafe() : string
161 161
     {
162 162
         $this->requireValidCollection();
@@ -164,16 +164,16 @@  discard block
 block discarded – undo
164 164
         return $this->makeSafePartial();
165 165
     }
166 166
     
167
-   /**
168
-    * Like makeSafe(), but allows partial (invalid) commands: use this
169
-    * if the subject string may contain only part of the whole set of
170
-    * commands. 
171
-    * 
172
-    * Example: parsing a text with an opening if statement, without the 
173
-    * matching end statement.
174
-    * 
175
-    * @return string
176
-    */
167
+    /**
168
+     * Like makeSafe(), but allows partial (invalid) commands: use this
169
+     * if the subject string may contain only part of the whole set of
170
+     * commands. 
171
+     * 
172
+     * Example: parsing a text with an opening if statement, without the 
173
+     * matching end statement.
174
+     * 
175
+     * @return string
176
+     */
177 177
     public function makeSafePartial() : string
178 178
     {
179 179
         $placeholders = $this->getPlaceholders();
@@ -257,13 +257,13 @@  discard block
 block discarded – undo
257 257
         $analyzer->analyze();
258 258
     }
259 259
     
260
-   /**
261
-    * Creates a formatting handler, which can be used to specify
262
-    * which formattings to use for the commands in the subject string.
263
-    * 
264
-    * @param Mailcode_StringContainer|string $subject
265
-    * @return Mailcode_Parser_Safeguard_Formatting
266
-    */
260
+    /**
261
+     * Creates a formatting handler, which can be used to specify
262
+     * which formattings to use for the commands in the subject string.
263
+     * 
264
+     * @param Mailcode_StringContainer|string $subject
265
+     * @return Mailcode_Parser_Safeguard_Formatting
266
+     */
267 267
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
268 268
     {
269 269
         if(is_string($subject))
@@ -274,12 +274,12 @@  discard block
 block discarded – undo
274 274
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
275 275
     }
276 276
     
277
-   /**
278
-    * Retrieves all placeholders that have to be added to
279
-    * the subject text.
280
-    * 
281
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
-    */
277
+    /**
278
+     * Retrieves all placeholders that have to be added to
279
+     * the subject text.
280
+     * 
281
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
+     */
283 283
     public function getPlaceholders()
284 284
     {
285 285
         if(isset($this->placeholders))
@@ -355,16 +355,16 @@  discard block
 block discarded – undo
355 355
         return $string;
356 356
     }
357 357
     
358
-   /**
359
-    * Makes the string whole again after transforming or filtering it,
360
-    * by replacing the command placeholders with the original commands.
361
-    *
362
-    * @param string $string
363
-    * @return string
364
-    * @throws Mailcode_Exception
365
-    *
366
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
367
-    */
358
+    /**
359
+     * Makes the string whole again after transforming or filtering it,
360
+     * by replacing the command placeholders with the original commands.
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 makeWhole(string $string) : string
369 369
     {
370 370
         return $this->restore(
@@ -374,15 +374,15 @@  discard block
 block discarded – undo
374 374
         );
375 375
     }
376 376
     
377
-   /**
378
-    * Like `makeWhole()`, but ignores missing command placeholders.
379
-    *
380
-    * @param string $string
381
-    * @return string
382
-    * @throws Mailcode_Exception
383
-    *
384
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
-    */
377
+    /**
378
+     * Like `makeWhole()`, but ignores missing command placeholders.
379
+     *
380
+     * @param string $string
381
+     * @return string
382
+     * @throws Mailcode_Exception
383
+     *
384
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
+     */
386 386
     public function makeWholePartial(string $string) : string
387 387
     {
388 388
         return $this->restore(
@@ -392,19 +392,19 @@  discard block
 block discarded – undo
392 392
         );
393 393
     }
394 394
 
395
-   /**
396
-    * Like `makeWhole()`, but replaces the commands with a syntax
397
-    * highlighted version, meant for human readable texts only.
398
-    * 
399
-    * Note: the commands lose their functionality (They cannot be 
400
-    * parsed from that string again).
401
-    *
402
-    * @param string $string
403
-    * @return string
404
-    * @throws Mailcode_Exception
405
-    *
406
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
-    */
395
+    /**
396
+     * Like `makeWhole()`, but replaces the commands with a syntax
397
+     * highlighted version, meant for human readable texts only.
398
+     * 
399
+     * Note: the commands lose their functionality (They cannot be 
400
+     * parsed from that string again).
401
+     *
402
+     * @param string $string
403
+     * @return string
404
+     * @throws Mailcode_Exception
405
+     *
406
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
+     */
408 408
     public function makeHighlighted(string $string) : string
409 409
     {
410 410
         return $this->restore(
@@ -414,15 +414,15 @@  discard block
 block discarded – undo
414 414
         );
415 415
     }
416 416
     
417
-   /**
418
-    * Like `makeHighlighted()`, but ignores missing command placeholders.
419
-    * 
420
-    * @param string $string
421
-    * @return string
422
-    * @throws Mailcode_Exception
423
-    *
424
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
-    */
417
+    /**
418
+     * Like `makeHighlighted()`, but ignores missing command placeholders.
419
+     * 
420
+     * @param string $string
421
+     * @return string
422
+     * @throws Mailcode_Exception
423
+     *
424
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
+     */
426 426
     public function makeHighlightedPartial(string $string) : string
427 427
     {
428 428
         return $this->restore(
@@ -432,11 +432,11 @@  discard block
 block discarded – undo
432 432
         );
433 433
     }
434 434
     
435
-   /**
436
-    * Retrieves the commands collection contained in the string.
437
-    * 
438
-    * @return Mailcode_Collection
439
-    */
435
+    /**
436
+     * Retrieves the commands collection contained in the string.
437
+     * 
438
+     * @return Mailcode_Collection
439
+     */
440 440
     public function getCollection() : Mailcode_Collection
441 441
     {
442 442
         if(isset($this->collection))
@@ -454,11 +454,11 @@  discard block
 block discarded – undo
454 454
         return $this->getCollection()->isValid();
455 455
     }
456 456
     
457
-   /**
458
-    * @throws Mailcode_Exception
459
-    * 
460
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
-    */
457
+    /**
458
+     * @throws Mailcode_Exception
459
+     * 
460
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
+     */
462 462
     protected function requireValidCollection() : void
463 463
     {
464 464
         if($this->getCollection()->isValid())
@@ -477,11 +477,11 @@  discard block
 block discarded – undo
477 477
         );
478 478
     }
479 479
     
480
-   /**
481
-    * Retrieves a list of all placeholder IDs used in the text.
482
-    * 
483
-    * @return string[]
484
-    */
480
+    /**
481
+     * Retrieves a list of all placeholder IDs used in the text.
482
+     * 
483
+     * @return string[]
484
+     */
485 485
     public function getPlaceholderStrings() : array
486 486
     {
487 487
         if(is_array($this->placeholderStrings))
@@ -508,13 +508,13 @@  discard block
 block discarded – undo
508 508
         return in_array($subject, $ids, true);
509 509
     }
510 510
     
511
-   /**
512
-    * Retrieves a placeholder instance by its ID.
513
-    * 
514
-    * @param int $id
515
-    * @throws Mailcode_Exception If the placeholder was not found.
516
-    * @return Mailcode_Parser_Safeguard_Placeholder
517
-    */
511
+    /**
512
+     * Retrieves a placeholder instance by its ID.
513
+     * 
514
+     * @param int $id
515
+     * @throws Mailcode_Exception If the placeholder was not found.
516
+     * @return Mailcode_Parser_Safeguard_Placeholder
517
+     */
518 518
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
519 519
     {
520 520
         $placeholders = $this->getPlaceholders();
@@ -537,13 +537,13 @@  discard block
 block discarded – undo
537 537
         );
538 538
     }
539 539
     
540
-   /**
541
-    * Retrieves a placeholder instance by its replacement text.
542
-    * 
543
-    * @param string $string
544
-    * @throws Mailcode_Exception
545
-    * @return Mailcode_Parser_Safeguard_Placeholder
546
-    */
540
+    /**
541
+     * Retrieves a placeholder instance by its replacement text.
542
+     * 
543
+     * @param string $string
544
+     * @throws Mailcode_Exception
545
+     * @return Mailcode_Parser_Safeguard_Placeholder
546
+     */
547 547
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
548 548
     {
549 549
         $placeholders = $this->getPlaceholders();
Please login to merge, or discard this patch.
src/Mailcode/StringContainer.php 2 patches
Indentation   +66 added lines, -66 removed lines patch added patch discarded remove patch
@@ -26,39 +26,39 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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);
Please login to merge, or discard this patch.
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -88,12 +88,12 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
     }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Location.php 2 patches
Indentation   +44 added lines, -44 removed lines patch added patch discarded remove patch
@@ -24,34 +24,34 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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;
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -89,23 +89,23 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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',
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter.php 2 patches
Indentation   +24 added lines, -24 removed lines patch added patch discarded remove patch
@@ -27,19 +27,19 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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;
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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.', 
Please login to merge, or discard this patch.
src/Mailcode/Traits/Formatting/HTMLHighlighting.php 2 patches
Indentation   +22 added lines, -22 removed lines patch added patch discarded remove patch
@@ -23,21 +23,21 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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);
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser.php 3 patches
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -146,8 +146,7 @@  discard block
 block discarded – undo
146 146
         if($cmd instanceof Mailcode_Commands_Command_Type_Opening)
147 147
         {
148 148
             $this->stack[] = $cmd;
149
-        }
150
-        else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
149
+        } else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
151 150
         {
152 151
             array_pop($this->stack);
153 152
         }
@@ -177,13 +176,11 @@  discard block
 block discarded – undo
177 176
         if(!empty($matches[1][$index]))
178 177
         {
179 178
             $name = $matches[1][$index];
180
-        }
181
-        else if(!empty($matches[2][$index]))
179
+        } else if(!empty($matches[2][$index]))
182 180
         {
183 181
             $name = $matches[2][$index];
184 182
             $params = $matches[3][$index];
185
-        }
186
-        else if(!empty($matches[4][$index]))
183
+        } else if(!empty($matches[4][$index]))
187 184
         {
188 185
             $name = $matches[4][$index];
189 186
             $type = $matches[5][$index];
Please login to merge, or discard this patch.
Indentation   +43 added lines, -43 removed lines patch added patch discarded remove patch
@@ -30,14 +30,14 @@  discard block
 block discarded – undo
30 30
         '{\s*([a-z]+)\s+([a-z-]+)\s*:([^}]*)}'
31 31
     );
32 32
     
33
-   /**
34
-    * @var Mailcode
35
-    */
33
+    /**
34
+     * @var Mailcode
35
+     */
36 36
     protected $mailcode;
37 37
     
38
-   /**
39
-    * @var Mailcode_Commands
40
-    */
38
+    /**
39
+     * @var Mailcode_Commands
40
+     */
41 41
     protected $commands;
42 42
 
43 43
     /**
@@ -51,24 +51,24 @@  discard block
 block discarded – undo
51 51
         $this->commands = $this->mailcode->getCommands();
52 52
     }
53 53
     
54
-   /**
55
-    * Gets the regex format string used to detect commands.
56
-    * 
57
-    * @return string
58
-    */
54
+    /**
55
+     * Gets the regex format string used to detect commands.
56
+     * 
57
+     * @return string
58
+     */
59 59
     protected static function getRegex() : string
60 60
     {
61 61
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
62 62
     }
63 63
     
64
-   /**
65
-    * Parses a string to detect all commands within. Returns a
66
-    * collection instance that contains information on all the 
67
-    * commands.
68
-    * 
69
-    * @param string $string
70
-    * @return Mailcode_Collection A collection with all unique commands found.
71
-    */
64
+    /**
65
+     * Parses a string to detect all commands within. Returns a
66
+     * collection instance that contains information on all the 
67
+     * commands.
68
+     * 
69
+     * @param string $string
70
+     * @return Mailcode_Collection A collection with all unique commands found.
71
+     */
72 72
     public function parseString(string $string) : Mailcode_Collection
73 73
     {
74 74
         $collection = new Mailcode_Collection();
@@ -103,14 +103,14 @@  discard block
 block discarded – undo
103 103
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
104 104
     }
105 105
     
106
-   /**
107
-    * Processes a single match found in the string: creates the command,
108
-    * and adds it to the collection if it's a valid command, or to the list
109
-    * of invalid commands otherwise.
110
-    * 
111
-    * @param Mailcode_Parser_Match $match
112
-    * @param Mailcode_Collection $collection
113
-    */
106
+    /**
107
+     * Processes a single match found in the string: creates the command,
108
+     * and adds it to the collection if it's a valid command, or to the list
109
+     * of invalid commands otherwise.
110
+     * 
111
+     * @param Mailcode_Parser_Match $match
112
+     * @param Mailcode_Collection $collection
113
+     */
114 114
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
115 115
     {
116 116
         $name = $match->getName();
@@ -173,14 +173,14 @@  discard block
 block discarded – undo
173 173
         throw new Mailcode_Exception('Not a command', '', self::ERROR_NOT_A_COMMAND);
174 174
     }
175 175
     
176
-   /**
177
-    * Parses a single regex match: determines which named group
178
-    * matches, and retrieves the according information.
179
-    * 
180
-    * @param array[] $matches The regex results array.
181
-    * @param int $index The matched index.
182
-    * @return Mailcode_Parser_Match
183
-    */
176
+    /**
177
+     * Parses a single regex match: determines which named group
178
+     * matches, and retrieves the according information.
179
+     * 
180
+     * @param array[] $matches The regex results array.
181
+     * @param int $index The matched index.
182
+     * @return Mailcode_Parser_Match
183
+     */
184 184
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
185 185
     {
186 186
         $name = ''; // the command name, e.g. "showvar"
@@ -218,14 +218,14 @@  discard block
 block discarded – undo
218 218
         );
219 219
     }
220 220
     
221
-   /**
222
-    * Creates an instance of the safeguard tool, which
223
-    * is used to safeguard commands in a string with placeholders.
224
-    * 
225
-    * @param string $subject The string to use to safeguard commands in.
226
-    * @return Mailcode_Parser_Safeguard
227
-    * @see Mailcode_Parser_Safeguard
228
-    */
221
+    /**
222
+     * Creates an instance of the safeguard tool, which
223
+     * is used to safeguard commands in a string with placeholders.
224
+     * 
225
+     * @param string $subject The string to use to safeguard commands in.
226
+     * @return Mailcode_Parser_Safeguard
227
+     * @see Mailcode_Parser_Safeguard
228
+     */
229 229
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
230 230
     {
231 231
         return new Mailcode_Parser_Safeguard($this, $subject);
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
         
81 81
         $total = count($matches[0]);
82 82
         
83
-        for($i=0; $i < $total; $i++)
83
+        for ($i = 0; $i < $total; $i++)
84 84
         {
85 85
             $match = $this->parseMatch($matches, $i);
86 86
             
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
 
95 95
     protected function prepareString(string $subject) : string
96 96
     {
97
-        if(!ConvertHelper::isStringHTML($subject))
97
+        if (!ConvertHelper::isStringHTML($subject))
98 98
         {
99 99
             return $subject;
100 100
         }
@@ -145,17 +145,17 @@  discard block
 block discarded – undo
145 145
     private function handleNesting(Mailcode_Commands_Command $cmd) : void
146 146
     {
147 147
         // Set the command's parent from the stack, if any is present.
148
-        if(!empty($this->stack))
148
+        if (!empty($this->stack))
149 149
         {
150 150
             $cmd->setParent($this->getStackLast());
151 151
         }
152 152
 
153 153
         // Handle opening and closing commands, adding and removing from the stack.
154
-        if($cmd instanceof Mailcode_Commands_Command_Type_Opening)
154
+        if ($cmd instanceof Mailcode_Commands_Command_Type_Opening)
155 155
         {
156 156
             $this->stack[] = $cmd;
157 157
         }
158
-        else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
158
+        else if ($cmd instanceof Mailcode_Commands_Command_Type_Closing)
159 159
         {
160 160
             array_pop($this->stack);
161 161
         }
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
     {
166 166
         $cmd = $this->stack[array_key_last($this->stack)];
167 167
 
168
-        if($cmd instanceof Mailcode_Commands_Command)
168
+        if ($cmd instanceof Mailcode_Commands_Command)
169 169
         {
170 170
             return $cmd;
171 171
         }
@@ -194,16 +194,16 @@  discard block
 block discarded – undo
194 194
         // 5 = parameter type command, type
195 195
         // 6 = parameter type command, params
196 196
         
197
-        if(!empty($matches[1][$index]))
197
+        if (!empty($matches[1][$index]))
198 198
         {
199 199
             $name = $matches[1][$index];
200 200
         }
201
-        else if(!empty($matches[2][$index]))
201
+        else if (!empty($matches[2][$index]))
202 202
         {
203 203
             $name = $matches[2][$index];
204 204
             $params = $matches[3][$index];
205 205
         }
206
-        else if(!empty($matches[4][$index]))
206
+        else if (!empty($matches[4][$index]))
207 207
         {
208 208
             $name = $matches[4][$index];
209 209
             $type = $matches[5][$index];
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
      * @param Mailcode_Commands_Command|null $sourceCommand
241 241
      * @return Mailcode_Parser_Statement
242 242
      */
243
-    public function createStatement(string $statement, bool $freeform=false, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Parser_Statement
243
+    public function createStatement(string $statement, bool $freeform = false, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Parser_Statement
244 244
     {
245 245
         return new Mailcode_Parser_Statement($statement, $freeform, $sourceCommand);
246 246
     }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Type/MarkVariables.php 1 patch
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -60,7 +60,7 @@  discard block
 block discarded – undo
60 60
     
61 61
     public function setTemplate(string $template) : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
62 62
     {
63
-        if(substr_count($template, '%s') !== 1)
63
+        if (substr_count($template, '%s') !== 1)
64 64
         {
65 65
             throw new Mailcode_Exception(
66 66
                 'Invalid tag template',
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
         $parts = explode('%s', $this->getTemplate());
102 102
         $tag = array_shift($parts);
103 103
 
104
-        if($this->templateMode === self::TEMPLATE_MODE_INLINE)
104
+        if ($this->templateMode === self::TEMPLATE_MODE_INLINE)
105 105
         {
106 106
             $tag = str_replace('__STYLES__', $this->getInlineStyles(), $tag);
107 107
         }
@@ -129,12 +129,12 @@  discard block
 block discarded – undo
129 129
         $styles = '';
130 130
         $regex = '/\.'.self::DEFAULT_CLASS_NAME.'{([^}]+)}/';
131 131
 
132
-        if(preg_match($regex, $this->getCSS(), $matches))
132
+        if (preg_match($regex, $this->getCSS(), $matches))
133 133
         {
134 134
             $styles = $matches[1];
135 135
         }
136 136
 
137
-        if(empty($styles))
137
+        if (empty($styles))
138 138
         {
139 139
             throw new Mailcode_Exception(
140 140
                 'Cannot extract styles.',
@@ -191,7 +191,7 @@  discard block
 block discarded – undo
191 191
         $file = MAILCODE_INSTALL_FOLDER.'/css/marked-variables.css';
192 192
         $path = realpath($file);
193 193
 
194
-        if($path !== false)
194
+        if ($path !== false)
195 195
         {
196 196
             return $path;
197 197
         }
Please login to merge, or discard this patch.