@@ -21,14 +21,14 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class Mailcode_Parser_Statement_Info |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 26 | + */ |
|
| 27 | 27 | protected $tokenizer; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 31 | + */ |
|
| 32 | 32 | protected $tokens = array(); |
| 33 | 33 | |
| 34 | 34 | /** |
@@ -48,21 +48,21 @@ discard block |
||
| 48 | 48 | $this->variables = new Mailcode_Parser_Statement_Info_Variables($this, $this->tokenizer); |
| 49 | 49 | } |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Whether the whole statement is a variable being assigned a value. |
|
| 53 | - * |
|
| 54 | - * @return bool |
|
| 55 | - */ |
|
| 51 | + /** |
|
| 52 | + * Whether the whole statement is a variable being assigned a value. |
|
| 53 | + * |
|
| 54 | + * @return bool |
|
| 55 | + */ |
|
| 56 | 56 | public function isVariableAssignment() : bool |
| 57 | 57 | { |
| 58 | 58 | return $this->variables->isAssignment(); |
| 59 | 59 | } |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Whether the whole statement is a variable being compared to something. |
|
| 63 | - * |
|
| 64 | - * @return bool |
|
| 65 | - */ |
|
| 61 | + /** |
|
| 62 | + * Whether the whole statement is a variable being compared to something. |
|
| 63 | + * |
|
| 64 | + * @return bool |
|
| 65 | + */ |
|
| 66 | 66 | public function isVariableComparison() : bool |
| 67 | 67 | { |
| 68 | 68 | return $this->variables->isComparison(); |
@@ -79,27 +79,27 @@ discard block |
||
| 79 | 79 | return $this->variables->getAll(); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Retrieves a variable by its position in the command's parameters. |
|
| 84 | - * Returns null if there is no parameter at the specified index, or |
|
| 85 | - * if it is of another type. |
|
| 86 | - * |
|
| 87 | - * @param int $index Zero-based index. |
|
| 88 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 89 | - */ |
|
| 82 | + /** |
|
| 83 | + * Retrieves a variable by its position in the command's parameters. |
|
| 84 | + * Returns null if there is no parameter at the specified index, or |
|
| 85 | + * if it is of another type. |
|
| 86 | + * |
|
| 87 | + * @param int $index Zero-based index. |
|
| 88 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 89 | + */ |
|
| 90 | 90 | public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable |
| 91 | 91 | { |
| 92 | 92 | return $this->variables->getByIndex($index); |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Retrieves a string literal by its position in the command's parameters. |
|
| 97 | - * Returns null if there is no parameter at the specified index, or |
|
| 98 | - * if it is of another type. |
|
| 99 | - * |
|
| 100 | - * @param int $index Zero-based index. |
|
| 101 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 102 | - */ |
|
| 95 | + /** |
|
| 96 | + * Retrieves a string literal by its position in the command's parameters. |
|
| 97 | + * Returns null if there is no parameter at the specified index, or |
|
| 98 | + * if it is of another type. |
|
| 99 | + * |
|
| 100 | + * @param int $index Zero-based index. |
|
| 101 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 102 | + */ |
|
| 103 | 103 | public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral |
| 104 | 104 | { |
| 105 | 105 | $token = $this->getTokenByIndex($index); |
@@ -112,27 +112,27 @@ discard block |
||
| 112 | 112 | return null; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Retrieves a keyword by its position in the command's parameters. |
|
| 117 | - * Returns null if there is no parameter at the specified index, or |
|
| 118 | - * if it is of another type. |
|
| 119 | - * |
|
| 120 | - * @param int $index Zero-based index. |
|
| 121 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 122 | - */ |
|
| 115 | + /** |
|
| 116 | + * Retrieves a keyword by its position in the command's parameters. |
|
| 117 | + * Returns null if there is no parameter at the specified index, or |
|
| 118 | + * if it is of another type. |
|
| 119 | + * |
|
| 120 | + * @param int $index Zero-based index. |
|
| 121 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 122 | + */ |
|
| 123 | 123 | public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword |
| 124 | 124 | { |
| 125 | 125 | return $this->keywords->getByIndex($index); |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Retrieves an operand by its position in the command's parameters. |
|
| 130 | - * Returns null if there is no parameter at the specified index, or |
|
| 131 | - * if it is of another type. |
|
| 132 | - * |
|
| 133 | - * @param int $index Zero-based index. |
|
| 134 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 135 | - */ |
|
| 128 | + /** |
|
| 129 | + * Retrieves an operand by its position in the command's parameters. |
|
| 130 | + * Returns null if there is no parameter at the specified index, or |
|
| 131 | + * if it is of another type. |
|
| 132 | + * |
|
| 133 | + * @param int $index Zero-based index. |
|
| 134 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 135 | + */ |
|
| 136 | 136 | public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand |
| 137 | 137 | { |
| 138 | 138 | $token = $this->getTokenByIndex($index); |
@@ -145,14 +145,14 @@ discard block |
||
| 145 | 145 | return null; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Retrieves a parameter token by its position in the command's parameters, |
|
| 150 | - * regardless of its type. Returns null if there is no parameter at the |
|
| 151 | - * specified index. |
|
| 152 | - * |
|
| 153 | - * @param int $index Zero-based index. |
|
| 154 | - * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 155 | - */ |
|
| 148 | + /** |
|
| 149 | + * Retrieves a parameter token by its position in the command's parameters, |
|
| 150 | + * regardless of its type. Returns null if there is no parameter at the |
|
| 151 | + * specified index. |
|
| 152 | + * |
|
| 153 | + * @param int $index Zero-based index. |
|
| 154 | + * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 155 | + */ |
|
| 156 | 156 | public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token |
| 157 | 157 | { |
| 158 | 158 | $tokens = $this->tokenizer->getTokens(); |
@@ -172,19 +172,19 @@ discard block |
||
| 172 | 172 | return isset($tokens[$index]); |
| 173 | 173 | } |
| 174 | 174 | |
| 175 | - /** |
|
| 176 | - * Retrieves all tokens. |
|
| 177 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 178 | - */ |
|
| 175 | + /** |
|
| 176 | + * Retrieves all tokens. |
|
| 177 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 178 | + */ |
|
| 179 | 179 | public function getTokens() : array |
| 180 | 180 | { |
| 181 | 181 | return $this->tokenizer->getTokens(); |
| 182 | 182 | } |
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * Retrieves all string literals that were found in the command. |
|
| 186 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 187 | - */ |
|
| 184 | + /** |
|
| 185 | + * Retrieves all string literals that were found in the command. |
|
| 186 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 187 | + */ |
|
| 188 | 188 | public function getStringLiterals() : array |
| 189 | 189 | { |
| 190 | 190 | $result = array(); |