@@ -29,24 +29,24 @@ 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 | - /** |
|
| 43 | - * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Parser_Statement_Tokenizer|NULL |
|
| 44 | + */ |
|
| 45 | 45 | protected $tokenizer; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
| 49 | + */ |
|
| 50 | 50 | protected $info; |
| 51 | 51 | |
| 52 | 52 | public function __construct(string $statement) |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | if($unknown) |
| 103 | 103 | { |
| 104 | 104 | $this->result->makeError( |
| 105 | - t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')', |
|
| 105 | + t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')', |
|
| 106 | 106 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
| 107 | 107 | ); |
| 108 | 108 | } |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | |
| 76 | 76 | public function getInfo() : Mailcode_Parser_Statement_Info |
| 77 | 77 | { |
| 78 | - if(isset($this->info)) |
|
| 78 | + if (isset($this->info)) |
|
| 79 | 79 | { |
| 80 | 80 | return $this->info; |
| 81 | 81 | } |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | |
| 88 | 88 | protected function validate() : void |
| 89 | 89 | { |
| 90 | - if(!$this->tokenizer->hasTokens()) |
|
| 90 | + if (!$this->tokenizer->hasTokens()) |
|
| 91 | 91 | { |
| 92 | 92 | $this->result->makeError( |
| 93 | 93 | t('Empty statement'), |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | |
| 100 | 100 | $unknown = $this->tokenizer->getFirstUnknown(); |
| 101 | 101 | |
| 102 | - if($unknown) |
|
| 102 | + if ($unknown) |
|
| 103 | 103 | { |
| 104 | 104 | $this->result->makeError( |
| 105 | 105 | t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')', |
@@ -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(); |
@@ -152,12 +152,12 @@ discard block |
||
| 152 | 152 | return array_values($hashes); |
| 153 | 153 | } |
| 154 | 154 | |
| 155 | - /** |
|
| 156 | - * Adds several commands at once. |
|
| 157 | - * |
|
| 158 | - * @param Mailcode_Commands_Command[] $commands |
|
| 159 | - * @return Mailcode_Collection |
|
| 160 | - */ |
|
| 155 | + /** |
|
| 156 | + * Adds several commands at once. |
|
| 157 | + * |
|
| 158 | + * @param Mailcode_Commands_Command[] $commands |
|
| 159 | + * @return Mailcode_Collection |
|
| 160 | + */ |
|
| 161 | 161 | public function addCommands(array $commands) : Mailcode_Collection |
| 162 | 162 | { |
| 163 | 163 | foreach($commands as $command) |
@@ -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 | } |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | */ |
| 161 | 161 | public function addCommands(array $commands) : Mailcode_Collection |
| 162 | 162 | { |
| 163 | - foreach($commands as $command) |
|
| 163 | + foreach ($commands as $command) |
|
| 164 | 164 | { |
| 165 | 165 | $this->addCommand($command); |
| 166 | 166 | } |
@@ -179,7 +179,7 @@ discard block |
||
| 179 | 179 | { |
| 180 | 180 | $collection = new Mailcode_Variables_Collection_Regular(); |
| 181 | 181 | |
| 182 | - foreach($this->commands as $command) |
|
| 182 | + foreach ($this->commands as $command) |
|
| 183 | 183 | { |
| 184 | 184 | $collection->mergeWith($command->getVariables()); |
| 185 | 185 | } |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | |
| 190 | 190 | public function getValidationResult() : OperationResult |
| 191 | 191 | { |
| 192 | - if(isset($this->validationResult)) |
|
| 192 | + if (isset($this->validationResult)) |
|
| 193 | 193 | { |
| 194 | 194 | return $this->validationResult; |
| 195 | 195 | } |
@@ -205,9 +205,9 @@ discard block |
||
| 205 | 205 | { |
| 206 | 206 | $errors = $this->getErrors(); |
| 207 | 207 | |
| 208 | - foreach($errors as $error) |
|
| 208 | + foreach ($errors as $error) |
|
| 209 | 209 | { |
| 210 | - if($error->getCode() === $code) |
|
| 210 | + if ($error->getCode() === $code) |
|
| 211 | 211 | { |
| 212 | 212 | return true; |
| 213 | 213 | } |
@@ -20,18 +20,18 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Factory_Exception extends Mailcode_Exception |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Commands_Command|NULL |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Commands_Command|NULL |
|
| 25 | + */ |
|
| 26 | 26 | protected $command; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $message |
|
| 30 | - * @param string|NULL $details |
|
| 31 | - * @param int|NULL $code |
|
| 32 | - * @param \Exception|NULL $previous |
|
| 33 | - * @param Mailcode_Commands_Command|NULL $command |
|
| 34 | - */ |
|
| 28 | + /** |
|
| 29 | + * @param string $message |
|
| 30 | + * @param string|NULL $details |
|
| 31 | + * @param int|NULL $code |
|
| 32 | + * @param \Exception|NULL $previous |
|
| 33 | + * @param Mailcode_Commands_Command|NULL $command |
|
| 34 | + */ |
|
| 35 | 35 | public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null) |
| 36 | 36 | { |
| 37 | 37 | parent::__construct($message, $details, $code, $previous); |
@@ -39,11 +39,11 @@ discard block |
||
| 39 | 39 | $this->command = $command; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Retrieves the erroneous command, if any. |
|
| 44 | - * |
|
| 45 | - * @return Mailcode_Commands_Command|NULL |
|
| 46 | - */ |
|
| 42 | + /** |
|
| 43 | + * Retrieves the erroneous command, if any. |
|
| 44 | + * |
|
| 45 | + * @return Mailcode_Commands_Command|NULL |
|
| 46 | + */ |
|
| 47 | 47 | public function getCommand() : ?Mailcode_Commands_Command |
| 48 | 48 | { |
| 49 | 49 | return $this->command; |
@@ -32,7 +32,7 @@ |
||
| 32 | 32 | * @param \Exception|NULL $previous |
| 33 | 33 | * @param Mailcode_Commands_Command|NULL $command |
| 34 | 34 | */ |
| 35 | - public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null) |
|
| 35 | + public function __construct(string $message, $details = null, $code = null, $previous = null, Mailcode_Commands_Command $command = null) |
|
| 36 | 36 | { |
| 37 | 37 | parent::__construct($message, $details, $code, $previous); |
| 38 | 38 | |
@@ -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); |