Passed
Push — master ( 724bce...8ec95d )
by Sebastian
04:58
created
src/Mailcode/Commands/Command/ShowNumber.php 1 patch
Indentation   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -31,10 +31,10 @@  discard block
 block discarded – undo
31 31
     const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209;
32 32
     const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210;
33 33
     
34
-   /**
35
-    * The default number format string.
36
-    * @var string
37
-    */
34
+    /**
35
+     * The default number format string.
36
+     * @var string
37
+     */
38 38
     private $formatString = Mailcode_Number_Info::DEFAULT_FORMAT;
39 39
     
40 40
     public function getName() : string
@@ -58,16 +58,16 @@  discard block
 block discarded – undo
58 58
 
59 59
     protected function validateSyntax_check_format() : void
60 60
     {
61
-         $tokens = $this->params->getInfo()->getStringLiterals();
61
+            $tokens = $this->params->getInfo()->getStringLiterals();
62 62
          
63
-         // no format specified? Use the default one.
64
-         if(empty($tokens))
65
-         {
66
-             return;
67
-         }
63
+            // no format specified? Use the default one.
64
+            if(empty($tokens))
65
+            {
66
+                return;
67
+            }
68 68
 
69
-         $token = array_pop($tokens);
70
-         $this->parseFormatString($token->getText());
69
+            $token = array_pop($tokens);
70
+            $this->parseFormatString($token->getText());
71 71
     }
72 72
 
73 73
     private function parseFormatString(string $format) : void
@@ -86,11 +86,11 @@  discard block
 block discarded – undo
86 86
         );
87 87
     }
88 88
     
89
-   /**
90
-    * Retrieves the format string used to format the number.
91
-    * 
92
-    * @return string
93
-    */
89
+    /**
90
+     * Retrieves the format string used to format the number.
91
+     * 
92
+     * @return string
93
+     */
94 94
     public function getFormatString() : string
95 95
     {
96 96
         return $this->formatString;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement.php 1 patch
Indentation   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -26,24 +26,24 @@  discard block
 block discarded – undo
26 26
     const VALIDATION_EMPTY = 48801;
27 27
     const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
28 28
     
29
-   /**
30
-    * @var string
31
-    */
29
+    /**
30
+     * @var string
31
+     */
32 32
     protected $statement;
33 33
     
34
-   /**
35
-    * @var OperationResult
36
-    */
34
+    /**
35
+     * @var OperationResult
36
+     */
37 37
     protected $result;
38 38
     
39
-   /**
40
-    * @var Mailcode_Parser_Statement_Tokenizer
41
-    */
39
+    /**
40
+     * @var Mailcode_Parser_Statement_Tokenizer
41
+     */
42 42
     protected $tokenizer;
43 43
     
44
-   /**
45
-    * @var Mailcode_Parser_Statement_Info|NULL
46
-    */
44
+    /**
45
+     * @var Mailcode_Parser_Statement_Info|NULL
46
+     */
47 47
     protected $info;
48 48
 
49 49
     /**
@@ -112,7 +112,7 @@  discard block
 block discarded – undo
112 112
         if($unknown)
113 113
         {
114 114
             $this->result->makeError(
115
-               t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
115
+                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
116 116
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
117 117
             );
118 118
         }
Please login to merge, or discard this patch.
src/Mailcode/Traits/Commands/Validation/Variable.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -24,9 +24,9 @@  discard block
 block discarded – undo
24 24
  */
25 25
 trait Mailcode_Traits_Commands_Validation_Variable
26 26
 {
27
-   /**
28
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
29
-    */
27
+    /**
28
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
29
+     */
30 30
     protected $variableToken;
31 31
     
32 32
     protected function validateSyntax_variable() : void
@@ -60,11 +60,11 @@  discard block
 block discarded – undo
60 60
         );
61 61
     }
62 62
     
63
-   /**
64
-    * Retrieves the variable being compared.
65
-    *
66
-    * @return Mailcode_Variables_Variable
67
-    */
63
+    /**
64
+     * Retrieves the variable being compared.
65
+     *
66
+     * @return Mailcode_Variables_Variable
67
+     */
68 68
     public function getVariable() : Mailcode_Variables_Variable
69 69
     {
70 70
         if(isset($this->variableToken))
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Info.php 1 patch
Indentation   +64 added lines, -64 removed lines patch added patch discarded remove patch
@@ -21,14 +21,14 @@  discard block
 block discarded – undo
21 21
  */
22 22
 class Mailcode_Parser_Statement_Info
23 23
 {
24
-   /**
25
-    * @var Mailcode_Parser_Statement_Tokenizer
26
-    */
24
+    /**
25
+     * @var Mailcode_Parser_Statement_Tokenizer
26
+     */
27 27
     protected $tokenizer;
28 28
     
29
-   /**
30
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
31
-    */
29
+    /**
30
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
31
+     */
32 32
     protected $tokens = array();
33 33
 
34 34
     /**
@@ -52,21 +52,21 @@  discard block
 block discarded – undo
52 52
         $this->tokenizer->onTokensChanged(array($this, 'handleTokensChanged'));
53 53
     }
54 54
     
55
-   /**
56
-    * Whether the whole statement is a variable being assigned a value.
57
-    * 
58
-    * @return bool
59
-    */
55
+    /**
56
+     * Whether the whole statement is a variable being assigned a value.
57
+     * 
58
+     * @return bool
59
+     */
60 60
     public function isVariableAssignment() : bool
61 61
     {
62 62
         return $this->variables->isAssignment();
63 63
     }
64 64
     
65
-   /**
66
-    * Whether the whole statement is a variable being compared to something.
67
-    * 
68
-    * @return bool
69
-    */
65
+    /**
66
+     * Whether the whole statement is a variable being compared to something.
67
+     * 
68
+     * @return bool
69
+     */
70 70
     public function isVariableComparison() : bool
71 71
     {
72 72
         return $this->variables->isComparison();
@@ -83,27 +83,27 @@  discard block
 block discarded – undo
83 83
         return $this->variables->getAll();
84 84
     }
85 85
     
86
-   /**
87
-    * Retrieves a variable by its position in the command's parameters.
88
-    * Returns null if there is no parameter at the specified index, or
89
-    * if it is of another type.
90
-    * 
91
-    * @param int $index Zero-based index.
92
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
93
-    */
86
+    /**
87
+     * Retrieves a variable by its position in the command's parameters.
88
+     * Returns null if there is no parameter at the specified index, or
89
+     * if it is of another type.
90
+     * 
91
+     * @param int $index Zero-based index.
92
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
93
+     */
94 94
     public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable
95 95
     {
96 96
         return $this->variables->getByIndex($index);
97 97
     }
98 98
     
99
-   /**
100
-    * Retrieves a string literal by its position in the command's parameters.
101
-    * Returns null if there is no parameter at the specified index, or
102
-    * if it is of another type.
103
-    *
104
-    * @param int $index Zero-based index.
105
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
106
-    */
99
+    /**
100
+     * Retrieves a string literal by its position in the command's parameters.
101
+     * Returns null if there is no parameter at the specified index, or
102
+     * if it is of another type.
103
+     *
104
+     * @param int $index Zero-based index.
105
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
106
+     */
107 107
     public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
108 108
     {
109 109
         $token = $this->getTokenByIndex($index);
@@ -116,27 +116,27 @@  discard block
 block discarded – undo
116 116
         return null;
117 117
     }
118 118
     
119
-   /**
120
-    * Retrieves a keyword by its position in the command's parameters.
121
-    * Returns null if there is no parameter at the specified index, or
122
-    * if it is of another type.
123
-    *
124
-    * @param int $index Zero-based index.
125
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
126
-    */
119
+    /**
120
+     * Retrieves a keyword by its position in the command's parameters.
121
+     * Returns null if there is no parameter at the specified index, or
122
+     * if it is of another type.
123
+     *
124
+     * @param int $index Zero-based index.
125
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
126
+     */
127 127
     public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
128 128
     {
129 129
         return $this->keywords->getByIndex($index);
130 130
     }
131 131
     
132
-   /**
133
-    * Retrieves an operand by its position in the command's parameters.
134
-    * Returns null if there is no parameter at the specified index, or
135
-    * if it is of another type.
136
-    *
137
-    * @param int $index Zero-based index.
138
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
139
-    */
132
+    /**
133
+     * Retrieves an operand by its position in the command's parameters.
134
+     * Returns null if there is no parameter at the specified index, or
135
+     * if it is of another type.
136
+     *
137
+     * @param int $index Zero-based index.
138
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
139
+     */
140 140
     public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand
141 141
     {
142 142
         $token = $this->getTokenByIndex($index);
@@ -149,14 +149,14 @@  discard block
 block discarded – undo
149 149
         return null;
150 150
     }
151 151
     
152
-   /**
153
-    * Retrieves a parameter token by its position in the command's parameters,
154
-    * regardless of its type. Returns null if there is no parameter at the 
155
-    * specified index.
156
-    *
157
-    * @param int $index Zero-based index.
158
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
159
-    */
152
+    /**
153
+     * Retrieves a parameter token by its position in the command's parameters,
154
+     * regardless of its type. Returns null if there is no parameter at the 
155
+     * specified index.
156
+     *
157
+     * @param int $index Zero-based index.
158
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
159
+     */
160 160
     public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token
161 161
     {
162 162
         if(isset($this->tokens[$index]))
@@ -172,19 +172,19 @@  discard block
 block discarded – undo
172 172
         return isset($this->tokens[$index]);
173 173
     }
174 174
     
175
-   /**
176
-    * Retrieves all tokens.
177
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
178
-    */
175
+    /**
176
+     * Retrieves all tokens.
177
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
178
+     */
179 179
     public function getTokens() : array
180 180
     {
181 181
         return $this->tokens;
182 182
     }
183 183
     
184
-   /**
185
-    * Retrieves all string literals that were found in the command.
186
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
187
-    */
184
+    /**
185
+     * Retrieves all string literals that were found in the command.
186
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
187
+     */
188 188
     public function getStringLiterals() : array
189 189
     {
190 190
         $result = array();
Please login to merge, or discard this patch.
src/Mailcode/Parser/Statement/Tokenizer.php 1 patch
Indentation   +32 added lines, -32 removed lines patch added patch discarded remove patch
@@ -38,14 +38,14 @@  discard block
 block discarded – undo
38 38
         'ExtractTokens'
39 39
     );
40 40
     
41
-   /**
42
-    * @var Mailcode_Parser_Statement
43
-    */
41
+    /**
42
+     * @var Mailcode_Parser_Statement
43
+     */
44 44
     protected $statement;
45 45
     
46
-   /**
47
-    * @var string
48
-    */
46
+    /**
47
+     * @var string
48
+     */
49 49
     protected $tokenized;
50 50
     
51 51
     /**
@@ -53,9 +53,9 @@  discard block
 block discarded – undo
53 53
      */
54 54
     protected $tokensOrdered = array();
55 55
     
56
-   /**
57
-    * @var string[]
58
-    */
56
+    /**
57
+     * @var string[]
58
+     */
59 59
     protected static $ids = array();
60 60
 
61 61
     /**
@@ -70,12 +70,12 @@  discard block
 block discarded – undo
70 70
         $this->tokenize($statement->getStatementString());
71 71
     }
72 72
 
73
-   /**
74
-    * Retrieves all tokens detected in the statement string, in 
75
-    * the order they were found.
76
-    * 
77
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
78
-    */
73
+    /**
74
+     * Retrieves all tokens detected in the statement string, in 
75
+     * the order they were found.
76
+     * 
77
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
78
+     */
79 79
     public function getTokens()
80 80
     {
81 81
         return $this->tokensOrdered;
@@ -86,11 +86,11 @@  discard block
 block discarded – undo
86 86
         return !empty($this->tokensOrdered);
87 87
     }
88 88
     
89
-   /**
90
-    * Whether there were any unknown tokens in the statement.
91
-    * 
92
-    * @return bool
93
-    */
89
+    /**
90
+     * Whether there were any unknown tokens in the statement.
91
+     * 
92
+     * @return bool
93
+     */
94 94
     public function hasUnknown() : bool
95 95
     {
96 96
         $unknown = $this->getUnknown();
@@ -98,11 +98,11 @@  discard block
 block discarded – undo
98 98
         return !empty($unknown);
99 99
     }
100 100
     
101
-   /**
102
-    * Retrieves all unknown content tokens, if any.
103
-    * 
104
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
105
-    */
101
+    /**
102
+     * Retrieves all unknown content tokens, if any.
103
+     * 
104
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
105
+     */
106 106
     public function getUnknown()
107 107
     {
108 108
         $result = array();
@@ -273,13 +273,13 @@  discard block
 block discarded – undo
273 273
         return $token;
274 274
     }
275 275
     
276
-   /**
277
-    * Generates a unique alphabet-based ID without numbers
278
-    * to use as token name, to avoid conflicts with the
279
-    * numbers detection.
280
-    *
281
-    * @return string
282
-    */
276
+    /**
277
+     * Generates a unique alphabet-based ID without numbers
278
+     * to use as token name, to avoid conflicts with the
279
+     * numbers detection.
280
+     *
281
+     * @return string
282
+     */
283 283
     protected function generateID() : string
284 284
     {
285 285
         static $alphas;
Please login to merge, or discard this patch.
src/Mailcode/Parser.php 1 patch
Indentation   +51 added lines, -51 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();
@@ -101,14 +101,14 @@  discard block
 block discarded – undo
101 101
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
102 102
     }
103 103
     
104
-   /**
105
-    * Processes a single match found in the string: creates the command,
106
-    * and adds it to the collection if it's a valid command, or to the list
107
-    * of invalid commands otherwise.
108
-    * 
109
-    * @param Mailcode_Parser_Match $match
110
-    * @param Mailcode_Collection $collection
111
-    */
104
+    /**
105
+     * Processes a single match found in the string: creates the command,
106
+     * and adds it to the collection if it's a valid command, or to the list
107
+     * of invalid commands otherwise.
108
+     * 
109
+     * @param Mailcode_Parser_Match $match
110
+     * @param Mailcode_Collection $collection
111
+     */
112 112
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
113 113
     {
114 114
         $name = $match->getName();
@@ -170,14 +170,14 @@  discard block
 block discarded – undo
170 170
         throw new Mailcode_Exception('Not a command', '', self::ERROR_NOT_A_COMMAND);
171 171
     }
172 172
     
173
-   /**
174
-    * Parses a single regex match: determines which named group
175
-    * matches, and retrieves the according information.
176
-    * 
177
-    * @param array[] $matches The regex results array.
178
-    * @param int $index The matched index.
179
-    * @return Mailcode_Parser_Match
180
-    */
173
+    /**
174
+     * Parses a single regex match: determines which named group
175
+     * matches, and retrieves the according information.
176
+     * 
177
+     * @param array[] $matches The regex results array.
178
+     * @param int $index The matched index.
179
+     * @return Mailcode_Parser_Match
180
+     */
181 181
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
182 182
     {
183 183
         $name = ''; // the command name, e.g. "showvar"
@@ -215,27 +215,27 @@  discard block
 block discarded – undo
215 215
         );
216 216
     }
217 217
     
218
-   /**
219
-    * Creates an instance of the safeguard tool, which
220
-    * is used to safeguard commands in a string with placeholders.
221
-    * 
222
-    * @param string $subject The string to use to safeguard commands in.
223
-    * @return Mailcode_Parser_Safeguard
224
-    * @see Mailcode_Parser_Safeguard
225
-    */
218
+    /**
219
+     * Creates an instance of the safeguard tool, which
220
+     * is used to safeguard commands in a string with placeholders.
221
+     * 
222
+     * @param string $subject The string to use to safeguard commands in.
223
+     * @return Mailcode_Parser_Safeguard
224
+     * @see Mailcode_Parser_Safeguard
225
+     */
226 226
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
227 227
     {
228 228
         return new Mailcode_Parser_Safeguard($this, $subject);
229 229
     }
230 230
     
231
-   /**
232
-    * Creates a statement parser, which is used to validate arbitrary
233
-    * command statements.
234
-    * 
235
-    * @param string $statement
236
-    * @param bool $freeform
237
-    * @return Mailcode_Parser_Statement
238
-    */
231
+    /**
232
+     * Creates a statement parser, which is used to validate arbitrary
233
+     * command statements.
234
+     * 
235
+     * @param string $statement
236
+     * @param bool $freeform
237
+     * @return Mailcode_Parser_Statement
238
+     */
239 239
     public function createStatement(string $statement, bool $freeform=false) : Mailcode_Parser_Statement
240 240
     {
241 241
         return new Mailcode_Parser_Statement($statement, $freeform);
Please login to merge, or discard this patch.
src/Mailcode/Translator/Syntax/ApacheVelocity.php 1 patch
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_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command
22 22
 {
23
-   /**
24
-    * @var string[]
25
-    */
23
+    /**
24
+     * @var string[]
25
+     */
26 26
     private $regexSpecialChars = array(
27 27
         '?',
28 28
         '.',
@@ -47,15 +47,15 @@  discard block
 block discarded – undo
47 47
     }
48 48
 
49 49
     /**
50
-    * Filters the string for use in an Apache Velocity (Java)
51
-    * regex string: escapes all special characters.
52
-    *
53
-    * Velocity does its own escaping, so no need to escape special
54
-    * characters as if they were a javascript string.
55
-    * 
56
-    * @param string $string
57
-    * @return string
58
-    */
50
+     * Filters the string for use in an Apache Velocity (Java)
51
+     * regex string: escapes all special characters.
52
+     *
53
+     * Velocity does its own escaping, so no need to escape special
54
+     * characters as if they were a javascript string.
55
+     * 
56
+     * @param string $string
57
+     * @return string
58
+     */
59 59
     protected function filterRegexString(string $string) : string
60 60
     {
61 61
         // Special case: previously escaped quotes. 
Please login to merge, or discard this patch.
src/Mailcode/Collection.php 1 patch
Indentation   +54 added lines, -54 removed lines patch added patch discarded remove patch
@@ -25,9 +25,9 @@  discard block
 block discarded – undo
25 25
     const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301;
26 26
     const ERROR_CANNOT_MODIFY_FINALIZED = 52302;
27 27
     
28
-   /**
29
-    * @var Mailcode_Commands_Command[]
30
-    */
28
+    /**
29
+     * @var Mailcode_Commands_Command[]
30
+     */
31 31
     protected $commands = array();
32 32
     
33 33
     /**
@@ -35,9 +35,9 @@  discard block
 block discarded – undo
35 35
      */
36 36
     protected $errors = array();
37 37
     
38
-   /**
39
-    * @var OperationResult|NULL
40
-    */
38
+    /**
39
+     * @var OperationResult|NULL
40
+     */
41 41
     protected $validationResult;
42 42
 
43 43
     /**
@@ -46,11 +46,11 @@  discard block
 block discarded – undo
46 46
     private $finalized = false;
47 47
 
48 48
     /**
49
-    * Adds a command to the collection.
50
-    * 
51
-    * @param Mailcode_Commands_Command $command
52
-    * @return Mailcode_Collection
53
-    */
49
+     * Adds a command to the collection.
50
+     * 
51
+     * @param Mailcode_Commands_Command $command
52
+     * @return Mailcode_Collection
53
+     */
54 54
     public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection
55 55
     {
56 56
         if($this->finalized)
@@ -71,21 +71,21 @@  discard block
 block discarded – undo
71 71
         return $this;
72 72
     }
73 73
     
74
-   /**
75
-    * Whether there are any commands in the collection.
76
-    * 
77
-    * @return bool
78
-    */
74
+    /**
75
+     * Whether there are any commands in the collection.
76
+     * 
77
+     * @return bool
78
+     */
79 79
     public function hasCommands() : bool
80 80
     {
81 81
         return !empty($this->commands);
82 82
     }
83 83
     
84
-   /**
85
-    * Counts the amount of commands in the collection.
86
-    * 
87
-    * @return int
88
-    */
84
+    /**
85
+     * Counts the amount of commands in the collection.
86
+     * 
87
+     * @return int
88
+     */
89 89
     public function countCommands() : int
90 90
     {
91 91
         return count($this->commands);
@@ -123,9 +123,9 @@  discard block
 block discarded – undo
123 123
         $this->commands = $keep;
124 124
     }
125 125
     
126
-   /**
127
-    * @return Mailcode_Collection_Error[]
128
-    */
126
+    /**
127
+     * @return Mailcode_Collection_Error[]
128
+     */
129 129
     public function getErrors()
130 130
     {
131 131
         $result = $this->getValidationResult();
@@ -167,25 +167,25 @@  discard block
 block discarded – undo
167 167
         return empty($errors);
168 168
     }
169 169
     
170
-   /**
171
-    * Retrieves all commands that were detected, in the exact order
172
-    * they were found.
173
-    * 
174
-    * @return \Mailcode\Mailcode_Commands_Command[]
175
-    */
170
+    /**
171
+     * Retrieves all commands that were detected, in the exact order
172
+     * they were found.
173
+     * 
174
+     * @return \Mailcode\Mailcode_Commands_Command[]
175
+     */
176 176
     public function getCommands()
177 177
     {
178
-       return $this->commands;
178
+        return $this->commands;
179 179
     }
180 180
     
181
-   /**
182
-    * Retrieves all unique commands by their matched
183
-    * string hash: this ensures only commands that were
184
-    * written the exact same way (including spacing)
185
-    * are returned.
186
-    * 
187
-    * @return \Mailcode\Mailcode_Commands_Command[]
188
-    */
181
+    /**
182
+     * Retrieves all unique commands by their matched
183
+     * string hash: this ensures only commands that were
184
+     * written the exact same way (including spacing)
185
+     * are returned.
186
+     * 
187
+     * @return \Mailcode\Mailcode_Commands_Command[]
188
+     */
189 189
     public function getGroupedByHash()
190 190
     {
191 191
         $hashes = array();
@@ -203,12 +203,12 @@  discard block
 block discarded – undo
203 203
         return array_values($hashes);
204 204
     }
205 205
 
206
-   /**
207
-    * Adds several commands at once.
208
-    * 
209
-    * @param Mailcode_Commands_Command[] $commands
210
-    * @return Mailcode_Collection
211
-    */
206
+    /**
207
+     * Adds several commands at once.
208
+     * 
209
+     * @param Mailcode_Commands_Command[] $commands
210
+     * @return Mailcode_Collection
211
+     */
212 212
     public function addCommands(array $commands) : Mailcode_Collection
213 213
     {
214 214
         foreach($commands as $command)
@@ -281,10 +281,10 @@  discard block
 block discarded – undo
281 281
     }
282 282
 
283 283
     /**
284
-    * Retrieves only show variable commands in the collection, if any.
285
-    * 
286
-    * @return Mailcode_Commands_Command_ShowVariable[]
287
-    */
284
+     * Retrieves only show variable commands in the collection, if any.
285
+     * 
286
+     * @return Mailcode_Commands_Command_ShowVariable[]
287
+     */
288 288
     public function getShowVariableCommands()
289 289
     {
290 290
         return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class);
@@ -298,11 +298,11 @@  discard block
 block discarded – undo
298 298
         return $this->getCommandsByClass(Mailcode_Commands_Command_For::class);
299 299
     }
300 300
 
301
-   /**
302
-    * Retrieves only show date commands in the collection, if any.
303
-    *
304
-    * @return Mailcode_Commands_Command_ShowDate[]
305
-    */
301
+    /**
302
+     * Retrieves only show date commands in the collection, if any.
303
+     *
304
+     * @return Mailcode_Commands_Command_ShowDate[]
305
+     */
306 306
     public function getShowDateCommands() : array
307 307
     {
308 308
         return $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class);
Please login to merge, or discard this patch.
src/Mailcode/Commands/Command.php 1 patch
Indentation   +106 added lines, -106 removed lines patch added patch discarded remove patch
@@ -43,44 +43,44 @@  discard block
 block discarded – undo
43 43
 
44 44
     const META_URL_ENCODING = 'url_encoding';
45 45
 
46
-   /**
47
-    * @var string
48
-    */
46
+    /**
47
+     * @var string
48
+     */
49 49
     protected $type = '';
50 50
 
51
-   /**
52
-    * @var string
53
-    */
51
+    /**
52
+     * @var string
53
+     */
54 54
     protected $paramsString = '';
55 55
     
56
-   /**
57
-    * @var string
58
-    */
56
+    /**
57
+     * @var string
58
+     */
59 59
     protected $matchedText = '';
60 60
 
61
-   /**
62
-    * @var string
63
-    */
61
+    /**
62
+     * @var string
63
+     */
64 64
     protected $hash = '';
65 65
     
66
-   /**
67
-    * @var OperationResult
68
-    */
66
+    /**
67
+     * @var OperationResult
68
+     */
69 69
     protected $validationResult = null;
70 70
     
71
-   /**
72
-    * @var \Mailcode\Mailcode
73
-    */
71
+    /**
72
+     * @var \Mailcode\Mailcode
73
+     */
74 74
     protected $mailcode;
75 75
     
76
-   /**
77
-    * @var \Mailcode\Mailcode_Parser_Statement
78
-    */
76
+    /**
77
+     * @var \Mailcode\Mailcode_Parser_Statement
78
+     */
79 79
     protected $params;
80 80
 
81
-   /**
82
-    * @var string[] 
83
-    */
81
+    /**
82
+     * @var string[] 
83
+     */
84 84
     protected $validations = array(
85 85
         'params_empty',
86 86
         'params_keywords',
@@ -89,24 +89,24 @@  discard block
 block discarded – undo
89 89
         'type_unsupported'
90 90
     );
91 91
     
92
-   /**
93
-    * @var string
94
-    */
92
+    /**
93
+     * @var string
94
+     */
95 95
     protected $comment = '';
96 96
     
97
-   /**
98
-    * @var Mailcode_Commands_LogicKeywords|NULL
99
-    */
97
+    /**
98
+     * @var Mailcode_Commands_LogicKeywords|NULL
99
+     */
100 100
     protected $logicKeywords;
101 101
     
102
-   /**
103
-    * @var Mailcode_Parser_Statement_Validator
104
-    */
102
+    /**
103
+     * @var Mailcode_Parser_Statement_Validator
104
+     */
105 105
     protected $validator;
106 106
     
107
-   /**
108
-    * @var boolean
109
-    */
107
+    /**
108
+     * @var boolean
109
+     */
110 110
     private $validated = false;
111 111
 
112 112
     /**
@@ -146,13 +146,13 @@  discard block
 block discarded – undo
146 146
         
147 147
     }
148 148
 
149
-   /**
150
-    * Sets the command's parent opening command, if any.
151
-    * NOTE: This is set automatically by the parser, and
152
-    * should not be called manually.
153
-    *
154
-    * @param Mailcode_Commands_Command $command
155
-    */
149
+    /**
150
+     * Sets the command's parent opening command, if any.
151
+     * NOTE: This is set automatically by the parser, and
152
+     * should not be called manually.
153
+     *
154
+     * @param Mailcode_Commands_Command $command
155
+     */
156 156
     public function setParent(Mailcode_Commands_Command $command) : void
157 157
     {
158 158
         $this->parent = $command;
@@ -168,9 +168,9 @@  discard block
 block discarded – undo
168 168
         return $this->parent;
169 169
     }
170 170
     
171
-   /**
172
-    * @return string The ID of the command = the name of the command class file.
173
-    */
171
+    /**
172
+     * @return string The ID of the command = the name of the command class file.
173
+     */
174 174
     public function getID() : string
175 175
     {
176 176
         // account for commands with types: If_Variable should still return If.
@@ -179,14 +179,14 @@  discard block
 block discarded – undo
179 179
         return array_shift($tokens);
180 180
     }
181 181
     
182
-   /**
183
-    * Sets an optional comment that is not used anywhere, but
184
-    * can be used by the application to track why a command is
185
-    * used somewhere. 
186
-    * 
187
-    * @param string $comment
188
-    * @return Mailcode_Commands_Command
189
-    */
182
+    /**
183
+     * Sets an optional comment that is not used anywhere, but
184
+     * can be used by the application to track why a command is
185
+     * used somewhere. 
186
+     * 
187
+     * @param string $comment
188
+     * @return Mailcode_Commands_Command
189
+     */
190 190
     public function setComment(string $comment) : Mailcode_Commands_Command
191 191
     {
192 192
         $this->comment = $comment;
@@ -194,34 +194,34 @@  discard block
 block discarded – undo
194 194
         return $this;
195 195
     }
196 196
     
197
-   /**
198
-    * Retrieves the previously set comment, if any.
199
-    * 
200
-    * @return string
201
-    */
197
+    /**
198
+     * Retrieves the previously set comment, if any.
199
+     * 
200
+     * @return string
201
+     */
202 202
     public function getComment() : string
203 203
     {
204 204
         return $this->comment;
205 205
     }
206 206
     
207
-   /**
208
-    * Checks whether this is a dummy command, which is only
209
-    * used to access information on the command type. It cannot
210
-    * be used as an actual live command.
211
-    * 
212
-    * @return bool
213
-    */
207
+    /**
208
+     * Checks whether this is a dummy command, which is only
209
+     * used to access information on the command type. It cannot
210
+     * be used as an actual live command.
211
+     * 
212
+     * @return bool
213
+     */
214 214
     public function isDummy() : bool
215 215
     {
216 216
         return $this->type === '__dummy';
217 217
     }
218 218
     
219
-   /**
220
-    * Retrieves a hash of the actual matched command string,
221
-    * which is used in collections to detect duplicate commands.
222
-    * 
223
-    * @return string
224
-    */
219
+    /**
220
+     * Retrieves a hash of the actual matched command string,
221
+     * which is used in collections to detect duplicate commands.
222
+     * 
223
+     * @return string
224
+     */
225 225
     public function getHash() : string
226 226
     {
227 227
         $this->requireNonDummy();
@@ -323,9 +323,9 @@  discard block
 block discarded – undo
323 323
         return $this->validationResult->isValid();
324 324
     }
325 325
     
326
-   /**
327
-    * @return string[]
328
-    */
326
+    /**
327
+     * @return string[]
328
+     */
329 329
     abstract protected function getValidations() : array;
330 330
 
331 331
     protected function _validateNesting() : void
@@ -413,12 +413,12 @@  discard block
 block discarded – undo
413 413
 
414 414
     abstract public function supportsURLEncoding() : bool;
415 415
     
416
-   /**
417
-    * Whether the command allows using logic keywords like "and:" or "or:"
418
-    * in the command parameters.
419
-    * 
420
-    * @return bool
421
-    */
416
+    /**
417
+     * Whether the command allows using logic keywords like "and:" or "or:"
418
+     * in the command parameters.
419
+     * 
420
+     * @return bool
421
+     */
422 422
     abstract public function supportsLogicKeywords() : bool;
423 423
     
424 424
     abstract public function generatesContent() : bool;
@@ -464,22 +464,22 @@  discard block
 block discarded – undo
464 464
         return $normalizer->normalize();
465 465
     }
466 466
     
467
-   /**
468
-    * Retrieves the names of all the command's supported types: the part
469
-    * between the command name and the colon. Example: {command type: params}.
470
-    * 
471
-    * @return string[]
472
-    */
467
+    /**
468
+     * Retrieves the names of all the command's supported types: the part
469
+     * between the command name and the colon. Example: {command type: params}.
470
+     * 
471
+     * @return string[]
472
+     */
473 473
     public function getSupportedTypes() : array
474 474
     {
475 475
         return array();
476 476
     }
477 477
     
478
-   /**
479
-    * Retrieves all variable names used in the command.
480
-    * 
481
-    * @return Mailcode_Variables_Collection_Regular
482
-    */
478
+    /**
479
+     * Retrieves all variable names used in the command.
480
+     * 
481
+     * @return Mailcode_Variables_Collection_Regular
482
+     */
483 483
     public function getVariables() : Mailcode_Variables_Collection_Regular
484 484
     {
485 485
         return Mailcode::create()->findVariables($this->paramsString);
@@ -504,26 +504,26 @@  discard block
 block discarded – undo
504 504
         );
505 505
     }
506 506
 
507
-   /**
508
-    * Sets a parameter for the translation backend. The backend can use
509
-    * these to allow command-specific configurations.
510
-    *
511
-    * @param string $name
512
-    * @param mixed $value
513
-    * @return $this
514
-    */
507
+    /**
508
+     * Sets a parameter for the translation backend. The backend can use
509
+     * these to allow command-specific configurations.
510
+     *
511
+     * @param string $name
512
+     * @param mixed $value
513
+     * @return $this
514
+     */
515 515
     public function setTranslationParam(string $name, $value)
516 516
     {
517 517
         $this->translationParams[$name] = $value;
518 518
         return $this;
519 519
     }
520 520
 
521
-   /**
522
-    * Retrieves a previously set translation parameter.
523
-    *
524
-    * @param string $name
525
-    * @return mixed
526
-    */
521
+    /**
522
+     * Retrieves a previously set translation parameter.
523
+     *
524
+     * @param string $name
525
+     * @return mixed
526
+     */
527 527
     public function getTranslationParam(string $name)
528 528
     {
529 529
         if(isset($this->translationParams[$name]))
Please login to merge, or discard this patch.