@@ -25,24 +25,24 @@ discard block |
||
| 25 | 25 | { |
| 26 | 26 | const ERROR_PLACEHOLDER_TOO_LONG = 47901; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var int |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var int |
|
| 30 | + */ |
|
| 31 | 31 | protected $id; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var Mailcode_Parser_Safeguard |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var Mailcode_Parser_Safeguard |
|
| 35 | + */ |
|
| 36 | 36 | protected $safeguard; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var Mailcode_Commands_Command |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var Mailcode_Commands_Command |
|
| 40 | + */ |
|
| 41 | 41 | protected $command; |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var string |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var string |
|
| 45 | + */ |
|
| 46 | 46 | protected $replacement = ''; |
| 47 | 47 | |
| 48 | 48 | public function __construct(int $id, Mailcode_Commands_Command $command, Mailcode_Parser_Safeguard $safeguard) |
@@ -115,18 +115,18 @@ discard block |
||
| 115 | 115 | return $this->command; |
| 116 | 116 | } |
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * Serializes the placeholder's information into |
|
| 120 | - * an array with the following keys: |
|
| 121 | - * |
|
| 122 | - * - originalText |
|
| 123 | - * - replacementText |
|
| 124 | - * - normalizedText |
|
| 125 | - * - length |
|
| 126 | - * - id |
|
| 127 | - * |
|
| 128 | - * @return array<string,string|integer> |
|
| 129 | - */ |
|
| 118 | + /** |
|
| 119 | + * Serializes the placeholder's information into |
|
| 120 | + * an array with the following keys: |
|
| 121 | + * |
|
| 122 | + * - originalText |
|
| 123 | + * - replacementText |
|
| 124 | + * - normalizedText |
|
| 125 | + * - length |
|
| 126 | + * - id |
|
| 127 | + * |
|
| 128 | + * @return array<string,string|integer> |
|
| 129 | + */ |
|
| 130 | 130 | public function serialize() : array |
| 131 | 131 | { |
| 132 | 132 | return array( |
@@ -28,9 +28,9 @@ discard block |
||
| 28 | 28 | */ |
| 29 | 29 | class Mailcode_Parser_Statement_Validator |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement |
|
| 33 | + */ |
|
| 34 | 34 | private $statement; |
| 35 | 35 | |
| 36 | 36 | public function __construct(Mailcode_Parser_Statement $statement) |
@@ -38,12 +38,12 @@ discard block |
||
| 38 | 38 | $this->statement = $statement; |
| 39 | 39 | } |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Creates a variable validator: checks whether a single |
|
| 43 | - * variable token is present in the parameters. |
|
| 44 | - * |
|
| 45 | - * @return Mailcode_Parser_Statement_Validator_Type_Variable |
|
| 46 | - */ |
|
| 41 | + /** |
|
| 42 | + * Creates a variable validator: checks whether a single |
|
| 43 | + * variable token is present in the parameters. |
|
| 44 | + * |
|
| 45 | + * @return Mailcode_Parser_Statement_Validator_Type_Variable |
|
| 46 | + */ |
|
| 47 | 47 | public function createVariable() : Mailcode_Parser_Statement_Validator_Type_Variable |
| 48 | 48 | { |
| 49 | 49 | $validate = new Mailcode_Parser_Statement_Validator_Type_Variable($this->statement); |
@@ -51,13 +51,13 @@ discard block |
||
| 51 | 51 | return $validate; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Creates a keyword validator: checks whether a single |
|
| 56 | - * keyword token is present in the parameters. |
|
| 57 | - * |
|
| 58 | - * @param string $keywordName |
|
| 59 | - * @return Mailcode_Parser_Statement_Validator_Type_Keyword |
|
| 60 | - */ |
|
| 54 | + /** |
|
| 55 | + * Creates a keyword validator: checks whether a single |
|
| 56 | + * keyword token is present in the parameters. |
|
| 57 | + * |
|
| 58 | + * @param string $keywordName |
|
| 59 | + * @return Mailcode_Parser_Statement_Validator_Type_Keyword |
|
| 60 | + */ |
|
| 61 | 61 | public function createKeyword(string $keywordName) : Mailcode_Parser_Statement_Validator_Type_Keyword |
| 62 | 62 | { |
| 63 | 63 | $validate = new Mailcode_Parser_Statement_Validator_Type_Keyword( |
@@ -22,53 +22,53 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | const VALIDATION_ERROR_COMMAND_WITHOUT_PARAMETERS = 62401; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var integer |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var integer |
|
| 27 | + */ |
|
| 28 | 28 | protected $searchIndex = -1; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 32 | + */ |
|
| 33 | 33 | protected $token; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Retrieves the class name of the token type to |
|
| 37 | - * limit the token search to. Only a token of this |
|
| 38 | - * type will be stored. |
|
| 39 | - * |
|
| 40 | - * @return string |
|
| 41 | - */ |
|
| 35 | + /** |
|
| 36 | + * Retrieves the class name of the token type to |
|
| 37 | + * limit the token search to. Only a token of this |
|
| 38 | + * type will be stored. |
|
| 39 | + * |
|
| 40 | + * @return string |
|
| 41 | + */ |
|
| 42 | 42 | abstract protected function getTokenClass() : string; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Allows the validator to apply custom search |
|
| 46 | - * criteria to the tokens that are searched |
|
| 47 | - * through to find the target token. |
|
| 48 | - * |
|
| 49 | - * NOTE: Should return true if there are no |
|
| 50 | - * custom criteria to apply. |
|
| 51 | - * |
|
| 52 | - * @param Mailcode_Parser_Statement_Tokenizer_Token $token |
|
| 53 | - * @return bool |
|
| 54 | - */ |
|
| 44 | + /** |
|
| 45 | + * Allows the validator to apply custom search |
|
| 46 | + * criteria to the tokens that are searched |
|
| 47 | + * through to find the target token. |
|
| 48 | + * |
|
| 49 | + * NOTE: Should return true if there are no |
|
| 50 | + * custom criteria to apply. |
|
| 51 | + * |
|
| 52 | + * @param Mailcode_Parser_Statement_Tokenizer_Token $token |
|
| 53 | + * @return bool |
|
| 54 | + */ |
|
| 55 | 55 | abstract protected function _isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token) : bool; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @return Mailcode_Parser_Statement_Tokenizer_Token |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @return Mailcode_Parser_Statement_Tokenizer_Token |
|
| 59 | + */ |
|
| 60 | 60 | abstract public function getToken(); |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Checks if the specified token matches the current |
|
| 64 | - * search criteria (index, type...). If the token is |
|
| 65 | - * a match, the `_isMatch()` method is called to allow |
|
| 66 | - * the validator class to apply some custom criteria. |
|
| 67 | - * |
|
| 68 | - * @param Mailcode_Parser_Statement_Tokenizer_Token $token |
|
| 69 | - * @param int $index |
|
| 70 | - * @return bool |
|
| 71 | - */ |
|
| 62 | + /** |
|
| 63 | + * Checks if the specified token matches the current |
|
| 64 | + * search criteria (index, type...). If the token is |
|
| 65 | + * a match, the `_isMatch()` method is called to allow |
|
| 66 | + * the validator class to apply some custom criteria. |
|
| 67 | + * |
|
| 68 | + * @param Mailcode_Parser_Statement_Tokenizer_Token $token |
|
| 69 | + * @param int $index |
|
| 70 | + * @return bool |
|
| 71 | + */ |
|
| 72 | 72 | protected function isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token, int $index) : bool |
| 73 | 73 | { |
| 74 | 74 | // filter out tokens of other types |
@@ -85,13 +85,13 @@ discard block |
||
| 85 | 85 | return $this->_isMatch($token); |
| 86 | 86 | } |
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * Attempts to find a token in the statement |
|
| 90 | - * that matches the current criteria, and the |
|
| 91 | - * first one it finds is returned. |
|
| 92 | - * |
|
| 93 | - * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 94 | - */ |
|
| 88 | + /** |
|
| 89 | + * Attempts to find a token in the statement |
|
| 90 | + * that matches the current criteria, and the |
|
| 91 | + * first one it finds is returned. |
|
| 92 | + * |
|
| 93 | + * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 94 | + */ |
|
| 95 | 95 | protected function findToken() : ?Mailcode_Parser_Statement_Tokenizer_Token |
| 96 | 96 | { |
| 97 | 97 | $tokens = $this->params->getTokens(); |
@@ -120,14 +120,14 @@ discard block |
||
| 120 | 120 | return false; |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * Searches for a specific token index. |
|
| 125 | - * |
|
| 126 | - * NOTE: only relevant when trying to find a single token. |
|
| 127 | - * |
|
| 128 | - * @param int $index |
|
| 129 | - * @return $this |
|
| 130 | - */ |
|
| 123 | + /** |
|
| 124 | + * Searches for a specific token index. |
|
| 125 | + * |
|
| 126 | + * NOTE: only relevant when trying to find a single token. |
|
| 127 | + * |
|
| 128 | + * @param int $index |
|
| 129 | + * @return $this |
|
| 130 | + */ |
|
| 131 | 131 | public function setIndex(int $index) : Mailcode_Parser_Statement_Validator_TokenType |
| 132 | 132 | { |
| 133 | 133 | $this->searchIndex = $index; |
@@ -20,9 +20,9 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Parser_Statement_Validator_Type |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Parser_Statement |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Parser_Statement |
|
| 25 | + */ |
|
| 26 | 26 | protected $statement; |
| 27 | 27 | |
| 28 | 28 | /** |
@@ -30,14 +30,14 @@ discard block |
||
| 30 | 30 | */ |
| 31 | 31 | protected $params; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var boolean |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var boolean |
|
| 35 | + */ |
|
| 36 | 36 | private $valid = true; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var boolean |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var boolean |
|
| 40 | + */ |
|
| 41 | 41 | private $validated = false; |
| 42 | 42 | |
| 43 | 43 | public function __construct(Mailcode_Parser_Statement $statement) |
@@ -53,9 +53,9 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @return $this |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @return $this |
|
| 58 | + */ |
|
| 59 | 59 | public function validate() : Mailcode_Parser_Statement_Validator_Type |
| 60 | 60 | { |
| 61 | 61 | if(!$this->validated) |
@@ -22,10 +22,10 @@ |
||
| 22 | 22 | { |
| 23 | 23 | const ERROR_NO_KEYWORD_TOKEN_FOUND = 62701; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * The name of the keyword, with ":" appended. |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 25 | + /** |
|
| 26 | + * The name of the keyword, with ":" appended. |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | protected $keywordName; |
| 30 | 30 | |
| 31 | 31 | public function __construct(Mailcode_Parser_Statement $statement, string $keywordName) |
@@ -22,9 +22,9 @@ |
||
| 22 | 22 | { |
| 23 | 23 | const ERROR_NO_OPERAND_TOKEN_FOUND = 62901; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | 28 | private $sign = ''; |
| 29 | 29 | |
| 30 | 30 | protected function getTokenClass() : string |
@@ -20,28 +20,28 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral extends Mailcode_Parser_Statement_Tokenizer_Token implements Mailcode_Parser_Statement_Tokenizer_ValueInterface |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * Retrieves the text with the surrounding quotes. |
|
| 25 | - * @return string |
|
| 26 | - */ |
|
| 23 | + /** |
|
| 24 | + * Retrieves the text with the surrounding quotes. |
|
| 25 | + * @return string |
|
| 26 | + */ |
|
| 27 | 27 | public function getNormalized() : string |
| 28 | 28 | { |
| 29 | 29 | return $this->restoreQuotes($this->matchedText); |
| 30 | 30 | } |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Retrieves the text with the surrounding quotes. |
|
| 34 | - * @return string |
|
| 35 | - */ |
|
| 32 | + /** |
|
| 33 | + * Retrieves the text with the surrounding quotes. |
|
| 34 | + * @return string |
|
| 35 | + */ |
|
| 36 | 36 | public function getValue() : string |
| 37 | 37 | { |
| 38 | 38 | return $this->getNormalized(); |
| 39 | 39 | } |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Retrieves the text without the surrounding quotes. |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 41 | + /** |
|
| 42 | + * Retrieves the text without the surrounding quotes. |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | 45 | public function getText() : string |
| 46 | 46 | { |
| 47 | 47 | $quoteless = trim($this->matchedText, '"\''); |
@@ -20,9 +20,9 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Commands_Command_SetVariable extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 25 | + */ |
|
| 26 | 26 | private $variableToken; |
| 27 | 27 | |
| 28 | 28 | public function getName() : string |
@@ -126,9 +126,9 @@ discard block |
||
| 126 | 126 | ); |
| 127 | 127 | } |
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 131 | - */ |
|
| 129 | + /** |
|
| 130 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 131 | + */ |
|
| 132 | 132 | public function getAssignmentTokens() : array |
| 133 | 133 | { |
| 134 | 134 | $params = $this->params->getInfo()->getTokens(); |
@@ -36,9 +36,9 @@ |
||
| 36 | 36 | ); |
| 37 | 37 | } |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return array<string> |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @return array<string> |
|
| 41 | + */ |
|
| 42 | 42 | protected function getAllowedOperands() : array |
| 43 | 43 | { |
| 44 | 44 | return Mailcode_Parser_Statement_Tokenizer_Token_Operand::getComparisonSigns(); |