@@ -36,44 +36,44 @@ discard block |
||
| 36 | 36 | |
| 37 | 37 | const META_URL_ENCODING = 'url_encoding'; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var string |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var string |
|
| 41 | + */ |
|
| 42 | 42 | protected $type = ''; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var string |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var string |
|
| 46 | + */ |
|
| 47 | 47 | protected $paramsString = ''; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | 52 | protected $matchedText = ''; |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var string |
|
| 56 | - */ |
|
| 54 | + /** |
|
| 55 | + * @var string |
|
| 56 | + */ |
|
| 57 | 57 | protected $hash = ''; |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @var OperationResult |
|
| 61 | - */ |
|
| 59 | + /** |
|
| 60 | + * @var OperationResult |
|
| 61 | + */ |
|
| 62 | 62 | protected $validationResult = null; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var \Mailcode\Mailcode |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var \Mailcode\Mailcode |
|
| 66 | + */ |
|
| 67 | 67 | protected $mailcode; |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
| 71 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
| 71 | + */ |
|
| 72 | 72 | protected $params; |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @var string[] |
|
| 76 | - */ |
|
| 74 | + /** |
|
| 75 | + * @var string[] |
|
| 76 | + */ |
|
| 77 | 77 | protected $validations = array( |
| 78 | 78 | 'params_empty', |
| 79 | 79 | 'params_keywords', |
@@ -82,24 +82,24 @@ discard block |
||
| 82 | 82 | 'type_unsupported' |
| 83 | 83 | ); |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * @var string |
|
| 87 | - */ |
|
| 85 | + /** |
|
| 86 | + * @var string |
|
| 87 | + */ |
|
| 88 | 88 | protected $comment = ''; |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @var Mailcode_Commands_LogicKeywords|NULL |
|
| 92 | - */ |
|
| 90 | + /** |
|
| 91 | + * @var Mailcode_Commands_LogicKeywords|NULL |
|
| 92 | + */ |
|
| 93 | 93 | protected $logicKeywords; |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @var Mailcode_Parser_Statement_Validator |
|
| 97 | - */ |
|
| 95 | + /** |
|
| 96 | + * @var Mailcode_Parser_Statement_Validator |
|
| 97 | + */ |
|
| 98 | 98 | protected $validator; |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * @var boolean |
|
| 102 | - */ |
|
| 100 | + /** |
|
| 101 | + * @var boolean |
|
| 102 | + */ |
|
| 103 | 103 | private $validated = false; |
| 104 | 104 | |
| 105 | 105 | /** |
@@ -134,13 +134,13 @@ discard block |
||
| 134 | 134 | |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Sets the command's parent opening command, if any. |
|
| 139 | - * NOTE: This is set automatically by the parser, and |
|
| 140 | - * should not be called manually. |
|
| 141 | - * |
|
| 142 | - * @param Mailcode_Commands_Command $command |
|
| 143 | - */ |
|
| 137 | + /** |
|
| 138 | + * Sets the command's parent opening command, if any. |
|
| 139 | + * NOTE: This is set automatically by the parser, and |
|
| 140 | + * should not be called manually. |
|
| 141 | + * |
|
| 142 | + * @param Mailcode_Commands_Command $command |
|
| 143 | + */ |
|
| 144 | 144 | public function setParent(Mailcode_Commands_Command $command) : void |
| 145 | 145 | { |
| 146 | 146 | $this->parent = $command; |
@@ -282,9 +282,9 @@ discard block |
||
| 282 | 282 | return $this->validationResult->isValid(); |
| 283 | 283 | } |
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * @return string[] |
|
| 287 | - */ |
|
| 285 | + /** |
|
| 286 | + * @return string[] |
|
| 287 | + */ |
|
| 288 | 288 | abstract protected function getValidations() : array; |
| 289 | 289 | |
| 290 | 290 | protected function _validateNesting() : void |
@@ -31,19 +31,19 @@ |
||
| 31 | 31 | const VALIDATION_VARIABLE_NAME_WITH_DOT = 49704; |
| 32 | 32 | const VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT = 49705; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 36 | + */ |
|
| 37 | 37 | private $loopVar; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 41 | + */ |
|
| 42 | 42 | private $sourceVar; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 46 | + */ |
|
| 47 | 47 | private $keyword; |
| 48 | 48 | |
| 49 | 49 | public function getName() : string |
@@ -25,9 +25,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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) |
@@ -293,10 +293,10 @@ discard block |
||
| 293 | 293 | } |
| 294 | 294 | |
| 295 | 295 | /** |
| 296 | - * Retrieves only show variable commands in the collection, if any. |
|
| 297 | - * |
|
| 298 | - * @return Mailcode_Commands_Command_ShowVariable[] |
|
| 299 | - */ |
|
| 296 | + * Retrieves only show variable commands in the collection, if any. |
|
| 297 | + * |
|
| 298 | + * @return Mailcode_Commands_Command_ShowVariable[] |
|
| 299 | + */ |
|
| 300 | 300 | public function getShowVariableCommands(): array |
| 301 | 301 | { |
| 302 | 302 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class); |
@@ -310,11 +310,11 @@ discard block |
||
| 310 | 310 | return $this->getCommandsByClass(Mailcode_Commands_Command_For::class); |
| 311 | 311 | } |
| 312 | 312 | |
| 313 | - /** |
|
| 314 | - * Retrieves only show date commands in the collection, if any. |
|
| 315 | - * |
|
| 316 | - * @return Mailcode_Commands_Command_ShowDate[] |
|
| 317 | - */ |
|
| 313 | + /** |
|
| 314 | + * Retrieves only show date commands in the collection, if any. |
|
| 315 | + * |
|
| 316 | + * @return Mailcode_Commands_Command_ShowDate[] |
|
| 317 | + */ |
|
| 318 | 318 | public function getShowDateCommands() : array |
| 319 | 319 | { |
| 320 | 320 | return $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class); |