@@ -20,9 +20,9 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Commands_Command_SetVariable extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 25 | + */ |
|
| 26 | 26 | private $variableToken; |
| 27 | 27 | |
| 28 | 28 | public function getName() : string |
@@ -153,9 +153,9 @@ discard block |
||
| 153 | 153 | ); |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 158 | - */ |
|
| 156 | + /** |
|
| 157 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 158 | + */ |
|
| 159 | 159 | public function getAssignmentTokens() : array |
| 160 | 160 | { |
| 161 | 161 | $params = $this->requireParams()->getInfo()->getTokens(); |
@@ -33,19 +33,19 @@ |
||
| 33 | 33 | public const VALIDATION_VARIABLE_NAME_WITH_DOT = 49704; |
| 34 | 34 | public const VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT = 49705; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 38 | + */ |
|
| 39 | 39 | private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $loopVar = null; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 43 | + */ |
|
| 44 | 44 | private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $sourceVar = null; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 48 | + */ |
|
| 49 | 49 | private ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword $keyword = null; |
| 50 | 50 | |
| 51 | 51 | public function getName() : string |
@@ -26,9 +26,9 @@ discard block |
||
| 26 | 26 | public const ERROR_CANNOT_MODIFY_FINALIZED = 52302; |
| 27 | 27 | public const ERROR_NO_VALIDATION_RESULT_AVAILABLE = 52303; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Commands_Command[] |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Commands_Command[] |
|
| 31 | + */ |
|
| 32 | 32 | protected array $commands = array(); |
| 33 | 33 | |
| 34 | 34 | /** |
@@ -63,21 +63,21 @@ discard block |
||
| 63 | 63 | return $this; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Whether there are any commands in the collection. |
|
| 68 | - * |
|
| 69 | - * @return bool |
|
| 70 | - */ |
|
| 66 | + /** |
|
| 67 | + * Whether there are any commands in the collection. |
|
| 68 | + * |
|
| 69 | + * @return bool |
|
| 70 | + */ |
|
| 71 | 71 | public function hasCommands() : bool |
| 72 | 72 | { |
| 73 | 73 | return !empty($this->commands); |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Counts the amount of commands in the collection. |
|
| 78 | - * |
|
| 79 | - * @return int |
|
| 80 | - */ |
|
| 76 | + /** |
|
| 77 | + * Counts the amount of commands in the collection. |
|
| 78 | + * |
|
| 79 | + * @return int |
|
| 80 | + */ |
|
| 81 | 81 | public function countCommands() : int |
| 82 | 82 | { |
| 83 | 83 | return count($this->commands); |
@@ -98,12 +98,12 @@ discard block |
||
| 98 | 98 | $this->commands = $keep; |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Retrieves all commands that were detected, in the exact order |
|
| 103 | - * they were found. |
|
| 104 | - * |
|
| 105 | - * @return Mailcode_Commands_Command[] |
|
| 106 | - */ |
|
| 101 | + /** |
|
| 102 | + * Retrieves all commands that were detected, in the exact order |
|
| 103 | + * they were found. |
|
| 104 | + * |
|
| 105 | + * @return Mailcode_Commands_Command[] |
|
| 106 | + */ |
|
| 107 | 107 | public function getCommands() : array |
| 108 | 108 | { |
| 109 | 109 | $this->validate(); |
@@ -357,10 +357,10 @@ discard block |
||
| 357 | 357 | } |
| 358 | 358 | |
| 359 | 359 | /** |
| 360 | - * Retrieves only show variable commands in the collection, if any. |
|
| 361 | - * |
|
| 362 | - * @return Mailcode_Commands_Command_ShowVariable[] |
|
| 363 | - */ |
|
| 360 | + * Retrieves only show variable commands in the collection, if any. |
|
| 361 | + * |
|
| 362 | + * @return Mailcode_Commands_Command_ShowVariable[] |
|
| 363 | + */ |
|
| 364 | 364 | public function getShowVariableCommands(): array |
| 365 | 365 | { |
| 366 | 366 | return Mailcode_Collection_TypeFilter::getShowVariableCommands($this->commands); |
@@ -374,11 +374,11 @@ discard block |
||
| 374 | 374 | return Mailcode_Collection_TypeFilter::getForCommands($this->commands); |
| 375 | 375 | } |
| 376 | 376 | |
| 377 | - /** |
|
| 378 | - * Retrieves only show date commands in the collection, if any. |
|
| 379 | - * |
|
| 380 | - * @return Mailcode_Commands_Command_ShowDate[] |
|
| 381 | - */ |
|
| 377 | + /** |
|
| 378 | + * Retrieves only show date commands in the collection, if any. |
|
| 379 | + * |
|
| 380 | + * @return Mailcode_Commands_Command_ShowDate[] |
|
| 381 | + */ |
|
| 382 | 382 | public function getShowDateCommands() : array |
| 383 | 383 | { |
| 384 | 384 | return Mailcode_Collection_TypeFilter::getShowDateCommands($this->commands); |
@@ -25,14 +25,14 @@ discard block |
||
| 25 | 25 | { |
| 26 | 26 | public const ERROR_CSS_FILE_NOT_FOUND = 60901; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | private string $path; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | 36 | private string $fileName = 'highlight.css'; |
| 37 | 37 | |
| 38 | 38 | public function __construct() |
@@ -55,22 +55,22 @@ discard block |
||
| 55 | 55 | $this->path = $path; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Retrieves the raw CSS source for the highlighting. |
|
| 60 | - * |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 58 | + /** |
|
| 59 | + * Retrieves the raw CSS source for the highlighting. |
|
| 60 | + * |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | 63 | public function getCSS() : string |
| 64 | 64 | { |
| 65 | 65 | return FileHelper::readContents($this->path); |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Retrieves a fully formed `code` tag with the CSS, |
|
| 70 | - * to inject inline into an HTML document. |
|
| 71 | - * |
|
| 72 | - * @return string |
|
| 73 | - */ |
|
| 68 | + /** |
|
| 69 | + * Retrieves a fully formed `code` tag with the CSS, |
|
| 70 | + * to inject inline into an HTML document. |
|
| 71 | + * |
|
| 72 | + * @return string |
|
| 73 | + */ |
|
| 74 | 74 | public function getStyleTag() : string |
| 75 | 75 | { |
| 76 | 76 | return sprintf( |
@@ -79,23 +79,23 @@ discard block |
||
| 79 | 79 | ); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Retrieves the path to the stylesheet file. |
|
| 84 | - * |
|
| 85 | - * @return string |
|
| 86 | - */ |
|
| 82 | + /** |
|
| 83 | + * Retrieves the path to the stylesheet file. |
|
| 84 | + * |
|
| 85 | + * @return string |
|
| 86 | + */ |
|
| 87 | 87 | public function getStylesheetPath() : string |
| 88 | 88 | { |
| 89 | 89 | return $this->path; |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Retrieves the URL to the stylesheet file, given the |
|
| 94 | - * local URL to the application's vendor folder. |
|
| 95 | - * |
|
| 96 | - * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot). |
|
| 97 | - * @return string |
|
| 98 | - */ |
|
| 92 | + /** |
|
| 93 | + * Retrieves the URL to the stylesheet file, given the |
|
| 94 | + * local URL to the application's vendor folder. |
|
| 95 | + * |
|
| 96 | + * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot). |
|
| 97 | + * @return string |
|
| 98 | + */ |
|
| 99 | 99 | public function getStylesheetURL(string $vendorURL) : string |
| 100 | 100 | { |
| 101 | 101 | return sprintf( |
@@ -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 bool $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)); |
@@ -22,9 +22,9 @@ |
||
| 22 | 22 | { |
| 23 | 23 | public const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six'; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var Mailcode_Variables_Collection_Regular |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var Mailcode_Variables_Collection_Regular |
|
| 27 | + */ |
|
| 28 | 28 | protected Mailcode_Variables_Collection_Regular $collection; |
| 29 | 29 | |
| 30 | 30 | /** |
@@ -23,24 +23,24 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class Mailcode_Parser_Match |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | 29 | protected string $name; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected string $type; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected string $params; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var string |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var string |
|
| 43 | + */ |
|
| 44 | 44 | protected string $matchedString; |
| 45 | 45 | |
| 46 | 46 | public function __construct(string $name, string $type, string $params, string $matchedString) |
@@ -24,9 +24,9 @@ discard block |
||
| 24 | 24 | protected string $matchedText; |
| 25 | 25 | private ?Mailcode_Commands_Command $sourceCommand; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var mixed |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var mixed |
|
| 29 | + */ |
|
| 30 | 30 | protected $subject; |
| 31 | 31 | |
| 32 | 32 | /** |
@@ -58,20 +58,20 @@ discard block |
||
| 58 | 58 | return $this->sourceCommand; |
| 59 | 59 | } |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 63 | - * @return string |
|
| 64 | - */ |
|
| 61 | + /** |
|
| 62 | + * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 63 | + * @return string |
|
| 64 | + */ |
|
| 65 | 65 | public function getTypeID() : string |
| 66 | 66 | { |
| 67 | 67 | $parts = explode('_', get_class($this)); |
| 68 | 68 | return array_pop($parts); |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Retrieves a unique ID of the token. |
|
| 73 | - * @return string |
|
| 74 | - */ |
|
| 71 | + /** |
|
| 72 | + * Retrieves a unique ID of the token. |
|
| 73 | + * @return string |
|
| 74 | + */ |
|
| 75 | 75 | public function getID() : string |
| 76 | 76 | { |
| 77 | 77 | return $this->tokenID; |
@@ -35,31 +35,31 @@ |
||
| 35 | 35 | } |
| 36 | 36 | |
| 37 | 37 | /** |
| 38 | - * Retrieves the text with the surrounding quotes, |
|
| 39 | - * and special characters escaped for Mailcode. |
|
| 40 | - * |
|
| 41 | - * @return string |
|
| 42 | - */ |
|
| 38 | + * Retrieves the text with the surrounding quotes, |
|
| 39 | + * and special characters escaped for Mailcode. |
|
| 40 | + * |
|
| 41 | + * @return string |
|
| 42 | + */ |
|
| 43 | 43 | public function getNormalized() : string |
| 44 | 44 | { |
| 45 | 45 | return '"'.SpecialChars::escape($this->text).'"'; |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Retrieves the text with the surrounding quotes. |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 48 | + /** |
|
| 49 | + * Retrieves the text with the surrounding quotes. |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | 52 | public function getValue() : string |
| 53 | 53 | { |
| 54 | 54 | return $this->getNormalized(); |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves the text without the surrounding quotes, |
|
| 59 | - * and special Mailcode characters not escaped. |
|
| 60 | - * |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves the text without the surrounding quotes, |
|
| 59 | + * and special Mailcode characters not escaped. |
|
| 60 | + * |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | 63 | public function getText() : string |
| 64 | 64 | { |
| 65 | 65 | return SpecialChars::decode($this->text); |