@@ -29,19 +29,19 @@ |
||
29 | 29 | const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103; |
30 | 30 | const VALIDATION_UNCLOSED_COMMAND = 49104; |
31 | 31 | |
32 | - /** |
|
33 | - * @var Mailcode_Collection |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var Mailcode_Collection |
|
34 | + */ |
|
35 | 35 | protected $collection; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * @var Mailcode_Commands_Command[] |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var Mailcode_Commands_Command[] |
|
44 | + */ |
|
45 | 45 | protected $stack = array(); |
46 | 46 | |
47 | 47 | public function __construct(Mailcode_Collection $collection) |
@@ -60,11 +60,11 @@ discard block |
||
60 | 60 | |
61 | 61 | $commands = $this->collection->getCommands(); |
62 | 62 | |
63 | - foreach($commands as $command) |
|
63 | + foreach ($commands as $command) |
|
64 | 64 | { |
65 | 65 | $method = 'validate_'.$command->getCommandType(); |
66 | 66 | |
67 | - if(!method_exists($this, $method)) |
|
67 | + if (!method_exists($this, $method)) |
|
68 | 68 | { |
69 | 69 | throw new Mailcode_Exception( |
70 | 70 | 'Unknown command type validation method.', |
@@ -79,13 +79,13 @@ discard block |
||
79 | 79 | |
80 | 80 | $this->$method($command); |
81 | 81 | |
82 | - if(!$this->validationResult->isValid()) |
|
82 | + if (!$this->validationResult->isValid()) |
|
83 | 83 | { |
84 | 84 | break; |
85 | 85 | } |
86 | 86 | } |
87 | 87 | |
88 | - if($this->validationResult->isValid()) |
|
88 | + if ($this->validationResult->isValid()) |
|
89 | 89 | { |
90 | 90 | $this->validate_Unclosed(); |
91 | 91 | } |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | { |
98 | 98 | $leftover = $this->getOpenCommand(); |
99 | 99 | |
100 | - if($leftover === null) |
|
100 | + if ($leftover === null) |
|
101 | 101 | { |
102 | 102 | return; |
103 | 103 | } |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | |
114 | 114 | protected function getOpenCommand() : ?Mailcode_Commands_Command_Type_Opening |
115 | 115 | { |
116 | - if(empty($this->stack)) |
|
116 | + if (empty($this->stack)) |
|
117 | 117 | { |
118 | 118 | return null; |
119 | 119 | } |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | |
125 | 125 | $cmd = $this->stack[$idx]; |
126 | 126 | |
127 | - if($cmd instanceof Mailcode_Commands_Command_Type_Opening) |
|
127 | + if ($cmd instanceof Mailcode_Commands_Command_Type_Opening) |
|
128 | 128 | { |
129 | 129 | return $cmd; |
130 | 130 | } |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | { |
149 | 149 | $parent = $this->getOpenCommand(); |
150 | 150 | |
151 | - if($parent === null) |
|
151 | + if ($parent === null) |
|
152 | 152 | { |
153 | 153 | $this->validationResult->makeError( |
154 | 154 | t( |
@@ -162,7 +162,7 @@ discard block |
||
162 | 162 | return; |
163 | 163 | } |
164 | 164 | |
165 | - if($parent->getName() !== $command->getParentName()) |
|
165 | + if ($parent->getName() !== $command->getParentName()) |
|
166 | 166 | { |
167 | 167 | $this->validationResult->makeError( |
168 | 168 | t( |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | |
182 | 182 | protected function validate_Closing(Mailcode_Commands_Command_Type_Closing $command) |
183 | 183 | { |
184 | - if(empty($this->stack)) |
|
184 | + if (empty($this->stack)) |
|
185 | 185 | { |
186 | 186 | $this->validationResult->makeError( |
187 | 187 | t('All open commands have already been ended.'), |
@@ -29,34 +29,34 @@ discard block |
||
29 | 29 | const VALIDATION_ADDON_NOT_SUPPORTED = 48303; |
30 | 30 | const VALIDATION_UNKNOWN_COMMAND_NAME = 48304; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $type = ''; |
36 | 36 | |
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | 40 | protected $paramsString = ''; |
41 | 41 | |
42 | - /** |
|
43 | - * @var string |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var string |
|
44 | + */ |
|
45 | 45 | protected $matchedText = ''; |
46 | 46 | |
47 | - /** |
|
48 | - * @var string |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var string |
|
49 | + */ |
|
50 | 50 | protected $hash = ''; |
51 | 51 | |
52 | - /** |
|
53 | - * @var \AppUtils\OperationResult |
|
54 | - */ |
|
52 | + /** |
|
53 | + * @var \AppUtils\OperationResult |
|
54 | + */ |
|
55 | 55 | protected $validationResult = null; |
56 | 56 | |
57 | - /** |
|
58 | - * @var \Mailcode\Mailcode |
|
59 | - */ |
|
57 | + /** |
|
58 | + * @var \Mailcode\Mailcode |
|
59 | + */ |
|
60 | 60 | protected $mailcode; |
61 | 61 | |
62 | 62 | public function __construct(string $type='', string $paramsString='', string $matchedText='') |
@@ -67,33 +67,33 @@ discard block |
||
67 | 67 | $this->mailcode = Mailcode::create(); |
68 | 68 | } |
69 | 69 | |
70 | - /** |
|
71 | - * @return string The ID of the command = the name of the command class file. |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @return string The ID of the command = the name of the command class file. |
|
72 | + */ |
|
73 | 73 | public function getID() : string |
74 | 74 | { |
75 | 75 | $tokens = explode('_', get_class($this)); |
76 | 76 | return array_pop($tokens); |
77 | 77 | } |
78 | 78 | |
79 | - /** |
|
80 | - * Checks whether this is a dummy command, which is only |
|
81 | - * used to access information on the command type. It cannot |
|
82 | - * be used as an actual live command. |
|
83 | - * |
|
84 | - * @return bool |
|
85 | - */ |
|
79 | + /** |
|
80 | + * Checks whether this is a dummy command, which is only |
|
81 | + * used to access information on the command type. It cannot |
|
82 | + * be used as an actual live command. |
|
83 | + * |
|
84 | + * @return bool |
|
85 | + */ |
|
86 | 86 | public function isDummy() : bool |
87 | 87 | { |
88 | 88 | return $this->type === '__dummy'; |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Retrieves a hash of the actual matched command string, |
|
93 | - * which is used in collections to detect duplicate commands. |
|
94 | - * |
|
95 | - * @return string |
|
96 | - */ |
|
91 | + /** |
|
92 | + * Retrieves a hash of the actual matched command string, |
|
93 | + * which is used in collections to detect duplicate commands. |
|
94 | + * |
|
95 | + * @return string |
|
96 | + */ |
|
97 | 97 | public function getHash() : string |
98 | 98 | { |
99 | 99 | $this->requireNonDummy(); |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | */ |
60 | 60 | protected $mailcode; |
61 | 61 | |
62 | - public function __construct(string $type='', string $paramsString='', string $matchedText='') |
|
62 | + public function __construct(string $type = '', string $paramsString = '', string $matchedText = '') |
|
63 | 63 | { |
64 | 64 | $this->type = $type; |
65 | 65 | $this->paramsString = $paramsString; |
@@ -98,7 +98,7 @@ discard block |
||
98 | 98 | { |
99 | 99 | $this->requireNonDummy(); |
100 | 100 | |
101 | - if($this->hash === '') { |
|
101 | + if ($this->hash === '') { |
|
102 | 102 | $this->hash = md5($this->matchedText); |
103 | 103 | } |
104 | 104 | |
@@ -107,7 +107,7 @@ discard block |
||
107 | 107 | |
108 | 108 | protected function requireNonDummy() : void |
109 | 109 | { |
110 | - if(!$this->isDummy()) |
|
110 | + if (!$this->isDummy()) |
|
111 | 111 | { |
112 | 112 | return; |
113 | 113 | } |
@@ -128,7 +128,7 @@ discard block |
||
128 | 128 | { |
129 | 129 | $this->requireNonDummy(); |
130 | 130 | |
131 | - if(isset($this->validationResult)) |
|
131 | + if (isset($this->validationResult)) |
|
132 | 132 | { |
133 | 133 | return $this->validationResult; |
134 | 134 | } |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | |
143 | 143 | public function getValidationResult() : \AppUtils\OperationResult |
144 | 144 | { |
145 | - if(isset($this->validationResult)) |
|
145 | + if (isset($this->validationResult)) |
|
146 | 146 | { |
147 | 147 | return $this->validationResult; |
148 | 148 | } |
@@ -165,11 +165,11 @@ discard block |
||
165 | 165 | { |
166 | 166 | $validations = array_merge($this->validations, $this->getValidations()); |
167 | 167 | |
168 | - foreach($validations as $validation) |
|
168 | + foreach ($validations as $validation) |
|
169 | 169 | { |
170 | 170 | $method = 'validateSyntax_'.$validation; |
171 | 171 | |
172 | - if(!method_exists($this, $method)) |
|
172 | + if (!method_exists($this, $method)) |
|
173 | 173 | { |
174 | 174 | throw new Mailcode_Exception( |
175 | 175 | 'Missing validation method', |
@@ -185,7 +185,7 @@ discard block |
||
185 | 185 | $this->$method(); |
186 | 186 | |
187 | 187 | // break off at the first validation issue |
188 | - if(!$this->validationResult->isValid()) |
|
188 | + if (!$this->validationResult->isValid()) |
|
189 | 189 | { |
190 | 190 | return; |
191 | 191 | } |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | |
197 | 197 | protected function validateSyntax_params() |
198 | 198 | { |
199 | - if($this->requiresParameters() && empty($this->paramsString)) |
|
199 | + if ($this->requiresParameters() && empty($this->paramsString)) |
|
200 | 200 | { |
201 | 201 | $this->validationResult->makeError( |
202 | 202 | t('Parameters have to be specified.'), |
@@ -208,14 +208,14 @@ discard block |
||
208 | 208 | |
209 | 209 | protected function validateSyntax_type_supported() |
210 | 210 | { |
211 | - if(!$this->supportsType() || empty($this->type)) |
|
211 | + if (!$this->supportsType() || empty($this->type)) |
|
212 | 212 | { |
213 | 213 | return; |
214 | 214 | } |
215 | 215 | |
216 | 216 | $types = $this->getSupportedTypes(); |
217 | 217 | |
218 | - if(!in_array($this->type, $types)) |
|
218 | + if (!in_array($this->type, $types)) |
|
219 | 219 | { |
220 | 220 | $this->validationResult->makeError( |
221 | 221 | t('The command addon %1$s is not supported.', $this->type).' '. |
@@ -229,7 +229,7 @@ discard block |
||
229 | 229 | |
230 | 230 | protected function validateSyntax_type_unsupported() |
231 | 231 | { |
232 | - if($this->supportsType() || empty($this->type)) |
|
232 | + if ($this->supportsType() || empty($this->type)) |
|
233 | 233 | { |
234 | 234 | return; |
235 | 235 | } |
@@ -244,7 +244,7 @@ discard block |
||
244 | 244 | { |
245 | 245 | $vars = $this->getVariables(); |
246 | 246 | |
247 | - if(!$vars->hasInvalid()) |
|
247 | + if (!$vars->hasInvalid()) |
|
248 | 248 | { |
249 | 249 | return; |
250 | 250 | } |
@@ -264,7 +264,7 @@ discard block |
||
264 | 264 | |
265 | 265 | public function getType() : string |
266 | 266 | { |
267 | - if($this->supportsType()) |
|
267 | + if ($this->supportsType()) |
|
268 | 268 | { |
269 | 269 | return $this->type; |
270 | 270 | } |
@@ -290,7 +290,7 @@ discard block |
||
290 | 290 | |
291 | 291 | public function getParamsString() : string |
292 | 292 | { |
293 | - if($this->requiresParameters()) |
|
293 | + if ($this->requiresParameters()) |
|
294 | 294 | { |
295 | 295 | return $this->paramsString; |
296 | 296 | } |
@@ -26,19 +26,19 @@ |
||
26 | 26 | const VALIDATION_VARIABLE_LEFT_UNRECOGNIZED = 48504; |
27 | 27 | const VALIDATION_ASSIGNMENT_STATEMENT_INVALID = 48505; |
28 | 28 | |
29 | - /** |
|
30 | - * @var string[] |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var string[] |
|
31 | + */ |
|
32 | 32 | protected $parts = array(); |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Variables_Variable |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Variables_Variable |
|
36 | + */ |
|
37 | 37 | protected $leftVar; |
38 | 38 | |
39 | - /** |
|
40 | - * @var Mailcode_Parser_Statement |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var Mailcode_Parser_Statement |
|
41 | + */ |
|
42 | 42 | protected $statement; |
43 | 43 | |
44 | 44 | public function getName() : string |
@@ -65,12 +65,12 @@ discard block |
||
65 | 65 | { |
66 | 66 | $amount = substr_count($this->paramsString, '='); |
67 | 67 | |
68 | - if($amount === 1) |
|
68 | + if ($amount === 1) |
|
69 | 69 | { |
70 | 70 | return; |
71 | 71 | } |
72 | 72 | |
73 | - if($amount < 1) |
|
73 | + if ($amount < 1) |
|
74 | 74 | { |
75 | 75 | $this->validationResult->makeError( |
76 | 76 | t('The quality operator (=) is missing.'), |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | { |
91 | 91 | $this->parts = \AppUtils\ConvertHelper::explodeTrim('=', $this->paramsString); |
92 | 92 | |
93 | - if(count($this->parts) === 2) |
|
93 | + if (count($this->parts) === 2) |
|
94 | 94 | { |
95 | 95 | return; |
96 | 96 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | // any variables we may find have already been validated. |
107 | 107 | $vars = $this->mailcode->findVariables($this->parts[0])->getGroupedByName(); |
108 | 108 | |
109 | - if(count($vars) === 1) |
|
109 | + if (count($vars) === 1) |
|
110 | 110 | { |
111 | 111 | $this->leftVar = array_shift($vars); |
112 | 112 | return; |
@@ -122,7 +122,7 @@ discard block |
||
122 | 122 | { |
123 | 123 | $this->statement = $this->mailcode->getParser()->createStatement($this->parts[1]); |
124 | 124 | |
125 | - if($this->statement->isValid()) |
|
125 | + if ($this->statement->isValid()) |
|
126 | 126 | { |
127 | 127 | return; |
128 | 128 | } |
@@ -76,8 +76,7 @@ |
||
76 | 76 | t('The quality operator (=) is missing.'), |
77 | 77 | self::VALIDATION_MISSING_EQUALS_SIGN |
78 | 78 | ); |
79 | - } |
|
80 | - else |
|
79 | + } else |
|
81 | 80 | { |
82 | 81 | $this->validationResult->makeError( |
83 | 82 | t('Only a single equality operator (=) should be used for variable assignment.'), |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | { |
47 | 47 | $amount = $this->getVariables()->countVariables(); |
48 | 48 | |
49 | - if($amount >= 1) |
|
49 | + if ($amount >= 1) |
|
50 | 50 | { |
51 | 51 | return; |
52 | 52 | } |
@@ -61,7 +61,7 @@ discard block |
||
61 | 61 | { |
62 | 62 | $validations = array(); |
63 | 63 | |
64 | - if($this->getType() === 'variable') |
|
64 | + if ($this->getType() === 'variable') |
|
65 | 65 | { |
66 | 66 | $validations[] = 'require_variable'; |
67 | 67 | } |
@@ -32,29 +32,29 @@ |
||
32 | 32 | const VALIDATION_ERROR_PATH_UNDERSCORE = 48203; |
33 | 33 | const VALIDATION_ERROR_NAME_UNDERSCORE = 48204; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $path; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $name; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $matchedText; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $hash = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var OperationResult |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var OperationResult |
|
57 | + */ |
|
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | 60 | public function __construct(string $path, string $name, string $matchedText) |
@@ -86,7 +86,7 @@ discard block |
||
86 | 86 | |
87 | 87 | public function getHash() : string |
88 | 88 | { |
89 | - if(empty($this->hash)) |
|
89 | + if (empty($this->hash)) |
|
90 | 90 | { |
91 | 91 | $this->hash = md5($this->matchedText); |
92 | 92 | } |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | |
102 | 102 | public function getValidationResult() : OperationResult |
103 | 103 | { |
104 | - if(isset($this->validationResult)) |
|
104 | + if (isset($this->validationResult)) |
|
105 | 105 | { |
106 | 106 | return $this->validationResult; |
107 | 107 | } |
@@ -122,11 +122,11 @@ discard block |
||
122 | 122 | |
123 | 123 | protected function validate() : void |
124 | 124 | { |
125 | - foreach($this->validations as $validation) |
|
125 | + foreach ($this->validations as $validation) |
|
126 | 126 | { |
127 | 127 | $method = 'validate_'.$validation; |
128 | 128 | |
129 | - if(!method_exists($this, $method)) |
|
129 | + if (!method_exists($this, $method)) |
|
130 | 130 | { |
131 | 131 | throw new Mailcode_Exception( |
132 | 132 | 'Unknown validation method', |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | |
142 | 142 | $this->$method(); |
143 | 143 | |
144 | - if(!$this->validationResult->isValid()) |
|
144 | + if (!$this->validationResult->isValid()) |
|
145 | 145 | { |
146 | 146 | return; |
147 | 147 | } |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | |
171 | 171 | protected function validateNumber(string $value, int $errorCode) |
172 | 172 | { |
173 | - if(!is_numeric(substr($value, 0, 1))) |
|
173 | + if (!is_numeric(substr($value, 0, 1))) |
|
174 | 174 | { |
175 | 175 | return; |
176 | 176 | } |
@@ -190,7 +190,7 @@ discard block |
||
190 | 190 | $length = strlen($value); |
191 | 191 | |
192 | 192 | // trimming underscores does not change the length: no underscores at start or end of string. |
193 | - if(strlen(trim($value, '_')) == $length) |
|
193 | + if (strlen(trim($value, '_')) == $length) |
|
194 | 194 | { |
195 | 195 | return; |
196 | 196 | } |
@@ -29,14 +29,14 @@ discard block |
||
29 | 29 | |
30 | 30 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $statement; |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult |
|
39 | + */ |
|
40 | 40 | protected $result; |
41 | 41 | |
42 | 42 | protected $operands = array( |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | if(!empty($leftover)) |
98 | 98 | { |
99 | 99 | $this->result->makeError( |
100 | - t('Unquoted string literals found:').' "'.$leftover.'"', |
|
100 | + t('Unquoted string literals found:').' "'.$leftover.'"', |
|
101 | 101 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
102 | 102 | ); |
103 | 103 | } |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | |
64 | 64 | public function getValidationResult() : OperationResult |
65 | 65 | { |
66 | - if(isset($this->result)) |
|
66 | + if (isset($this->result)) |
|
67 | 67 | { |
68 | 68 | return $this->result; |
69 | 69 | } |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | { |
80 | 80 | $statement = trim($this->statement); |
81 | 81 | |
82 | - if(empty($statement)) |
|
82 | + if (empty($statement)) |
|
83 | 83 | { |
84 | 84 | $this->result->makeError( |
85 | 85 | t('Empty statement'), |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | $leftover = $this->removeTokens($tokenized); |
95 | 95 | $leftover = str_replace(' ', '', $leftover); |
96 | 96 | |
97 | - if(!empty($leftover)) |
|
97 | + if (!empty($leftover)) |
|
98 | 98 | { |
99 | 99 | $this->result->makeError( |
100 | 100 | t('Unquoted string literals found:').' "'.$leftover.'"', |
@@ -118,7 +118,7 @@ discard block |
||
118 | 118 | $matches = array(); |
119 | 119 | preg_match_all('/'.sprintf($this->token, '[A-Z0-9_]+').'/sx', $statement, $matches, PREG_PATTERN_ORDER); |
120 | 120 | |
121 | - foreach($matches[0] as $match) |
|
121 | + foreach ($matches[0] as $match) |
|
122 | 122 | { |
123 | 123 | $statement = str_replace($match, '', $statement); |
124 | 124 | } |
@@ -140,11 +140,11 @@ discard block |
||
140 | 140 | { |
141 | 141 | $tokenized = trim($statement); |
142 | 142 | |
143 | - foreach($this->tokens as $token) |
|
143 | + foreach ($this->tokens as $token) |
|
144 | 144 | { |
145 | 145 | $method = 'tokenize_'.$token; |
146 | 146 | |
147 | - if(!method_exists($this, $method)) |
|
147 | + if (!method_exists($this, $method)) |
|
148 | 148 | { |
149 | 149 | throw new Mailcode_Exception( |
150 | 150 | 'Unknown statement token.', |
@@ -172,7 +172,7 @@ discard block |
||
172 | 172 | { |
173 | 173 | $vars = Mailcode::create()->findVariables($tokenized)->getGroupedByHash(); |
174 | 174 | |
175 | - foreach($vars as $var) |
|
175 | + foreach ($vars as $var) |
|
176 | 176 | { |
177 | 177 | $tokenized = str_replace($var->getMatchedText(), $this->getToken('VARIABLE'), $tokenized); |
178 | 178 | } |
@@ -182,7 +182,7 @@ discard block |
||
182 | 182 | |
183 | 183 | protected function tokenize_operands(string $tokenized) : string |
184 | 184 | { |
185 | - foreach($this->operands as $operand) |
|
185 | + foreach ($this->operands as $operand) |
|
186 | 186 | { |
187 | 187 | $tokenized = str_replace($operand, $this->getToken('OPERAND'), $tokenized); |
188 | 188 | } |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | $matches = array(); |
196 | 196 | preg_match_all('/"(.*)"/sx', $tokenized, $matches, PREG_PATTERN_ORDER); |
197 | 197 | |
198 | - foreach($matches[0] as $match) |
|
198 | + foreach ($matches[0] as $match) |
|
199 | 199 | { |
200 | 200 | $tokenized = str_replace($match, $this->getToken('STRING_LITERAL'), $tokenized); |
201 | 201 | } |
@@ -208,7 +208,7 @@ discard block |
||
208 | 208 | $matches = array(); |
209 | 209 | preg_match_all('/[0-9]+\s*[.,]\s*[0-9]+|[0-9]+/sx', $tokenized, $matches, PREG_PATTERN_ORDER); |
210 | 210 | |
211 | - foreach($matches[0] as $match) |
|
211 | + foreach ($matches[0] as $match) |
|
212 | 212 | { |
213 | 213 | $tokenized = str_replace($match, $this->getToken('NUMBER'), $tokenized); |
214 | 214 | } |
@@ -22,9 +22,9 @@ discard block |
||
22 | 22 | */ |
23 | 23 | class Mailcode_Collection |
24 | 24 | { |
25 | - /** |
|
26 | - * @var Mailcode_Commands_Command[] |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var Mailcode_Commands_Command[] |
|
27 | + */ |
|
28 | 28 | protected $commands = array(); |
29 | 29 | |
30 | 30 | /** |
@@ -32,17 +32,17 @@ discard block |
||
32 | 32 | */ |
33 | 33 | protected $errors = array(); |
34 | 34 | |
35 | - /** |
|
36 | - * @var OperationResult|NULL |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var OperationResult|NULL |
|
37 | + */ |
|
38 | 38 | protected $validationResult; |
39 | 39 | |
40 | - /** |
|
41 | - * Adds a command to the collection. |
|
42 | - * |
|
43 | - * @param Mailcode_Commands_Command $command |
|
44 | - * @return Mailcode_Collection |
|
45 | - */ |
|
40 | + /** |
|
41 | + * Adds a command to the collection. |
|
42 | + * |
|
43 | + * @param Mailcode_Commands_Command $command |
|
44 | + * @return Mailcode_Collection |
|
45 | + */ |
|
46 | 46 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
47 | 47 | { |
48 | 48 | $this->commands[] = $command; |
@@ -54,21 +54,21 @@ discard block |
||
54 | 54 | return $this; |
55 | 55 | } |
56 | 56 | |
57 | - /** |
|
58 | - * Whether there are any commands in the collection. |
|
59 | - * |
|
60 | - * @return bool |
|
61 | - */ |
|
57 | + /** |
|
58 | + * Whether there are any commands in the collection. |
|
59 | + * |
|
60 | + * @return bool |
|
61 | + */ |
|
62 | 62 | public function hasCommands() : bool |
63 | 63 | { |
64 | 64 | return !empty($this->commands); |
65 | 65 | } |
66 | 66 | |
67 | - /** |
|
68 | - * Counts the amount of commands in the collection. |
|
69 | - * |
|
70 | - * @return int |
|
71 | - */ |
|
67 | + /** |
|
68 | + * Counts the amount of commands in the collection. |
|
69 | + * |
|
70 | + * @return int |
|
71 | + */ |
|
72 | 72 | public function countCommands() : int |
73 | 73 | { |
74 | 74 | return count($this->commands); |
@@ -88,9 +88,9 @@ discard block |
||
88 | 88 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * @return Mailcode_Collection_Error[] |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @return Mailcode_Collection_Error[] |
|
93 | + */ |
|
94 | 94 | public function getErrors() |
95 | 95 | { |
96 | 96 | $result = $this->getValidationResult(); |
@@ -116,25 +116,25 @@ discard block |
||
116 | 116 | return empty($errors); |
117 | 117 | } |
118 | 118 | |
119 | - /** |
|
120 | - * Retrieves all commands that were detected, in the exact order |
|
121 | - * they were found. |
|
122 | - * |
|
123 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
124 | - */ |
|
119 | + /** |
|
120 | + * Retrieves all commands that were detected, in the exact order |
|
121 | + * they were found. |
|
122 | + * |
|
123 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
124 | + */ |
|
125 | 125 | public function getCommands() |
126 | 126 | { |
127 | - return $this->commands; |
|
127 | + return $this->commands; |
|
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Retrieves all unique commands by their matched |
|
132 | - * string hash: this ensures only commands that were |
|
133 | - * written the exact same way (including spacing) |
|
134 | - * are returned. |
|
135 | - * |
|
136 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
137 | - */ |
|
130 | + /** |
|
131 | + * Retrieves all unique commands by their matched |
|
132 | + * string hash: this ensures only commands that were |
|
133 | + * written the exact same way (including spacing) |
|
134 | + * are returned. |
|
135 | + * |
|
136 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
137 | + */ |
|
138 | 138 | public function getGroupedByHash() |
139 | 139 | { |
140 | 140 | $hashes = array(); |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | |
98 | 98 | $errors = $this->errors; |
99 | 99 | |
100 | - if(!$result->isValid()) |
|
100 | + if (!$result->isValid()) |
|
101 | 101 | { |
102 | 102 | $errors[] = new Mailcode_Collection_Error_Message( |
103 | 103 | '', |
@@ -139,11 +139,11 @@ discard block |
||
139 | 139 | { |
140 | 140 | $hashes = array(); |
141 | 141 | |
142 | - foreach($this->commands as $command) |
|
142 | + foreach ($this->commands as $command) |
|
143 | 143 | { |
144 | 144 | $hash = $command->getHash(); |
145 | 145 | |
146 | - if(!isset($hashes[$hash])) |
|
146 | + if (!isset($hashes[$hash])) |
|
147 | 147 | { |
148 | 148 | $hashes[$hash] = $command; |
149 | 149 | } |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | |
155 | 155 | public function addCommands(array $commands) : Mailcode_Collection |
156 | 156 | { |
157 | - foreach($commands as $command) |
|
157 | + foreach ($commands as $command) |
|
158 | 158 | { |
159 | 159 | $this->addCommand($command); |
160 | 160 | } |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | { |
174 | 174 | $collection = new Mailcode_Variables_Collection_Regular(); |
175 | 175 | |
176 | - foreach($this->commands as $command) |
|
176 | + foreach ($this->commands as $command) |
|
177 | 177 | { |
178 | 178 | $collection->mergeWith($command->getVariables()); |
179 | 179 | } |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | |
184 | 184 | public function getValidationResult() : OperationResult |
185 | 185 | { |
186 | - if(isset($this->validationResult)) |
|
186 | + if (isset($this->validationResult)) |
|
187 | 187 | { |
188 | 188 | return $this->validationResult; |
189 | 189 | } |
@@ -199,9 +199,9 @@ discard block |
||
199 | 199 | { |
200 | 200 | $errors = $this->getErrors(); |
201 | 201 | |
202 | - foreach($errors as $error) |
|
202 | + foreach ($errors as $error) |
|
203 | 203 | { |
204 | - if($error->getCode() === $code) |
|
204 | + if ($error->getCode() === $code) |
|
205 | 205 | { |
206 | 206 | return true; |
207 | 207 | } |
@@ -26,14 +26,14 @@ discard block |
||
26 | 26 | '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]*)}' |
27 | 27 | ); |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode |
|
31 | + */ |
|
32 | 32 | protected $mailcode; |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Commands |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Commands |
|
36 | + */ |
|
37 | 37 | protected $commands; |
38 | 38 | |
39 | 39 | public function __construct(Mailcode $mailcode) |
@@ -42,24 +42,24 @@ discard block |
||
42 | 42 | $this->commands = $this->mailcode->getCommands(); |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * Gets the regex format string used to detect commands. |
|
47 | - * |
|
48 | - * @return string |
|
49 | - */ |
|
45 | + /** |
|
46 | + * Gets the regex format string used to detect commands. |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
50 | 50 | protected static function getRegex() : string |
51 | 51 | { |
52 | 52 | return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU'; |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Parses a string to detect all commands within. Returns a |
|
57 | - * collection instance that contains information on all the |
|
58 | - * commands. |
|
59 | - * |
|
60 | - * @param string $string |
|
61 | - * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | - */ |
|
55 | + /** |
|
56 | + * Parses a string to detect all commands within. Returns a |
|
57 | + * collection instance that contains information on all the |
|
58 | + * commands. |
|
59 | + * |
|
60 | + * @param string $string |
|
61 | + * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | + */ |
|
63 | 63 | public function parseString(string $string) : Mailcode_Collection |
64 | 64 | { |
65 | 65 | $collection = new Mailcode_Collection(); |
@@ -79,14 +79,14 @@ discard block |
||
79 | 79 | return $collection; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Processes a single match found in the string: creates the command, |
|
84 | - * and adds it to the collection if it's a valid command, or to the list |
|
85 | - * of invalid commands otherwise. |
|
86 | - * |
|
87 | - * @param Mailcode_Parser_Match $match |
|
88 | - * @param Mailcode_Collection $collection |
|
89 | - */ |
|
82 | + /** |
|
83 | + * Processes a single match found in the string: creates the command, |
|
84 | + * and adds it to the collection if it's a valid command, or to the list |
|
85 | + * of invalid commands otherwise. |
|
86 | + * |
|
87 | + * @param Mailcode_Parser_Match $match |
|
88 | + * @param Mailcode_Collection $collection |
|
89 | + */ |
|
90 | 90 | protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void |
91 | 91 | { |
92 | 92 | $name = $match->getName(); |
@@ -117,14 +117,14 @@ discard block |
||
117 | 117 | $collection->addInvalidCommand($cmd); |
118 | 118 | } |
119 | 119 | |
120 | - /** |
|
121 | - * Parses a single regex match: determines which named group |
|
122 | - * matches, and retrieves the according information. |
|
123 | - * |
|
124 | - * @param array $matches The regex results array. |
|
125 | - * @param int $index The matched index. |
|
126 | - * @return Mailcode_Parser_Match |
|
127 | - */ |
|
120 | + /** |
|
121 | + * Parses a single regex match: determines which named group |
|
122 | + * matches, and retrieves the according information. |
|
123 | + * |
|
124 | + * @param array $matches The regex results array. |
|
125 | + * @param int $index The matched index. |
|
126 | + * @return Mailcode_Parser_Match |
|
127 | + */ |
|
128 | 128 | protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match |
129 | 129 | { |
130 | 130 | $name = ''; // the command name, e.g. "showvar" |
@@ -162,26 +162,26 @@ discard block |
||
162 | 162 | ); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * Creates an instance of the safeguard tool, which |
|
167 | - * is used to safeguard commands in a string with placeholders. |
|
168 | - * |
|
169 | - * @param string $subject The string to use to safeguard commands in. |
|
170 | - * @return Mailcode_Parser_Safeguard |
|
171 | - * @see Mailcode_Parser_Safeguard |
|
172 | - */ |
|
165 | + /** |
|
166 | + * Creates an instance of the safeguard tool, which |
|
167 | + * is used to safeguard commands in a string with placeholders. |
|
168 | + * |
|
169 | + * @param string $subject The string to use to safeguard commands in. |
|
170 | + * @return Mailcode_Parser_Safeguard |
|
171 | + * @see Mailcode_Parser_Safeguard |
|
172 | + */ |
|
173 | 173 | public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard |
174 | 174 | { |
175 | 175 | return new Mailcode_Parser_Safeguard($this, $subject); |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Creates a statement parser, which is used to validate arbitrary |
|
180 | - * command statements. |
|
181 | - * |
|
182 | - * @param string $statement |
|
183 | - * @return Mailcode_Parser_Statement |
|
184 | - */ |
|
178 | + /** |
|
179 | + * Creates a statement parser, which is used to validate arbitrary |
|
180 | + * command statements. |
|
181 | + * |
|
182 | + * @param string $statement |
|
183 | + * @return Mailcode_Parser_Statement |
|
184 | + */ |
|
185 | 185 | public function createStatement(string $statement) : Mailcode_Parser_Statement |
186 | 186 | { |
187 | 187 | return new Mailcode_Parser_Statement($statement); |
@@ -22,12 +22,12 @@ |
||
22 | 22 | { |
23 | 23 | const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)/sx'; |
24 | 24 | |
25 | - /** |
|
26 | - * Parses the specified string to find all variable names contained within, if any. |
|
27 | - * |
|
28 | - * @param string $subject |
|
29 | - * @return Mailcode_Variables_Collection_Regular |
|
30 | - */ |
|
25 | + /** |
|
26 | + * Parses the specified string to find all variable names contained within, if any. |
|
27 | + * |
|
28 | + * @param string $subject |
|
29 | + * @return Mailcode_Variables_Collection_Regular |
|
30 | + */ |
|
31 | 31 | public function parseString(string $subject) : Mailcode_Variables_Collection_Regular |
32 | 32 | { |
33 | 33 | $collection = new Mailcode_Variables_Collection_Regular(); |