Passed
Push — master ( 89d9c2...d06d8f )
by Sebastian
02:25
created
localization/index.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -12,7 +12,7 @@
 block discarded – undo
12 12
     $autoload = realpath($root.'/../vendor/autoload.php');
13 13
     
14 14
     // we need the autoloader to be present
15
-    if($autoload === false) 
15
+    if ($autoload === false) 
16 16
     {
17 17
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
18 18
     }
Please login to merge, or discard this patch.
src/Mailcode/Commands.php 2 patches
Indentation   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -23,16 +23,16 @@  discard block
 block discarded – undo
23 23
 {
24 24
     const ERROR_COMMAND_NAME_DOES_NOT_EXIST = 45901;
25 25
     
26
-   /**
27
-    * @var Mailcode_Commands_Command[]
28
-    */
26
+    /**
27
+     * @var Mailcode_Commands_Command[]
28
+     */
29 29
     private $commands = array();
30 30
     
31
-   /**
32
-    * Retrieves a list of all available command IDs.
33
-    * 
34
-    * @return string[]
35
-    */
31
+    /**
32
+     * Retrieves a list of all available command IDs.
33
+     * 
34
+     * @return string[]
35
+     */
36 36
     public function getIDs() : array
37 37
     {
38 38
         static $ids = array();
@@ -45,13 +45,13 @@  discard block
 block discarded – undo
45 45
         return $ids;
46 46
     }
47 47
     
48
-   /**
49
-    * Retrieves a list of all available commands, sorted by label.
50
-    * 
51
-    * NOTE: These instances are only used for information purposes.
52
-    * 
53
-    * @return Mailcode_Commands_Command[]
54
-    */
48
+    /**
49
+     * Retrieves a list of all available commands, sorted by label.
50
+     * 
51
+     * NOTE: These instances are only used for information purposes.
52
+     * 
53
+     * @return Mailcode_Commands_Command[]
54
+     */
55 55
     public function getAll()
56 56
     {
57 57
         if(!empty($this->commands)) {
@@ -77,12 +77,12 @@  discard block
 block discarded – undo
77 77
         return $result;
78 78
     }
79 79
     
80
-   /**
81
-    * Gets an available command by its ID.
82
-    * 
83
-    * @param string $id
84
-    * @return Mailcode_Commands_Command
85
-    */
80
+    /**
81
+     * Gets an available command by its ID.
82
+     * 
83
+     * @param string $id
84
+     * @return Mailcode_Commands_Command
85
+     */
86 86
     public function getByID(string $id) : Mailcode_Commands_Command
87 87
     {
88 88
         static $instances = array();
@@ -95,15 +95,15 @@  discard block
 block discarded – undo
95 95
         return $instances[$id];
96 96
     }
97 97
     
98
-   /**
99
-    * Retrieves the ID of a command by its name.
100
-    * 
101
-    * @param string $name
102
-    * @throws Mailcode_Exception
103
-    * @return string
104
-    * 
105
-    * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
106
-    */
98
+    /**
99
+     * Retrieves the ID of a command by its name.
100
+     * 
101
+     * @param string $name
102
+     * @throws Mailcode_Exception
103
+     * @return string
104
+     * 
105
+     * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
106
+     */
107 107
     public function getIDByName(string $name) : string
108 108
     {
109 109
         $items = $this->getAll();
@@ -132,12 +132,12 @@  discard block
 block discarded – undo
132 132
         return in_array($id, $ids);
133 133
     }
134 134
     
135
-   /**
136
-    * Checks wether the specified name exists.
137
-    * 
138
-    * @param string $name For example: "showvar".
139
-    * @return bool
140
-    */
135
+    /**
136
+     * Checks wether the specified name exists.
137
+     * 
138
+     * @param string $name For example: "showvar".
139
+     * @return bool
140
+     */
141 141
     public function nameExists(string $name) : bool
142 142
     {
143 143
         $items = $this->getAll();
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -37,7 +37,7 @@  discard block
 block discarded – undo
37 37
     {
38 38
         static $ids = array();
39 39
         
40
-        if(empty($ids)) {
40
+        if (empty($ids)) {
41 41
             $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command')
42 42
             ->getPHPClassNames();
43 43
         }
@@ -54,7 +54,7 @@  discard block
 block discarded – undo
54 54
     */
55 55
     public function getAll()
56 56
     {
57
-        if(!empty($this->commands)) {
57
+        if (!empty($this->commands)) {
58 58
             return $this->commands;
59 59
         }
60 60
         
@@ -62,7 +62,7 @@  discard block
 block discarded – undo
62 62
         
63 63
         $result = array();
64 64
         
65
-        foreach($ids as $id) 
65
+        foreach ($ids as $id) 
66 66
         {
67 67
             $result[] = $this->getByID($id);
68 68
         }
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
     {
88 88
         static $instances = array();
89 89
         
90
-        if(!isset($instances[$id])) 
90
+        if (!isset($instances[$id])) 
91 91
         {
92 92
             $instances[$id] = $this->createCommand($id, '__dummy', '', '');
93 93
         }
@@ -108,9 +108,9 @@  discard block
 block discarded – undo
108 108
     {
109 109
         $items = $this->getAll();
110 110
         
111
-        foreach($items as $item) 
111
+        foreach ($items as $item) 
112 112
         {
113
-            if($item->getName() === $name) {
113
+            if ($item->getName() === $name) {
114 114
                 return $item->getID();
115 115
             }
116 116
         }
@@ -142,9 +142,9 @@  discard block
 block discarded – undo
142 142
     {
143 143
         $items = $this->getAll();
144 144
         
145
-        foreach($items as $item)
145
+        foreach ($items as $item)
146 146
         {
147
-            if($item->getName() === $name) {
147
+            if ($item->getName() === $name) {
148 148
                 return true;
149 149
             }
150 150
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Placeholder.php 2 patches
Indentation   +12 added lines, -12 removed lines patch added patch discarded remove patch
@@ -25,24 +25,24 @@
 block discarded – undo
25 25
 {
26 26
     const ERROR_PLACEHOLDER_TOO_LONG = 47901;
27 27
     
28
-   /**
29
-    * @var int
30
-    */
28
+    /**
29
+     * @var int
30
+     */
31 31
     protected $id;
32 32
     
33
-   /**
34
-    * @var Mailcode_Parser_Safeguard
35
-    */
33
+    /**
34
+     * @var Mailcode_Parser_Safeguard
35
+     */
36 36
     protected $safeguard;
37 37
 
38
-   /**
39
-    * @var Mailcode_Commands_Command
40
-    */
38
+    /**
39
+     * @var Mailcode_Commands_Command
40
+     */
41 41
     protected $command;
42 42
     
43
-   /**
44
-    * @var string
45
-    */
43
+    /**
44
+     * @var string
45
+     */
46 46
     protected $replacement = '';
47 47
     
48 48
     public function __construct(int $id, Mailcode_Commands_Command $command, Mailcode_Parser_Safeguard $safeguard)
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -64,7 +64,7 @@  discard block
 block discarded – undo
64 64
     
65 65
     public function getReplacementText() : string
66 66
     {
67
-        if(!empty($this->replacement))
67
+        if (!empty($this->replacement))
68 68
         {
69 69
             return $this->replacement;
70 70
         }
@@ -82,13 +82,13 @@  discard block
 block discarded – undo
82 82
         // to total amount of zeroes to pad with to obtain the total length
83 83
         $padLength = $this->getLength() - $length;
84 84
         
85
-        if($padLength < 0) 
85
+        if ($padLength < 0) 
86 86
         {
87 87
             $padLength = 0;
88 88
         }
89 89
         
90 90
         // create the zero-padded ID to fill the format string with 
91
-        $paddedID  = str_pad((string)$this->id, $padLength, '0');
91
+        $paddedID = str_pad((string)$this->id, $padLength, '0');
92 92
         
93 93
         $this->replacement = sprintf($format, $paddedID);
94 94
         
Please login to merge, or discard this patch.
src/Mailcode/Parser.php 3 patches
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
         
70 70
         $total = count($matches[0]);
71 71
         
72
-        for($i=0; $i < $total; $i++)
72
+        for ($i = 0; $i < $total; $i++)
73 73
         {
74 74
             $match = $this->parseMatch($matches, $i);
75 75
             
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
91 91
     {
92 92
         $name = $match->getName();
93 93
         
94
-        if(!$this->commands->nameExists($name))
94
+        if (!$this->commands->nameExists($name))
95 95
         {
96 96
             $collection->addErrorMessage(
97 97
                 $match->getMatchedString(),
@@ -108,7 +108,7 @@  discard block
 block discarded – undo
108 108
             $match->getMatchedString()
109 109
         );
110 110
         
111
-        if($cmd->isValid())
111
+        if ($cmd->isValid())
112 112
         {
113 113
             $collection->addCommand($cmd);
114 114
             return;
@@ -138,16 +138,16 @@  discard block
 block discarded – undo
138 138
         // 5 = parameter type command, type
139 139
         // 6 = parameter type command, params
140 140
         
141
-        if(!empty($matches[1][$index]))
141
+        if (!empty($matches[1][$index]))
142 142
         {
143 143
             $name = $matches[1][$index];
144 144
         }
145
-        else if(!empty($matches[2][$index]))
145
+        else if (!empty($matches[2][$index]))
146 146
         {
147 147
             $name = $matches[2][$index];
148 148
             $params = $matches[3][$index];
149 149
         }
150
-        else if(!empty($matches[4][$index]))
150
+        else if (!empty($matches[4][$index]))
151 151
         {
152 152
             $name = $matches[4][$index];
153 153
             $type = $matches[5][$index];
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -141,13 +141,11 @@
 block discarded – undo
141 141
         if(!empty($matches[1][$index]))
142 142
         {
143 143
             $name = $matches[1][$index];
144
-        }
145
-        else if(!empty($matches[2][$index]))
144
+        } else if(!empty($matches[2][$index]))
146 145
         {
147 146
             $name = $matches[2][$index];
148 147
             $params = $matches[3][$index];
149
-        }
150
-        else if(!empty($matches[4][$index]))
148
+        } else if(!empty($matches[4][$index]))
151 149
         {
152 150
             $name = $matches[4][$index];
153 151
             $type = $matches[5][$index];
Please login to merge, or discard this patch.
Indentation   +50 added lines, -50 removed lines patch added patch discarded remove patch
@@ -26,14 +26,14 @@  discard block
 block discarded – undo
26 26
         '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]*)}'
27 27
     );
28 28
     
29
-   /**
30
-    * @var Mailcode
31
-    */
29
+    /**
30
+     * @var Mailcode
31
+     */
32 32
     protected $mailcode;
33 33
     
34
-   /**
35
-    * @var Mailcode_Commands
36
-    */
34
+    /**
35
+     * @var Mailcode_Commands
36
+     */
37 37
     protected $commands;
38 38
     
39 39
     public function __construct(Mailcode $mailcode)
@@ -42,24 +42,24 @@  discard block
 block discarded – undo
42 42
         $this->commands = $this->mailcode->getCommands();
43 43
     }
44 44
     
45
-   /**
46
-    * Gets the regex format string used to detect commands.
47
-    * 
48
-    * @return string
49
-    */
45
+    /**
46
+     * Gets the regex format string used to detect commands.
47
+     * 
48
+     * @return string
49
+     */
50 50
     protected static function getRegex() : string
51 51
     {
52 52
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
53 53
     }
54 54
     
55
-   /**
56
-    * Parses a string to detect all commands within. Returns a
57
-    * collection instance that contains information on all the 
58
-    * commands.
59
-    * 
60
-    * @param string $string
61
-    * @return Mailcode_Collection A collection with all unique commands found.
62
-    */
55
+    /**
56
+     * Parses a string to detect all commands within. Returns a
57
+     * collection instance that contains information on all the 
58
+     * commands.
59
+     * 
60
+     * @param string $string
61
+     * @return Mailcode_Collection A collection with all unique commands found.
62
+     */
63 63
     public function parseString(string $string) : Mailcode_Collection
64 64
     {
65 65
         $collection = new Mailcode_Collection();
@@ -79,14 +79,14 @@  discard block
 block discarded – undo
79 79
         return $collection;
80 80
     }
81 81
     
82
-   /**
83
-    * Processes a single match found in the string: creates the command,
84
-    * and adds it to the collection if it's a valid command, or to the list
85
-    * of invalid commands otherwise.
86
-    * 
87
-    * @param Mailcode_Parser_Match $match
88
-    * @param Mailcode_Collection $collection
89
-    */
82
+    /**
83
+     * Processes a single match found in the string: creates the command,
84
+     * and adds it to the collection if it's a valid command, or to the list
85
+     * of invalid commands otherwise.
86
+     * 
87
+     * @param Mailcode_Parser_Match $match
88
+     * @param Mailcode_Collection $collection
89
+     */
90 90
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
91 91
     {
92 92
         $name = $match->getName();
@@ -117,14 +117,14 @@  discard block
 block discarded – undo
117 117
         $collection->addInvalidCommand($cmd);
118 118
     }
119 119
     
120
-   /**
121
-    * Parses a single regex match: determines which named group
122
-    * matches, and retrieves the according information.
123
-    * 
124
-    * @param array[] $matches The regex results array.
125
-    * @param int $index The matched index.
126
-    * @return Mailcode_Parser_Match
127
-    */
120
+    /**
121
+     * Parses a single regex match: determines which named group
122
+     * matches, and retrieves the according information.
123
+     * 
124
+     * @param array[] $matches The regex results array.
125
+     * @param int $index The matched index.
126
+     * @return Mailcode_Parser_Match
127
+     */
128 128
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
129 129
     {
130 130
         $name = ''; // the command name, e.g. "showvar"
@@ -162,26 +162,26 @@  discard block
 block discarded – undo
162 162
         );
163 163
     }
164 164
     
165
-   /**
166
-    * Creates an instance of the safeguard tool, which
167
-    * is used to safeguard commands in a string with placeholders.
168
-    * 
169
-    * @param string $subject The string to use to safeguard commands in.
170
-    * @return Mailcode_Parser_Safeguard
171
-    * @see Mailcode_Parser_Safeguard
172
-    */
165
+    /**
166
+     * Creates an instance of the safeguard tool, which
167
+     * is used to safeguard commands in a string with placeholders.
168
+     * 
169
+     * @param string $subject The string to use to safeguard commands in.
170
+     * @return Mailcode_Parser_Safeguard
171
+     * @see Mailcode_Parser_Safeguard
172
+     */
173 173
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
174 174
     {
175 175
         return new Mailcode_Parser_Safeguard($this, $subject);
176 176
     }
177 177
     
178
-   /**
179
-    * Creates a statement parser, which is used to validate arbitrary
180
-    * command statements.
181
-    * 
182
-    * @param string $statement
183
-    * @return Mailcode_Parser_Statement
184
-    */
178
+    /**
179
+     * Creates a statement parser, which is used to validate arbitrary
180
+     * command statements.
181
+     * 
182
+     * @param string $statement
183
+     * @return Mailcode_Parser_Statement
184
+     */
185 185
     public function createStatement(string $statement) : Mailcode_Parser_Statement
186 186
     {
187 187
         return new Mailcode_Parser_Statement($statement);
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
@@ -158,8 +158,7 @@
 block discarded – undo
158 158
             if($highlighted)
159 159
             {
160 160
                 $replace = $placeholder->getHighlightedText();
161
-            }
162
-            else 
161
+            } else 
163 162
             {
164 163
                 $replace = $placeholder->getOriginalText();
165 164
             }
Please login to merge, or discard this patch.
Spacing   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -115,7 +115,7 @@  discard block
 block discarded – undo
115 115
     */
116 116
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
117 117
     {
118
-        if(empty($delimiter))
118
+        if (empty($delimiter))
119 119
         {
120 120
             throw new Mailcode_Exception(
121 121
                 'Empty delimiter',
@@ -156,17 +156,17 @@  discard block
 block discarded – undo
156 156
     * @param bool $highlighted
157 157
     * @return string[]string
158 158
     */
159
-    protected function getReplaces(bool $highlighted=false) : array
159
+    protected function getReplaces(bool $highlighted = false) : array
160 160
     {
161 161
         $placeholders = $this->getPlaceholders();
162 162
         
163 163
         $replaces = array();
164 164
         
165
-        foreach($placeholders as $placeholder)
165
+        foreach ($placeholders as $placeholder)
166 166
         {
167 167
             $replace = '';
168 168
             
169
-            if($highlighted)
169
+            if ($highlighted)
170 170
             {
171 171
                 $replace = $placeholder->getHighlightedText();
172 172
             }
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
     */
191 191
     public function getPlaceholders()
192 192
     {
193
-        if(isset($this->placeholders))
193
+        if (isset($this->placeholders))
194 194
         {
195 195
             return $this->placeholders;
196 196
         }
@@ -199,7 +199,7 @@  discard block
 block discarded – undo
199 199
         
200 200
         $cmds = $this->getCollection()->getGroupedByHash();
201 201
         
202
-        foreach($cmds as $command)
202
+        foreach ($cmds as $command)
203 203
         {
204 204
             self::$counter++;
205 205
             
@@ -213,7 +213,7 @@  discard block
 block discarded – undo
213 213
         return $this->placeholders;
214 214
     }
215 215
     
216
-    protected function restore(string $string, bool $highlighted=false) : string
216
+    protected function restore(string $string, bool $highlighted = false) : string
217 217
     {
218 218
         $this->requireValidCollection();
219 219
         
@@ -221,9 +221,9 @@  discard block
 block discarded – undo
221 221
         
222 222
         $placeholderStrings = array_keys($replaces);
223 223
         
224
-        foreach($placeholderStrings as $search)
224
+        foreach ($placeholderStrings as $search)
225 225
         {
226
-            if(!strstr($string, $search))
226
+            if (!strstr($string, $search))
227 227
             {
228 228
                 throw new Mailcode_Exception(
229 229
                     'Command placeholder not found',
@@ -281,7 +281,7 @@  discard block
 block discarded – undo
281 281
     */
282 282
     public function getCollection() : Mailcode_Collection
283 283
     {
284
-        if(isset($this->collection))
284
+        if (isset($this->collection))
285 285
         {
286 286
             return $this->collection;
287 287
         }
@@ -303,7 +303,7 @@  discard block
 block discarded – undo
303 303
     */
304 304
     protected function requireValidCollection() : void
305 305
     {
306
-        if($this->getCollection()->isValid())
306
+        if ($this->getCollection()->isValid())
307 307
         {
308 308
             return;
309 309
         }
@@ -325,7 +325,7 @@  discard block
 block discarded – undo
325 325
     */
326 326
     public function getPlaceholderStrings() : array
327 327
     {
328
-        if(isset($this->placeholderStrings))
328
+        if (isset($this->placeholderStrings))
329 329
         {
330 330
             return $this->placeholderStrings;
331 331
         }
@@ -334,7 +334,7 @@  discard block
 block discarded – undo
334 334
         
335 335
         $this->placeholderStrings = array();
336 336
         
337
-        foreach($placeholders as $placeholder)
337
+        foreach ($placeholders as $placeholder)
338 338
         {
339 339
             $this->placeholderStrings[] = $placeholder->getReplacementText();
340 340
         }
@@ -360,9 +360,9 @@  discard block
 block discarded – undo
360 360
     {
361 361
         $placeholders = $this->getPlaceholders();
362 362
         
363
-        foreach($placeholders as $placeholder)
363
+        foreach ($placeholders as $placeholder)
364 364
         {
365
-            if($placeholder->getID() === $id)
365
+            if ($placeholder->getID() === $id)
366 366
             {
367 367
                 return $placeholder;
368 368
             }
@@ -389,9 +389,9 @@  discard block
 block discarded – undo
389 389
     {
390 390
         $placeholders = $this->getPlaceholders();
391 391
         
392
-        foreach($placeholders as $placeholder)
392
+        foreach ($placeholders as $placeholder)
393 393
         {
394
-            if($placeholder->getReplacementText() === $string)
394
+            if ($placeholder->getReplacementText() === $string)
395 395
             {
396 396
                 return $placeholder;
397 397
             }
Please login to merge, or discard this patch.
Indentation   +107 added lines, -107 removed lines patch added patch discarded remove patch
@@ -57,45 +57,45 @@  discard block
 block discarded – undo
57 57
     
58 58
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
59 59
     
60
-   /**
61
-    * @var Mailcode_Parser
62
-    */
60
+    /**
61
+     * @var Mailcode_Parser
62
+     */
63 63
     protected $parser;
64 64
     
65
-   /**
66
-    * @var Mailcode_Collection
67
-    */
65
+    /**
66
+     * @var Mailcode_Collection
67
+     */
68 68
     protected $commands;
69 69
     
70
-   /**
71
-    * @var string
72
-    */
70
+    /**
71
+     * @var string
72
+     */
73 73
     protected $originalString;
74 74
     
75
-   /**
76
-    * @var Mailcode_Collection
77
-    */
75
+    /**
76
+     * @var Mailcode_Collection
77
+     */
78 78
     protected $collection;
79 79
     
80
-   /**
81
-    * Counter for the placeholders, global for all placeholders.
82
-    * @var integer
83
-    */
80
+    /**
81
+     * Counter for the placeholders, global for all placeholders.
82
+     * @var integer
83
+     */
84 84
     private static $counter = 0;
85 85
     
86
-   /**
87
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
88
-    */
86
+    /**
87
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
88
+     */
89 89
     protected $placeholders;
90 90
     
91
-   /**
92
-    * @var string
93
-    */
91
+    /**
92
+     * @var string
93
+     */
94 94
     protected $delimiter = '__';
95 95
     
96
-   /**
97
-    * @var string[]|NULL
98
-    */
96
+    /**
97
+     * @var string[]|NULL
98
+     */
99 99
     protected $placeholderStrings;
100 100
     
101 101
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -104,15 +104,15 @@  discard block
 block discarded – undo
104 104
         $this->originalString = $subject;
105 105
     }
106 106
     
107
-   /**
108
-    * Sets the delimiter character sequence used to prepend
109
-    * and append to the placeholders.
110
-    * 
111
-    * The delimiter's default is "__" (two underscores).
112
-    * 
113
-    * @param string $delimiter
114
-    * @return Mailcode_Parser_Safeguard
115
-    */
107
+    /**
108
+     * Sets the delimiter character sequence used to prepend
109
+     * and append to the placeholders.
110
+     * 
111
+     * The delimiter's default is "__" (two underscores).
112
+     * 
113
+     * @param string $delimiter
114
+     * @return Mailcode_Parser_Safeguard
115
+     */
116 116
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
117 117
     {
118 118
         if(empty($delimiter))
@@ -134,15 +134,15 @@  discard block
 block discarded – undo
134 134
         return $this->delimiter;
135 135
     }
136 136
     
137
-   /**
138
-    * Retrieves the safe string in which all commands have been replaced
139
-    * by placeholder strings.
140
-    * 
141
-    * @return string
142
-    * @throws Mailcode_Exception 
143
-    *
144
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
145
-    */
137
+    /**
138
+     * Retrieves the safe string in which all commands have been replaced
139
+     * by placeholder strings.
140
+     * 
141
+     * @return string
142
+     * @throws Mailcode_Exception 
143
+     *
144
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
145
+     */
146 146
     public function makeSafe() : string
147 147
     {
148 148
         $this->requireValidCollection();
@@ -152,10 +152,10 @@  discard block
 block discarded – undo
152 152
         return str_replace(array_values($replaces), array_keys($replaces), $this->originalString);
153 153
     }
154 154
     
155
-   /**
156
-    * @param bool $highlighted
157
-    * @return string[]string
158
-    */
155
+    /**
156
+     * @param bool $highlighted
157
+     * @return string[]string
158
+     */
159 159
     protected function getReplaces(bool $highlighted=false) : array
160 160
     {
161 161
         $placeholders = $this->getPlaceholders();
@@ -182,12 +182,12 @@  discard block
 block discarded – undo
182 182
     }
183 183
     
184 184
     
185
-   /**
186
-    * Retrieves all placeholders that have to be added to
187
-    * the subject text.
188
-    * 
189
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
190
-    */
185
+    /**
186
+     * Retrieves all placeholders that have to be added to
187
+     * the subject text.
188
+     * 
189
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
190
+     */
191 191
     public function getPlaceholders()
192 192
     {
193 193
         if(isset($this->placeholders))
@@ -239,46 +239,46 @@  discard block
 block discarded – undo
239 239
         return str_replace($placeholderStrings, array_values($replaces), $string);
240 240
     }
241 241
     
242
-   /**
243
-    * Makes the string whole again after transforming or filtering it,
244
-    * by replacing the command placeholders with the original commands.
245
-    *
246
-    * @param string $string
247
-    * @return string
248
-    * @throws Mailcode_Exception
249
-    *
250
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
251
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
252
-    */
242
+    /**
243
+     * Makes the string whole again after transforming or filtering it,
244
+     * by replacing the command placeholders with the original commands.
245
+     *
246
+     * @param string $string
247
+     * @return string
248
+     * @throws Mailcode_Exception
249
+     *
250
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
251
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
252
+     */
253 253
     public function makeWhole(string $string) : string
254 254
     {
255 255
         return $this->restore($string, false);
256 256
     }
257 257
 
258
-   /**
259
-    * Like makeWhole(), but replaces the commands with a syntax
260
-    * highlighted version, meant for human readable texts only.
261
-    * 
262
-    * Note: the commands lose their functionality (They cannot be 
263
-    * parsed from that string again).
264
-    *
265
-    * @param string $string
266
-    * @return string
267
-    * @throws Mailcode_Exception
268
-    *
269
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
270
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
271
-    */
258
+    /**
259
+     * Like makeWhole(), but replaces the commands with a syntax
260
+     * highlighted version, meant for human readable texts only.
261
+     * 
262
+     * Note: the commands lose their functionality (They cannot be 
263
+     * parsed from that string again).
264
+     *
265
+     * @param string $string
266
+     * @return string
267
+     * @throws Mailcode_Exception
268
+     *
269
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
270
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
271
+     */
272 272
     public function makeHighlighted(string $string) : string
273 273
     {
274 274
         return $this->restore($string, true);
275 275
     }
276 276
     
277
-   /**
278
-    * Retrieves the commands collection contained in the string.
279
-    * 
280
-    * @return Mailcode_Collection
281
-    */
277
+    /**
278
+     * Retrieves the commands collection contained in the string.
279
+     * 
280
+     * @return Mailcode_Collection
281
+     */
282 282
     public function getCollection() : Mailcode_Collection
283 283
     {
284 284
         if(isset($this->collection))
@@ -296,11 +296,11 @@  discard block
 block discarded – undo
296 296
         return $this->getCollection()->isValid();
297 297
     }
298 298
     
299
-   /**
300
-    * @throws Mailcode_Exception
301
-    * 
302
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
303
-    */
299
+    /**
300
+     * @throws Mailcode_Exception
301
+     * 
302
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
303
+     */
304 304
     protected function requireValidCollection() : void
305 305
     {
306 306
         if($this->getCollection()->isValid())
@@ -318,11 +318,11 @@  discard block
 block discarded – undo
318 318
         );
319 319
     }
320 320
     
321
-   /**
322
-    * Retrieves a list of all placeholder IDs used in the text.
323
-    * 
324
-    * @return string[]
325
-    */
321
+    /**
322
+     * Retrieves a list of all placeholder IDs used in the text.
323
+     * 
324
+     * @return string[]
325
+     */
326 326
     public function getPlaceholderStrings() : array
327 327
     {
328 328
         if(isset($this->placeholderStrings))
@@ -349,13 +349,13 @@  discard block
 block discarded – undo
349 349
         return in_array($subject, $ids);
350 350
     }
351 351
     
352
-   /**
353
-    * Retrieves a placeholder instance by its ID.
354
-    * 
355
-    * @param int $id
356
-    * @throws Mailcode_Exception If the placeholder was not found.
357
-    * @return Mailcode_Parser_Safeguard_Placeholder
358
-    */
352
+    /**
353
+     * Retrieves a placeholder instance by its ID.
354
+     * 
355
+     * @param int $id
356
+     * @throws Mailcode_Exception If the placeholder was not found.
357
+     * @return Mailcode_Parser_Safeguard_Placeholder
358
+     */
359 359
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
360 360
     {
361 361
         $placeholders = $this->getPlaceholders();
@@ -378,13 +378,13 @@  discard block
 block discarded – undo
378 378
         );
379 379
     }
380 380
     
381
-   /**
382
-    * Retrieves a placeholder instance by its replacement text.
383
-    * 
384
-    * @param string $string
385
-    * @throws Mailcode_Exception
386
-    * @return Mailcode_Parser_Safeguard_Placeholder
387
-    */
381
+    /**
382
+     * Retrieves a placeholder instance by its replacement text.
383
+     * 
384
+     * @param string $string
385
+     * @throws Mailcode_Exception
386
+     * @return Mailcode_Parser_Safeguard_Placeholder
387
+     */
388 388
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
389 389
     {
390 390
         $placeholders = $this->getPlaceholders();
Please login to merge, or discard this patch.
src/Mailcode.php 2 patches
Indentation   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -26,46 +26,46 @@  discard block
 block discarded – undo
26 26
  */
27 27
 class Mailcode
28 28
 {
29
-   /**
30
-    * @var Mailcode_Parser|NULL
31
-    */
29
+    /**
30
+     * @var Mailcode_Parser|NULL
31
+     */
32 32
     protected $parser = null;
33 33
     
34
-   /**
35
-    * @var Mailcode_Commands|NULL
36
-    */
34
+    /**
35
+     * @var Mailcode_Commands|NULL
36
+     */
37 37
     protected $commands = null;
38 38
     
39
-   /**
40
-    * @var Mailcode_Variables|NULL
41
-    */
39
+    /**
40
+     * @var Mailcode_Variables|NULL
41
+     */
42 42
     protected $variables = null;
43 43
     
44
-   /**
45
-    * Creates a new mailcode instance.
46
-    * @return Mailcode
47
-    */
44
+    /**
45
+     * Creates a new mailcode instance.
46
+     * @return Mailcode
47
+     */
48 48
     public static function create() : Mailcode
49 49
     {
50 50
         return new Mailcode();
51 51
     }
52 52
     
53
-   /**
54
-    * Parses the string to detect all commands contained within.
55
-    * 
56
-    * @param string $string
57
-    * @return Mailcode_Collection
58
-    */
53
+    /**
54
+     * Parses the string to detect all commands contained within.
55
+     * 
56
+     * @param string $string
57
+     * @return Mailcode_Collection
58
+     */
59 59
     public function parseString(string $string) : Mailcode_Collection
60 60
     {
61 61
         return $this->getParser()->parseString($string);
62 62
     }
63 63
     
64
-   /**
65
-    * Retrieves the string parser instance used to detect commands.
66
-    * 
67
-    * @return Mailcode_Parser
68
-    */
64
+    /**
65
+     * Retrieves the string parser instance used to detect commands.
66
+     * 
67
+     * @return Mailcode_Parser
68
+     */
69 69
     public function getParser() : Mailcode_Parser
70 70
     {
71 71
         if(!isset($this->parser)) 
@@ -76,12 +76,12 @@  discard block
 block discarded – undo
76 76
         return $this->parser;
77 77
     }
78 78
     
79
-   /**
80
-    * Retrieves the commands collection, which is used to
81
-    * access information on the available commands.
82
-    * 
83
-    * @return Mailcode_Commands
84
-    */
79
+    /**
80
+     * Retrieves the commands collection, which is used to
81
+     * access information on the available commands.
82
+     * 
83
+     * @return Mailcode_Commands
84
+     */
85 85
     public function getCommands() : Mailcode_Commands
86 86
     {
87 87
         if(!isset($this->commands)) 
@@ -97,12 +97,12 @@  discard block
 block discarded – undo
97 97
         return $this->getParser()->createSafeguard($subject);
98 98
     }
99 99
     
100
-   /**
101
-    * Attempts to find all variables in the target string.
102
-    * 
103
-    * @param string $subject
104
-    * @return Mailcode_Variables_Collection_Regular
105
-    */
100
+    /**
101
+     * Attempts to find all variables in the target string.
102
+     * 
103
+     * @param string $subject
104
+     * @return Mailcode_Variables_Collection_Regular
105
+     */
106 106
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
107 107
     {
108 108
         return $this->createVariables()->parseString($subject);
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -68,7 +68,7 @@  discard block
 block discarded – undo
68 68
     */
69 69
     public function getParser() : Mailcode_Parser
70 70
     {
71
-        if(!isset($this->parser)) 
71
+        if (!isset($this->parser)) 
72 72
         {
73 73
             $this->parser = new Mailcode_Parser($this);
74 74
         }
@@ -84,7 +84,7 @@  discard block
 block discarded – undo
84 84
     */
85 85
     public function getCommands() : Mailcode_Commands
86 86
     {
87
-        if(!isset($this->commands)) 
87
+        if (!isset($this->commands)) 
88 88
         {
89 89
             $this->commands = new Mailcode_Commands();
90 90
         }
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
     
111 111
     public function createVariables() : Mailcode_Variables
112 112
     {
113
-        if(!isset($this->variables))
113
+        if (!isset($this->variables))
114 114
         {
115 115
             $this->variables = new Mailcode_Variables();
116 116
         }
Please login to merge, or discard this patch.
src/Mailcode/Variables/Collection/Regular.php 2 patches
Indentation   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -20,9 +20,9 @@  discard block
 block discarded – undo
20 20
  */
21 21
 class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection
22 22
 {
23
-   /**
24
-    * @var Mailcode_Variables_Collection_Invalid
25
-    */
23
+    /**
24
+     * @var Mailcode_Variables_Collection_Invalid
25
+     */
26 26
     protected $invalid;
27 27
 
28 28
     protected function init() : void
@@ -47,30 +47,30 @@  discard block
 block discarded – undo
47 47
         return $this;
48 48
     }
49 49
 
50
-   /**
51
-    * Whether any of the variables in the collection are invalid.
52
-    * 
53
-    * @return bool
54
-    */
50
+    /**
51
+     * Whether any of the variables in the collection are invalid.
52
+     * 
53
+     * @return bool
54
+     */
55 55
     public function hasInvalid() : bool
56 56
     {
57 57
         return isset($this->invalid) && $this->invalid->hasVariables();
58 58
     }
59 59
     
60
-   /**
61
-    * Retrieves the collection of invalid variables, if any.
62
-    * Behaves like a variables collection.
63
-    * 
64
-    * @return Mailcode_Variables_Collection_Invalid
65
-    */
60
+    /**
61
+     * Retrieves the collection of invalid variables, if any.
62
+     * Behaves like a variables collection.
63
+     * 
64
+     * @return Mailcode_Variables_Collection_Invalid
65
+     */
66 66
     public function getInvalid() : Mailcode_Variables_Collection_Invalid
67 67
     {
68 68
         return $this->invalid;
69 69
     }
70 70
     
71
-   /**
72
-    * @return Mailcode_Variables_Collection_Regular
73
-    */
71
+    /**
72
+     * @return Mailcode_Variables_Collection_Regular
73
+     */
74 74
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
75 75
     {
76 76
         parent::mergeWith($collection);
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -32,7 +32,7 @@  discard block
 block discarded – undo
32 32
     
33 33
     public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection
34 34
     {
35
-        if(!$variable->isValid())
35
+        if (!$variable->isValid())
36 36
         {
37 37
             return $this->addInvalid($variable);
38 38
         }
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
         parent::mergeWith($collection);
77 77
         
78 78
         // also inherit any invalid variables
79
-        if($collection instanceof Mailcode_Variables_Collection_Regular)
79
+        if ($collection instanceof Mailcode_Variables_Collection_Regular)
80 80
         {
81 81
             $invalid = $collection->getInvalid();
82 82
             
Please login to merge, or discard this patch.
src/Mailcode/Variables/Collection/Invalid.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -24,7 +24,7 @@
 block discarded – undo
24 24
 {
25 25
     public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection
26 26
     {
27
-        if($variable->isValid())
27
+        if ($variable->isValid())
28 28
         {
29 29
             return $this;
30 30
         }
Please login to merge, or discard this patch.
src/Mailcode/Collection/NestingValidator.php 2 patches
Indentation   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -29,19 +29,19 @@
 block discarded – undo
29 29
     const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103;
30 30
     const VALIDATION_UNCLOSED_COMMAND = 49104;
31 31
     
32
-   /**
33
-    * @var Mailcode_Collection
34
-    */
32
+    /**
33
+     * @var Mailcode_Collection
34
+     */
35 35
     protected $collection;
36 36
     
37
-   /**
38
-    * @var OperationResult
39
-    */
37
+    /**
38
+     * @var OperationResult
39
+     */
40 40
     protected $validationResult;
41 41
     
42
-   /**
43
-    * @var Mailcode_Commands_Command[]
44
-    */
42
+    /**
43
+     * @var Mailcode_Commands_Command[]
44
+     */
45 45
     protected $stack = array();
46 46
     
47 47
     public function __construct(Mailcode_Collection $collection)
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -60,11 +60,11 @@  discard block
 block discarded – undo
60 60
         
61 61
         $commands = $this->collection->getCommands();
62 62
         
63
-        foreach($commands as $command)
63
+        foreach ($commands as $command)
64 64
         {
65 65
             $method = 'validate_'.$command->getCommandType();
66 66
             
67
-            if(!method_exists($this, $method))
67
+            if (!method_exists($this, $method))
68 68
             {
69 69
                 throw new Mailcode_Exception(
70 70
                     'Unknown command type validation method.',
@@ -79,13 +79,13 @@  discard block
 block discarded – undo
79 79
             
80 80
             $this->$method($command);
81 81
             
82
-            if(!$this->validationResult->isValid())
82
+            if (!$this->validationResult->isValid())
83 83
             {
84 84
                 break;
85 85
             }
86 86
         }
87 87
         
88
-        if($this->validationResult->isValid())
88
+        if ($this->validationResult->isValid())
89 89
         {
90 90
             $this->validate_Unclosed();
91 91
         }
@@ -97,7 +97,7 @@  discard block
 block discarded – undo
97 97
     {
98 98
         $leftover = $this->getOpenCommand();
99 99
         
100
-        if($leftover === null)
100
+        if ($leftover === null)
101 101
         {
102 102
             return;
103 103
         }
@@ -113,7 +113,7 @@  discard block
 block discarded – undo
113 113
     
114 114
     protected function getOpenCommand() : ?Mailcode_Commands_Command_Type_Opening
115 115
     {
116
-        if(empty($this->stack))
116
+        if (empty($this->stack))
117 117
         {
118 118
             return null;
119 119
         }
@@ -124,7 +124,7 @@  discard block
 block discarded – undo
124 124
         
125 125
         $cmd = $this->stack[$idx];
126 126
         
127
-        if($cmd instanceof Mailcode_Commands_Command_Type_Opening)
127
+        if ($cmd instanceof Mailcode_Commands_Command_Type_Opening)
128 128
         {
129 129
             return $cmd;
130 130
         }
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
     {
149 149
         $parent = $this->getOpenCommand();
150 150
         
151
-        if($parent === null)
151
+        if ($parent === null)
152 152
         {
153 153
             $this->validationResult->makeError(
154 154
                 t(
@@ -162,7 +162,7 @@  discard block
 block discarded – undo
162 162
             return;
163 163
         }
164 164
         
165
-        if($parent->getName() !== $command->getParentName())
165
+        if ($parent->getName() !== $command->getParentName())
166 166
         {
167 167
             $this->validationResult->makeError(
168 168
                 t(
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
     
182 182
     protected function validate_Closing(Mailcode_Commands_Command_Type_Closing $command) : void
183 183
     {
184
-        if(empty($this->stack))
184
+        if (empty($this->stack))
185 185
         {
186 186
             $this->validationResult->makeError(
187 187
                 t('All open commands have already been ended.'),
Please login to merge, or discard this patch.