@@ -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', |
@@ -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) |
@@ -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(); |
@@ -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, '"\''); |
@@ -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; |
@@ -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 | } |
@@ -23,19 +23,19 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Commands_IfVariable |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 28 | + */ |
|
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $comparisonToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL |
|
| 38 | + */ |
|
| 39 | 39 | protected $valueToken; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -123,11 +123,11 @@ discard block |
||
| 123 | 123 | ); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Retrieves the variable being compared. |
|
| 128 | - * |
|
| 129 | - * @return Mailcode_Variables_Variable |
|
| 130 | - */ |
|
| 126 | + /** |
|
| 127 | + * Retrieves the variable being compared. |
|
| 128 | + * |
|
| 129 | + * @return Mailcode_Variables_Variable |
|
| 130 | + */ |
|
| 131 | 131 | public function getVariable() : Mailcode_Variables_Variable |
| 132 | 132 | { |
| 133 | 133 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -142,12 +142,12 @@ discard block |
||
| 142 | 142 | ); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Retrieves the comparison operator sign. |
|
| 147 | - * |
|
| 148 | - * @throws Mailcode_Exception |
|
| 149 | - * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | - */ |
|
| 145 | + /** |
|
| 146 | + * Retrieves the comparison operator sign. |
|
| 147 | + * |
|
| 148 | + * @throws Mailcode_Exception |
|
| 149 | + * @return string The comparison string, e.g. "==", "!=", etc. |
|
| 150 | + */ |
|
| 151 | 151 | public function getComparator() : string |
| 152 | 152 | { |
| 153 | 153 | if($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand) |
@@ -162,10 +162,10 @@ discard block |
||
| 162 | 162 | ); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Retrieves the unquoted value |
|
| 167 | - * @return string |
|
| 168 | - */ |
|
| 165 | + /** |
|
| 166 | + * Retrieves the unquoted value |
|
| 167 | + * @return string |
|
| 168 | + */ |
|
| 169 | 169 | public function getValue() : string |
| 170 | 170 | { |
| 171 | 171 | if($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value) |
@@ -28,14 +28,14 @@ discard block |
||
| 28 | 28 | */ |
| 29 | 29 | protected $variableToken; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL |
|
| 33 | + */ |
|
| 34 | 34 | protected $stringToken; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var boolean |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var boolean |
|
| 38 | + */ |
|
| 39 | 39 | protected $caseInsensitive = false; |
| 40 | 40 | |
| 41 | 41 | protected function getValidations() : array |
@@ -131,11 +131,11 @@ discard block |
||
| 131 | 131 | ); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Retrieves the variable being compared. |
|
| 136 | - * |
|
| 137 | - * @return Mailcode_Variables_Variable |
|
| 138 | - */ |
|
| 134 | + /** |
|
| 135 | + * Retrieves the variable being compared. |
|
| 136 | + * |
|
| 137 | + * @return Mailcode_Variables_Variable |
|
| 138 | + */ |
|
| 139 | 139 | public function getVariable() : Mailcode_Variables_Variable |
| 140 | 140 | { |
| 141 | 141 | if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable) |
@@ -23,17 +23,17 @@ 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 | - /** |
|
| 32 | - * Creates a ShowVariable command. |
|
| 33 | - * |
|
| 34 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 35 | - * @return Mailcode_Commands_Command_ShowVariable |
|
| 36 | - */ |
|
| 31 | + /** |
|
| 32 | + * Creates a ShowVariable command. |
|
| 33 | + * |
|
| 34 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 35 | + * @return Mailcode_Commands_Command_ShowVariable |
|
| 36 | + */ |
|
| 37 | 37 | public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable |
| 38 | 38 | { |
| 39 | 39 | return self::$commandSets->show()->showVar($variableName); |
@@ -52,41 +52,41 @@ discard block |
||
| 52 | 52 | return self::$commandSets->show()->showDate($variableName, $formatString); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Creates a ShowSnippet command. |
|
| 57 | - * |
|
| 58 | - * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 59 | - * @return Mailcode_Commands_Command_ShowSnippet |
|
| 60 | - */ |
|
| 55 | + /** |
|
| 56 | + * Creates a ShowSnippet command. |
|
| 57 | + * |
|
| 58 | + * @param string $snippetName A snippet name, with or without the $ sign prepended. |
|
| 59 | + * @return Mailcode_Commands_Command_ShowSnippet |
|
| 60 | + */ |
|
| 61 | 61 | public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet |
| 62 | 62 | { |
| 63 | 63 | return self::$commandSets->show()->showSnippet($snippetName); |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Creates a SetVariable command. |
|
| 68 | - * |
|
| 69 | - * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 70 | - * @param string $value |
|
| 71 | - * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 72 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 73 | - * @throws Mailcode_Factory_Exception |
|
| 74 | - * |
|
| 75 | - * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 76 | - */ |
|
| 66 | + /** |
|
| 67 | + * Creates a SetVariable command. |
|
| 68 | + * |
|
| 69 | + * @param string $variableName A variable name, with or without the $ sign prepended. |
|
| 70 | + * @param string $value |
|
| 71 | + * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it. |
|
| 72 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 73 | + * @throws Mailcode_Factory_Exception |
|
| 74 | + * |
|
| 75 | + * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED |
|
| 76 | + */ |
|
| 77 | 77 | public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
| 78 | 78 | { |
| 79 | 79 | return self::$commandSets->set()->setVar($variableName, $value, $quoteValue); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Like setVar(), but treats the value as a string literal |
|
| 84 | - * and automatically adds quotes to it. |
|
| 85 | - * |
|
| 86 | - * @param string $variableName |
|
| 87 | - * @param string $value |
|
| 88 | - * @return Mailcode_Commands_Command_SetVariable |
|
| 89 | - */ |
|
| 82 | + /** |
|
| 83 | + * Like setVar(), but treats the value as a string literal |
|
| 84 | + * and automatically adds quotes to it. |
|
| 85 | + * |
|
| 86 | + * @param string $variableName |
|
| 87 | + * @param string $value |
|
| 88 | + * @return Mailcode_Commands_Command_SetVariable |
|
| 89 | + */ |
|
| 90 | 90 | public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable |
| 91 | 91 | { |
| 92 | 92 | return self::$commandSets->set()->setVar($variableName, $value, true); |
@@ -207,34 +207,34 @@ discard block |
||
| 207 | 207 | return self::$commandSets->if()->ifNotEmpty($variable); |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Creates a renderer instance, which can be used to easily |
|
| 212 | - * create and convert commands to strings. |
|
| 213 | - * |
|
| 214 | - * @return Mailcode_Renderer |
|
| 215 | - */ |
|
| 210 | + /** |
|
| 211 | + * Creates a renderer instance, which can be used to easily |
|
| 212 | + * create and convert commands to strings. |
|
| 213 | + * |
|
| 214 | + * @return Mailcode_Renderer |
|
| 215 | + */ |
|
| 216 | 216 | public static function createRenderer() : Mailcode_Renderer |
| 217 | 217 | { |
| 218 | 218 | return new Mailcode_Renderer(); |
| 219 | 219 | } |
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * Creates a printer instance, which works like the renderer, |
|
| 223 | - * but outputs the generated strings to standard output. |
|
| 224 | - * |
|
| 225 | - * @return Mailcode_Printer |
|
| 226 | - */ |
|
| 221 | + /** |
|
| 222 | + * Creates a printer instance, which works like the renderer, |
|
| 223 | + * but outputs the generated strings to standard output. |
|
| 224 | + * |
|
| 225 | + * @return Mailcode_Printer |
|
| 226 | + */ |
|
| 227 | 227 | public static function createPrinter() : Mailcode_Printer |
| 228 | 228 | { |
| 229 | 229 | return new Mailcode_Printer(); |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - /** |
|
| 233 | - * Gets/creates the global instance of the date format info |
|
| 234 | - * class, used to handle date formatting aspects. |
|
| 235 | - * |
|
| 236 | - * @return Mailcode_Date_FormatInfo |
|
| 237 | - */ |
|
| 232 | + /** |
|
| 233 | + * Gets/creates the global instance of the date format info |
|
| 234 | + * class, used to handle date formatting aspects. |
|
| 235 | + * |
|
| 236 | + * @return Mailcode_Date_FormatInfo |
|
| 237 | + */ |
|
| 238 | 238 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
| 239 | 239 | { |
| 240 | 240 | return Mailcode_Date_FormatInfo::getInstance(); |