| @@ -20,9 +20,9 @@ discard block | ||
| 20 | 20 | */ | 
| 21 | 21 | class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection | 
| 22 | 22 |  { | 
| 23 | - /** | |
| 24 | - * @var Mailcode_Variables_Collection_Invalid | |
| 25 | - */ | |
| 23 | + /** | |
| 24 | + * @var Mailcode_Variables_Collection_Invalid | |
| 25 | + */ | |
| 26 | 26 | protected $invalid; | 
| 27 | 27 | |
| 28 | 28 | protected function init() : void | 
| @@ -47,30 +47,30 @@ discard block | ||
| 47 | 47 | return $this; | 
| 48 | 48 | } | 
| 49 | 49 | |
| 50 | - /** | |
| 51 | - * Whether any of the variables in the collection are invalid. | |
| 52 | - * | |
| 53 | - * @return bool | |
| 54 | - */ | |
| 50 | + /** | |
| 51 | + * Whether any of the variables in the collection are invalid. | |
| 52 | + * | |
| 53 | + * @return bool | |
| 54 | + */ | |
| 55 | 55 | public function hasInvalid() : bool | 
| 56 | 56 |      { | 
| 57 | 57 | return isset($this->invalid) && $this->invalid->hasVariables(); | 
| 58 | 58 | } | 
| 59 | 59 | |
| 60 | - /** | |
| 61 | - * Retrieves the collection of invalid variables, if any. | |
| 62 | - * Behaves like a variables collection. | |
| 63 | - * | |
| 64 | - * @return Mailcode_Variables_Collection_Invalid | |
| 65 | - */ | |
| 60 | + /** | |
| 61 | + * Retrieves the collection of invalid variables, if any. | |
| 62 | + * Behaves like a variables collection. | |
| 63 | + * | |
| 64 | + * @return Mailcode_Variables_Collection_Invalid | |
| 65 | + */ | |
| 66 | 66 | public function getInvalid() : Mailcode_Variables_Collection_Invalid | 
| 67 | 67 |      { | 
| 68 | 68 | return $this->invalid; | 
| 69 | 69 | } | 
| 70 | 70 | |
| 71 | - /** | |
| 72 | - * @return Mailcode_Variables_Collection_Regular | |
| 73 | - */ | |
| 71 | + /** | |
| 72 | + * @return Mailcode_Variables_Collection_Regular | |
| 73 | + */ | |
| 74 | 74 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection | 
| 75 | 75 |      { | 
| 76 | 76 | parent::mergeWith($collection); | 
| @@ -20,19 +20,19 @@ | ||
| 20 | 20 | */ | 
| 21 | 21 | abstract class Mailcode_Collection_Error | 
| 22 | 22 |  { | 
| 23 | - /** | |
| 24 | - * @var integer | |
| 25 | - */ | |
| 23 | + /** | |
| 24 | + * @var integer | |
| 25 | + */ | |
| 26 | 26 | protected $code = 0; | 
| 27 | 27 | |
| 28 | - /** | |
| 29 | - * @var string | |
| 30 | - */ | |
| 28 | + /** | |
| 29 | + * @var string | |
| 30 | + */ | |
| 31 | 31 | protected $matchedText = ''; | 
| 32 | 32 | |
| 33 | - /** | |
| 34 | - * @var string | |
| 35 | - */ | |
| 33 | + /** | |
| 34 | + * @var string | |
| 35 | + */ | |
| 36 | 36 | protected $message = ''; | 
| 37 | 37 | |
| 38 | 38 | public function getCode() : int | 
| @@ -32,34 +32,34 @@ | ||
| 32 | 32 | const VALIDATION_ERROR_PATH_UNDERSCORE = 48203; | 
| 33 | 33 | const VALIDATION_ERROR_NAME_UNDERSCORE = 48204; | 
| 34 | 34 | |
| 35 | - /** | |
| 36 | - * @var string | |
| 37 | - */ | |
| 35 | + /** | |
| 36 | + * @var string | |
| 37 | + */ | |
| 38 | 38 | protected $path; | 
| 39 | 39 | |
| 40 | - /** | |
| 41 | - * @var string | |
| 42 | - */ | |
| 40 | + /** | |
| 41 | + * @var string | |
| 42 | + */ | |
| 43 | 43 | protected $name; | 
| 44 | 44 | |
| 45 | - /** | |
| 46 | - * @var string | |
| 47 | - */ | |
| 45 | + /** | |
| 46 | + * @var string | |
| 47 | + */ | |
| 48 | 48 | protected $matchedText; | 
| 49 | 49 | |
| 50 | - /** | |
| 51 | - * @var string | |
| 52 | - */ | |
| 50 | + /** | |
| 51 | + * @var string | |
| 52 | + */ | |
| 53 | 53 | protected $hash = ''; | 
| 54 | 54 | |
| 55 | - /** | |
| 56 | - * @var OperationResult | |
| 57 | - */ | |
| 55 | + /** | |
| 56 | + * @var OperationResult | |
| 57 | + */ | |
| 58 | 58 | protected $validationResult = null; | 
| 59 | 59 | |
| 60 | - /** | |
| 61 | - * @var array<string> | |
| 62 | - */ | |
| 60 | + /** | |
| 61 | + * @var array<string> | |
| 62 | + */ | |
| 63 | 63 | protected $validations = array( | 
| 64 | 64 | 'number_path', | 
| 65 | 65 | 'number_name', | 
| @@ -21,24 +21,24 @@ | ||
| 21 | 21 | */ | 
| 22 | 22 | class Mailcode_Parser_Match | 
| 23 | 23 |  { | 
| 24 | - /** | |
| 25 | - * @var string | |
| 26 | - */ | |
| 24 | + /** | |
| 25 | + * @var string | |
| 26 | + */ | |
| 27 | 27 | protected $name; | 
| 28 | 28 | |
| 29 | - /** | |
| 30 | - * @var string | |
| 31 | - */ | |
| 29 | + /** | |
| 30 | + * @var string | |
| 31 | + */ | |
| 32 | 32 | protected $type; | 
| 33 | 33 | |
| 34 | - /** | |
| 35 | - * @var string | |
| 36 | - */ | |
| 34 | + /** | |
| 35 | + * @var string | |
| 36 | + */ | |
| 37 | 37 | protected $params; | 
| 38 | 38 | |
| 39 | - /** | |
| 40 | - * @var string | |
| 41 | - */ | |
| 39 | + /** | |
| 40 | + * @var string | |
| 41 | + */ | |
| 42 | 42 | protected $matchedString; | 
| 43 | 43 | |
| 44 | 44 | public function __construct(string $name, string $type, string $params, string $matchedString) | 
| @@ -20,18 +20,18 @@ discard block | ||
| 20 | 20 | */ | 
| 21 | 21 | class Mailcode_Factory_Exception extends Mailcode_Exception | 
| 22 | 22 |  { | 
| 23 | - /** | |
| 24 | - * @var Mailcode_Commands_Command|NULL | |
| 25 | - */ | |
| 23 | + /** | |
| 24 | + * @var Mailcode_Commands_Command|NULL | |
| 25 | + */ | |
| 26 | 26 | protected $command; | 
| 27 | 27 | |
| 28 | - /** | |
| 29 | - * @param string $message | |
| 30 | - * @param string|NULL $details | |
| 31 | - * @param int|NULL $code | |
| 32 | - * @param \Exception|NULL $previous | |
| 33 | - * @param Mailcode_Commands_Command|NULL $command | |
| 34 | - */ | |
| 28 | + /** | |
| 29 | + * @param string $message | |
| 30 | + * @param string|NULL $details | |
| 31 | + * @param int|NULL $code | |
| 32 | + * @param \Exception|NULL $previous | |
| 33 | + * @param Mailcode_Commands_Command|NULL $command | |
| 34 | + */ | |
| 35 | 35 | public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null) | 
| 36 | 36 |      { | 
| 37 | 37 | parent::__construct($message, $details, $code, $previous); | 
| @@ -39,11 +39,11 @@ discard block | ||
| 39 | 39 | $this->command = $command; | 
| 40 | 40 | } | 
| 41 | 41 | |
| 42 | - /** | |
| 43 | - * Retrieves the erroneous command, if any. | |
| 44 | - * | |
| 45 | - * @return Mailcode_Commands_Command|NULL | |
| 46 | - */ | |
| 42 | + /** | |
| 43 | + * Retrieves the erroneous command, if any. | |
| 44 | + * | |
| 45 | + * @return Mailcode_Commands_Command|NULL | |
| 46 | + */ | |
| 47 | 47 | public function getCommand() : ?Mailcode_Commands_Command | 
| 48 | 48 |      { | 
| 49 | 49 | return $this->command; | 
| @@ -23,9 +23,9 @@ discard block | ||
| 23 | 23 |  { | 
| 24 | 24 | const ERROR_UNKNOWN_COMMAND_TYPE = 50401; | 
| 25 | 25 | |
| 26 | - /** | |
| 27 | - * @var string | |
| 28 | - */ | |
| 26 | + /** | |
| 27 | + * @var string | |
| 28 | + */ | |
| 29 | 29 | protected $typeID; | 
| 30 | 30 | |
| 31 | 31 | public function __construct(string $typeID) | 
| @@ -33,22 +33,22 @@ discard block | ||
| 33 | 33 | $this->typeID = $typeID; | 
| 34 | 34 | } | 
| 35 | 35 | |
| 36 | - /** | |
| 37 | - * Retrieves the syntax' type ID, e.g. "ApacheVelocity". | |
| 38 | - * @return string | |
| 39 | - */ | |
| 36 | + /** | |
| 37 | + * Retrieves the syntax' type ID, e.g. "ApacheVelocity". | |
| 38 | + * @return string | |
| 39 | + */ | |
| 40 | 40 | public function getTypeID() : string | 
| 41 | 41 |      { | 
| 42 | 42 | return $this->typeID; | 
| 43 | 43 | } | 
| 44 | 44 | |
| 45 | - /** | |
| 46 | - * Translates a single command to the target syntax. | |
| 47 | - * | |
| 48 | - * @param Mailcode_Commands_Command $command | |
| 49 | - * @throws Mailcode_Translator_Exception | |
| 50 | - * @return string | |
| 51 | - */ | |
| 45 | + /** | |
| 46 | + * Translates a single command to the target syntax. | |
| 47 | + * | |
| 48 | + * @param Mailcode_Commands_Command $command | |
| 49 | + * @throws Mailcode_Translator_Exception | |
| 50 | + * @return string | |
| 51 | + */ | |
| 52 | 52 | public function translateCommand(Mailcode_Commands_Command $command) : string | 
| 53 | 53 |      { | 
| 54 | 54 | $translator = $this->createTranslator($command); | 
| @@ -81,13 +81,13 @@ discard block | ||
| 81 | 81 | return $translator; | 
| 82 | 82 | } | 
| 83 | 83 | |
| 84 | - /** | |
| 85 | - * Translates all safeguarded commands in the subject string to the | |
| 86 | - * target syntax in one go. | |
| 87 | - * | |
| 88 | - * @param Mailcode_Parser_Safeguard $safeguard | |
| 89 | - * @return string | |
| 90 | - */ | |
| 84 | + /** | |
| 85 | + * Translates all safeguarded commands in the subject string to the | |
| 86 | + * target syntax in one go. | |
| 87 | + * | |
| 88 | + * @param Mailcode_Parser_Safeguard $safeguard | |
| 89 | + * @return string | |
| 90 | + */ | |
| 91 | 91 | public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string | 
| 92 | 92 |      { | 
| 93 | 93 | $subject = $safeguard->makeSafe(); | 
| @@ -29,19 +29,19 @@ | ||
| 29 | 29 | const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103; | 
| 30 | 30 | const VALIDATION_UNCLOSED_COMMAND = 49104; | 
| 31 | 31 | |
| 32 | - /** | |
| 33 | - * @var Mailcode_Collection | |
| 34 | - */ | |
| 32 | + /** | |
| 33 | + * @var Mailcode_Collection | |
| 34 | + */ | |
| 35 | 35 | protected $collection; | 
| 36 | 36 | |
| 37 | - /** | |
| 38 | - * @var OperationResult | |
| 39 | - */ | |
| 37 | + /** | |
| 38 | + * @var OperationResult | |
| 39 | + */ | |
| 40 | 40 | protected $validationResult; | 
| 41 | 41 | |
| 42 | - /** | |
| 43 | - * @var Mailcode_Commands_Command_Type[] | |
| 44 | - */ | |
| 42 | + /** | |
| 43 | + * @var Mailcode_Commands_Command_Type[] | |
| 44 | + */ | |
| 45 | 45 | protected $stack = array(); | 
| 46 | 46 | |
| 47 | 47 | public function __construct(Mailcode_Collection $collection) | 
| @@ -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(); |