@@ -24,15 +24,15 @@ |
||
| 24 | 24 | { |
| 25 | 25 | const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * The date format used in the date variable. This is used to convert |
|
| 29 | - * the native date to the format specified in the variable command. |
|
| 30 | - */ |
|
| 27 | + /** |
|
| 28 | + * The date format used in the date variable. This is used to convert |
|
| 29 | + * the native date to the format specified in the variable command. |
|
| 30 | + */ |
|
| 31 | 31 | const DEFAULT_INTERNAL_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var string[]string |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var string[]string |
|
| 35 | + */ |
|
| 36 | 36 | private $charTable = array( |
| 37 | 37 | 'd' => 'dd', |
| 38 | 38 | 'j' => 'd', |
@@ -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; |
| 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 |
@@ -90,11 +90,11 @@ discard block |
||
| 90 | 90 | ); |
| 91 | 91 | } |
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * Retrieves the format string used to format the date. |
|
| 95 | - * |
|
| 96 | - * @return string A PHP compatible date format string. |
|
| 97 | - */ |
|
| 93 | + /** |
|
| 94 | + * Retrieves the format string used to format the date. |
|
| 95 | + * |
|
| 96 | + * @return string A PHP compatible date format string. |
|
| 97 | + */ |
|
| 98 | 98 | public function getFormatString() : string |
| 99 | 99 | { |
| 100 | 100 | return $this->formatString; |
@@ -31,10 +31,10 @@ discard block |
||
| 31 | 31 | const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209; |
| 32 | 32 | const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * The default number format string. |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 34 | + /** |
|
| 35 | + * The default number format string. |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | 38 | private $formatString = Mailcode_Number_Info::DEFAULT_FORMAT; |
| 39 | 39 | |
| 40 | 40 | public function getName() : string |
@@ -58,16 +58,16 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | protected function validateSyntax_check_format() : void |
| 60 | 60 | { |
| 61 | - $tokens = $this->params->getInfo()->getStringLiterals(); |
|
| 61 | + $tokens = $this->params->getInfo()->getStringLiterals(); |
|
| 62 | 62 | |
| 63 | - // no format specified? Use the default one. |
|
| 64 | - if(empty($tokens)) |
|
| 65 | - { |
|
| 66 | - return; |
|
| 67 | - } |
|
| 63 | + // no format specified? Use the default one. |
|
| 64 | + if(empty($tokens)) |
|
| 65 | + { |
|
| 66 | + return; |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - $token = array_pop($tokens); |
|
| 70 | - $this->parseFormatString($token->getText()); |
|
| 69 | + $token = array_pop($tokens); |
|
| 70 | + $this->parseFormatString($token->getText()); |
|
| 71 | 71 | } |
| 72 | 72 | |
| 73 | 73 | private function parseFormatString(string $format) : void |
@@ -86,11 +86,11 @@ discard block |
||
| 86 | 86 | ); |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Retrieves the format string used to format the number. |
|
| 91 | - * |
|
| 92 | - * @return string |
|
| 93 | - */ |
|
| 89 | + /** |
|
| 90 | + * Retrieves the format string used to format the number. |
|
| 91 | + * |
|
| 92 | + * @return string |
|
| 93 | + */ |
|
| 94 | 94 | public function getFormatString() : string |
| 95 | 95 | { |
| 96 | 96 | return $this->formatString; |
@@ -26,24 +26,24 @@ discard block |
||
| 26 | 26 | const VALIDATION_EMPTY = 48801; |
| 27 | 27 | const VALIDATION_UNQUOTED_STRING_LITERALS = 48802; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | 32 | protected $statement; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var OperationResult |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var OperationResult |
|
| 36 | + */ |
|
| 37 | 37 | protected $result; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 41 | + */ |
|
| 42 | 42 | protected $tokenizer; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Parser_Statement_Info|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Parser_Statement_Info|NULL |
|
| 46 | + */ |
|
| 47 | 47 | protected $info; |
| 48 | 48 | |
| 49 | 49 | /** |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | if($unknown) |
| 113 | 113 | { |
| 114 | 114 | $this->result->makeError( |
| 115 | - t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 115 | + t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')', |
|
| 116 | 116 | self::VALIDATION_UNQUOTED_STRING_LITERALS |
| 117 | 117 | ); |
| 118 | 118 | } |
@@ -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 | /** |
@@ -52,21 +52,21 @@ discard block |
||
| 52 | 52 | $this->tokenizer->onTokensChanged(array($this, 'handleTokensChanged')); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Whether the whole statement is a variable being assigned a value. |
|
| 57 | - * |
|
| 58 | - * @return bool |
|
| 59 | - */ |
|
| 55 | + /** |
|
| 56 | + * Whether the whole statement is a variable being assigned a value. |
|
| 57 | + * |
|
| 58 | + * @return bool |
|
| 59 | + */ |
|
| 60 | 60 | public function isVariableAssignment() : bool |
| 61 | 61 | { |
| 62 | 62 | return $this->variables->isAssignment(); |
| 63 | 63 | } |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Whether the whole statement is a variable being compared to something. |
|
| 67 | - * |
|
| 68 | - * @return bool |
|
| 69 | - */ |
|
| 65 | + /** |
|
| 66 | + * Whether the whole statement is a variable being compared to something. |
|
| 67 | + * |
|
| 68 | + * @return bool |
|
| 69 | + */ |
|
| 70 | 70 | public function isVariableComparison() : bool |
| 71 | 71 | { |
| 72 | 72 | return $this->variables->isComparison(); |
@@ -83,27 +83,27 @@ discard block |
||
| 83 | 83 | return $this->variables->getAll(); |
| 84 | 84 | } |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Retrieves a variable by its position in the command's parameters. |
|
| 88 | - * Returns null if there is no parameter at the specified index, or |
|
| 89 | - * if it is of another type. |
|
| 90 | - * |
|
| 91 | - * @param int $index Zero-based index. |
|
| 92 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 93 | - */ |
|
| 86 | + /** |
|
| 87 | + * Retrieves a variable by its position in the command's parameters. |
|
| 88 | + * Returns null if there is no parameter at the specified index, or |
|
| 89 | + * if it is of another type. |
|
| 90 | + * |
|
| 91 | + * @param int $index Zero-based index. |
|
| 92 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 93 | + */ |
|
| 94 | 94 | public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable |
| 95 | 95 | { |
| 96 | 96 | return $this->variables->getByIndex($index); |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Retrieves a string literal by its position in the command's parameters. |
|
| 101 | - * Returns null if there is no parameter at the specified index, or |
|
| 102 | - * if it is of another type. |
|
| 103 | - * |
|
| 104 | - * @param int $index Zero-based index. |
|
| 105 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 106 | - */ |
|
| 99 | + /** |
|
| 100 | + * Retrieves a string literal by its position in the command's parameters. |
|
| 101 | + * Returns null if there is no parameter at the specified index, or |
|
| 102 | + * if it is of another type. |
|
| 103 | + * |
|
| 104 | + * @param int $index Zero-based index. |
|
| 105 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 106 | + */ |
|
| 107 | 107 | public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral |
| 108 | 108 | { |
| 109 | 109 | $token = $this->getTokenByIndex($index); |
@@ -116,27 +116,27 @@ discard block |
||
| 116 | 116 | return null; |
| 117 | 117 | } |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Retrieves a keyword by its position in the command's parameters. |
|
| 121 | - * Returns null if there is no parameter at the specified index, or |
|
| 122 | - * if it is of another type. |
|
| 123 | - * |
|
| 124 | - * @param int $index Zero-based index. |
|
| 125 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 126 | - */ |
|
| 119 | + /** |
|
| 120 | + * Retrieves a keyword by its position in the command's parameters. |
|
| 121 | + * Returns null if there is no parameter at the specified index, or |
|
| 122 | + * if it is of another type. |
|
| 123 | + * |
|
| 124 | + * @param int $index Zero-based index. |
|
| 125 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 126 | + */ |
|
| 127 | 127 | public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword |
| 128 | 128 | { |
| 129 | 129 | return $this->keywords->getByIndex($index); |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | - /** |
|
| 133 | - * Retrieves an operand by its position in the command's parameters. |
|
| 134 | - * Returns null if there is no parameter at the specified index, or |
|
| 135 | - * if it is of another type. |
|
| 136 | - * |
|
| 137 | - * @param int $index Zero-based index. |
|
| 138 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 139 | - */ |
|
| 132 | + /** |
|
| 133 | + * Retrieves an operand by its position in the command's parameters. |
|
| 134 | + * Returns null if there is no parameter at the specified index, or |
|
| 135 | + * if it is of another type. |
|
| 136 | + * |
|
| 137 | + * @param int $index Zero-based index. |
|
| 138 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 139 | + */ |
|
| 140 | 140 | public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand |
| 141 | 141 | { |
| 142 | 142 | $token = $this->getTokenByIndex($index); |
@@ -149,14 +149,14 @@ discard block |
||
| 149 | 149 | return null; |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Retrieves a parameter token by its position in the command's parameters, |
|
| 154 | - * regardless of its type. Returns null if there is no parameter at the |
|
| 155 | - * specified index. |
|
| 156 | - * |
|
| 157 | - * @param int $index Zero-based index. |
|
| 158 | - * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 159 | - */ |
|
| 152 | + /** |
|
| 153 | + * Retrieves a parameter token by its position in the command's parameters, |
|
| 154 | + * regardless of its type. Returns null if there is no parameter at the |
|
| 155 | + * specified index. |
|
| 156 | + * |
|
| 157 | + * @param int $index Zero-based index. |
|
| 158 | + * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL |
|
| 159 | + */ |
|
| 160 | 160 | public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token |
| 161 | 161 | { |
| 162 | 162 | if(isset($this->tokens[$index])) |
@@ -172,19 +172,19 @@ discard block |
||
| 172 | 172 | return isset($this->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->tokens; |
| 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(); |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | const ERROR_INVALID_COMMAND_CREATED = 50001; |
| 24 | 24 | const ERROR_UNEXPECTED_COMMAND_TYPE = 50002; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Factory_CommandSets |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Factory_CommandSets |
|
| 28 | + */ |
|
| 29 | 29 | private static $commandSets; |
| 30 | 30 | |
| 31 | 31 | /** |
@@ -79,33 +79,33 @@ discard block |
||
| 79 | 79 | } |
| 80 | 80 | |
| 81 | 81 | /** |
| 82 | - * Creates a renderer instance, which can be used to easily |
|
| 83 | - * create and convert commands to strings. |
|
| 84 | - * |
|
| 85 | - * @return Mailcode_Renderer |
|
| 86 | - */ |
|
| 82 | + * Creates a renderer instance, which can be used to easily |
|
| 83 | + * create and convert commands to strings. |
|
| 84 | + * |
|
| 85 | + * @return Mailcode_Renderer |
|
| 86 | + */ |
|
| 87 | 87 | public static function createRenderer() : Mailcode_Renderer |
| 88 | 88 | { |
| 89 | 89 | return new Mailcode_Renderer(); |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Creates a printer instance, which works like the renderer, |
|
| 94 | - * but outputs the generated strings to standard output. |
|
| 95 | - * |
|
| 96 | - * @return Mailcode_Printer |
|
| 97 | - */ |
|
| 92 | + /** |
|
| 93 | + * Creates a printer instance, which works like the renderer, |
|
| 94 | + * but outputs the generated strings to standard output. |
|
| 95 | + * |
|
| 96 | + * @return Mailcode_Printer |
|
| 97 | + */ |
|
| 98 | 98 | public static function createPrinter() : Mailcode_Printer |
| 99 | 99 | { |
| 100 | 100 | return new Mailcode_Printer(); |
| 101 | 101 | } |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Gets/creates the global instance of the date format info |
|
| 105 | - * class, used to handle date formatting aspects. |
|
| 106 | - * |
|
| 107 | - * @return Mailcode_Date_FormatInfo |
|
| 108 | - */ |
|
| 103 | + /** |
|
| 104 | + * Gets/creates the global instance of the date format info |
|
| 105 | + * class, used to handle date formatting aspects. |
|
| 106 | + * |
|
| 107 | + * @return Mailcode_Date_FormatInfo |
|
| 108 | + */ |
|
| 109 | 109 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
| 110 | 110 | { |
| 111 | 111 | return Mailcode_Date_FormatInfo::getInstance(); |
@@ -21,17 +21,17 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class Mailcode_Renderer |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var boolean |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var boolean |
|
| 26 | + */ |
|
| 27 | 27 | protected $highlighted = false; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Sets whether to output highlighted commands instead of the default plain text. |
|
| 31 | - * |
|
| 32 | - * @param bool $highlighted |
|
| 33 | - * @return Mailcode_Renderer |
|
| 34 | - */ |
|
| 29 | + /** |
|
| 30 | + * Sets whether to output highlighted commands instead of the default plain text. |
|
| 31 | + * |
|
| 32 | + * @param bool $highlighted |
|
| 33 | + * @return Mailcode_Renderer |
|
| 34 | + */ |
|
| 35 | 35 | public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer |
| 36 | 36 | { |
| 37 | 37 | $this->highlighted = $highlighted; |
@@ -39,12 +39,12 @@ discard block |
||
| 39 | 39 | return $this; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Converts a show variable command to string. |
|
| 44 | - * |
|
| 45 | - * @param string $variableName The variable name, with or without $ sign. |
|
| 46 | - * @return string |
|
| 47 | - */ |
|
| 42 | + /** |
|
| 43 | + * Converts a show variable command to string. |
|
| 44 | + * |
|
| 45 | + * @param string $variableName The variable name, with or without $ sign. |
|
| 46 | + * @return string |
|
| 47 | + */ |
|
| 48 | 48 | public function showVar(string $variableName) : string |
| 49 | 49 | { |
| 50 | 50 | return $this->command2string(Mailcode_Factory::show()->var($variableName)); |
@@ -54,45 +54,45 @@ discard block |
||
| 54 | 54 | const ERROR_INVALID_COMMANDS = 47801; |
| 55 | 55 | const ERROR_PLACEHOLDER_NOT_FOUND = 47804; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var Mailcode_Parser |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var Mailcode_Parser |
|
| 59 | + */ |
|
| 60 | 60 | protected $parser; |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @var Mailcode_Collection |
|
| 64 | - */ |
|
| 62 | + /** |
|
| 63 | + * @var Mailcode_Collection |
|
| 64 | + */ |
|
| 65 | 65 | protected $commands; |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @var string |
|
| 69 | - */ |
|
| 67 | + /** |
|
| 68 | + * @var string |
|
| 69 | + */ |
|
| 70 | 70 | protected $originalString; |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * @var Mailcode_Collection |
|
| 74 | - */ |
|
| 72 | + /** |
|
| 73 | + * @var Mailcode_Collection |
|
| 74 | + */ |
|
| 75 | 75 | protected $collection; |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Counter for the placeholders, global for all placeholders. |
|
| 79 | - * @var integer |
|
| 80 | - */ |
|
| 77 | + /** |
|
| 78 | + * Counter for the placeholders, global for all placeholders. |
|
| 79 | + * @var integer |
|
| 80 | + */ |
|
| 81 | 81 | private static $counter = 0; |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 85 | - */ |
|
| 83 | + /** |
|
| 84 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 85 | + */ |
|
| 86 | 86 | protected $placeholders; |
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * @var string |
|
| 90 | - */ |
|
| 88 | + /** |
|
| 89 | + * @var string |
|
| 90 | + */ |
|
| 91 | 91 | protected $delimiter = '999'; |
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * @var string[]|NULL |
|
| 95 | - */ |
|
| 93 | + /** |
|
| 94 | + * @var string[]|NULL |
|
| 95 | + */ |
|
| 96 | 96 | protected $placeholderStrings; |
| 97 | 97 | |
| 98 | 98 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -111,28 +111,28 @@ discard block |
||
| 111 | 111 | self::$counter = 0; |
| 112 | 112 | } |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Retrieves the string the safeguard was created for. |
|
| 116 | - * |
|
| 117 | - * @return string |
|
| 118 | - */ |
|
| 114 | + /** |
|
| 115 | + * Retrieves the string the safeguard was created for. |
|
| 116 | + * |
|
| 117 | + * @return string |
|
| 118 | + */ |
|
| 119 | 119 | public function getOriginalString() : string |
| 120 | 120 | { |
| 121 | 121 | return $this->originalString; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Sets the delimiter character sequence used to prepend |
|
| 126 | - * and append to the placeholders. |
|
| 127 | - * |
|
| 128 | - * The delimiter's default is "999". |
|
| 129 | - * |
|
| 130 | - * Minimum characters: 2 |
|
| 131 | - * Invalid characters: Any characters that get URL encoded |
|
| 132 | - * |
|
| 133 | - * @param string $delimiter |
|
| 134 | - * @return Mailcode_Parser_Safeguard |
|
| 135 | - */ |
|
| 124 | + /** |
|
| 125 | + * Sets the delimiter character sequence used to prepend |
|
| 126 | + * and append to the placeholders. |
|
| 127 | + * |
|
| 128 | + * The delimiter's default is "999". |
|
| 129 | + * |
|
| 130 | + * Minimum characters: 2 |
|
| 131 | + * Invalid characters: Any characters that get URL encoded |
|
| 132 | + * |
|
| 133 | + * @param string $delimiter |
|
| 134 | + * @return Mailcode_Parser_Safeguard |
|
| 135 | + */ |
|
| 136 | 136 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
| 137 | 137 | { |
| 138 | 138 | $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter); |
@@ -148,15 +148,15 @@ discard block |
||
| 148 | 148 | return $this->delimiter; |
| 149 | 149 | } |
| 150 | 150 | |
| 151 | - /** |
|
| 152 | - * Retrieves the safe string in which all commands have been replaced |
|
| 153 | - * by placeholder strings. |
|
| 154 | - * |
|
| 155 | - * @return string |
|
| 156 | - * @throws Mailcode_Exception |
|
| 157 | - * |
|
| 158 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 159 | - */ |
|
| 151 | + /** |
|
| 152 | + * Retrieves the safe string in which all commands have been replaced |
|
| 153 | + * by placeholder strings. |
|
| 154 | + * |
|
| 155 | + * @return string |
|
| 156 | + * @throws Mailcode_Exception |
|
| 157 | + * |
|
| 158 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 159 | + */ |
|
| 160 | 160 | public function makeSafe() : string |
| 161 | 161 | { |
| 162 | 162 | $this->requireValidCollection(); |
@@ -164,16 +164,16 @@ discard block |
||
| 164 | 164 | return $this->makeSafePartial(); |
| 165 | 165 | } |
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 169 | - * if the subject string may contain only part of the whole set of |
|
| 170 | - * commands. |
|
| 171 | - * |
|
| 172 | - * Example: parsing a text with an opening if statement, without the |
|
| 173 | - * matching end statement. |
|
| 174 | - * |
|
| 175 | - * @return string |
|
| 176 | - */ |
|
| 167 | + /** |
|
| 168 | + * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 169 | + * if the subject string may contain only part of the whole set of |
|
| 170 | + * commands. |
|
| 171 | + * |
|
| 172 | + * Example: parsing a text with an opening if statement, without the |
|
| 173 | + * matching end statement. |
|
| 174 | + * |
|
| 175 | + * @return string |
|
| 176 | + */ |
|
| 177 | 177 | public function makeSafePartial() : string |
| 178 | 178 | { |
| 179 | 179 | $placeholders = $this->getPlaceholders(); |
@@ -257,13 +257,13 @@ discard block |
||
| 257 | 257 | $analyzer->analyze(); |
| 258 | 258 | } |
| 259 | 259 | |
| 260 | - /** |
|
| 261 | - * Creates a formatting handler, which can be used to specify |
|
| 262 | - * which formattings to use for the commands in the subject string. |
|
| 263 | - * |
|
| 264 | - * @param Mailcode_StringContainer|string $subject |
|
| 265 | - * @return Mailcode_Parser_Safeguard_Formatting |
|
| 266 | - */ |
|
| 260 | + /** |
|
| 261 | + * Creates a formatting handler, which can be used to specify |
|
| 262 | + * which formattings to use for the commands in the subject string. |
|
| 263 | + * |
|
| 264 | + * @param Mailcode_StringContainer|string $subject |
|
| 265 | + * @return Mailcode_Parser_Safeguard_Formatting |
|
| 266 | + */ |
|
| 267 | 267 | public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting |
| 268 | 268 | { |
| 269 | 269 | if(is_string($subject)) |
@@ -274,12 +274,12 @@ discard block |
||
| 274 | 274 | return new Mailcode_Parser_Safeguard_Formatting($this, $subject); |
| 275 | 275 | } |
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Retrieves all placeholders that have to be added to |
|
| 279 | - * the subject text. |
|
| 280 | - * |
|
| 281 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 282 | - */ |
|
| 277 | + /** |
|
| 278 | + * Retrieves all placeholders that have to be added to |
|
| 279 | + * the subject text. |
|
| 280 | + * |
|
| 281 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 282 | + */ |
|
| 283 | 283 | public function getPlaceholders() |
| 284 | 284 | { |
| 285 | 285 | if(isset($this->placeholders)) |
@@ -355,16 +355,16 @@ discard block |
||
| 355 | 355 | return $string; |
| 356 | 356 | } |
| 357 | 357 | |
| 358 | - /** |
|
| 359 | - * Makes the string whole again after transforming or filtering it, |
|
| 360 | - * by replacing the command placeholders with the original commands. |
|
| 361 | - * |
|
| 362 | - * @param string $string |
|
| 363 | - * @return string |
|
| 364 | - * @throws Mailcode_Exception |
|
| 365 | - * |
|
| 366 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 367 | - */ |
|
| 358 | + /** |
|
| 359 | + * Makes the string whole again after transforming or filtering it, |
|
| 360 | + * by replacing the command placeholders with the original commands. |
|
| 361 | + * |
|
| 362 | + * @param string $string |
|
| 363 | + * @return string |
|
| 364 | + * @throws Mailcode_Exception |
|
| 365 | + * |
|
| 366 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 367 | + */ |
|
| 368 | 368 | public function makeWhole(string $string) : string |
| 369 | 369 | { |
| 370 | 370 | return $this->restore( |
@@ -374,15 +374,15 @@ discard block |
||
| 374 | 374 | ); |
| 375 | 375 | } |
| 376 | 376 | |
| 377 | - /** |
|
| 378 | - * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 379 | - * |
|
| 380 | - * @param string $string |
|
| 381 | - * @return string |
|
| 382 | - * @throws Mailcode_Exception |
|
| 383 | - * |
|
| 384 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 385 | - */ |
|
| 377 | + /** |
|
| 378 | + * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 379 | + * |
|
| 380 | + * @param string $string |
|
| 381 | + * @return string |
|
| 382 | + * @throws Mailcode_Exception |
|
| 383 | + * |
|
| 384 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 385 | + */ |
|
| 386 | 386 | public function makeWholePartial(string $string) : string |
| 387 | 387 | { |
| 388 | 388 | return $this->restore( |
@@ -392,19 +392,19 @@ discard block |
||
| 392 | 392 | ); |
| 393 | 393 | } |
| 394 | 394 | |
| 395 | - /** |
|
| 396 | - * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 397 | - * highlighted version, meant for human readable texts only. |
|
| 398 | - * |
|
| 399 | - * Note: the commands lose their functionality (They cannot be |
|
| 400 | - * parsed from that string again). |
|
| 401 | - * |
|
| 402 | - * @param string $string |
|
| 403 | - * @return string |
|
| 404 | - * @throws Mailcode_Exception |
|
| 405 | - * |
|
| 406 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 407 | - */ |
|
| 395 | + /** |
|
| 396 | + * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 397 | + * highlighted version, meant for human readable texts only. |
|
| 398 | + * |
|
| 399 | + * Note: the commands lose their functionality (They cannot be |
|
| 400 | + * parsed from that string again). |
|
| 401 | + * |
|
| 402 | + * @param string $string |
|
| 403 | + * @return string |
|
| 404 | + * @throws Mailcode_Exception |
|
| 405 | + * |
|
| 406 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 407 | + */ |
|
| 408 | 408 | public function makeHighlighted(string $string) : string |
| 409 | 409 | { |
| 410 | 410 | return $this->restore( |
@@ -414,15 +414,15 @@ discard block |
||
| 414 | 414 | ); |
| 415 | 415 | } |
| 416 | 416 | |
| 417 | - /** |
|
| 418 | - * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 419 | - * |
|
| 420 | - * @param string $string |
|
| 421 | - * @return string |
|
| 422 | - * @throws Mailcode_Exception |
|
| 423 | - * |
|
| 424 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 425 | - */ |
|
| 417 | + /** |
|
| 418 | + * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 419 | + * |
|
| 420 | + * @param string $string |
|
| 421 | + * @return string |
|
| 422 | + * @throws Mailcode_Exception |
|
| 423 | + * |
|
| 424 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 425 | + */ |
|
| 426 | 426 | public function makeHighlightedPartial(string $string) : string |
| 427 | 427 | { |
| 428 | 428 | return $this->restore( |
@@ -432,11 +432,11 @@ discard block |
||
| 432 | 432 | ); |
| 433 | 433 | } |
| 434 | 434 | |
| 435 | - /** |
|
| 436 | - * Retrieves the commands collection contained in the string. |
|
| 437 | - * |
|
| 438 | - * @return Mailcode_Collection |
|
| 439 | - */ |
|
| 435 | + /** |
|
| 436 | + * Retrieves the commands collection contained in the string. |
|
| 437 | + * |
|
| 438 | + * @return Mailcode_Collection |
|
| 439 | + */ |
|
| 440 | 440 | public function getCollection() : Mailcode_Collection |
| 441 | 441 | { |
| 442 | 442 | if(isset($this->collection)) |
@@ -454,11 +454,11 @@ discard block |
||
| 454 | 454 | return $this->getCollection()->isValid(); |
| 455 | 455 | } |
| 456 | 456 | |
| 457 | - /** |
|
| 458 | - * @throws Mailcode_Exception |
|
| 459 | - * |
|
| 460 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 461 | - */ |
|
| 457 | + /** |
|
| 458 | + * @throws Mailcode_Exception |
|
| 459 | + * |
|
| 460 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 461 | + */ |
|
| 462 | 462 | protected function requireValidCollection() : void |
| 463 | 463 | { |
| 464 | 464 | if($this->getCollection()->isValid()) |
@@ -477,11 +477,11 @@ discard block |
||
| 477 | 477 | ); |
| 478 | 478 | } |
| 479 | 479 | |
| 480 | - /** |
|
| 481 | - * Retrieves a list of all placeholder IDs used in the text. |
|
| 482 | - * |
|
| 483 | - * @return string[] |
|
| 484 | - */ |
|
| 480 | + /** |
|
| 481 | + * Retrieves a list of all placeholder IDs used in the text. |
|
| 482 | + * |
|
| 483 | + * @return string[] |
|
| 484 | + */ |
|
| 485 | 485 | public function getPlaceholderStrings() : array |
| 486 | 486 | { |
| 487 | 487 | if(is_array($this->placeholderStrings)) |
@@ -508,13 +508,13 @@ discard block |
||
| 508 | 508 | return in_array($subject, $ids, true); |
| 509 | 509 | } |
| 510 | 510 | |
| 511 | - /** |
|
| 512 | - * Retrieves a placeholder instance by its ID. |
|
| 513 | - * |
|
| 514 | - * @param int $id |
|
| 515 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
| 516 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 517 | - */ |
|
| 511 | + /** |
|
| 512 | + * Retrieves a placeholder instance by its ID. |
|
| 513 | + * |
|
| 514 | + * @param int $id |
|
| 515 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
| 516 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 517 | + */ |
|
| 518 | 518 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
| 519 | 519 | { |
| 520 | 520 | $placeholders = $this->getPlaceholders(); |
@@ -537,13 +537,13 @@ discard block |
||
| 537 | 537 | ); |
| 538 | 538 | } |
| 539 | 539 | |
| 540 | - /** |
|
| 541 | - * Retrieves a placeholder instance by its replacement text. |
|
| 542 | - * |
|
| 543 | - * @param string $string |
|
| 544 | - * @throws Mailcode_Exception |
|
| 545 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 546 | - */ |
|
| 540 | + /** |
|
| 541 | + * Retrieves a placeholder instance by its replacement text. |
|
| 542 | + * |
|
| 543 | + * @param string $string |
|
| 544 | + * @throws Mailcode_Exception |
|
| 545 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 546 | + */ |
|
| 547 | 547 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
| 548 | 548 | { |
| 549 | 549 | $placeholders = $this->getPlaceholders(); |
@@ -176,27 +176,27 @@ |
||
| 176 | 176 | * @return array<string,string> |
| 177 | 177 | * @throws Mailcode_Exception |
| 178 | 178 | */ |
| 179 | - private function parseVarName() : array |
|
| 180 | - { |
|
| 181 | - $tokens = explode('.', ltrim($this->variable->getFullName(), '$')); |
|
| 182 | - |
|
| 183 | - if(count($tokens) === 2) |
|
| 184 | - { |
|
| 185 | - return array( |
|
| 186 | - 'path' => $tokens[0], |
|
| 187 | - 'name' => $tokens[1] |
|
| 188 | - ); |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - throw new Mailcode_Exception( |
|
| 192 | - 'Invalid variable name for a list property.', |
|
| 193 | - sprintf( |
|
| 194 | - 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
| 195 | - $this->variable->getFullName(), |
|
| 196 | - count($tokens) |
|
| 197 | - ), |
|
| 198 | - self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
| 199 | - ); |
|
| 200 | - } |
|
| 179 | + private function parseVarName() : array |
|
| 180 | + { |
|
| 181 | + $tokens = explode('.', ltrim($this->variable->getFullName(), '$')); |
|
| 182 | + |
|
| 183 | + if(count($tokens) === 2) |
|
| 184 | + { |
|
| 185 | + return array( |
|
| 186 | + 'path' => $tokens[0], |
|
| 187 | + 'name' => $tokens[1] |
|
| 188 | + ); |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + throw new Mailcode_Exception( |
|
| 192 | + 'Invalid variable name for a list property.', |
|
| 193 | + sprintf( |
|
| 194 | + 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
| 195 | + $this->variable->getFullName(), |
|
| 196 | + count($tokens) |
|
| 197 | + ), |
|
| 198 | + self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
| 199 | + ); |
|
| 200 | + } |
|
| 201 | 201 | } |
| 202 | 202 | |