Passed
Push — master ( 5ccc42...a49720 )
by Sebastian
02:49
created
src/Mailcode/Commands/Command.php 1 patch
Indentation   +106 added lines, -106 removed lines patch added patch discarded remove patch
@@ -37,44 +37,44 @@  discard block
 block discarded – undo
37 37
 
38 38
     const META_URL_ENCODING = 'url_encoding';
39 39
 
40
-   /**
41
-    * @var string
42
-    */
40
+    /**
41
+     * @var string
42
+     */
43 43
     protected $type = '';
44 44
 
45
-   /**
46
-    * @var string
47
-    */
45
+    /**
46
+     * @var string
47
+     */
48 48
     protected $paramsString = '';
49 49
     
50
-   /**
51
-    * @var string
52
-    */
50
+    /**
51
+     * @var string
52
+     */
53 53
     protected $matchedText = '';
54 54
 
55
-   /**
56
-    * @var string
57
-    */
55
+    /**
56
+     * @var string
57
+     */
58 58
     protected $hash = '';
59 59
     
60
-   /**
61
-    * @var OperationResult
62
-    */
60
+    /**
61
+     * @var OperationResult
62
+     */
63 63
     protected $validationResult = null;
64 64
     
65
-   /**
66
-    * @var \Mailcode\Mailcode
67
-    */
65
+    /**
66
+     * @var \Mailcode\Mailcode
67
+     */
68 68
     protected $mailcode;
69 69
     
70
-   /**
71
-    * @var \Mailcode\Mailcode_Parser_Statement
72
-    */
70
+    /**
71
+     * @var \Mailcode\Mailcode_Parser_Statement
72
+     */
73 73
     protected $params;
74 74
 
75
-   /**
76
-    * @var string[] 
77
-    */
75
+    /**
76
+     * @var string[] 
77
+     */
78 78
     protected $validations = array(
79 79
         'params_empty',
80 80
         'params_keywords',
@@ -83,24 +83,24 @@  discard block
 block discarded – undo
83 83
         'type_unsupported'
84 84
     );
85 85
     
86
-   /**
87
-    * @var string
88
-    */
86
+    /**
87
+     * @var string
88
+     */
89 89
     protected $comment = '';
90 90
     
91
-   /**
92
-    * @var Mailcode_Commands_LogicKeywords|NULL
93
-    */
91
+    /**
92
+     * @var Mailcode_Commands_LogicKeywords|NULL
93
+     */
94 94
     protected $logicKeywords;
95 95
     
96
-   /**
97
-    * @var Mailcode_Parser_Statement_Validator
98
-    */
96
+    /**
97
+     * @var Mailcode_Parser_Statement_Validator
98
+     */
99 99
     protected $validator;
100 100
     
101
-   /**
102
-    * @var boolean
103
-    */
101
+    /**
102
+     * @var boolean
103
+     */
104 104
     private $validated = false;
105 105
 
106 106
     /**
@@ -130,13 +130,13 @@  discard block
 block discarded – undo
130 130
         
131 131
     }
132 132
 
133
-   /**
134
-    * Sets the command's parent opening command, if any.
135
-    * NOTE: This is set automatically by the parser, and
136
-    * should not be called manually.
137
-    *
138
-    * @param Mailcode_Commands_Command $command
139
-    */
133
+    /**
134
+     * Sets the command's parent opening command, if any.
135
+     * NOTE: This is set automatically by the parser, and
136
+     * should not be called manually.
137
+     *
138
+     * @param Mailcode_Commands_Command $command
139
+     */
140 140
     public function setParent(Mailcode_Commands_Command $command) : void
141 141
     {
142 142
         $this->parent = $command;
@@ -152,9 +152,9 @@  discard block
 block discarded – undo
152 152
         return $this->parent;
153 153
     }
154 154
     
155
-   /**
156
-    * @return string The ID of the command = the name of the command class file.
157
-    */
155
+    /**
156
+     * @return string The ID of the command = the name of the command class file.
157
+     */
158 158
     public function getID() : string
159 159
     {
160 160
         // account for commands with types: If_Variable should still return If.
@@ -163,14 +163,14 @@  discard block
 block discarded – undo
163 163
         return array_shift($tokens);
164 164
     }
165 165
     
166
-   /**
167
-    * Sets an optional comment that is not used anywhere, but
168
-    * can be used by the application to track why a command is
169
-    * used somewhere. 
170
-    * 
171
-    * @param string $comment
172
-    * @return Mailcode_Commands_Command
173
-    */
166
+    /**
167
+     * Sets an optional comment that is not used anywhere, but
168
+     * can be used by the application to track why a command is
169
+     * used somewhere. 
170
+     * 
171
+     * @param string $comment
172
+     * @return Mailcode_Commands_Command
173
+     */
174 174
     public function setComment(string $comment) : Mailcode_Commands_Command
175 175
     {
176 176
         $this->comment = $comment;
@@ -178,34 +178,34 @@  discard block
 block discarded – undo
178 178
         return $this;
179 179
     }
180 180
     
181
-   /**
182
-    * Retrieves the previously set comment, if any.
183
-    * 
184
-    * @return string
185
-    */
181
+    /**
182
+     * Retrieves the previously set comment, if any.
183
+     * 
184
+     * @return string
185
+     */
186 186
     public function getComment() : string
187 187
     {
188 188
         return $this->comment;
189 189
     }
190 190
     
191
-   /**
192
-    * Checks whether this is a dummy command, which is only
193
-    * used to access information on the command type. It cannot
194
-    * be used as an actual live command.
195
-    * 
196
-    * @return bool
197
-    */
191
+    /**
192
+     * Checks whether this is a dummy command, which is only
193
+     * used to access information on the command type. It cannot
194
+     * be used as an actual live command.
195
+     * 
196
+     * @return bool
197
+     */
198 198
     public function isDummy() : bool
199 199
     {
200 200
         return $this->type === '__dummy';
201 201
     }
202 202
     
203
-   /**
204
-    * Retrieves a hash of the actual matched command string,
205
-    * which is used in collections to detect duplicate commands.
206
-    * 
207
-    * @return string
208
-    */
203
+    /**
204
+     * Retrieves a hash of the actual matched command string,
205
+     * which is used in collections to detect duplicate commands.
206
+     * 
207
+     * @return string
208
+     */
209 209
     public function getHash() : string
210 210
     {
211 211
         $this->requireNonDummy();
@@ -307,9 +307,9 @@  discard block
 block discarded – undo
307 307
         return $this->validationResult->isValid();
308 308
     }
309 309
     
310
-   /**
311
-    * @return string[]
312
-    */
310
+    /**
311
+     * @return string[]
312
+     */
313 313
     abstract protected function getValidations() : array;
314 314
     
315 315
     protected function validateSyntax_params_empty() : void
@@ -478,12 +478,12 @@  discard block
 block discarded – undo
478 478
 
479 479
     abstract public function supportsURLEncoding() : bool;
480 480
     
481
-   /**
482
-    * Whether the command allows using logic keywords like "and:" or "or:"
483
-    * in the command parameters.
484
-    * 
485
-    * @return bool
486
-    */
481
+    /**
482
+     * Whether the command allows using logic keywords like "and:" or "or:"
483
+     * in the command parameters.
484
+     * 
485
+     * @return bool
486
+     */
487 487
     abstract public function supportsLogicKeywords() : bool;
488 488
     
489 489
     abstract public function generatesContent() : bool;
@@ -529,22 +529,22 @@  discard block
 block discarded – undo
529 529
         return $normalizer->normalize();
530 530
     }
531 531
     
532
-   /**
533
-    * Retrieves the names of all the command's supported types: the part
534
-    * between the command name and the colon. Example: {command type: params}.
535
-    * 
536
-    * @return string[]
537
-    */
532
+    /**
533
+     * Retrieves the names of all the command's supported types: the part
534
+     * between the command name and the colon. Example: {command type: params}.
535
+     * 
536
+     * @return string[]
537
+     */
538 538
     public function getSupportedTypes() : array
539 539
     {
540 540
         return array();
541 541
     }
542 542
     
543
-   /**
544
-    * Retrieves all variable names used in the command.
545
-    * 
546
-    * @return Mailcode_Variables_Collection_Regular
547
-    */
543
+    /**
544
+     * Retrieves all variable names used in the command.
545
+     * 
546
+     * @return Mailcode_Variables_Collection_Regular
547
+     */
548 548
     public function getVariables() : Mailcode_Variables_Collection_Regular
549 549
     {
550 550
         return Mailcode::create()->findVariables($this->paramsString);
@@ -569,26 +569,26 @@  discard block
 block discarded – undo
569 569
         );
570 570
     }
571 571
 
572
-   /**
573
-    * Sets a parameter for the translation backend. The backend can use
574
-    * these to allow command-specific configurations.
575
-    *
576
-    * @param string $name
577
-    * @param mixed $value
578
-    * @return $this
579
-    */
572
+    /**
573
+     * Sets a parameter for the translation backend. The backend can use
574
+     * these to allow command-specific configurations.
575
+     *
576
+     * @param string $name
577
+     * @param mixed $value
578
+     * @return $this
579
+     */
580 580
     public function setTranslationParam(string $name, $value)
581 581
     {
582 582
         $this->translationParams[$name] = $value;
583 583
         return $this;
584 584
     }
585 585
 
586
-   /**
587
-    * Retrieves a previously set translation parameter.
588
-    *
589
-    * @param string $name
590
-    * @return mixed
591
-    */
586
+    /**
587
+     * Retrieves a previously set translation parameter.
588
+     *
589
+     * @param string $name
590
+     * @return mixed
591
+     */
592 592
     public function getTranslationParam(string $name)
593 593
     {
594 594
         if(isset($this->translationParams[$name]))
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/Parser/Safeguard.php 1 patch
Indentation   +144 added lines, -144 removed lines patch added patch discarded remove patch
@@ -54,45 +54,45 @@  discard block
 block discarded – undo
54 54
     const ERROR_INVALID_COMMANDS = 47801;
55 55
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
56 56
 
57
-   /**
58
-    * @var Mailcode_Parser
59
-    */
57
+    /**
58
+     * @var Mailcode_Parser
59
+     */
60 60
     protected $parser;
61 61
     
62
-   /**
63
-    * @var Mailcode_Collection
64
-    */
62
+    /**
63
+     * @var Mailcode_Collection
64
+     */
65 65
     protected $commands;
66 66
     
67
-   /**
68
-    * @var string
69
-    */
67
+    /**
68
+     * @var string
69
+     */
70 70
     protected $originalString;
71 71
     
72
-   /**
73
-    * @var Mailcode_Collection
74
-    */
72
+    /**
73
+     * @var Mailcode_Collection
74
+     */
75 75
     protected $collection;
76 76
     
77
-   /**
78
-    * Counter for the placeholders, global for all placeholders.
79
-    * @var integer
80
-    */
77
+    /**
78
+     * Counter for the placeholders, global for all placeholders.
79
+     * @var integer
80
+     */
81 81
     private static $counter = 0;
82 82
     
83
-   /**
84
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
85
-    */
83
+    /**
84
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
85
+     */
86 86
     protected $placeholders;
87 87
     
88
-   /**
89
-    * @var string
90
-    */
88
+    /**
89
+     * @var string
90
+     */
91 91
     protected $delimiter = '999';
92 92
     
93
-   /**
94
-    * @var string[]|NULL
95
-    */
93
+    /**
94
+     * @var string[]|NULL
95
+     */
96 96
     protected $placeholderStrings;
97 97
 
98 98
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -111,28 +111,28 @@  discard block
 block discarded – undo
111 111
         self::$counter = 0;
112 112
     }
113 113
     
114
-   /**
115
-    * Retrieves the string the safeguard was created for.
116
-    * 
117
-    * @return string
118
-    */
114
+    /**
115
+     * Retrieves the string the safeguard was created for.
116
+     * 
117
+     * @return string
118
+     */
119 119
     public function getOriginalString() : string
120 120
     {
121 121
         return $this->originalString;
122 122
     }
123 123
     
124
-   /**
125
-    * Sets the delimiter character sequence used to prepend
126
-    * and append to the placeholders.
127
-    * 
128
-    * The delimiter's default is "999".
129
-    *
130
-    * Minimum characters: 2
131
-    * Invalid characters: Any characters that get URL encoded
132
-    *
133
-    * @param string $delimiter
134
-    * @return Mailcode_Parser_Safeguard
135
-    */
124
+    /**
125
+     * Sets the delimiter character sequence used to prepend
126
+     * and append to the placeholders.
127
+     * 
128
+     * The delimiter's default is "999".
129
+     *
130
+     * Minimum characters: 2
131
+     * Invalid characters: Any characters that get URL encoded
132
+     *
133
+     * @param string $delimiter
134
+     * @return Mailcode_Parser_Safeguard
135
+     */
136 136
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
137 137
     {
138 138
         $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter);
@@ -148,15 +148,15 @@  discard block
 block discarded – undo
148 148
         return $this->delimiter;
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves the safe string in which all commands have been replaced
153
-    * by placeholder strings.
154
-    *
155
-    * @return string
156
-    * @throws Mailcode_Exception 
157
-    *
158
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
-    */
151
+    /**
152
+     * Retrieves the safe string in which all commands have been replaced
153
+     * by placeholder strings.
154
+     *
155
+     * @return string
156
+     * @throws Mailcode_Exception 
157
+     *
158
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
+     */
160 160
     public function makeSafe() : string
161 161
     {
162 162
         $this->requireValidCollection();
@@ -164,16 +164,16 @@  discard block
 block discarded – undo
164 164
         return $this->makeSafePartial();
165 165
     }
166 166
     
167
-   /**
168
-    * Like makeSafe(), but allows partial (invalid) commands: use this
169
-    * if the subject string may contain only part of the whole set of
170
-    * commands. 
171
-    * 
172
-    * Example: parsing a text with an opening if statement, without the 
173
-    * matching end statement.
174
-    * 
175
-    * @return string
176
-    */
167
+    /**
168
+     * Like makeSafe(), but allows partial (invalid) commands: use this
169
+     * if the subject string may contain only part of the whole set of
170
+     * commands. 
171
+     * 
172
+     * Example: parsing a text with an opening if statement, without the 
173
+     * matching end statement.
174
+     * 
175
+     * @return string
176
+     */
177 177
     public function makeSafePartial() : string
178 178
     {
179 179
         $placeholders = $this->getPlaceholders();
@@ -257,13 +257,13 @@  discard block
 block discarded – undo
257 257
         $analyzer->analyze();
258 258
     }
259 259
     
260
-   /**
261
-    * Creates a formatting handler, which can be used to specify
262
-    * which formattings to use for the commands in the subject string.
263
-    * 
264
-    * @param Mailcode_StringContainer|string $subject
265
-    * @return Mailcode_Parser_Safeguard_Formatting
266
-    */
260
+    /**
261
+     * Creates a formatting handler, which can be used to specify
262
+     * which formattings to use for the commands in the subject string.
263
+     * 
264
+     * @param Mailcode_StringContainer|string $subject
265
+     * @return Mailcode_Parser_Safeguard_Formatting
266
+     */
267 267
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
268 268
     {
269 269
         if(is_string($subject))
@@ -274,12 +274,12 @@  discard block
 block discarded – undo
274 274
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
275 275
     }
276 276
     
277
-   /**
278
-    * Retrieves all placeholders that have to be added to
279
-    * the subject text.
280
-    * 
281
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
-    */
277
+    /**
278
+     * Retrieves all placeholders that have to be added to
279
+     * the subject text.
280
+     * 
281
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
+     */
283 283
     public function getPlaceholders()
284 284
     {
285 285
         if(isset($this->placeholders))
@@ -355,16 +355,16 @@  discard block
 block discarded – undo
355 355
         return $string;
356 356
     }
357 357
     
358
-   /**
359
-    * Makes the string whole again after transforming or filtering it,
360
-    * by replacing the command placeholders with the original commands.
361
-    *
362
-    * @param string $string
363
-    * @return string
364
-    * @throws Mailcode_Exception
365
-    *
366
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
367
-    */
358
+    /**
359
+     * Makes the string whole again after transforming or filtering it,
360
+     * by replacing the command placeholders with the original commands.
361
+     *
362
+     * @param string $string
363
+     * @return string
364
+     * @throws Mailcode_Exception
365
+     *
366
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
367
+     */
368 368
     public function makeWhole(string $string) : string
369 369
     {
370 370
         return $this->restore(
@@ -374,15 +374,15 @@  discard block
 block discarded – undo
374 374
         );
375 375
     }
376 376
     
377
-   /**
378
-    * Like `makeWhole()`, but ignores missing command placeholders.
379
-    *
380
-    * @param string $string
381
-    * @return string
382
-    * @throws Mailcode_Exception
383
-    *
384
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
-    */
377
+    /**
378
+     * Like `makeWhole()`, but ignores missing command placeholders.
379
+     *
380
+     * @param string $string
381
+     * @return string
382
+     * @throws Mailcode_Exception
383
+     *
384
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
+     */
386 386
     public function makeWholePartial(string $string) : string
387 387
     {
388 388
         return $this->restore(
@@ -392,19 +392,19 @@  discard block
 block discarded – undo
392 392
         );
393 393
     }
394 394
 
395
-   /**
396
-    * Like `makeWhole()`, but replaces the commands with a syntax
397
-    * highlighted version, meant for human readable texts only.
398
-    * 
399
-    * Note: the commands lose their functionality (They cannot be 
400
-    * parsed from that string again).
401
-    *
402
-    * @param string $string
403
-    * @return string
404
-    * @throws Mailcode_Exception
405
-    *
406
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
-    */
395
+    /**
396
+     * Like `makeWhole()`, but replaces the commands with a syntax
397
+     * highlighted version, meant for human readable texts only.
398
+     * 
399
+     * Note: the commands lose their functionality (They cannot be 
400
+     * parsed from that string again).
401
+     *
402
+     * @param string $string
403
+     * @return string
404
+     * @throws Mailcode_Exception
405
+     *
406
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
+     */
408 408
     public function makeHighlighted(string $string) : string
409 409
     {
410 410
         return $this->restore(
@@ -414,15 +414,15 @@  discard block
 block discarded – undo
414 414
         );
415 415
     }
416 416
     
417
-   /**
418
-    * Like `makeHighlighted()`, but ignores missing command placeholders.
419
-    * 
420
-    * @param string $string
421
-    * @return string
422
-    * @throws Mailcode_Exception
423
-    *
424
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
-    */
417
+    /**
418
+     * Like `makeHighlighted()`, but ignores missing command placeholders.
419
+     * 
420
+     * @param string $string
421
+     * @return string
422
+     * @throws Mailcode_Exception
423
+     *
424
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
+     */
426 426
     public function makeHighlightedPartial(string $string) : string
427 427
     {
428 428
         return $this->restore(
@@ -432,11 +432,11 @@  discard block
 block discarded – undo
432 432
         );
433 433
     }
434 434
     
435
-   /**
436
-    * Retrieves the commands collection contained in the string.
437
-    * 
438
-    * @return Mailcode_Collection
439
-    */
435
+    /**
436
+     * Retrieves the commands collection contained in the string.
437
+     * 
438
+     * @return Mailcode_Collection
439
+     */
440 440
     public function getCollection() : Mailcode_Collection
441 441
     {
442 442
         if(isset($this->collection))
@@ -454,11 +454,11 @@  discard block
 block discarded – undo
454 454
         return $this->getCollection()->isValid();
455 455
     }
456 456
     
457
-   /**
458
-    * @throws Mailcode_Exception
459
-    * 
460
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
-    */
457
+    /**
458
+     * @throws Mailcode_Exception
459
+     * 
460
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
+     */
462 462
     protected function requireValidCollection() : void
463 463
     {
464 464
         if($this->getCollection()->isValid())
@@ -477,11 +477,11 @@  discard block
 block discarded – undo
477 477
         );
478 478
     }
479 479
     
480
-   /**
481
-    * Retrieves a list of all placeholder IDs used in the text.
482
-    * 
483
-    * @return string[]
484
-    */
480
+    /**
481
+     * Retrieves a list of all placeholder IDs used in the text.
482
+     * 
483
+     * @return string[]
484
+     */
485 485
     public function getPlaceholderStrings() : array
486 486
     {
487 487
         if(is_array($this->placeholderStrings))
@@ -508,13 +508,13 @@  discard block
 block discarded – undo
508 508
         return in_array($subject, $ids);
509 509
     }
510 510
     
511
-   /**
512
-    * Retrieves a placeholder instance by its ID.
513
-    * 
514
-    * @param int $id
515
-    * @throws Mailcode_Exception If the placeholder was not found.
516
-    * @return Mailcode_Parser_Safeguard_Placeholder
517
-    */
511
+    /**
512
+     * Retrieves a placeholder instance by its ID.
513
+     * 
514
+     * @param int $id
515
+     * @throws Mailcode_Exception If the placeholder was not found.
516
+     * @return Mailcode_Parser_Safeguard_Placeholder
517
+     */
518 518
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
519 519
     {
520 520
         $placeholders = $this->getPlaceholders();
@@ -537,13 +537,13 @@  discard block
 block discarded – undo
537 537
         );
538 538
     }
539 539
     
540
-   /**
541
-    * Retrieves a placeholder instance by its replacement text.
542
-    * 
543
-    * @param string $string
544
-    * @throws Mailcode_Exception
545
-    * @return Mailcode_Parser_Safeguard_Placeholder
546
-    */
540
+    /**
541
+     * Retrieves a placeholder instance by its replacement text.
542
+     * 
543
+     * @param string $string
544
+     * @throws Mailcode_Exception
545
+     * @return Mailcode_Parser_Safeguard_Placeholder
546
+     */
547 547
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
548 548
     {
549 549
         $placeholders = $this->getPlaceholders();
Please login to merge, or discard this patch.