@@ -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 | public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer) |
@@ -37,11 +37,11 @@ discard block |
||
| 37 | 37 | $this->tokens = $this->tokenizer->getTokens(); |
| 38 | 38 | } |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Whether the whole statement is a variable being assigned a value. |
|
| 42 | - * |
|
| 43 | - * @return bool |
|
| 44 | - */ |
|
| 40 | + /** |
|
| 41 | + * Whether the whole statement is a variable being assigned a value. |
|
| 42 | + * |
|
| 43 | + * @return bool |
|
| 44 | + */ |
|
| 45 | 45 | public function isVariableAssignment() : bool |
| 46 | 46 | { |
| 47 | 47 | $variable = $this->getVariableByIndex(0); |
@@ -56,11 +56,11 @@ discard block |
||
| 56 | 56 | return false; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Whether the whole statement is a variable being compared to something. |
|
| 61 | - * |
|
| 62 | - * @return bool |
|
| 63 | - */ |
|
| 59 | + /** |
|
| 60 | + * Whether the whole statement is a variable being compared to something. |
|
| 61 | + * |
|
| 62 | + * @return bool |
|
| 63 | + */ |
|
| 64 | 64 | public function isVariableComparison() : bool |
| 65 | 65 | { |
| 66 | 66 | $variable = $this->getVariableByIndex(0); |
@@ -75,11 +75,11 @@ discard block |
||
| 75 | 75 | return false; |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Retrieves all variables used in the statement. |
|
| 80 | - * |
|
| 81 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
| 82 | - */ |
|
| 78 | + /** |
|
| 79 | + * Retrieves all variables used in the statement. |
|
| 80 | + * |
|
| 81 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
| 82 | + */ |
|
| 83 | 83 | public function getVariables() |
| 84 | 84 | { |
| 85 | 85 | $result = array(); |
@@ -95,14 +95,14 @@ discard block |
||
| 95 | 95 | return $result; |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * Retrieves a variable by its position in the command's parameters. |
|
| 100 | - * Returns null if there is no parameter at the specified index, or |
|
| 101 | - * if it is of another type. |
|
| 102 | - * |
|
| 103 | - * @param int $index Zero-based index. |
|
| 104 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 105 | - */ |
|
| 98 | + /** |
|
| 99 | + * Retrieves a variable by its position in the command's parameters. |
|
| 100 | + * Returns null if there is no parameter at the specified index, or |
|
| 101 | + * if it is of another type. |
|
| 102 | + * |
|
| 103 | + * @param int $index Zero-based index. |
|
| 104 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 105 | + */ |
|
| 106 | 106 | public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable |
| 107 | 107 | { |
| 108 | 108 | $token = $this->getTokenByIndex($index); |
@@ -115,14 +115,14 @@ discard block |
||
| 115 | 115 | return null; |
| 116 | 116 | } |
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * Retrieves a string literal by its position in the command's parameters. |
|
| 120 | - * Returns null if there is no parameter at the specified index, or |
|
| 121 | - * if it is of another type. |
|
| 122 | - * |
|
| 123 | - * @param int $index Zero-based index. |
|
| 124 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 125 | - */ |
|
| 118 | + /** |
|
| 119 | + * Retrieves a string literal by its position in the command's parameters. |
|
| 120 | + * Returns null if there is no parameter at the specified index, or |
|
| 121 | + * if it is of another type. |
|
| 122 | + * |
|
| 123 | + * @param int $index Zero-based index. |
|
| 124 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 125 | + */ |
|
| 126 | 126 | public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral |
| 127 | 127 | { |
| 128 | 128 | $token = $this->getTokenByIndex($index); |
@@ -135,14 +135,14 @@ discard block |
||
| 135 | 135 | return null; |
| 136 | 136 | } |
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * Retrieves a keyword by its position in the command's parameters. |
|
| 140 | - * Returns null if there is no parameter at the specified index, or |
|
| 141 | - * if it is of another type. |
|
| 142 | - * |
|
| 143 | - * @param int $index Zero-based index. |
|
| 144 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 145 | - */ |
|
| 138 | + /** |
|
| 139 | + * Retrieves a keyword by its position in the command's parameters. |
|
| 140 | + * Returns null if there is no parameter at the specified index, or |
|
| 141 | + * if it is of another type. |
|
| 142 | + * |
|
| 143 | + * @param int $index Zero-based index. |
|
| 144 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 145 | + */ |
|
| 146 | 146 | public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword |
| 147 | 147 | { |
| 148 | 148 | $token = $this->getTokenByIndex($index); |
@@ -155,14 +155,14 @@ discard block |
||
| 155 | 155 | return null; |
| 156 | 156 | } |
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * Retrieves an operand by its position in the command's parameters. |
|
| 160 | - * Returns null if there is no parameter at the specified index, or |
|
| 161 | - * if it is of another type. |
|
| 162 | - * |
|
| 163 | - * @param int $index Zero-based index. |
|
| 164 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 165 | - */ |
|
| 158 | + /** |
|
| 159 | + * Retrieves an operand by its position in the command's parameters. |
|
| 160 | + * Returns null if there is no parameter at the specified index, or |
|
| 161 | + * if it is of another type. |
|
| 162 | + * |
|
| 163 | + * @param int $index Zero-based index. |
|
| 164 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 165 | + */ |
|
| 166 | 166 | public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand |
| 167 | 167 | { |
| 168 | 168 | $token = $this->getTokenByIndex($index); |
@@ -175,14 +175,14 @@ discard block |
||
| 175 | 175 | return null; |
| 176 | 176 | } |
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * Retrieves a parameter token by its position in the command's parameters, |
|
| 180 | - * regardless of its type. Returns null if there is no parameter at the |
|
| 181 | - * specified index. |
|
| 182 | - * |
|
| 183 | - * @param int $index Zero-based index. |
|
| 184 | - * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 185 | - */ |
|
| 178 | + /** |
|
| 179 | + * Retrieves a parameter token by its position in the command's parameters, |
|
| 180 | + * regardless of its type. Returns null if there is no parameter at the |
|
| 181 | + * specified index. |
|
| 182 | + * |
|
| 183 | + * @param int $index Zero-based index. |
|
| 184 | + * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 185 | + */ |
|
| 186 | 186 | public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token |
| 187 | 187 | { |
| 188 | 188 | if(isset($this->tokens[$index])) |
@@ -198,10 +198,10 @@ discard block |
||
| 198 | 198 | return isset($this->tokens[$index]); |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - /** |
|
| 202 | - * Retrieves all string literals that were found in the command. |
|
| 203 | - * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 204 | - */ |
|
| 201 | + /** |
|
| 202 | + * Retrieves all string literals that were found in the command. |
|
| 203 | + * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 204 | + */ |
|
| 205 | 205 | public function getStringLiterals() |
| 206 | 206 | { |
| 207 | 207 | $result = array(); |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | $operand = $this->getOperandByIndex(1); |
| 49 | 49 | $value = $this->getTokenByIndex(2); |
| 50 | 50 | |
| 51 | - if($variable && $operand && $value && $operand->isAssignment()) |
|
| 51 | + if ($variable && $operand && $value && $operand->isAssignment()) |
|
| 52 | 52 | { |
| 53 | 53 | return true; |
| 54 | 54 | } |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | $operand = $this->getOperandByIndex(1); |
| 68 | 68 | $value = $this->getTokenByIndex(2); |
| 69 | 69 | |
| 70 | - if($variable && $operand && $value && $operand->isComparator()) |
|
| 70 | + if ($variable && $operand && $value && $operand->isComparator()) |
|
| 71 | 71 | { |
| 72 | 72 | return true; |
| 73 | 73 | } |
@@ -84,9 +84,9 @@ discard block |
||
| 84 | 84 | { |
| 85 | 85 | $result = array(); |
| 86 | 86 | |
| 87 | - foreach($this->tokens as $token) |
|
| 87 | + foreach ($this->tokens as $token) |
|
| 88 | 88 | { |
| 89 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 89 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 90 | 90 | { |
| 91 | 91 | $result[] = $token->getVariable(); |
| 92 | 92 | } |
@@ -107,7 +107,7 @@ discard block |
||
| 107 | 107 | { |
| 108 | 108 | $token = $this->getTokenByIndex($index); |
| 109 | 109 | |
| 110 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 110 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 111 | 111 | { |
| 112 | 112 | return $token; |
| 113 | 113 | } |
@@ -127,7 +127,7 @@ discard block |
||
| 127 | 127 | { |
| 128 | 128 | $token = $this->getTokenByIndex($index); |
| 129 | 129 | |
| 130 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 130 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 131 | 131 | { |
| 132 | 132 | return $token; |
| 133 | 133 | } |
@@ -147,7 +147,7 @@ discard block |
||
| 147 | 147 | { |
| 148 | 148 | $token = $this->getTokenByIndex($index); |
| 149 | 149 | |
| 150 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword) |
|
| 150 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Keyword) |
|
| 151 | 151 | { |
| 152 | 152 | return $token; |
| 153 | 153 | } |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | { |
| 168 | 168 | $token = $this->getTokenByIndex($index); |
| 169 | 169 | |
| 170 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
| 170 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
| 171 | 171 | { |
| 172 | 172 | return $token; |
| 173 | 173 | } |
@@ -185,7 +185,7 @@ discard block |
||
| 185 | 185 | */ |
| 186 | 186 | public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token |
| 187 | 187 | { |
| 188 | - if(isset($this->tokens[$index])) |
|
| 188 | + if (isset($this->tokens[$index])) |
|
| 189 | 189 | { |
| 190 | 190 | return $this->tokens[$index]; |
| 191 | 191 | } |
@@ -206,9 +206,9 @@ discard block |
||
| 206 | 206 | { |
| 207 | 207 | $result = array(); |
| 208 | 208 | |
| 209 | - foreach($this->tokens as $token) |
|
| 209 | + foreach ($this->tokens as $token) |
|
| 210 | 210 | { |
| 211 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 211 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 212 | 212 | { |
| 213 | 213 | $result[] = $token; |
| 214 | 214 | } |
@@ -22,15 +22,15 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | const VALIDATION_NOT_A_FORMAT_STRING = 55401; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * The date format string. |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 25 | + /** |
|
| 26 | + * The date format string. |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | private $formatString = "Y/m/d"; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Date_FormatInfo |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Date_FormatInfo |
|
| 33 | + */ |
|
| 34 | 34 | private $formatInfo; |
| 35 | 35 | |
| 36 | 36 | public function getName() : string |
@@ -53,46 +53,46 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | protected function validateSyntax_check_format() : void |
| 55 | 55 | { |
| 56 | - $token = $this->params->getInfo()->getTokenByIndex(1); |
|
| 56 | + $token = $this->params->getInfo()->getTokenByIndex(1); |
|
| 57 | 57 | |
| 58 | - // no format specified? Use the default one. |
|
| 59 | - if($token === null) |
|
| 60 | - { |
|
| 61 | - return; |
|
| 62 | - } |
|
| 58 | + // no format specified? Use the default one. |
|
| 59 | + if($token === null) |
|
| 60 | + { |
|
| 61 | + return; |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 65 | - { |
|
| 66 | - $format = $token->getText(); |
|
| 64 | + if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 65 | + { |
|
| 66 | + $format = $token->getText(); |
|
| 67 | 67 | |
| 68 | - $result = $this->formatInfo->validateFormat($format); |
|
| 68 | + $result = $this->formatInfo->validateFormat($format); |
|
| 69 | 69 | |
| 70 | - if($result->isValid()) |
|
| 71 | - { |
|
| 70 | + if($result->isValid()) |
|
| 71 | + { |
|
| 72 | 72 | $this->formatString = $format; |
| 73 | - } |
|
| 74 | - else |
|
| 75 | - { |
|
| 76 | - $this->validationResult->makeError( |
|
| 77 | - $result->getErrorMessage(), |
|
| 78 | - $result->getCode() |
|
| 79 | - ); |
|
| 80 | - } |
|
| 73 | + } |
|
| 74 | + else |
|
| 75 | + { |
|
| 76 | + $this->validationResult->makeError( |
|
| 77 | + $result->getErrorMessage(), |
|
| 78 | + $result->getCode() |
|
| 79 | + ); |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - return; |
|
| 83 | - } |
|
| 82 | + return; |
|
| 83 | + } |
|
| 84 | 84 | |
| 85 | - $this->validationResult->makeError( |
|
| 85 | + $this->validationResult->makeError( |
|
| 86 | 86 | t('The second parameter must be a date format string.'), |
| 87 | 87 | self::VALIDATION_NOT_A_FORMAT_STRING |
| 88 | - ); |
|
| 88 | + ); |
|
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Retrieves the format string used to format the date. |
|
| 93 | - * |
|
| 94 | - * @return string A PHP compatible date format string. |
|
| 95 | - */ |
|
| 91 | + /** |
|
| 92 | + * Retrieves the format string used to format the date. |
|
| 93 | + * |
|
| 94 | + * @return string A PHP compatible date format string. |
|
| 95 | + */ |
|
| 96 | 96 | public function getFormatString() : string |
| 97 | 97 | { |
| 98 | 98 | return $this->formatString; |
@@ -56,18 +56,18 @@ |
||
| 56 | 56 | $token = $this->params->getInfo()->getTokenByIndex(1); |
| 57 | 57 | |
| 58 | 58 | // no format specified? Use the default one. |
| 59 | - if($token === null) |
|
| 59 | + if ($token === null) |
|
| 60 | 60 | { |
| 61 | 61 | return; |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 64 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 65 | 65 | { |
| 66 | 66 | $format = $token->getText(); |
| 67 | 67 | |
| 68 | 68 | $result = $this->formatInfo->validateFormat($format); |
| 69 | 69 | |
| 70 | - if($result->isValid()) |
|
| 70 | + if ($result->isValid()) |
|
| 71 | 71 | { |
| 72 | 72 | $this->formatString = $format; |
| 73 | 73 | } |
@@ -70,8 +70,7 @@ |
||
| 70 | 70 | if($result->isValid()) |
| 71 | 71 | { |
| 72 | 72 | $this->formatString = $format; |
| 73 | - } |
|
| 74 | - else |
|
| 73 | + } else |
|
| 75 | 74 | { |
| 76 | 75 | $this->validationResult->makeError( |
| 77 | 76 | $result->getErrorMessage(), |
@@ -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 |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 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:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 105 | + t('Unquoted string literal found:').' ('.htmlspecialchars($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($this->info instanceof Mailcode_Parser_Statement_Info) |
|
| 78 | + if ($this->info instanceof Mailcode_Parser_Statement_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:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
@@ -27,21 +27,21 @@ discard block |
||
| 27 | 27 | |
| 28 | 28 | const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Commands_Command[] |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Commands_Command[] |
|
| 32 | + */ |
|
| 33 | 33 | private $commands = array(); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string[]Mailcode_Commands_Command |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string[]Mailcode_Commands_Command |
|
| 37 | + */ |
|
| 38 | 38 | private static $dummyCommands = array(); |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Retrieves a list of all available command IDs. |
|
| 42 | - * |
|
| 43 | - * @return string[] |
|
| 44 | - */ |
|
| 40 | + /** |
|
| 41 | + * Retrieves a list of all available command IDs. |
|
| 42 | + * |
|
| 43 | + * @return string[] |
|
| 44 | + */ |
|
| 45 | 45 | public function getIDs() : array |
| 46 | 46 | { |
| 47 | 47 | static $ids = array(); |
@@ -54,13 +54,13 @@ discard block |
||
| 54 | 54 | return $ids; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves a list of all available commands, sorted by label. |
|
| 59 | - * |
|
| 60 | - * NOTE: These instances are only used for information purposes. |
|
| 61 | - * |
|
| 62 | - * @return Mailcode_Commands_Command[] |
|
| 63 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves a list of all available commands, sorted by label. |
|
| 59 | + * |
|
| 60 | + * NOTE: These instances are only used for information purposes. |
|
| 61 | + * |
|
| 62 | + * @return Mailcode_Commands_Command[] |
|
| 63 | + */ |
|
| 64 | 64 | public function getAll() |
| 65 | 65 | { |
| 66 | 66 | if(!empty($this->commands)) { |
@@ -86,12 +86,12 @@ discard block |
||
| 86 | 86 | return $result; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Gets an available command by its ID. |
|
| 91 | - * |
|
| 92 | - * @param string $id |
|
| 93 | - * @return Mailcode_Commands_Command |
|
| 94 | - */ |
|
| 89 | + /** |
|
| 90 | + * Gets an available command by its ID. |
|
| 91 | + * |
|
| 92 | + * @param string $id |
|
| 93 | + * @return Mailcode_Commands_Command |
|
| 94 | + */ |
|
| 95 | 95 | public function getByID(string $id) : Mailcode_Commands_Command |
| 96 | 96 | { |
| 97 | 97 | static $instances = array(); |
@@ -104,15 +104,15 @@ discard block |
||
| 104 | 104 | return $instances[$id]; |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Retrieves the ID of a command by its name. |
|
| 109 | - * |
|
| 110 | - * @param string $name |
|
| 111 | - * @throws Mailcode_Exception |
|
| 112 | - * @return string |
|
| 113 | - * |
|
| 114 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | - */ |
|
| 107 | + /** |
|
| 108 | + * Retrieves the ID of a command by its name. |
|
| 109 | + * |
|
| 110 | + * @param string $name |
|
| 111 | + * @throws Mailcode_Exception |
|
| 112 | + * @return string |
|
| 113 | + * |
|
| 114 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | + */ |
|
| 116 | 116 | public function getIDByName(string $name) : string |
| 117 | 117 | { |
| 118 | 118 | $items = $this->getAll(); |
@@ -141,12 +141,12 @@ discard block |
||
| 141 | 141 | return in_array($id, $ids); |
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - /** |
|
| 145 | - * Checks wether the specified name exists. |
|
| 146 | - * |
|
| 147 | - * @param string $name For example: "showvar". |
|
| 148 | - * @return bool |
|
| 149 | - */ |
|
| 144 | + /** |
|
| 145 | + * Checks wether the specified name exists. |
|
| 146 | + * |
|
| 147 | + * @param string $name For example: "showvar". |
|
| 148 | + * @return bool |
|
| 149 | + */ |
|
| 150 | 150 | public function nameExists(string $name) : bool |
| 151 | 151 | { |
| 152 | 152 | $items = $this->getAll(); |
@@ -200,13 +200,13 @@ discard block |
||
| 200 | 200 | return $class; |
| 201 | 201 | } |
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * Retrieves the dummy command of the specified type, which |
|
| 205 | - * is used to retrieve information on the command's capabilities. |
|
| 206 | - * |
|
| 207 | - * @param string $id |
|
| 208 | - * @return Mailcode_Commands_Command |
|
| 209 | - */ |
|
| 203 | + /** |
|
| 204 | + * Retrieves the dummy command of the specified type, which |
|
| 205 | + * is used to retrieve information on the command's capabilities. |
|
| 206 | + * |
|
| 207 | + * @param string $id |
|
| 208 | + * @return Mailcode_Commands_Command |
|
| 209 | + */ |
|
| 210 | 210 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
| 211 | 211 | { |
| 212 | 212 | if(!isset(self::$dummyCommands[$id])) |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | { |
| 47 | 47 | static $ids = array(); |
| 48 | 48 | |
| 49 | - if(empty($ids)) { |
|
| 49 | + if (empty($ids)) { |
|
| 50 | 50 | $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command') |
| 51 | 51 | ->getPHPClassNames(); |
| 52 | 52 | } |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | */ |
| 64 | 64 | public function getAll() |
| 65 | 65 | { |
| 66 | - if(!empty($this->commands)) { |
|
| 66 | + if (!empty($this->commands)) { |
|
| 67 | 67 | return $this->commands; |
| 68 | 68 | } |
| 69 | 69 | |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | $result = array(); |
| 73 | 73 | |
| 74 | - foreach($ids as $id) |
|
| 74 | + foreach ($ids as $id) |
|
| 75 | 75 | { |
| 76 | 76 | $result[] = $this->getDummyCommand($id); |
| 77 | 77 | } |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | { |
| 97 | 97 | static $instances = array(); |
| 98 | 98 | |
| 99 | - if(!isset($instances[$id])) |
|
| 99 | + if (!isset($instances[$id])) |
|
| 100 | 100 | { |
| 101 | 101 | $instances[$id] = $this->createCommand($id, '__dummy', '', ''); |
| 102 | 102 | } |
@@ -117,9 +117,9 @@ discard block |
||
| 117 | 117 | { |
| 118 | 118 | $items = $this->getAll(); |
| 119 | 119 | |
| 120 | - foreach($items as $item) |
|
| 120 | + foreach ($items as $item) |
|
| 121 | 121 | { |
| 122 | - if($item->getName() === $name) { |
|
| 122 | + if ($item->getName() === $name) { |
|
| 123 | 123 | return $item->getID(); |
| 124 | 124 | } |
| 125 | 125 | } |
@@ -151,9 +151,9 @@ discard block |
||
| 151 | 151 | { |
| 152 | 152 | $items = $this->getAll(); |
| 153 | 153 | |
| 154 | - foreach($items as $item) |
|
| 154 | + foreach ($items as $item) |
|
| 155 | 155 | { |
| 156 | - if($item->getName() === $name) { |
|
| 156 | + if ($item->getName() === $name) { |
|
| 157 | 157 | return true; |
| 158 | 158 | } |
| 159 | 159 | } |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | { |
| 166 | 166 | $class = $this->resolveClassName($id, $type); |
| 167 | 167 | |
| 168 | - if(!class_exists($class)) |
|
| 168 | + if (!class_exists($class)) |
|
| 169 | 169 | { |
| 170 | 170 | throw new Mailcode_Exception( |
| 171 | 171 | 'No such command', |
@@ -187,9 +187,9 @@ discard block |
||
| 187 | 187 | |
| 188 | 188 | $dummy = $this->getDummyCommand($id); |
| 189 | 189 | |
| 190 | - if($dummy->supportsType()) |
|
| 190 | + if ($dummy->supportsType()) |
|
| 191 | 191 | { |
| 192 | - if(empty($type)) |
|
| 192 | + if (empty($type)) |
|
| 193 | 193 | { |
| 194 | 194 | $type = $dummy->getDefaultType(); |
| 195 | 195 | } |
@@ -209,13 +209,13 @@ discard block |
||
| 209 | 209 | */ |
| 210 | 210 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
| 211 | 211 | { |
| 212 | - if(!isset(self::$dummyCommands[$id])) |
|
| 212 | + if (!isset(self::$dummyCommands[$id])) |
|
| 213 | 213 | { |
| 214 | 214 | $class = 'Mailcode\Mailcode_Commands_Command_'.$id; |
| 215 | 215 | self::$dummyCommands[$id] = new $class('__dummy'); |
| 216 | 216 | } |
| 217 | 217 | |
| 218 | - if(self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
| 218 | + if (self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
| 219 | 219 | { |
| 220 | 220 | return self::$dummyCommands[$id]; |
| 221 | 221 | } |
@@ -23,19 +23,19 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Commands_IfVariable |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | + */ |
|
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $comparisonToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | + */ |
|
| 39 | 39 | protected $valueToken; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -123,11 +123,11 @@ discard block |
||
| 123 | 123 | ); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Retrieves the variable being compared. |
|
| 128 | - * |
|
| 129 | - * @return Mailcode_Variables_Variable |
|
| 130 | - */ |
|
| 126 | + /** |
|
| 127 | + * Retrieves the variable being compared. |
|
| 128 | + * |
|
| 129 | + * @return Mailcode_Variables_Variable |
|
| 130 | + */ |
|
| 131 | 131 | public function getVariable() : Mailcode_Variables_Variable |
| 132 | 132 | { |
| 133 | 133 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -142,12 +142,12 @@ discard block |
||
| 142 | 142 | ); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Retrieves the comparison operator sign. |
|
| 147 | - * |
|
| 148 | - * @throws Mailcode_Exception |
|
| 149 | - * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | - */ |
|
| 145 | + /** |
|
| 146 | + * Retrieves the comparison operator sign. |
|
| 147 | + * |
|
| 148 | + * @throws Mailcode_Exception |
|
| 149 | + * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | + */ |
|
| 151 | 151 | public function getComparator() : string |
| 152 | 152 | { |
| 153 | 153 | if($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
@@ -162,10 +162,10 @@ discard block |
||
| 162 | 162 | ); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Retrieves the unquoted value |
|
| 167 | - * @return string |
|
| 168 | - */ |
|
| 165 | + /** |
|
| 166 | + * Retrieves the unquoted value |
|
| 167 | + * @return string |
|
| 168 | + */ |
|
| 169 | 169 | public function getValue() : string |
| 170 | 170 | { |
| 171 | 171 | if($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | $var = $info->getVariableByIndex(0); |
| 55 | 55 | |
| 56 | - if($var !== null) |
|
| 56 | + if ($var !== null) |
|
| 57 | 57 | { |
| 58 | 58 | $this->variableToken = $var; |
| 59 | 59 | return; |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | $operand = $info->getOperandByIndex(1); |
| 73 | 73 | |
| 74 | - if($operand === null) |
|
| 74 | + if ($operand === null) |
|
| 75 | 75 | { |
| 76 | 76 | $this->validationResult->makeError( |
| 77 | 77 | t('No operand sign after the variable name.'), |
@@ -81,7 +81,7 @@ discard block |
||
| 81 | 81 | return; |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - if(!$operand->isComparator()) |
|
| 84 | + if (!$operand->isComparator()) |
|
| 85 | 85 | { |
| 86 | 86 | $this->validationResult->makeError( |
| 87 | 87 | t('The operand sign is not a comparison operand.'), |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | |
| 101 | 101 | $token = $info->getTokenByIndex(2); |
| 102 | 102 | |
| 103 | - if($token === null) |
|
| 103 | + if ($token === null) |
|
| 104 | 104 | { |
| 105 | 105 | $this->validationResult->makeError( |
| 106 | 106 | t('Nothing found after the comparison operand.'), |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | return; |
| 111 | 111 | } |
| 112 | 112 | |
| 113 | - if($token instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 113 | + if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 114 | 114 | { |
| 115 | 115 | $this->valueToken = $token; |
| 116 | 116 | |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | */ |
| 131 | 131 | public function getVariable() : Mailcode_Variables_Variable |
| 132 | 132 | { |
| 133 | - if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 133 | + if ($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 134 | 134 | { |
| 135 | 135 | return $this->variableToken->getVariable(); |
| 136 | 136 | } |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | */ |
| 151 | 151 | public function getComparator() : string |
| 152 | 152 | { |
| 153 | - if($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
| 153 | + if ($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
|
| 154 | 154 | { |
| 155 | 155 | return $this->comparisonToken->getOperand(); |
| 156 | 156 | } |
@@ -168,7 +168,7 @@ discard block |
||
| 168 | 168 | */ |
| 169 | 169 | public function getValue() : string |
| 170 | 170 | { |
| 171 | - if($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 171 | + if ($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
|
| 172 | 172 | { |
| 173 | 173 | return $this->valueToken->getValue(); |
| 174 | 174 | } |
@@ -28,14 +28,14 @@ discard block |
||
| 28 | 28 | */ |
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $stringToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var boolean |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var boolean |
|
| 38 | + */ |
|
| 39 | 39 | protected $caseInsensitive = false; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -131,11 +131,11 @@ discard block |
||
| 131 | 131 | ); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Retrieves the variable being compared. |
|
| 136 | - * |
|
| 137 | - * @return Mailcode_Variables_Variable |
|
| 138 | - */ |
|
| 134 | + /** |
|
| 135 | + * Retrieves the variable being compared. |
|
| 136 | + * |
|
| 137 | + * @return Mailcode_Variables_Variable |
|
| 138 | + */ |
|
| 139 | 139 | public function getVariable() : Mailcode_Variables_Variable |
| 140 | 140 | { |
| 141 | 141 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -52,7 +52,7 @@ discard block |
||
| 52 | 52 | |
| 53 | 53 | $variable = $info->getVariableByIndex(0); |
| 54 | 54 | |
| 55 | - if($variable !== null) |
|
| 55 | + if ($variable !== null) |
|
| 56 | 56 | { |
| 57 | 57 | $this->variableToken = $variable; |
| 58 | 58 | return; |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | // first variant: variable "Search term" |
| 72 | 72 | $string = $info->getStringLiteralByIndex(1); |
| 73 | 73 | |
| 74 | - if($string !== null) |
|
| 74 | + if ($string !== null) |
|
| 75 | 75 | { |
| 76 | 76 | $this->stringToken = $string; |
| 77 | 77 | return; |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | // second variant: variable insensitive: "Search term" |
| 88 | 88 | $keyword = $info->getKeywordByIndex(1); |
| 89 | 89 | |
| 90 | - if($keyword === null) |
|
| 90 | + if ($keyword === null) |
|
| 91 | 91 | { |
| 92 | 92 | $this->validationResult->makeError( |
| 93 | 93 | t('Expected a search term or the %1$s keyword after the variable name.', 'insensitive:'), |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | return; |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - if($keyword->getKeyword() !== 'insensitive:') |
|
| 100 | + if ($keyword->getKeyword() !== 'insensitive:') |
|
| 101 | 101 | { |
| 102 | 102 | $this->validationResult->makeError( |
| 103 | 103 | t('Invalid keyword %1$s.', $keyword->getKeyword()).' '. |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | |
| 120 | 120 | $string = $info->getStringLiteralByIndex(2); |
| 121 | 121 | |
| 122 | - if($string !== null) |
|
| 122 | + if ($string !== null) |
|
| 123 | 123 | { |
| 124 | 124 | $this->stringToken = $string; |
| 125 | 125 | return; |
@@ -138,7 +138,7 @@ discard block |
||
| 138 | 138 | */ |
| 139 | 139 | public function getVariable() : Mailcode_Variables_Variable |
| 140 | 140 | { |
| 141 | - if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 141 | + if ($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
|
| 142 | 142 | { |
| 143 | 143 | return $this->variableToken->getVariable(); |
| 144 | 144 | } |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | |
| 158 | 158 | public function getSearchTerm() : string |
| 159 | 159 | { |
| 160 | - if($this->stringToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 160 | + if ($this->stringToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) |
|
| 161 | 161 | { |
| 162 | 162 | return $this->stringToken->getNormalized(); |
| 163 | 163 | } |