@@ -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) |
@@ -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(); |
@@ -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 |
@@ -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) |
@@ -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 | } |
@@ -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(); |
@@ -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(); |