@@ -24,14 +24,14 @@ discard block |
||
| 24 | 24 | { |
| 25 | 25 | const ERROR_CSS_FILE_NOT_FOUND = 60901; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | 30 | private $path; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | private $fileName = 'highlight.css'; |
| 36 | 36 | |
| 37 | 37 | public function __construct() |
@@ -54,22 +54,22 @@ discard block |
||
| 54 | 54 | $this->path = $path; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves the raw CSS source for the highlighting. |
|
| 59 | - * |
|
| 60 | - * @return string |
|
| 61 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves the raw CSS source for the highlighting. |
|
| 59 | + * |
|
| 60 | + * @return string |
|
| 61 | + */ |
|
| 62 | 62 | public function getCSS() : string |
| 63 | 63 | { |
| 64 | 64 | return FileHelper::readContents($this->path); |
| 65 | 65 | } |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Retrieves a fully formed `code` tag with the CSS, |
|
| 69 | - * to inject inline into an HTML document. |
|
| 70 | - * |
|
| 71 | - * @return string |
|
| 72 | - */ |
|
| 67 | + /** |
|
| 68 | + * Retrieves a fully formed `code` tag with the CSS, |
|
| 69 | + * to inject inline into an HTML document. |
|
| 70 | + * |
|
| 71 | + * @return string |
|
| 72 | + */ |
|
| 73 | 73 | public function getStyleTag() : string |
| 74 | 74 | { |
| 75 | 75 | return sprintf( |
@@ -78,23 +78,23 @@ discard block |
||
| 78 | 78 | ); |
| 79 | 79 | } |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * Retrieves the path to the stylesheet file. |
|
| 83 | - * |
|
| 84 | - * @return string |
|
| 85 | - */ |
|
| 81 | + /** |
|
| 82 | + * Retrieves the path to the stylesheet file. |
|
| 83 | + * |
|
| 84 | + * @return string |
|
| 85 | + */ |
|
| 86 | 86 | public function getStylesheetPath() : string |
| 87 | 87 | { |
| 88 | 88 | return $this->path; |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Retrieves the URL to the stylesheet file, given the |
|
| 93 | - * local URL to the application's vendor folder. |
|
| 94 | - * |
|
| 95 | - * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot). |
|
| 96 | - * @return string |
|
| 97 | - */ |
|
| 91 | + /** |
|
| 92 | + * Retrieves the URL to the stylesheet file, given the |
|
| 93 | + * local URL to the application's vendor folder. |
|
| 94 | + * |
|
| 95 | + * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot). |
|
| 96 | + * @return string |
|
| 97 | + */ |
|
| 98 | 98 | public function getStylesheetURL(string $vendorURL) : string |
| 99 | 99 | { |
| 100 | 100 | return sprintf( |
@@ -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,19 +198,19 @@ discard block |
||
| 198 | 198 | return isset($this->tokens[$index]); |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - /** |
|
| 202 | - * Retrieves all tokens. |
|
| 203 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 204 | - */ |
|
| 201 | + /** |
|
| 202 | + * Retrieves all tokens. |
|
| 203 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 204 | + */ |
|
| 205 | 205 | public function getTokens() : array |
| 206 | 206 | { |
| 207 | 207 | return $this->tokens; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves all string literals that were found in the command. |
|
| 212 | - * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 213 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves all string literals that were found in the command. |
|
| 212 | + * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 213 | + */ |
|
| 214 | 214 | public function getStringLiterals() |
| 215 | 215 | { |
| 216 | 216 | $result = array(); |
@@ -29,39 +29,39 @@ discard block |
||
| 29 | 29 | const VALIDATION_NO_COMMAND_CREATED = 61101; |
| 30 | 30 | const VALIDATION_INVALID_COMMAND_CREATED = 61102; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var Mailcode_Commands_LogicKeywords |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var Mailcode_Commands_LogicKeywords |
|
| 34 | + */ |
|
| 35 | 35 | private $keywords; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | private $name; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | private $keywordType; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | private $matchedString; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var string |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var string |
|
| 54 | + */ |
|
| 55 | 55 | private $params = ''; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var boolean |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var boolean |
|
| 59 | + */ |
|
| 60 | 60 | private $paramsSet = false; |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @var Mailcode_Collection |
|
| 64 | - */ |
|
| 62 | + /** |
|
| 63 | + * @var Mailcode_Collection |
|
| 64 | + */ |
|
| 65 | 65 | private $collection; |
| 66 | 66 | |
| 67 | 67 | public function __construct(Mailcode_Commands_LogicKeywords $keywords, string $name, string $matchedString, string $type) |
@@ -72,10 +72,10 @@ discard block |
||
| 72 | 72 | $this->matchedString = $matchedString; |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * The keyword name, e.g. "and". Always lowercase. |
|
| 77 | - * @return string |
|
| 78 | - */ |
|
| 75 | + /** |
|
| 76 | + * The keyword name, e.g. "and". Always lowercase. |
|
| 77 | + * @return string |
|
| 78 | + */ |
|
| 79 | 79 | public function getName() : string |
| 80 | 80 | { |
| 81 | 81 | return $this->name; |
@@ -98,24 +98,24 @@ discard block |
||
| 98 | 98 | return $string; |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * The full string that was matched in the command's parameters |
|
| 103 | - * string. Examples: "and:", "and variable:"... |
|
| 104 | - * |
|
| 105 | - * @return string |
|
| 106 | - */ |
|
| 101 | + /** |
|
| 102 | + * The full string that was matched in the command's parameters |
|
| 103 | + * string. Examples: "and:", "and variable:"... |
|
| 104 | + * |
|
| 105 | + * @return string |
|
| 106 | + */ |
|
| 107 | 107 | public function getMatchedString() : string |
| 108 | 108 | { |
| 109 | 109 | return $this->matchedString; |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Sets the parameters string matching this logic keyword, |
|
| 114 | - * which is used to build the actual sub-command. Set by |
|
| 115 | - * the LogicKeywords class instance. |
|
| 116 | - * |
|
| 117 | - * @param string $params |
|
| 118 | - */ |
|
| 112 | + /** |
|
| 113 | + * Sets the parameters string matching this logic keyword, |
|
| 114 | + * which is used to build the actual sub-command. Set by |
|
| 115 | + * the LogicKeywords class instance. |
|
| 116 | + * |
|
| 117 | + * @param string $params |
|
| 118 | + */ |
|
| 119 | 119 | public function setParamsString(string $params) : void |
| 120 | 120 | { |
| 121 | 121 | if($this->paramsSet) |
@@ -133,13 +133,13 @@ discard block |
||
| 133 | 133 | $this->createCommand(); |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | - /** |
|
| 137 | - * Retrieves the full command string used to create |
|
| 138 | - * the actual command. For opening commands like IF, |
|
| 139 | - * this includes the closing {end} command. |
|
| 140 | - * |
|
| 141 | - * @return string |
|
| 142 | - */ |
|
| 136 | + /** |
|
| 137 | + * Retrieves the full command string used to create |
|
| 138 | + * the actual command. For opening commands like IF, |
|
| 139 | + * this includes the closing {end} command. |
|
| 140 | + * |
|
| 141 | + * @return string |
|
| 142 | + */ |
|
| 143 | 143 | public function getCommandString() : string |
| 144 | 144 | { |
| 145 | 145 | $string = sprintf( |
@@ -182,12 +182,12 @@ discard block |
||
| 182 | 182 | } |
| 183 | 183 | } |
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * Retrieves the command for the keyword. |
|
| 187 | - * |
|
| 188 | - * @throws Mailcode_Exception |
|
| 189 | - * @return Mailcode_Commands_Command |
|
| 190 | - */ |
|
| 185 | + /** |
|
| 186 | + * Retrieves the command for the keyword. |
|
| 187 | + * |
|
| 188 | + * @throws Mailcode_Exception |
|
| 189 | + * @return Mailcode_Commands_Command |
|
| 190 | + */ |
|
| 191 | 191 | public function getCommand() : Mailcode_Commands_Command |
| 192 | 192 | { |
| 193 | 193 | $command = $this->collection->getFirstCommand(); |
@@ -20,19 +20,19 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Commands_Highlighter |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Commands_Command |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Commands_Command |
|
| 25 | + */ |
|
| 26 | 26 | protected $command; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string[] |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var string[] |
|
| 30 | + */ |
|
| 31 | 31 | protected $parts = array(); |
| 32 | 32 | |
| 33 | 33 | public function __construct(Mailcode_Commands_Command $command) |
| 34 | 34 | { |
| 35 | - $this->command = $command; |
|
| 35 | + $this->command = $command; |
|
| 36 | 36 | } |
| 37 | 37 | |
| 38 | 38 | public function highlight() : string |
@@ -121,11 +121,11 @@ discard block |
||
| 121 | 121 | $this->appendParams($keyword->getCommand()); |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * @param string[] $classes |
|
| 126 | - * @param string $content |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 124 | + /** |
|
| 125 | + * @param string[] $classes |
|
| 126 | + * @param string $content |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | 129 | protected function renderTag(array $classes, string $content) : string |
| 130 | 130 | { |
| 131 | 131 | $parts = array(); |
@@ -48,13 +48,13 @@ |
||
| 48 | 48 | <body> |
| 49 | 49 | <p> |
| 50 | 50 | <?php |
| 51 | - pts('This showcases the command\'s syntax highlighting.'); |
|
| 52 | - pts( |
|
| 53 | - 'It is based on the %1$s color scheme%2$s:', |
|
| 54 | - '<a href="https://ethanschoonover.com/solarized/">"Solarized"', |
|
| 55 | - '</a>' |
|
| 56 | - ); |
|
| 57 | - ?> |
|
| 51 | + pts('This showcases the command\'s syntax highlighting.'); |
|
| 52 | + pts( |
|
| 53 | + 'It is based on the %1$s color scheme%2$s:', |
|
| 54 | + '<a href="https://ethanschoonover.com/solarized/">"Solarized"', |
|
| 55 | + '</a>' |
|
| 56 | + ); |
|
| 57 | + ?> |
|
| 58 | 58 | </p> |
| 59 | 59 | <br> |
| 60 | 60 | <div class="commands"> |
@@ -61,50 +61,50 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | const ERROR_NOT_A_SINGLE_LINES_FORMATTER = 47806; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var Mailcode_Parser |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var Mailcode_Parser |
|
| 66 | + */ |
|
| 67 | 67 | protected $parser; |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var Mailcode_Collection |
|
| 71 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var Mailcode_Collection |
|
| 71 | + */ |
|
| 72 | 72 | protected $commands; |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @var string |
|
| 76 | - */ |
|
| 74 | + /** |
|
| 75 | + * @var string |
|
| 76 | + */ |
|
| 77 | 77 | protected $originalString; |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * @var Mailcode_Collection |
|
| 81 | - */ |
|
| 79 | + /** |
|
| 80 | + * @var Mailcode_Collection |
|
| 81 | + */ |
|
| 82 | 82 | protected $collection; |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Counter for the placeholders, global for all placeholders. |
|
| 86 | - * @var integer |
|
| 87 | - */ |
|
| 84 | + /** |
|
| 85 | + * Counter for the placeholders, global for all placeholders. |
|
| 86 | + * @var integer |
|
| 87 | + */ |
|
| 88 | 88 | private static $counter = 0; |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 92 | - */ |
|
| 90 | + /** |
|
| 91 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
| 92 | + */ |
|
| 93 | 93 | protected $placeholders; |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @var string |
|
| 97 | - */ |
|
| 95 | + /** |
|
| 96 | + * @var string |
|
| 97 | + */ |
|
| 98 | 98 | protected $delimiter = '__'; |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * @var string[]|NULL |
|
| 102 | - */ |
|
| 100 | + /** |
|
| 101 | + * @var string[]|NULL |
|
| 102 | + */ |
|
| 103 | 103 | protected $placeholderStrings; |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * @var Mailcode_Parser_Safeguard_Formatter |
|
| 107 | - */ |
|
| 105 | + /** |
|
| 106 | + * @var Mailcode_Parser_Safeguard_Formatter |
|
| 107 | + */ |
|
| 108 | 108 | protected $formatter; |
| 109 | 109 | |
| 110 | 110 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -113,25 +113,25 @@ discard block |
||
| 113 | 113 | $this->originalString = $subject; |
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * Retrieves the string the safeguard was created for. |
|
| 118 | - * |
|
| 119 | - * @return string |
|
| 120 | - */ |
|
| 116 | + /** |
|
| 117 | + * Retrieves the string the safeguard was created for. |
|
| 118 | + * |
|
| 119 | + * @return string |
|
| 120 | + */ |
|
| 121 | 121 | public function getOriginalString() : string |
| 122 | 122 | { |
| 123 | 123 | return $this->originalString; |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Sets the delimiter character sequence used to prepend |
|
| 128 | - * and append to the placeholders. |
|
| 129 | - * |
|
| 130 | - * The delimiter's default is "__" (two underscores). |
|
| 131 | - * |
|
| 132 | - * @param string $delimiter |
|
| 133 | - * @return Mailcode_Parser_Safeguard |
|
| 134 | - */ |
|
| 126 | + /** |
|
| 127 | + * Sets the delimiter character sequence used to prepend |
|
| 128 | + * and append to the placeholders. |
|
| 129 | + * |
|
| 130 | + * The delimiter's default is "__" (two underscores). |
|
| 131 | + * |
|
| 132 | + * @param string $delimiter |
|
| 133 | + * @return Mailcode_Parser_Safeguard |
|
| 134 | + */ |
|
| 135 | 135 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
| 136 | 136 | { |
| 137 | 137 | if(empty($delimiter)) |
@@ -153,15 +153,15 @@ discard block |
||
| 153 | 153 | return $this->delimiter; |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * Retrieves the safe string in which all commands have been replaced |
|
| 158 | - * by placeholder strings. |
|
| 159 | - * |
|
| 160 | - * @return string |
|
| 161 | - * @throws Mailcode_Exception |
|
| 162 | - * |
|
| 163 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 164 | - */ |
|
| 156 | + /** |
|
| 157 | + * Retrieves the safe string in which all commands have been replaced |
|
| 158 | + * by placeholder strings. |
|
| 159 | + * |
|
| 160 | + * @return string |
|
| 161 | + * @throws Mailcode_Exception |
|
| 162 | + * |
|
| 163 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 164 | + */ |
|
| 165 | 165 | public function makeSafe() : string |
| 166 | 166 | { |
| 167 | 167 | $this->requireValidCollection(); |
@@ -169,16 +169,16 @@ discard block |
||
| 169 | 169 | return $this->makeSafePartial(); |
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 174 | - * if the subject string may contain only part of the whole set of |
|
| 175 | - * commands. |
|
| 176 | - * |
|
| 177 | - * Example: parsing a text with an opening if statement, without the |
|
| 178 | - * matching end statement. |
|
| 179 | - * |
|
| 180 | - * @return string |
|
| 181 | - */ |
|
| 172 | + /** |
|
| 173 | + * Like makeSafe(), but allows partial (invalid) commands: use this |
|
| 174 | + * if the subject string may contain only part of the whole set of |
|
| 175 | + * commands. |
|
| 176 | + * |
|
| 177 | + * Example: parsing a text with an opening if statement, without the |
|
| 178 | + * matching end statement. |
|
| 179 | + * |
|
| 180 | + * @return string |
|
| 181 | + */ |
|
| 182 | 182 | public function makeSafePartial() : string |
| 183 | 183 | { |
| 184 | 184 | $replaces = $this->getReplaces(); |
@@ -216,10 +216,10 @@ discard block |
||
| 216 | 216 | ); |
| 217 | 217 | } |
| 218 | 218 | |
| 219 | - /** |
|
| 220 | - * Enables the formatter that ensures that all commands that |
|
| 221 | - * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 222 | - */ |
|
| 219 | + /** |
|
| 220 | + * Enables the formatter that ensures that all commands that |
|
| 221 | + * @return Mailcode_Parser_Safeguard_Formatter_SingleLines |
|
| 222 | + */ |
|
| 223 | 223 | public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines |
| 224 | 224 | { |
| 225 | 225 | $formatter = $this->selectFormatter('SingleLines'); |
@@ -239,13 +239,13 @@ discard block |
||
| 239 | 239 | ); |
| 240 | 240 | } |
| 241 | 241 | |
| 242 | - /** |
|
| 243 | - * Retrieves an associative array with pairs of |
|
| 244 | - * [placeholder string => replacement text]. |
|
| 245 | - * |
|
| 246 | - * @param bool $highlighted |
|
| 247 | - * @return string[]string |
|
| 248 | - */ |
|
| 242 | + /** |
|
| 243 | + * Retrieves an associative array with pairs of |
|
| 244 | + * [placeholder string => replacement text]. |
|
| 245 | + * |
|
| 246 | + * @param bool $highlighted |
|
| 247 | + * @return string[]string |
|
| 248 | + */ |
|
| 249 | 249 | protected function getReplaces(bool $highlighted=false, bool $normalize=false) : array |
| 250 | 250 | { |
| 251 | 251 | $placeholders = $this->getPlaceholders(); |
@@ -276,12 +276,12 @@ discard block |
||
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | |
| 279 | - /** |
|
| 280 | - * Retrieves all placeholders that have to be added to |
|
| 281 | - * the subject text. |
|
| 282 | - * |
|
| 283 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 284 | - */ |
|
| 279 | + /** |
|
| 280 | + * Retrieves all placeholders that have to be added to |
|
| 281 | + * the subject text. |
|
| 282 | + * |
|
| 283 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 284 | + */ |
|
| 285 | 285 | public function getPlaceholders() |
| 286 | 286 | { |
| 287 | 287 | if(isset($this->placeholders)) |
@@ -336,17 +336,17 @@ discard block |
||
| 336 | 336 | return str_replace($placeholderStrings, array_values($replaces), $string); |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | - /** |
|
| 340 | - * Makes the string whole again after transforming or filtering it, |
|
| 341 | - * by replacing the command placeholders with the original commands. |
|
| 342 | - * |
|
| 343 | - * @param string $string |
|
| 344 | - * @return string |
|
| 345 | - * @throws Mailcode_Exception |
|
| 346 | - * |
|
| 347 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 348 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 349 | - */ |
|
| 339 | + /** |
|
| 340 | + * Makes the string whole again after transforming or filtering it, |
|
| 341 | + * by replacing the command placeholders with the original commands. |
|
| 342 | + * |
|
| 343 | + * @param string $string |
|
| 344 | + * @return string |
|
| 345 | + * @throws Mailcode_Exception |
|
| 346 | + * |
|
| 347 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 348 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 349 | + */ |
|
| 350 | 350 | public function makeWhole(string $string) : string |
| 351 | 351 | { |
| 352 | 352 | return $this->restore( |
@@ -356,15 +356,15 @@ discard block |
||
| 356 | 356 | ); |
| 357 | 357 | } |
| 358 | 358 | |
| 359 | - /** |
|
| 360 | - * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 361 | - * |
|
| 362 | - * @param string $string |
|
| 363 | - * @return string |
|
| 364 | - * @throws Mailcode_Exception |
|
| 365 | - * |
|
| 366 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 367 | - */ |
|
| 359 | + /** |
|
| 360 | + * Like `makeWhole()`, but ignores missing command placeholders. |
|
| 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 makeWholePartial(string $string) : string |
| 369 | 369 | { |
| 370 | 370 | return $this->restore( |
@@ -374,20 +374,20 @@ discard block |
||
| 374 | 374 | ); |
| 375 | 375 | } |
| 376 | 376 | |
| 377 | - /** |
|
| 378 | - * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 379 | - * highlighted version, meant for human readable texts only. |
|
| 380 | - * |
|
| 381 | - * Note: the commands lose their functionality (They cannot be |
|
| 382 | - * parsed from that string again). |
|
| 383 | - * |
|
| 384 | - * @param string $string |
|
| 385 | - * @return string |
|
| 386 | - * @throws Mailcode_Exception |
|
| 387 | - * |
|
| 388 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 389 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 390 | - */ |
|
| 377 | + /** |
|
| 378 | + * Like `makeWhole()`, but replaces the commands with a syntax |
|
| 379 | + * highlighted version, meant for human readable texts only. |
|
| 380 | + * |
|
| 381 | + * Note: the commands lose their functionality (They cannot be |
|
| 382 | + * parsed from that string again). |
|
| 383 | + * |
|
| 384 | + * @param string $string |
|
| 385 | + * @return string |
|
| 386 | + * @throws Mailcode_Exception |
|
| 387 | + * |
|
| 388 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 389 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
| 390 | + */ |
|
| 391 | 391 | public function makeHighlighted(string $string) : string |
| 392 | 392 | { |
| 393 | 393 | return $this->restore( |
@@ -397,15 +397,15 @@ discard block |
||
| 397 | 397 | ); |
| 398 | 398 | } |
| 399 | 399 | |
| 400 | - /** |
|
| 401 | - * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 402 | - * |
|
| 403 | - * @param string $string |
|
| 404 | - * @return string |
|
| 405 | - * @throws Mailcode_Exception |
|
| 406 | - * |
|
| 407 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 408 | - */ |
|
| 400 | + /** |
|
| 401 | + * Like `makeHighlighted()`, but ignores missing command placeholders. |
|
| 402 | + * |
|
| 403 | + * @param string $string |
|
| 404 | + * @return string |
|
| 405 | + * @throws Mailcode_Exception |
|
| 406 | + * |
|
| 407 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 408 | + */ |
|
| 409 | 409 | public function makeHighlightedPartial(string $string) : string |
| 410 | 410 | { |
| 411 | 411 | return $this->restore( |
@@ -415,11 +415,11 @@ discard block |
||
| 415 | 415 | ); |
| 416 | 416 | } |
| 417 | 417 | |
| 418 | - /** |
|
| 419 | - * Retrieves the commands collection contained in the string. |
|
| 420 | - * |
|
| 421 | - * @return Mailcode_Collection |
|
| 422 | - */ |
|
| 418 | + /** |
|
| 419 | + * Retrieves the commands collection contained in the string. |
|
| 420 | + * |
|
| 421 | + * @return Mailcode_Collection |
|
| 422 | + */ |
|
| 423 | 423 | public function getCollection() : Mailcode_Collection |
| 424 | 424 | { |
| 425 | 425 | if(isset($this->collection)) |
@@ -437,11 +437,11 @@ discard block |
||
| 437 | 437 | return $this->getCollection()->isValid(); |
| 438 | 438 | } |
| 439 | 439 | |
| 440 | - /** |
|
| 441 | - * @throws Mailcode_Exception |
|
| 442 | - * |
|
| 443 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 444 | - */ |
|
| 440 | + /** |
|
| 441 | + * @throws Mailcode_Exception |
|
| 442 | + * |
|
| 443 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
| 444 | + */ |
|
| 445 | 445 | protected function requireValidCollection() : void |
| 446 | 446 | { |
| 447 | 447 | if($this->getCollection()->isValid()) |
@@ -460,11 +460,11 @@ discard block |
||
| 460 | 460 | ); |
| 461 | 461 | } |
| 462 | 462 | |
| 463 | - /** |
|
| 464 | - * Retrieves a list of all placeholder IDs used in the text. |
|
| 465 | - * |
|
| 466 | - * @return string[] |
|
| 467 | - */ |
|
| 463 | + /** |
|
| 464 | + * Retrieves a list of all placeholder IDs used in the text. |
|
| 465 | + * |
|
| 466 | + * @return string[] |
|
| 467 | + */ |
|
| 468 | 468 | public function getPlaceholderStrings() : array |
| 469 | 469 | { |
| 470 | 470 | if(is_array($this->placeholderStrings)) |
@@ -491,13 +491,13 @@ discard block |
||
| 491 | 491 | return in_array($subject, $ids); |
| 492 | 492 | } |
| 493 | 493 | |
| 494 | - /** |
|
| 495 | - * Retrieves a placeholder instance by its ID. |
|
| 496 | - * |
|
| 497 | - * @param int $id |
|
| 498 | - * @throws Mailcode_Exception If the placeholder was not found. |
|
| 499 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 500 | - */ |
|
| 494 | + /** |
|
| 495 | + * Retrieves a placeholder instance by its ID. |
|
| 496 | + * |
|
| 497 | + * @param int $id |
|
| 498 | + * @throws Mailcode_Exception If the placeholder was not found. |
|
| 499 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 500 | + */ |
|
| 501 | 501 | public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder |
| 502 | 502 | { |
| 503 | 503 | $placeholders = $this->getPlaceholders(); |
@@ -520,13 +520,13 @@ discard block |
||
| 520 | 520 | ); |
| 521 | 521 | } |
| 522 | 522 | |
| 523 | - /** |
|
| 524 | - * Retrieves a placeholder instance by its replacement text. |
|
| 525 | - * |
|
| 526 | - * @param string $string |
|
| 527 | - * @throws Mailcode_Exception |
|
| 528 | - * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 529 | - */ |
|
| 523 | + /** |
|
| 524 | + * Retrieves a placeholder instance by its replacement text. |
|
| 525 | + * |
|
| 526 | + * @param string $string |
|
| 527 | + * @throws Mailcode_Exception |
|
| 528 | + * @return Mailcode_Parser_Safeguard_Placeholder |
|
| 529 | + */ |
|
| 530 | 530 | public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder |
| 531 | 531 | { |
| 532 | 532 | $placeholders = $this->getPlaceholders(); |