View GitHub Repository mailcode

Schedule Inspection
Subscribe
Passed
Push — master ( 1b5df6...213867 )
by Sebastian
13:22
created
Status
Category
Toggle Patches
src/Mailcode/Collection/NestingValidator.php 1 patch
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_Type[]
44 
-    */
42 
+    /**
43 
+     * @var Mailcode_Commands_Command_Type[]
44 
+     */
45 45 
     protected $stack = array();
46 46
47 47 
     public function __construct(Mailcode_Collection $collection)
Please login to merge, or discard this patch.
src/Mailcode/Commands/Command/SetVariable.php 2 patches
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -25,9 +25,9 @@
 
 block discarded – undo
25 25
26 26 
     const VALIDATION_NOT_ASSIGNMENT_STATEMENT = 48501;
27 27
28 
-   /**
29 
-    * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
30 
-    */
28 
+    /**
29 
+     * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
30 
+     */
31 31 
     protected $value;
32 32
33 33 
     public function getName() : string
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 
         $variable = $this->params->getInfo()->getVariableByIndex(0);
70 70
71 
-        if($variable)
71 
+        if ($variable)
72 72 
         {
73 73 
             return $variable->getVariable();
74 74 
         }
 
@@ -96,7 +96,7 @@  discard block
 
 block discarded – undo
96 96
97 97 
     protected function validateSyntax_assignment() : void
98 98 
     {
99 
-        if($this->params->getInfo()->isVariableAssignment())
99 
+        if ($this->params->getInfo()->isVariableAssignment())
100 100 
         {
101 101 
             return;
102 102 
         }
 
@@ -113,7 +113,7 @@  discard block
 
 block discarded – undo
113 113
114 114 
         $value = $info->getTokenByIndex(2);
115 115
116 
-        if($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value)
116 
+        if ($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value)
117 117 
         {
118 118 
             $this->value = $value;
119 119 
             return;
Please login to merge, or discard this patch.
src/Mailcode/Commands/Command/ShowVariable.php 1 patch
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch 
@@ -26,9 +26,9 @@  discard block
 
 block discarded – undo
26 26
27 27 
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 48402;
28 28
29 
-   /**
30 
-    * @var Mailcode_Variables_Variable|NULL
31 
-    */
29 
+    /**
30 
+     * @var Mailcode_Variables_Variable|NULL
31 
+     */
32 32 
     protected $variable;
33 33
34 34 
     public function getName() : string
 
@@ -56,15 +56,15 @@  discard block
 
 block discarded – undo
56 56 
         return true;
57 57 
     }
58 58
59 
-   /**
60 
-    * Retrieves the variable to show.
61 
-    *
62 
-    * NOTE: Only available once the command has been
63 
-    * validated. Always use isValid() first.
64 
-    *
65 
-    * @throws Mailcode_Exception
66 
-    * @return Mailcode_Variables_Variable
67 
-    */
59 
+    /**
60 
+     * Retrieves the variable to show.
61 
+     *
62 
+     * NOTE: Only available once the command has been
63 
+     * validated. Always use isValid() first.
64 
+     *
65 
+     * @throws Mailcode_Exception
66 
+     * @return Mailcode_Variables_Variable
67 
+     */
68 68 
     public function getVariable() : Mailcode_Variables_Variable
69 69 
     {
70 70 
         $this->validate();
 
@@ -81,15 +81,15 @@  discard block
 
 block discarded – undo
81 81 
         );
82 82 
     }
83 83
84 
-   /**
85 
-    * Retrieves the full name of the variable to show.
86 
-    *
87 
-    * NOTE: Only available once the command has been
88 
-    * validated. Always use isValid() first.
89 
-    *
90 
-    * @throws Mailcode_Exception
91 
-    * @return string
92 
-    */
84 
+    /**
85 
+     * Retrieves the full name of the variable to show.
86 
+     *
87 
+     * NOTE: Only available once the command has been
88 
+     * validated. Always use isValid() first.
89 
+     *
90 
+     * @throws Mailcode_Exception
91 
+     * @return string
92 
+     */
93 93 
     public function getVariableName() : string
94 94 
     {
95 95 
         return $this->getVariable()->getFullName();
 
@@ -97,19 +97,19 @@  discard block
 
 block discarded – undo
97 97
98 98 
     protected function validateSyntax_require_variable() : void
99 99 
     {
100 
-         $vars = $this->getVariables()->getGroupedByName();
101 
-         $amount = count($vars);
100 
+            $vars = $this->getVariables()->getGroupedByName();
101 
+            $amount = count($vars);
102 102
103 
-         if($amount === 1)
104 
-         {
105 
-             $this->variable = array_pop($vars);
106 
-             return;
107 
-         }
103 
+            if($amount === 1)
104 
+            {
105 
+                $this->variable = array_pop($vars);
106 
+                return;
107 
+            }
108 108
109 
-         $this->validationResult->makeError(
109 
+            $this->validationResult->makeError(
110 110 
             t('Command has %1$s variables, %2$s expected.', $amount, 1),
111 111 
             self::VALIDATION_VARIABLE_COUNT_MISMATCH
112 
-         );
112 
+            );
113 113 
     }
114 114
115 115 
     protected function getValidations() : array
Please login to merge, or discard this patch.
src/Mailcode/Commands/Command/ShowSnippet.php 2 patches
Indentation   +21 added lines, -21 removed lines patch added patch discarded remove patch 
@@ -24,9 +24,9 @@  discard block
 
 block discarded – undo
24 24
25 25 
     const VALIDATION_VARIABLE_MISSING = 52001;
26 26
27 
-   /**
28 
-    * @var Mailcode_Variables_Variable|NULL
29 
-    */
27 
+    /**
28 
+     * @var Mailcode_Variables_Variable|NULL
29 
+     */
30 30 
     protected $variable;
31 31
32 32 
     public function getName() : string
 
@@ -54,15 +54,15 @@  discard block
 
 block discarded – undo
54 54 
         return true;
55 55 
     }
56 56
57 
-   /**
58 
-    * Retrieves the variable to show.
59 
-    *
60 
-    * NOTE: Only available once the command has been
61 
-    * validated. Always use isValid() first.
62 
-    *
63 
-    * @throws Mailcode_Exception
64 
-    * @return Mailcode_Variables_Variable
65 
-    */
57 
+    /**
58 
+     * Retrieves the variable to show.
59 
+     *
60 
+     * NOTE: Only available once the command has been
61 
+     * validated. Always use isValid() first.
62 
+     *
63 
+     * @throws Mailcode_Exception
64 
+     * @return Mailcode_Variables_Variable
65 
+     */
66 66 
     public function getVariable() : Mailcode_Variables_Variable
67 67 
     {
68 68 
         $this->validate();
 
@@ -79,15 +79,15 @@  discard block
 
 block discarded – undo
79 79 
         );
80 80 
     }
81 81
82 
-   /**
83 
-    * Retrieves the full name of the variable to show.
84 
-    *
85 
-    * NOTE: Only available once the command has been
86 
-    * validated. Always use isValid() first.
87 
-    *
88 
-    * @throws Mailcode_Exception
89 
-    * @return string
90 
-    */
82 
+    /**
83 
+     * Retrieves the full name of the variable to show.
84 
+     *
85 
+     * NOTE: Only available once the command has been
86 
+     * validated. Always use isValid() first.
87 
+     *
88 
+     * @throws Mailcode_Exception
89 
+     * @return string
90 
+     */
91 91 
     public function getVariableName() : string
92 92 
     {
93 93 
         return $this->getVariable()->getFullName();
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch 
@@ -67,7 +67,7 @@  discard block
 
 block discarded – undo
67 67 
     {
68 68 
         $this->validate();
69 69
70 
-        if(isset($this->variable))
70 
+        if (isset($this->variable))
71 71 
         {
72 72 
             return $this->variable;
73 73 
         }
 
@@ -99,7 +99,7 @@  discard block
 
 block discarded – undo
99 99
100 100 
         $var = $info->getVariableByIndex(0);
101 101
102 
-        if($var)
102 
+        if ($var)
103 103 
         {
104 104 
             return;
105 105 
         }
Please login to merge, or discard this patch.
src/Mailcode/Commands/Command.php 2 patches
Indentation   +70 added lines, -70 removed lines patch added patch discarded remove patch 
@@ -31,53 +31,53 @@  discard block
 
 block discarded – undo
31 31 
     const VALIDATION_UNKNOWN_COMMAND_NAME = 48304;
32 32 
     const VALIDATION_INVALID_PARAMS_STATEMENT = 48305;
33 33
34 
-   /**
35 
-    * @var string
36 
-    */
34 
+    /**
35 
+     * @var string
36 
+     */
37 37 
     protected $type = '';
38 38
39 
-   /**
40 
-    * @var string
41 
-    */
39 
+    /**
40 
+     * @var string
41 
+     */
42 42 
     protected $paramsString = '';
43 43
44 
-   /**
45 
-    * @var string
46 
-    */
44 
+    /**
45 
+     * @var string
46 
+     */
47 47 
     protected $matchedText = '';
48 48
49 
-   /**
50 
-    * @var string
51 
-    */
49 
+    /**
50 
+     * @var string
51 
+     */
52 52 
     protected $hash = '';
53 53
54 
-   /**
55 
-    * @var \AppUtils\OperationResult
56 
-    */
54 
+    /**
55 
+     * @var \AppUtils\OperationResult
56 
+     */
57 57 
     protected $validationResult = null;
58 58
59 
-   /**
60 
-    * @var \Mailcode\Mailcode
61 
-    */
59 
+    /**
60 
+     * @var \Mailcode\Mailcode
61 
+     */
62 62 
     protected $mailcode;
63 63
64 
-   /**
65 
-    * @var \Mailcode\Mailcode_Parser_Statement
66 
-    */
64 
+    /**
65 
+     * @var \Mailcode\Mailcode_Parser_Statement
66 
+     */
67 67 
     protected $params;
68 68
69 
-   /**
70 
-    * @var string[]
71 
-    */
69 
+    /**
70 
+     * @var string[]
71 
+     */
72 72 
     protected $validations = array(
73 73 
         'params',
74 74 
         'type_supported',
75 75 
         'type_unsupported'
76 76 
     );
77 77
78 
-   /**
79 
-    * @var string
80 
-    */
78 
+    /**
79 
+     * @var string
80 
+     */
81 81 
     protected $comment = '';
82 82
83 83 
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
 
@@ -95,9 +95,9 @@  discard block
 
 block discarded – undo
95 95
96 96 
     }
97 97
98 
-   /**
99 
-    * @return string The ID of the command = the name of the command class file.
100 
-    */
98 
+    /**
99 
+     * @return string The ID of the command = the name of the command class file.
100 
+     */
101 101 
     public function getID() : string
102 102 
     {
103 103 
         // account for commands with types: If_Variable should still return If.
 
@@ -106,14 +106,14 @@  discard block
 
 block discarded – undo
106 106 
         return array_shift($tokens);
107 107 
     }
108 108
109 
-   /**
110 
-    * Sets an optional comment that is not used anywhere, but
111 
-    * can be used by the application to track why a command is
112 
-    * used somewhere.
113 
-    *
114 
-    * @param string $comment
115 
-    * @return Mailcode_Commands_Command
116 
-    */
109 
+    /**
110 
+     * Sets an optional comment that is not used anywhere, but
111 
+     * can be used by the application to track why a command is
112 
+     * used somewhere.
113 
+     *
114 
+     * @param string $comment
115 
+     * @return Mailcode_Commands_Command
116 
+     */
117 117 
     public function setComment(string $comment) : Mailcode_Commands_Command
118 118 
     {
119 119 
         $this->comment = $comment;
 
@@ -121,34 +121,34 @@  discard block
 
 block discarded – undo
121 121 
         return $this;
122 122 
     }
123 123
124 
-   /**
125 
-    * Retrieves the previously set comment, if any.
126 
-    *
127 
-    * @return string
128 
-    */
124 
+    /**
125 
+     * Retrieves the previously set comment, if any.
126 
+     *
127 
+     * @return string
128 
+     */
129 129 
     public function getComment() : string
130 130 
     {
131 131 
         return $this->comment;
132 132 
     }
133 133
134 
-   /**
135 
-    * Checks whether this is a dummy command, which is only
136 
-    * used to access information on the command type. It cannot
137 
-    * be used as an actual live command.
138 
-    *
139 
-    * @return bool
140 
-    */
134 
+    /**
135 
+     * Checks whether this is a dummy command, which is only
136 
+     * used to access information on the command type. It cannot
137 
+     * be used as an actual live command.
138 
+     *
139 
+     * @return bool
140 
+     */
141 141 
     public function isDummy() : bool
142 142 
     {
143 143 
         return $this->type === '__dummy';
144 144 
     }
145 145
146 
-   /**
147 
-    * Retrieves a hash of the actual matched command string,
148 
-    * which is used in collections to detect duplicate commands.
149 
-    *
150 
-    * @return string
151 
-    */
146 
+    /**
147 
+     * Retrieves a hash of the actual matched command string,
148 
+     * which is used in collections to detect duplicate commands.
149 
+     *
150 
+     * @return string
151 
+     */
152 152 
     public function getHash() : string
153 153 
     {
154 154 
         $this->requireNonDummy();
 
@@ -240,9 +240,9 @@  discard block
 
 block discarded – undo
240 240 
         }
241 241 
     }
242 242
243 
-   /**
244 
-    * @return string[]
245 
-    */
243 
+    /**
244 
+     * @return string[]
245 
+     */
246 246 
     abstract protected function getValidations() : array;
247 247
248 248 
     protected function validateSyntax_params() : void
 
@@ -429,22 +429,22 @@  discard block
 
 block discarded – undo
429 429 
         return implode('', $parts);
430 430 
     }
431 431
432 
-   /**
433 
-    * Retrieves the names of all the command's supported types: the part
434 
-    * between the command name and the colon. Example: {command type: params}.
435 
-    *
436 
-    * @return string[]
437 
-    */
432 
+    /**
433 
+     * Retrieves the names of all the command's supported types: the part
434 
+     * between the command name and the colon. Example: {command type: params}.
435 
+     *
436 
+     * @return string[]
437 
+     */
438 438 
     public function getSupportedTypes() : array
439 439 
     {
440 440 
         return array();
441 441 
     }
442 442
443 
-   /**
444 
-    * Retrieves all variable names used in the command.
445 
-    *
446 
-    * @return Mailcode_Variables_Collection_Regular
447 
-    */
443 
+    /**
444 
+     * Retrieves all variable names used in the command.
445 
+     *
446 
+     * @return Mailcode_Variables_Collection_Regular
447 
+     */
448 448 
     public function getVariables() : Mailcode_Variables_Collection_Regular
449 449 
     {
450 450 
         return Mailcode::create()->findVariables($this->paramsString);
Please login to merge, or discard this patch.
Spacing   +24 added lines, -24 removed lines patch added patch discarded remove patch 
@@ -80,7 +80,7 @@  discard block
 
 block discarded – undo
80 80 
     */
81 81 
     protected $comment = '';
82 82
83 
-    public function __construct(string $type='', string $paramsString='', string $matchedText='')
83 
+    public function __construct(string $type = '', string $paramsString = '', string $matchedText = '')
84 84 
     {
85 85 
         $this->type = $type;
86 86 
         $this->paramsString = html_entity_decode($paramsString);
 
@@ -153,7 +153,7 @@  discard block
 
 block discarded – undo
153 153 
     {
154 154 
         $this->requireNonDummy();
155 155
156 
-        if($this->hash === '') {
156 
+        if ($this->hash === '') {
157 157 
             $this->hash = md5($this->matchedText);
158 158 
         }
159 159 
         
@@ -162,7 +162,7 @@  discard block
 
 block discarded – undo
162 162
163 163 
     protected function requireNonDummy() : void
164 164 
     {
165 
-        if(!$this->isDummy())
165 
+        if (!$this->isDummy())
166 166 
         {
167 167 
             return;
168 168 
         }
 
@@ -183,7 +183,7 @@  discard block
 
 block discarded – undo
183 183 
     {
184 184 
         $this->requireNonDummy();
185 185
186 
-        if(isset($this->validationResult))
186 
+        if (isset($this->validationResult))
187 187 
         {
188 188 
             return $this->validationResult;
189 189 
         }
 
@@ -197,7 +197,7 @@  discard block
 
 block discarded – undo
197 197
198 198 
     public function getValidationResult() :  \AppUtils\OperationResult
199 199 
     {
200 
-        if(isset($this->validationResult))
200 
+        if (isset($this->validationResult))
201 201 
         {
202 202 
             return $this->validationResult;
203 203 
         }
 
@@ -213,11 +213,11 @@  discard block
 
 block discarded – undo
213 213 
     {
214 214 
         $validations = array_merge($this->validations, $this->getValidations());
215 215
216 
-        foreach($validations as $validation)
216 
+        foreach ($validations as $validation)
217 217 
         {
218 218 
             $method = 'validateSyntax_'.$validation;
219 219
220 
-            if(!method_exists($this, $method))
220 
+            if (!method_exists($this, $method))
221 221 
             {
222 222 
                 throw new Mailcode_Exception(
223 223 
                     'Missing validation method',
 
@@ -233,7 +233,7 @@  discard block
 
 block discarded – undo
233 233 
             $this->$method();
234 234
235 235 
             // break off at the first validation issue
236 
-            if(!$this->validationResult->isValid())
236 
+            if (!$this->validationResult->isValid())
237 237 
             {
238 238 
                 return;
239 239 
             }
 
@@ -247,12 +247,12 @@  discard block
 
 block discarded – undo
247 247
248 248 
     protected function validateSyntax_params() : void
249 249 
     {
250 
-        if(!$this->requiresParameters())
250 
+        if (!$this->requiresParameters())
251 251 
         {
252 252 
             return;
253 253 
         }
254 254
255 
-        if(empty($this->paramsString))
255 
+        if (empty($this->paramsString))
256 256 
         {
257 257 
             $this->validationResult->makeError(
258 258 
                 t('Parameters have to be specified.'),
 
@@ -263,7 +263,7 @@  discard block
 
 block discarded – undo
263 263
264 264 
         $this->params = $this->mailcode->getParser()->createStatement($this->paramsString);
265 265
266 
-        if(!$this->params->isValid())
266 
+        if (!$this->params->isValid())
267 267 
         {
268 268 
             $error = $this->params->getValidationResult();
269 269 
             
@@ -276,14 +276,14 @@  discard block
 
 block discarded – undo
276 276
277 277 
     protected function validateSyntax_type_supported() : void
278 278 
     {
279 
-        if(!$this->supportsType() || empty($this->type))
279 
+        if (!$this->supportsType() || empty($this->type))
280 280 
         {
281 281 
             return;
282 282 
         }
283 283
284 284 
         $types = $this->getSupportedTypes();
285 285
286 
-        if(!in_array($this->type, $types))
286 
+        if (!in_array($this->type, $types))
287 287 
         {
288 288 
             $this->validationResult->makeError(
289 289 
                 t('The command addon %1$s is not supported.', $this->type).' '.
 
@@ -297,7 +297,7 @@  discard block
 
 block discarded – undo
297 297
298 298 
     protected function validateSyntax_type_unsupported() : void
299 299 
     {
300 
-        if($this->supportsType() || empty($this->type))
300 
+        if ($this->supportsType() || empty($this->type))
301 301 
         {
302 302 
             return;
303 303 
         }
 
@@ -315,7 +315,7 @@  discard block
 
 block discarded – undo
315 315
316 316 
     public function getType() : string
317 317 
     {
318 
-        if($this->supportsType())
318 
+        if ($this->supportsType())
319 319 
         {
320 320 
             return $this->type;
321 321 
         }
 
@@ -335,7 +335,7 @@  discard block
 
 block discarded – undo
335 335
336 336 
     public function getHighlighted() : string
337 337 
     {
338 
-        if(!$this->isValid())
338 
+        if (!$this->isValid())
339 339 
         {
340 340 
             return '';
341 341 
         }
 
@@ -346,7 +346,7 @@  discard block
 
 block discarded – undo
346 346
347 347 
     public function getParamsString() : string
348 348 
     {
349 
-        if($this->requiresParameters())
349 
+        if ($this->requiresParameters())
350 350 
         {
351 351 
             return $this->paramsString;
352 352 
         }
 
@@ -373,22 +373,22 @@  discard block
 
 block discarded – undo
373 373
374 374 
     public final function getCommandType() : string
375 375 
     {
376 
-        if($this instanceof Mailcode_Commands_Command_Type_Closing)
376 
+        if ($this instanceof Mailcode_Commands_Command_Type_Closing)
377 377 
         {
378 378 
             return 'Closing';
379 379 
         }
380 380
381 
-        if($this instanceof Mailcode_Commands_Command_Type_Opening)
381 
+        if ($this instanceof Mailcode_Commands_Command_Type_Opening)
382 382 
         {
383 383 
             return 'Opening';
384 384 
         }
385 385
386 
-        if($this instanceof Mailcode_Commands_Command_Type_Sibling)
386 
+        if ($this instanceof Mailcode_Commands_Command_Type_Sibling)
387 387 
         {
388 388 
             return 'Sibling';
389 389 
         }
390 390
391 
-        if($this instanceof Mailcode_Commands_Command_Type_Standalone)
391 
+        if ($this instanceof Mailcode_Commands_Command_Type_Standalone)
392 392 
         {
393 393 
             return 'Standalone';
394 394 
         }
 
@@ -405,7 +405,7 @@  discard block
 
 block discarded – undo
405 405
406 406 
     public function getNormalized() : string
407 407 
     {
408 
-        if(!$this->isValid())
408 
+        if (!$this->isValid())
409 409 
         {
410 410 
             return '';
411 411 
         }
 
@@ -413,12 +413,12 @@  discard block
 
 block discarded – undo
413 413 
         $parts = array();
414 414 
         $parts[] = '{'.$this->getName();
415 415
416 
-        if($this->supportsType() && $this->hasType())
416 
+        if ($this->supportsType() && $this->hasType())
417 417 
         {
418 418 
             $parts[] = ' '.$this->getType();
419 419 
         }
420 420
421 
-        if($this->requiresParameters() && isset($this->params))
421 
+        if ($this->requiresParameters() && isset($this->params))
422 422 
         {
423 423 
             $parts[] = ': ';
424 424 
             $parts[] = $this->params->getNormalized();
Please login to merge, or discard this patch.