@@ -24,9 +24,9 @@ |
||
| 24 | 24 | { |
| 25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var string[]string |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var string[]string |
|
| 29 | + */ |
|
| 30 | 30 | private $charTable = array( |
| 31 | 31 | 'd' => 'd', |
| 32 | 32 | 'm' => 'M', |
@@ -56,9 +56,9 @@ |
||
| 56 | 56 | $chars = ConvertHelper::string2array($formatString); |
| 57 | 57 | $result = array(); |
| 58 | 58 | |
| 59 | - foreach($chars as $char) |
|
| 59 | + foreach ($chars as $char) |
|
| 60 | 60 | { |
| 61 | - if(!isset($this->charTable[$char])) |
|
| 61 | + if (!isset($this->charTable[$char])) |
|
| 62 | 62 | { |
| 63 | 63 | throw new Mailcode_Translator_Exception( |
| 64 | 64 | 'Unknown date format string character', |
@@ -23,19 +23,19 @@ discard block |
||
| 23 | 23 | { |
| 24 | 24 | const ERROR_UNHANDLED_CHARTYPE = 55601; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | private $type; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | private $char; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | private $description; |
| 40 | 40 | |
| 41 | 41 | public function __construct(string $type, string $char, string $description) |
@@ -45,46 +45,46 @@ discard block |
||
| 45 | 45 | $this->description = $description; |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Retrieves the format character (PHP date format). |
|
| 50 | - * |
|
| 51 | - * @return string |
|
| 52 | - */ |
|
| 48 | + /** |
|
| 49 | + * Retrieves the format character (PHP date format). |
|
| 50 | + * |
|
| 51 | + * @return string |
|
| 52 | + */ |
|
| 53 | 53 | public function getChar() : string |
| 54 | 54 | { |
| 55 | 55 | return $this->char; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Retrieves a human readable description of the character's role. |
|
| 60 | - * |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 58 | + /** |
|
| 59 | + * Retrieves a human readable description of the character's role. |
|
| 60 | + * |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | 63 | public function getDescription() : string |
| 64 | 64 | { |
| 65 | 65 | return $this->description; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Retrieves the character type ID. |
|
| 70 | - * |
|
| 71 | - * @return string |
|
| 72 | - * |
|
| 73 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
| 74 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
| 75 | - * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
| 76 | - */ |
|
| 68 | + /** |
|
| 69 | + * Retrieves the character type ID. |
|
| 70 | + * |
|
| 71 | + * @return string |
|
| 72 | + * |
|
| 73 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE |
|
| 74 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME |
|
| 75 | + * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION |
|
| 76 | + */ |
|
| 77 | 77 | public function getTypeID() : string |
| 78 | 78 | { |
| 79 | 79 | return $this->type; |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
| 84 | - * |
|
| 85 | - * @throws Mailcode_Exception If the character type is unknown. |
|
| 86 | - * @return string |
|
| 87 | - */ |
|
| 82 | + /** |
|
| 83 | + * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation". |
|
| 84 | + * |
|
| 85 | + * @throws Mailcode_Exception If the character type is unknown. |
|
| 86 | + * @return string |
|
| 87 | + */ |
|
| 88 | 88 | public function getTypeLabel() : string |
| 89 | 89 | { |
| 90 | 90 | switch($this->type) |
@@ -87,7 +87,7 @@ |
||
| 87 | 87 | */ |
| 88 | 88 | public function getTypeLabel() : string |
| 89 | 89 | { |
| 90 | - switch($this->type) |
|
| 90 | + switch ($this->type) |
|
| 91 | 91 | { |
| 92 | 92 | case Mailcode_Date_FormatInfo::CHARTYPE_DATE: |
| 93 | 93 | return t('Date'); |
@@ -31,24 +31,24 @@ discard block |
||
| 31 | 31 | const CHARTYPE_TIME = 'time'; |
| 32 | 32 | const CHARTYPE_PUNCTUATION = 'punctuation'; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | 37 | private $defaultFormat = "Y/m/d"; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Date_FormatInfo_Character[] |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Date_FormatInfo_Character[] |
|
| 41 | + */ |
|
| 42 | 42 | private $formatChars = array(); |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var string[] |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var string[] |
|
| 46 | + */ |
|
| 47 | 47 | private $allowedChars = array(); |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var Mailcode_Date_FormatInfo|NULL |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var Mailcode_Date_FormatInfo|NULL |
|
| 51 | + */ |
|
| 52 | 52 | private static $instance; |
| 53 | 53 | |
| 54 | 54 | private function __construct() |
@@ -66,11 +66,11 @@ discard block |
||
| 66 | 66 | return self::$instance; |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Initialized the list of allowed date formatting |
|
| 71 | - * characters. This is done only once per request |
|
| 72 | - * by storing them statically for performance reasons. |
|
| 73 | - */ |
|
| 69 | + /** |
|
| 70 | + * Initialized the list of allowed date formatting |
|
| 71 | + * characters. This is done only once per request |
|
| 72 | + * by storing them statically for performance reasons. |
|
| 73 | + */ |
|
| 74 | 74 | private function initCharacters() : void |
| 75 | 75 | { |
| 76 | 76 | $chars = array( |
@@ -113,16 +113,16 @@ discard block |
||
| 113 | 113 | $this->defaultFormat = $formatString; |
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * Validates the date format string, by ensuring that |
|
| 118 | - * all the characters it is composed of are known. |
|
| 119 | - * |
|
| 120 | - * @param string $formatString |
|
| 121 | - * @return OperationResult |
|
| 122 | - * |
|
| 123 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
| 124 | - * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
| 125 | - */ |
|
| 116 | + /** |
|
| 117 | + * Validates the date format string, by ensuring that |
|
| 118 | + * all the characters it is composed of are known. |
|
| 119 | + * |
|
| 120 | + * @param string $formatString |
|
| 121 | + * @return OperationResult |
|
| 122 | + * |
|
| 123 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING |
|
| 124 | + * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER |
|
| 125 | + */ |
|
| 126 | 126 | public function validateFormat(string $formatString) : OperationResult |
| 127 | 127 | { |
| 128 | 128 | $result = new OperationResult($this); |
@@ -161,23 +161,23 @@ discard block |
||
| 161 | 161 | return $result; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Retrieves all characters that are allowed to |
|
| 166 | - * be used in a date format string, with information |
|
| 167 | - * on each. |
|
| 168 | - * |
|
| 169 | - * @return Mailcode_Date_FormatInfo_Character[] |
|
| 170 | - */ |
|
| 164 | + /** |
|
| 165 | + * Retrieves all characters that are allowed to |
|
| 166 | + * be used in a date format string, with information |
|
| 167 | + * on each. |
|
| 168 | + * |
|
| 169 | + * @return Mailcode_Date_FormatInfo_Character[] |
|
| 170 | + */ |
|
| 171 | 171 | public function getCharactersList() : array |
| 172 | 172 | { |
| 173 | 173 | return $this->formatChars; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Retrieves the characters list, grouped by type label. |
|
| 178 | - * |
|
| 179 | - * @return array<string, array> |
|
| 180 | - */ |
|
| 176 | + /** |
|
| 177 | + * Retrieves the characters list, grouped by type label. |
|
| 178 | + * |
|
| 179 | + * @return array<string, array> |
|
| 180 | + */ |
|
| 181 | 181 | public function getCharactersGrouped() : array |
| 182 | 182 | { |
| 183 | 183 | $grouped = array(); |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | public static function getInstance() : Mailcode_Date_FormatInfo |
| 60 | 60 | { |
| 61 | - if(!isset(self::$instance)) |
|
| 61 | + if (!isset(self::$instance)) |
|
| 62 | 62 | { |
| 63 | 63 | self::$instance = new Mailcode_Date_FormatInfo(); |
| 64 | 64 | } |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | array(self::CHARTYPE_PUNCTUATION, ' ', t('Space')) |
| 91 | 91 | ); |
| 92 | 92 | |
| 93 | - foreach($chars as $def) |
|
| 93 | + foreach ($chars as $def) |
|
| 94 | 94 | { |
| 95 | 95 | $char = new Mailcode_Date_FormatInfo_Character( |
| 96 | 96 | $def[0], |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | |
| 130 | 130 | $trimmed = trim($formatString); |
| 131 | 131 | |
| 132 | - if(empty($trimmed)) |
|
| 132 | + if (empty($trimmed)) |
|
| 133 | 133 | { |
| 134 | 134 | $result->makeError( |
| 135 | 135 | t('Empty date format.'), |
@@ -142,15 +142,15 @@ discard block |
||
| 142 | 142 | $chars = ConvertHelper::string2array($formatString); |
| 143 | 143 | $total = count($chars); |
| 144 | 144 | |
| 145 | - for($i=0; $i < $total; $i++) |
|
| 145 | + for ($i = 0; $i < $total; $i++) |
|
| 146 | 146 | { |
| 147 | 147 | $char = $chars[$i]; |
| 148 | 148 | |
| 149 | - if(!in_array($char, $this->allowedChars)) |
|
| 149 | + if (!in_array($char, $this->allowedChars)) |
|
| 150 | 150 | { |
| 151 | 151 | $result->makeError( |
| 152 | 152 | t('Invalid character in date format:').' '. |
| 153 | - t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1), |
|
| 153 | + t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i + 1), |
|
| 154 | 154 | self::VALIDATION_INVALID_FORMAT_CHARACTER |
| 155 | 155 | ); |
| 156 | 156 | |
@@ -182,11 +182,11 @@ discard block |
||
| 182 | 182 | { |
| 183 | 183 | $grouped = array(); |
| 184 | 184 | |
| 185 | - foreach($this->formatChars as $char) |
|
| 185 | + foreach ($this->formatChars as $char) |
|
| 186 | 186 | { |
| 187 | 187 | $type = $char->getTypeLabel(); |
| 188 | 188 | |
| 189 | - if(!isset($grouped[$type])) |
|
| 189 | + if (!isset($grouped[$type])) |
|
| 190 | 190 | { |
| 191 | 191 | $grouped[$type] = array(); |
| 192 | 192 | } |
@@ -196,7 +196,7 @@ discard block |
||
| 196 | 196 | |
| 197 | 197 | $groups = array_keys($grouped); |
| 198 | 198 | |
| 199 | - foreach($groups as $group) |
|
| 199 | + foreach ($groups as $group) |
|
| 200 | 200 | { |
| 201 | 201 | usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b) |
| 202 | 202 | { |
@@ -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_Type_Value |
| 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, '"\''); |
@@ -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()).')', |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | { |
| 70 | 70 | $this->validate(); |
| 71 | 71 | |
| 72 | - if($this->variable instanceof Mailcode_Variables_Variable) |
|
| 72 | + if ($this->variable instanceof Mailcode_Variables_Variable) |
|
| 73 | 73 | { |
| 74 | 74 | return $this->variable; |
| 75 | 75 | } |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | $vars = $this->getVariables()->getGroupedByName(); |
| 101 | 101 | $amount = count($vars); |
| 102 | 102 | |
| 103 | - if($amount === 1) |
|
| 103 | + if ($amount === 1) |
|
| 104 | 104 | { |
| 105 | 105 | $this->variable = array_pop($vars); |
| 106 | 106 | return; |
@@ -26,9 +26,9 @@ discard block |
||
| 26 | 26 | |
| 27 | 27 | const VALIDATION_VARIABLE_COUNT_MISMATCH = 48402; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Variables_Variable|NULL |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Variables_Variable|NULL |
|
| 31 | + */ |
|
| 32 | 32 | protected $variable; |
| 33 | 33 | |
| 34 | 34 | public function getName() : string |
@@ -61,15 +61,15 @@ discard block |
||
| 61 | 61 | return false; |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Retrieves the variable to show. |
|
| 66 | - * |
|
| 67 | - * NOTE: Only available once the command has been |
|
| 68 | - * validated. Always use isValid() first. |
|
| 69 | - * |
|
| 70 | - * @throws Mailcode_Exception |
|
| 71 | - * @return Mailcode_Variables_Variable |
|
| 72 | - */ |
|
| 64 | + /** |
|
| 65 | + * Retrieves the variable to show. |
|
| 66 | + * |
|
| 67 | + * NOTE: Only available once the command has been |
|
| 68 | + * validated. Always use isValid() first. |
|
| 69 | + * |
|
| 70 | + * @throws Mailcode_Exception |
|
| 71 | + * @return Mailcode_Variables_Variable |
|
| 72 | + */ |
|
| 73 | 73 | public function getVariable() : Mailcode_Variables_Variable |
| 74 | 74 | { |
| 75 | 75 | $this->validate(); |
@@ -86,15 +86,15 @@ discard block |
||
| 86 | 86 | ); |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Retrieves the full name of the variable to show. |
|
| 91 | - * |
|
| 92 | - * NOTE: Only available once the command has been |
|
| 93 | - * validated. Always use isValid() first. |
|
| 94 | - * |
|
| 95 | - * @throws Mailcode_Exception |
|
| 96 | - * @return string |
|
| 97 | - */ |
|
| 89 | + /** |
|
| 90 | + * Retrieves the full name of the variable to show. |
|
| 91 | + * |
|
| 92 | + * NOTE: Only available once the command has been |
|
| 93 | + * validated. Always use isValid() first. |
|
| 94 | + * |
|
| 95 | + * @throws Mailcode_Exception |
|
| 96 | + * @return string |
|
| 97 | + */ |
|
| 98 | 98 | public function getVariableName() : string |
| 99 | 99 | { |
| 100 | 100 | return $this->getVariable()->getFullName(); |
@@ -102,19 +102,19 @@ discard block |
||
| 102 | 102 | |
| 103 | 103 | protected function validateSyntax_require_variable() : void |
| 104 | 104 | { |
| 105 | - $vars = $this->getVariables()->getGroupedByName(); |
|
| 106 | - $amount = count($vars); |
|
| 105 | + $vars = $this->getVariables()->getGroupedByName(); |
|
| 106 | + $amount = count($vars); |
|
| 107 | 107 | |
| 108 | - if($amount === 1) |
|
| 109 | - { |
|
| 110 | - $this->variable = array_pop($vars); |
|
| 111 | - return; |
|
| 112 | - } |
|
| 108 | + if($amount === 1) |
|
| 109 | + { |
|
| 110 | + $this->variable = array_pop($vars); |
|
| 111 | + return; |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | - $this->validationResult->makeError( |
|
| 114 | + $this->validationResult->makeError( |
|
| 115 | 115 | t('Command has %1$s variables, %2$s expected.', $amount, 1), |
| 116 | 116 | self::VALIDATION_VARIABLE_COUNT_MISMATCH |
| 117 | - ); |
|
| 117 | + ); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | 120 | protected function getValidations() : array |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | { |
| 66 | 66 | $this->validate(); |
| 67 | 67 | |
| 68 | - if($this->variable instanceof Mailcode_Variables_Variable) |
|
| 68 | + if ($this->variable instanceof Mailcode_Variables_Variable) |
|
| 69 | 69 | { |
| 70 | 70 | return $this->variable; |
| 71 | 71 | } |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | |
| 96 | 96 | $var = $info->getVariableByIndex(0); |
| 97 | 97 | |
| 98 | - if($var) |
|
| 98 | + if ($var) |
|
| 99 | 99 | { |
| 100 | 100 | $this->variable = $var->getVariable(); |
| 101 | 101 | return; |
@@ -24,9 +24,9 @@ discard block |
||
| 24 | 24 | |
| 25 | 25 | const VALIDATION_VARIABLE_MISSING = 52001; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var Mailcode_Variables_Variable|NULL |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var Mailcode_Variables_Variable|NULL |
|
| 29 | + */ |
|
| 30 | 30 | protected $variable; |
| 31 | 31 | |
| 32 | 32 | public function getName() : string |
@@ -59,13 +59,13 @@ discard block |
||
| 59 | 59 | return false; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Retrieves the variable to show, provided the command |
|
| 64 | - * is valid. |
|
| 65 | - * |
|
| 66 | - * @throws Mailcode_Exception |
|
| 67 | - * @return Mailcode_Variables_Variable |
|
| 68 | - */ |
|
| 62 | + /** |
|
| 63 | + * Retrieves the variable to show, provided the command |
|
| 64 | + * is valid. |
|
| 65 | + * |
|
| 66 | + * @throws Mailcode_Exception |
|
| 67 | + * @return Mailcode_Variables_Variable |
|
| 68 | + */ |
|
| 69 | 69 | public function getVariable() : Mailcode_Variables_Variable |
| 70 | 70 | { |
| 71 | 71 | $this->validate(); |
@@ -82,13 +82,13 @@ discard block |
||
| 82 | 82 | ); |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Retrieves the full name of the variable to show, |
|
| 87 | - * provided the command is valid. |
|
| 88 | - * |
|
| 89 | - * @throws Mailcode_Exception |
|
| 90 | - * @return string |
|
| 91 | - */ |
|
| 85 | + /** |
|
| 86 | + * Retrieves the full name of the variable to show, |
|
| 87 | + * provided the command is valid. |
|
| 88 | + * |
|
| 89 | + * @throws Mailcode_Exception |
|
| 90 | + * @return string |
|
| 91 | + */ |
|
| 92 | 92 | public function getVariableName() : string |
| 93 | 93 | { |
| 94 | 94 | return $this->getVariable()->getFullName(); |