View GitHub Repository mailcode

Schedule Inspection
Subscribe
Passed
Pull Request — master (#16)
by Sebastian
10:17
created
Status
Category
Toggle Patches
src/Mailcode/Commands/Highlighter.php 2 patches
Indentation   +12 added lines, -12 removed lines patch added patch discarded remove patch 
@@ -20,19 +20,19 @@  discard block
 
 block discarded – undo
20 20 
  */
21 21 
 class Mailcode_Commands_Highlighter
22 22 
 {
23 
-   /**
24 
-    * @var Mailcode_Commands_Command
25 
-    */
23 
+    /**
24 
+     * @var Mailcode_Commands_Command
25 
+     */
26 26 
     protected $command;
27 27
28 
-   /**
29 
-    * @var string[]
30 
-    */
28 
+    /**
29 
+     * @var string[]
30 
+     */
31 31 
     protected $parts = array();
32 32
33 33 
     public function __construct(Mailcode_Commands_Command $command)
34 34 
     {
35 
-       $this->command = $command;
35 
+        $this->command = $command;
36 36 
     }
37 37
38 38 
     public function highlight() : string
 
@@ -121,11 +121,11 @@  discard block
 
 block discarded – undo
121 121 
         $this->appendParams($keyword->getCommand());
122 122 
     }
123 123
124 
-   /**
125 
-    * @param string[] $classes
126 
-    * @param string $content
127 
-    * @return string
128 
-    */
124 
+    /**
125 
+     * @param string[] $classes
126 
+     * @param string $content
127 
+     * @return string
128 
+     */
129 129 
     protected function renderTag(array $classes, string $content) : string
130 130 
     {
131 131 
         $parts = array();
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch 
@@ -52,12 +52,12 @@  discard block
 
 block discarded – undo
52 52 
     {
53 53 
         $this->parts[] = $this->renderTag(array('command-name'), $this->command->getName());
54 54
55 
-        if($this->command->hasType())
55 
+        if ($this->command->hasType())
56 56 
         {
57 57 
             $this->parts[] = ' '.$this->renderTag(array('command-type'), $this->command->getType());
58 58 
         }
59 59
60 
-        if($this->command->requiresParameters())
60 
+        if ($this->command->requiresParameters())
61 61 
         {
62 62 
             $this->parts[] = $this->renderTag(array('hyphen'), ':');
63 63 
             $this->parts[] = '<wbr>';
 
@@ -68,14 +68,14 @@  discard block
 
 block discarded – undo
68 68 
     {
69 69 
         $params = $command->getParams();
70 70
71 
-        if($params === null)
71 
+        if ($params === null)
72 72 
         {
73 73 
             return;
74 74 
         }
75 75
76 76 
         $tokens = $params->getInfo()->getTokens();
77 77
78 
-        if(!empty($tokens))
78 
+        if (!empty($tokens))
79 79 
         {
80 80 
             $this->parts[] = ' ';
81 81 
             $this->parts[] = '<span class="mailcode-params">';
 
@@ -91,9 +91,9 @@  discard block
 
 block discarded – undo
91 91 
         }
92 92 
     }
93 93
94 
-    protected function appendParamToken(Mailcode_Parser_Statement_Tokenizer_Token $token, ?Mailcode_Parser_Statement_Tokenizer_Token $previous=null) : void
94 
+    protected function appendParamToken(Mailcode_Parser_Statement_Tokenizer_Token $token, ?Mailcode_Parser_Statement_Tokenizer_Token $previous = null) : void
95 95 
     {
96 
-        if($previous && $previous->hasSpacing()) {
96 
+        if ($previous && $previous->hasSpacing()) {
97 97 
             $this->parts[] = ' ';
98 98 
         }
99 99 
 
@@ -102,14 +102,14 @@  discard block
 
 block discarded – undo
102 102
103 103 
     protected function appendLogicKeywords() : void
104 104 
     {
105 
-        if(!$this->command->supportsLogicKeywords())
105 
+        if (!$this->command->supportsLogicKeywords())
106 106 
         {
107 107 
             return;
108 108 
         }
109 109
110 110 
         $keywords = $this->command->getLogicKeywords()->getKeywords();
111 111
112 
-        foreach($keywords as $keyword)
112 
+        foreach ($keywords as $keyword)
113 113 
         {
114 114 
             $this->appendLogicKeyword($keyword);
115 115 
         }
 
@@ -121,7 +121,7 @@  discard block
 
 block discarded – undo
121 121
122 122 
         $type = $keyword->getType();
123 123
124 
-        if(!empty($type))
124 
+        if (!empty($type))
125 125 
         {
126 126 
             $this->parts[] = ' '.$this->renderTag(array('command-type'), $type);
127 127 
         }
 
@@ -140,7 +140,7 @@  discard block
 
 block discarded – undo
140 140 
     {
141 141 
         $parts = array();
142 142
143 
-        foreach($classes as $class)
143 
+        foreach ($classes as $class)
144 144 
         {
145 145 
             $parts[] = 'mailcode-'.$class;
146 146 
         }
Please login to merge, or discard this patch.
css/index.php 3 patches
Indentation   +7 added lines, -7 removed lines patch added patch discarded remove patch 
@@ -48,13 +48,13 @@
 
 block discarded – undo
48 48 
     <body>
49 49 
     	<p>
50 50 
     		<?php
51 
-    		    pts('This showcases the command\'s syntax highlighting.');
52 
-    		    pts(
53 
-    		        'It is based on the %1$s color scheme%2$s:',
54 
-    		        '<a href="https://ethanschoonover.com/solarized/">"Solarized"',
55 
-    		        '</a>'
56 
-		        );
57 
-    		?>
51 
+                pts('This showcases the command\'s syntax highlighting.');
52 
+                pts(
53 
+                    'It is based on the %1$s color scheme%2$s:',
54 
+                    '<a href="https://ethanschoonover.com/solarized/">"Solarized"',
55 
+                    '</a>'
56 
+                );
57 
+            ?>
58 58 
 		</p>
59 59 
 		<br>
60 60 
     	<div class="commands">
Please login to merge, or discard this patch.
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch 
@@ -17,7 +17,7 @@  discard block
 
 block discarded – undo
17 17 
     $autoload = realpath($root.'/../vendor/autoload.php');
18 18
19 19 
     // we need the autoloader to be present
20 
-    if($autoload === false)
20 
+    if ($autoload === false)
21 21 
     {
22 22 
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
23 23 
     }
 
@@ -65,19 +65,19 @@  discard block
 
 block discarded – undo
65 65 
                     Mailcode_Factory::misc()->comment('Some comments here'),
66 66 
                     Mailcode_Factory::show()->snippet('snippet_name'),
67 67 
                     Mailcode_Factory::show()->date('DATE.VARIABLE'),
68 
-                    Mailcode_Factory::if()->if('1 + 1 == 2'),
69 
-                    Mailcode_Factory::if()->contains('CUSTOMER.NAME', array('John')),
70 
-                    Mailcode_Factory::if()->varEquals('NUMBER', '124'),
68 
+                    Mailcode_Factory::if ()->if('1 + 1 == 2'),
69 
+                    Mailcode_Factory::if ()->contains('CUSTOMER.NAME', array('John')),
70 
+                    Mailcode_Factory::if ()->varEquals('NUMBER', '124'),
71 71 
                 );
72 72
73 
-                $and = Mailcode_Factory::elseIf()->varEqualsString('STRINGVAR', 'John');
73 
+                $and = Mailcode_Factory::elseIf ()->varEqualsString('STRINGVAR', 'John');
74 74 
                 $and->getLogicKeywords()->appendOR('$STRINGVAR == "Steve"', "variable");
75 75
76 76 
                 $commands[] = $and;
77 77
78 78 
                 $commands[] = Mailcode_Factory::misc()->end();
79 79
80 
-                foreach($commands as $command)
80 
+                foreach ($commands as $command)
81 81 
                 {
82 82 
                     ?>
83 83 
                     	<p>
Please login to merge, or discard this patch.
Braces   +6 added lines, -2 removed lines patch added patch discarded remove patch 
@@ -65,12 +65,16 @@
 
 block discarded – undo
65 65 
                     Mailcode_Factory::misc()->comment('Some comments here'),
66 66 
                     Mailcode_Factory::show()->snippet('snippet_name'),
67 67 
                     Mailcode_Factory::show()->date('DATE.VARIABLE'),
68 
-                    Mailcode_Factory::if()->if('1 + 1 == 2'),
68 
+                    Mailcode_Factory::if() {
69 
+                        ->if('1 + 1 == 2'),
69 70 
                     Mailcode_Factory::if()->contains('CUSTOMER.NAME', array('John')),
70 71 
                     Mailcode_Factory::if()->varEquals('NUMBER', '124'),
71 72 
                 );
73 
+                    }
72 74
73 
-                $and = Mailcode_Factory::elseIf()->varEqualsString('STRINGVAR', 'John');
75 
+                $and = Mailcode_Factory::elseIf() {
76 
+                    ->varEqualsString('STRINGVAR', 'John');
77 
+                }
74 78 
                 $and->getLogicKeywords()->appendOR('$STRINGVAR == "Steve"', "variable");
75 79
76 80 
                 $commands[] = $and;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/TokenType.php 2 patches
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch 
@@ -72,12 +72,12 @@  discard block
 
 block discarded – undo
72 72 
     protected function isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token, int $index) : bool
73 73 
     {
74 74 
         // filter out tokens of other types
75 
-        if(!is_a($token, $this->getTokenClass()))
75 
+        if (!is_a($token, $this->getTokenClass()))
76 76 
         {
77 77 
             return false;
78 78 
         }
79 79
80 
-        if($this->searchIndex >= 0 && $index !== $this->searchIndex)
80 
+        if ($this->searchIndex >= 0 && $index !== $this->searchIndex)
81 81 
         {
82 82 
             return false;
83 83 
         }
 
@@ -96,9 +96,9 @@  discard block
 
 block discarded – undo
96 96 
     {
97 97 
         $tokens = $this->params->getTokens();
98 98
99 
-        foreach($tokens as $index => $token)
99 
+        foreach ($tokens as $index => $token)
100 100 
         {
101 
-            if($this->isMatch($token, $index))
101 
+            if ($this->isMatch($token, $index))
102 102 
             {
103 103 
                 return $token;
104 104 
             }
 
@@ -111,7 +111,7 @@  discard block
 
 block discarded – undo
111 111 
     {
112 112 
         $token = $this->findToken();
113 113
114 
-        if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token && is_a($token, $this->getTokenClass()))
114 
+        if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token && is_a($token, $this->getTokenClass()))
115 115 
         {
116 116 
             $this->token = $token;
117 117 
             return true;
Please login to merge, or discard this patch.
Indentation   +52 added lines, -52 removed lines patch added patch discarded remove patch 
@@ -22,53 +22,53 @@  discard block
 
 block discarded – undo
22 22 
 {
23 23 
     public const VALIDATION_ERROR_COMMAND_WITHOUT_PARAMETERS = 62401;
24 24
25 
-   /**
26 
-    * @var integer
27 
-    */
25 
+    /**
26 
+     * @var integer
27 
+     */
28 28 
     protected $searchIndex = -1;
29 29
30 
-   /**
31 
-    * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL
32 
-    */
30 
+    /**
31 
+     * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL
32 
+     */
33 33 
     protected $token;
34 34
35 
-   /**
36 
-    * Retrieves the class name of the token type to
37 
-    * limit the token search to. Only a token of this
38 
-    * type will be stored.
39 
-    *
40 
-    * @return string
41 
-    */
35 
+    /**
36 
+     * Retrieves the class name of the token type to
37 
+     * limit the token search to. Only a token of this
38 
+     * type will be stored.
39 
+     *
40 
+     * @return string
41 
+     */
42 42 
     abstract protected function getTokenClass() : string;
43 43
44 
-   /**
45 
-    * Allows the validator to apply custom search
46 
-    * criteria to the tokens that are searched
47 
-    * through to find the target token.
48 
-    *
49 
-    * NOTE: Should return true if there are no
50 
-    * custom criteria to apply.
51 
-    *
52 
-    * @param Mailcode_Parser_Statement_Tokenizer_Token $token
53 
-    * @return bool
54 
-    */
44 
+    /**
45 
+     * Allows the validator to apply custom search
46 
+     * criteria to the tokens that are searched
47 
+     * through to find the target token.
48 
+     *
49 
+     * NOTE: Should return true if there are no
50 
+     * custom criteria to apply.
51 
+     *
52 
+     * @param Mailcode_Parser_Statement_Tokenizer_Token $token
53 
+     * @return bool
54 
+     */
55 55 
     abstract protected function _isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token) : bool;
56 56
57 
-   /**
58 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token
59 
-    */
57 
+    /**
58 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token
59 
+     */
60 60 
     abstract public function getToken();
61 61
62 
-   /**
63 
-    * Checks if the specified token matches the current
64 
-    * search criteria (index, type...). If the token is
65 
-    * a match, the `_isMatch()` method is called to allow
66 
-    * the validator class to apply some custom criteria.
67 
-    *
68 
-    * @param Mailcode_Parser_Statement_Tokenizer_Token $token
69 
-    * @param int $index
70 
-    * @return bool
71 
-    */
62 
+    /**
63 
+     * Checks if the specified token matches the current
64 
+     * search criteria (index, type...). If the token is
65 
+     * a match, the `_isMatch()` method is called to allow
66 
+     * the validator class to apply some custom criteria.
67 
+     *
68 
+     * @param Mailcode_Parser_Statement_Tokenizer_Token $token
69 
+     * @param int $index
70 
+     * @return bool
71 
+     */
72 72 
     protected function isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token, int $index) : bool
73 73 
     {
74 74 
         // filter out tokens of other types
 
@@ -85,13 +85,13 @@  discard block
 
 block discarded – undo
85 85 
         return $this->_isMatch($token);
86 86 
     }
87 87
88 
-   /**
89 
-    * Attempts to find a token in the statement
90 
-    * that matches the current criteria, and the
91 
-    * first one it finds is returned.
92 
-    *
93 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
94 
-    */
88 
+    /**
89 
+     * Attempts to find a token in the statement
90 
+     * that matches the current criteria, and the
91 
+     * first one it finds is returned.
92 
+     *
93 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
94 
+     */
95 95 
     protected function findToken() : ?Mailcode_Parser_Statement_Tokenizer_Token
96 96 
     {
97 97 
         $tokens = $this->params->getTokens();
 
@@ -120,14 +120,14 @@  discard block
 
 block discarded – undo
120 120 
         return false;
121 121 
     }
122 122
123 
-   /**
124 
-    * Searches for a specific token index.
125 
-    *
126 
-    * NOTE: only relevant when trying to find a single token.
127 
-    *
128 
-    * @param int $index
129 
-    * @return $this
130 
-    */
123 
+    /**
124 
+     * Searches for a specific token index.
125 
+     *
126 
+     * NOTE: only relevant when trying to find a single token.
127 
+     *
128 
+     * @param int $index
129 
+     * @return $this
130 
+     */
131 131 
     public function setIndex(int $index) : Mailcode_Parser_Statement_Validator_TokenType
132 132 
     {
133 133 
         $this->searchIndex = $index;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type.php 2 patches
Indentation   +12 added lines, -12 removed lines patch added patch discarded remove patch 
@@ -20,9 +20,9 @@  discard block
 
 block discarded – undo
20 20 
  */
21 21 
 abstract class Mailcode_Parser_Statement_Validator_Type
22 22 
 {
23 
-   /**
24 
-    * @var Mailcode_Parser_Statement
25 
-    */
23 
+    /**
24 
+     * @var Mailcode_Parser_Statement
25 
+     */
26 26 
     protected $statement;
27 27
28 28 
     /**
 
@@ -30,14 +30,14 @@  discard block
 
 block discarded – undo
30 30 
      */
31 31 
     protected $params;
32 32
33 
-   /**
34 
-    * @var boolean
35 
-    */
33 
+    /**
34 
+     * @var boolean
35 
+     */
36 36 
     private $valid = true;
37 37
38 
-   /**
39 
-    * @var boolean
40 
-    */
38 
+    /**
39 
+     * @var boolean
40 
+     */
41 41 
     private $validated = false;
42 42
43 43 
     public function __construct(Mailcode_Parser_Statement $statement)
 
@@ -53,9 +53,9 @@  discard block
 
 block discarded – undo
53 53
54 54 
     }
55 55
56 
-   /**
57 
-    * @return $this
58 
-    */
56 
+    /**
57 
+     * @return $this
58 
+     */
59 59 
     public function validate() : Mailcode_Parser_Statement_Validator_Type
60 60 
     {
61 61 
         if(!$this->validated)
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch 
@@ -58,7 +58,7 @@
 
 block discarded – undo
58 58 
     */
59 59 
     public function validate() : Mailcode_Parser_Statement_Validator_Type
60 60 
     {
61 
-        if(!$this->validated)
61 
+        if (!$this->validated)
62 62 
         {
63 63 
             $this->valid = $this->_validate();
64 64 
             $this->validated = true;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type/Keyword.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch 
@@ -50,7 +50,7 @@
 
 block discarded – undo
50 50
51 51 
     public function getToken() : Mailcode_Parser_Statement_Tokenizer_Token_Keyword
52 52 
     {
53 
-        if($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword)
53 
+        if ($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword)
54 54 
         {
55 55 
             return $this->token;
56 56 
         }
Please login to merge, or discard this patch.
Indentation   +4 added lines, -4 removed lines patch added patch discarded remove patch 
@@ -22,10 +22,10 @@
 
 block discarded – undo
22 22 
 {
23 23 
     public const ERROR_NO_KEYWORD_TOKEN_FOUND = 62701;
24 24
25 
-   /**
26 
-    * The name of the keyword, with ":" appended.
27 
-    * @var string
28 
-    */
25 
+    /**
26 
+     * The name of the keyword, with ":" appended.
27 
+     * @var string
28 
+     */
29 29 
     protected $keywordName;
30 30
31 31 
     public function __construct(Mailcode_Parser_Statement $statement, string $keywordName)
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type/Value.php 1 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 
     public function getToken() : Mailcode_Parser_Statement_Tokenizer_ValueInterface
36 36 
     {
37 
-        if($this->token instanceof Mailcode_Parser_Statement_Tokenizer_ValueInterface)
37 
+        if ($this->token instanceof Mailcode_Parser_Statement_Tokenizer_ValueInterface)
38 38 
         {
39 39 
             return $this->token;
40 40 
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type/StringLiteral.php 1 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 
     public function getToken() : Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
36 36 
     {
37 
-        if($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral)
37 
+        if ($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral)
38 38 
         {
39 39 
             return $this->token;
40 40 
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type/Operand.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch 
@@ -41,7 +41,7 @@  discard block
 
 block discarded – undo
41 41
42 42 
     protected function _isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token) : bool
43 43 
     {
44 
-        if(!empty($this->sign) && $token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand)
44 
+        if (!empty($this->sign) && $token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand)
45 45 
         {
46 46 
             return $token->getSign() === $this->sign;
47 47 
         }
 
@@ -51,7 +51,7 @@  discard block
 
 block discarded – undo
51 51
52 52 
     public function getToken() : Mailcode_Parser_Statement_Tokenizer_Token_Operand
53 53 
     {
54 
-        if($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand)
54 
+        if ($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand)
55 55 
         {
56 56 
             return $this->token;
57 57 
         }
Please login to merge, or discard this patch.
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -22,9 +22,9 @@
 
 block discarded – undo
22 22 
 {
23 23 
     public const ERROR_NO_OPERAND_TOKEN_FOUND = 62901;
24 24
25 
-   /**
26 
-    * @var string
27 
-    */
25 
+    /**
26 
+     * @var string
27 
+     */
28 28 
     private $sign = '';
29 29
30 30 
     protected function getTokenClass() : string
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Validator/Type/Variable.php 1 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 
     public function getToken() : Mailcode_Parser_Statement_Tokenizer_Token_Variable
36 36 
     {
37 
-        if($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)
37 
+        if ($this->token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)
38 38 
         {
39 39 
             return $this->token;
40 40 
         }
Please login to merge, or discard this patch.