@@ -40,7 +40,7 @@ |
||
| 40 | 40 | * @param string $matchedText |
| 41 | 41 | * @param mixed $subject |
| 42 | 42 | */ |
| 43 | - public function __construct(string $tokenID, string $matchedText, $subject=null) |
|
| 43 | + public function __construct(string $tokenID, string $matchedText, $subject = null) |
|
| 44 | 44 | { |
| 45 | 45 | $this->tokenID = $tokenID; |
| 46 | 46 | $this->matchedText = $matchedText; |
@@ -20,26 +20,26 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Parser_Statement_Tokenizer_Token implements Mailcode_Parser_Statement_Tokenizer_TypeInterface |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | 26 | protected $tokenID; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | protected $matchedText; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var mixed |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var mixed |
|
| 35 | + */ |
|
| 36 | 36 | protected $subject; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @param string $tokenID |
|
| 40 | - * @param string $matchedText |
|
| 41 | - * @param mixed $subject |
|
| 42 | - */ |
|
| 38 | + /** |
|
| 39 | + * @param string $tokenID |
|
| 40 | + * @param string $matchedText |
|
| 41 | + * @param mixed $subject |
|
| 42 | + */ |
|
| 43 | 43 | public function __construct(string $tokenID, string $matchedText, $subject=null) |
| 44 | 44 | { |
| 45 | 45 | $this->tokenID = $tokenID; |
@@ -47,20 +47,20 @@ discard block |
||
| 47 | 47 | $this->subject = $subject; |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 52 | - * @return string |
|
| 53 | - */ |
|
| 50 | + /** |
|
| 51 | + * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 52 | + * @return string |
|
| 53 | + */ |
|
| 54 | 54 | public function getTypeID() : string |
| 55 | 55 | { |
| 56 | 56 | $parts = explode('_', get_class($this)); |
| 57 | 57 | return array_pop($parts); |
| 58 | 58 | } |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Retrieves a unique ID of the token. |
|
| 62 | - * @return string |
|
| 63 | - */ |
|
| 60 | + /** |
|
| 61 | + * Retrieves a unique ID of the token. |
|
| 62 | + * @return string |
|
| 63 | + */ |
|
| 64 | 64 | public function getID() : string |
| 65 | 65 | { |
| 66 | 66 | return $this->tokenID; |
@@ -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; |
@@ -32,7 +32,7 @@ |
||
| 32 | 32 | * @param \Exception|NULL $previous |
| 33 | 33 | * @param Mailcode_Commands_Command|NULL $command |
| 34 | 34 | */ |
| 35 | - public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null) |
|
| 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); |
| 38 | 38 | |
@@ -22,17 +22,17 @@ |
||
| 22 | 22 | { |
| 23 | 23 | 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 $collection; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * Parses the specified string to find all variable names contained within, if any. |
|
| 32 | - * |
|
| 33 | - * @param string $subject |
|
| 34 | - * @return Mailcode_Variables_Collection_Regular |
|
| 35 | - */ |
|
| 30 | + /** |
|
| 31 | + * Parses the specified string to find all variable names contained within, if any. |
|
| 32 | + * |
|
| 33 | + * @param string $subject |
|
| 34 | + * @return Mailcode_Variables_Collection_Regular |
|
| 35 | + */ |
|
| 36 | 36 | public function parseString(string $subject) : Mailcode_Variables_Collection_Regular |
| 37 | 37 | { |
| 38 | 38 | $this->collection = new Mailcode_Variables_Collection_Regular(); |
@@ -40,14 +40,14 @@ discard block |
||
| 40 | 40 | $matches = array(); |
| 41 | 41 | preg_match_all(self::REGEX_VARIABLE_NAME, $subject, $matches, PREG_PATTERN_ORDER); |
| 42 | 42 | |
| 43 | - if(!isset($matches[0]) || empty($matches[0])) |
|
| 43 | + if (!isset($matches[0]) || empty($matches[0])) |
|
| 44 | 44 | { |
| 45 | 45 | return $this->collection; |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | - foreach($matches[0] as $idx => $matchedText) |
|
| 48 | + foreach ($matches[0] as $idx => $matchedText) |
|
| 49 | 49 | { |
| 50 | - if(!empty($matches[3][$idx])) |
|
| 50 | + if (!empty($matches[3][$idx])) |
|
| 51 | 51 | { |
| 52 | 52 | $this->addSingle($matches[3][$idx], $matchedText); |
| 53 | 53 | } |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | protected function addSingle(string $name, string $matchedText) : void |
| 64 | 64 | { |
| 65 | 65 | // ignore US style numbers like $451 |
| 66 | - if(is_numeric($name)) |
|
| 66 | + if (is_numeric($name)) |
|
| 67 | 67 | { |
| 68 | 68 | return; |
| 69 | 69 | } |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | protected function addPathed(string $path, string $name, string $matchedText) : void |
| 75 | 75 | { |
| 76 | 76 | // ignore US style numbers like $45.12 |
| 77 | - if(is_numeric($path.'.'.$name)) |
|
| 77 | + if (is_numeric($path.'.'.$name)) |
|
| 78 | 78 | { |
| 79 | 79 | return; |
| 80 | 80 | } |
@@ -50,8 +50,7 @@ |
||
| 50 | 50 | if(!empty($matches[3][$idx])) |
| 51 | 51 | { |
| 52 | 52 | $this->addSingle($matches[3][$idx], $matchedText); |
| 53 | - } |
|
| 54 | - else |
|
| 53 | + } else |
|
| 55 | 54 | { |
| 56 | 55 | $this->addPathed($matches[1][$idx], $matches[2][$idx], $matchedText); |
| 57 | 56 | } |
@@ -73,7 +73,7 @@ discard block |
||
| 73 | 73 | */ |
| 74 | 74 | public function getParser() : Mailcode_Parser |
| 75 | 75 | { |
| 76 | - if(!isset($this->parser)) |
|
| 76 | + if (!isset($this->parser)) |
|
| 77 | 77 | { |
| 78 | 78 | $this->parser = new Mailcode_Parser($this); |
| 79 | 79 | } |
@@ -89,7 +89,7 @@ discard block |
||
| 89 | 89 | */ |
| 90 | 90 | public function getCommands() : Mailcode_Commands |
| 91 | 91 | { |
| 92 | - if(!isset($this->commands)) |
|
| 92 | + if (!isset($this->commands)) |
|
| 93 | 93 | { |
| 94 | 94 | $this->commands = new Mailcode_Commands(); |
| 95 | 95 | } |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | |
| 116 | 116 | public function createVariables() : Mailcode_Variables |
| 117 | 117 | { |
| 118 | - if(!isset($this->variables)) |
|
| 118 | + if (!isset($this->variables)) |
|
| 119 | 119 | { |
| 120 | 120 | $this->variables = new Mailcode_Variables(); |
| 121 | 121 | } |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | */ |
| 132 | 132 | public function createTranslator() : Mailcode_Translator |
| 133 | 133 | { |
| 134 | - if(!isset($this->translator)) |
|
| 134 | + if (!isset($this->translator)) |
|
| 135 | 135 | { |
| 136 | 136 | $this->translator = new Mailcode_Translator(); |
| 137 | 137 | } |
@@ -26,51 +26,51 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | class Mailcode |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Parser|NULL |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Parser|NULL |
|
| 31 | + */ |
|
| 32 | 32 | protected $parser = null; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var Mailcode_Commands|NULL |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var Mailcode_Commands|NULL |
|
| 36 | + */ |
|
| 37 | 37 | protected $commands = null; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Variables|NULL |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Variables|NULL |
|
| 41 | + */ |
|
| 42 | 42 | protected $variables = null; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Translator|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Translator|NULL |
|
| 46 | + */ |
|
| 47 | 47 | protected $translator = null; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Creates a new mailcode instance. |
|
| 51 | - * @return Mailcode |
|
| 52 | - */ |
|
| 49 | + /** |
|
| 50 | + * Creates a new mailcode instance. |
|
| 51 | + * @return Mailcode |
|
| 52 | + */ |
|
| 53 | 53 | public static function create() : Mailcode |
| 54 | 54 | { |
| 55 | 55 | return new Mailcode(); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Parses the string to detect all commands contained within. |
|
| 60 | - * |
|
| 61 | - * @param string $string |
|
| 62 | - * @return Mailcode_Collection |
|
| 63 | - */ |
|
| 58 | + /** |
|
| 59 | + * Parses the string to detect all commands contained within. |
|
| 60 | + * |
|
| 61 | + * @param string $string |
|
| 62 | + * @return Mailcode_Collection |
|
| 63 | + */ |
|
| 64 | 64 | public function parseString(string $string) : Mailcode_Collection |
| 65 | 65 | { |
| 66 | 66 | return $this->getParser()->parseString($string); |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Retrieves the string parser instance used to detect commands. |
|
| 71 | - * |
|
| 72 | - * @return Mailcode_Parser |
|
| 73 | - */ |
|
| 69 | + /** |
|
| 70 | + * Retrieves the string parser instance used to detect commands. |
|
| 71 | + * |
|
| 72 | + * @return Mailcode_Parser |
|
| 73 | + */ |
|
| 74 | 74 | public function getParser() : Mailcode_Parser |
| 75 | 75 | { |
| 76 | 76 | if(!isset($this->parser)) |
@@ -81,12 +81,12 @@ discard block |
||
| 81 | 81 | return $this->parser; |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Retrieves the commands collection, which is used to |
|
| 86 | - * access information on the available commands. |
|
| 87 | - * |
|
| 88 | - * @return Mailcode_Commands |
|
| 89 | - */ |
|
| 84 | + /** |
|
| 85 | + * Retrieves the commands collection, which is used to |
|
| 86 | + * access information on the available commands. |
|
| 87 | + * |
|
| 88 | + * @return Mailcode_Commands |
|
| 89 | + */ |
|
| 90 | 90 | public function getCommands() : Mailcode_Commands |
| 91 | 91 | { |
| 92 | 92 | if(!isset($this->commands)) |
@@ -107,12 +107,12 @@ discard block |
||
| 107 | 107 | return new Mailcode_StringContainer($subject); |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Attempts to find all variables in the target string. |
|
| 112 | - * |
|
| 113 | - * @param string $subject |
|
| 114 | - * @return Mailcode_Variables_Collection_Regular |
|
| 115 | - */ |
|
| 110 | + /** |
|
| 111 | + * Attempts to find all variables in the target string. |
|
| 112 | + * |
|
| 113 | + * @param string $subject |
|
| 114 | + * @return Mailcode_Variables_Collection_Regular |
|
| 115 | + */ |
|
| 116 | 116 | public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular |
| 117 | 117 | { |
| 118 | 118 | return $this->createVariables()->parseString($subject); |
@@ -128,12 +128,12 @@ discard block |
||
| 128 | 128 | return $this->variables; |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Creates the translator, which can be used to convert commands |
|
| 133 | - * to another supported syntax. |
|
| 134 | - * |
|
| 135 | - * @return Mailcode_Translator |
|
| 136 | - */ |
|
| 131 | + /** |
|
| 132 | + * Creates the translator, which can be used to convert commands |
|
| 133 | + * to another supported syntax. |
|
| 134 | + * |
|
| 135 | + * @return Mailcode_Translator |
|
| 136 | + */ |
|
| 137 | 137 | public function createTranslator() : Mailcode_Translator |
| 138 | 138 | { |
| 139 | 139 | if(!isset($this->translator)) |
@@ -144,12 +144,12 @@ discard block |
||
| 144 | 144 | return $this->translator; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Creates the styler, which can be used to retrieve the |
|
| 149 | - * CSS required to style the highlighted commands in HTML. |
|
| 150 | - * |
|
| 151 | - * @return Mailcode_Styler |
|
| 152 | - */ |
|
| 147 | + /** |
|
| 148 | + * Creates the styler, which can be used to retrieve the |
|
| 149 | + * CSS required to style the highlighted commands in HTML. |
|
| 150 | + * |
|
| 151 | + * @return Mailcode_Styler |
|
| 152 | + */ |
|
| 153 | 153 | public function createStyler() : Mailcode_Styler |
| 154 | 154 | { |
| 155 | 155 | return new Mailcode_Styler(); |
@@ -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(); |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | $command->getID() |
| 65 | 65 | ); |
| 66 | 66 | |
| 67 | - if(!class_exists($class)) |
|
| 67 | + if (!class_exists($class)) |
|
| 68 | 68 | { |
| 69 | 69 | throw new Mailcode_Translator_Exception( |
| 70 | 70 | sprintf('Unknown command %s in translator', $command->getID()), |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | { |
| 93 | 93 | $subject = $safeguard->makeSafe(); |
| 94 | 94 | |
| 95 | - if(!$safeguard->hasPlaceholders()) |
|
| 95 | + if (!$safeguard->hasPlaceholders()) |
|
| 96 | 96 | { |
| 97 | 97 | return $subject; |
| 98 | 98 | } |
@@ -101,13 +101,13 @@ discard block |
||
| 101 | 101 | |
| 102 | 102 | $replaces = array(); |
| 103 | 103 | |
| 104 | - foreach($placeholders as $placeholder) |
|
| 104 | + foreach ($placeholders as $placeholder) |
|
| 105 | 105 | { |
| 106 | 106 | $command = $placeholder->getCommand(); |
| 107 | 107 | |
| 108 | 108 | $replaces[$placeholder->getReplacementText()] = $this->translateCommand($command); |
| 109 | 109 | |
| 110 | - if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent) |
|
| 110 | + if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent) |
|
| 111 | 111 | { |
| 112 | 112 | $replaces[$command->getContentPlaceholder()] = $command->getContent(); |
| 113 | 113 | } |
@@ -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) |
@@ -87,7 +87,7 @@ |
||
| 87 | 87 | */ |
| 88 | 88 | public function getTypeLabel() : string |
| 89 | 89 | { |
| 90 | - switch($this->type) |
|
| 90 | + switch ($this->type) |
|
| 91 | 91 | { |
| 92 | 92 | case Mailcode_Date_FormatInfo::CHARTYPE_DATE: |
| 93 | 93 | return t('Date'); |
@@ -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(); |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | public static function getInstance() : Mailcode_Date_FormatInfo |
| 60 | 60 | { |
| 61 | - if(!isset(self::$instance)) |
|
| 61 | + if (!isset(self::$instance)) |
|
| 62 | 62 | { |
| 63 | 63 | self::$instance = new Mailcode_Date_FormatInfo(); |
| 64 | 64 | } |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | array(self::CHARTYPE_PUNCTUATION, ' ', t('Space')) |
| 91 | 91 | ); |
| 92 | 92 | |
| 93 | - foreach($chars as $def) |
|
| 93 | + foreach ($chars as $def) |
|
| 94 | 94 | { |
| 95 | 95 | $char = new Mailcode_Date_FormatInfo_Character( |
| 96 | 96 | $def[0], |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | |
| 130 | 130 | $trimmed = trim($formatString); |
| 131 | 131 | |
| 132 | - if(empty($trimmed)) |
|
| 132 | + if (empty($trimmed)) |
|
| 133 | 133 | { |
| 134 | 134 | $result->makeError( |
| 135 | 135 | t('Empty date format.'), |
@@ -142,15 +142,15 @@ discard block |
||
| 142 | 142 | $chars = ConvertHelper::string2array($formatString); |
| 143 | 143 | $total = count($chars); |
| 144 | 144 | |
| 145 | - for($i=0; $i < $total; $i++) |
|
| 145 | + for ($i = 0; $i < $total; $i++) |
|
| 146 | 146 | { |
| 147 | 147 | $char = $chars[$i]; |
| 148 | 148 | |
| 149 | - if(!in_array($char, $this->allowedChars)) |
|
| 149 | + if (!in_array($char, $this->allowedChars)) |
|
| 150 | 150 | { |
| 151 | 151 | $result->makeError( |
| 152 | 152 | t('Invalid character in date format:').' '. |
| 153 | - t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1), |
|
| 153 | + t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i + 1), |
|
| 154 | 154 | self::VALIDATION_INVALID_FORMAT_CHARACTER |
| 155 | 155 | ); |
| 156 | 156 | |
@@ -182,11 +182,11 @@ discard block |
||
| 182 | 182 | { |
| 183 | 183 | $grouped = array(); |
| 184 | 184 | |
| 185 | - foreach($this->formatChars as $char) |
|
| 185 | + foreach ($this->formatChars as $char) |
|
| 186 | 186 | { |
| 187 | 187 | $type = $char->getTypeLabel(); |
| 188 | 188 | |
| 189 | - if(!isset($grouped[$type])) |
|
| 189 | + if (!isset($grouped[$type])) |
|
| 190 | 190 | { |
| 191 | 191 | $grouped[$type] = array(); |
| 192 | 192 | } |
@@ -196,7 +196,7 @@ discard block |
||
| 196 | 196 | |
| 197 | 197 | $groups = array_keys($grouped); |
| 198 | 198 | |
| 199 | - foreach($groups as $group) |
|
| 199 | + foreach ($groups as $group) |
|
| 200 | 200 | { |
| 201 | 201 | usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b) |
| 202 | 202 | { |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | { |
| 47 | 47 | static $ids = array(); |
| 48 | 48 | |
| 49 | - if(empty($ids)) { |
|
| 49 | + if (empty($ids)) { |
|
| 50 | 50 | $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command') |
| 51 | 51 | ->getPHPClassNames(); |
| 52 | 52 | } |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | */ |
| 64 | 64 | public function getAll() |
| 65 | 65 | { |
| 66 | - if(!empty($this->commands)) { |
|
| 66 | + if (!empty($this->commands)) { |
|
| 67 | 67 | return $this->commands; |
| 68 | 68 | } |
| 69 | 69 | |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | $result = array(); |
| 73 | 73 | |
| 74 | - foreach($ids as $id) |
|
| 74 | + foreach ($ids as $id) |
|
| 75 | 75 | { |
| 76 | 76 | $result[] = $this->getDummyCommand($id); |
| 77 | 77 | } |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | { |
| 97 | 97 | static $instances = array(); |
| 98 | 98 | |
| 99 | - if(!isset($instances[$id])) |
|
| 99 | + if (!isset($instances[$id])) |
|
| 100 | 100 | { |
| 101 | 101 | $instances[$id] = $this->createCommand($id, '__dummy', '', ''); |
| 102 | 102 | } |
@@ -117,9 +117,9 @@ discard block |
||
| 117 | 117 | { |
| 118 | 118 | $items = $this->getAll(); |
| 119 | 119 | |
| 120 | - foreach($items as $item) |
|
| 120 | + foreach ($items as $item) |
|
| 121 | 121 | { |
| 122 | - if($item->getName() === $name) { |
|
| 122 | + if ($item->getName() === $name) { |
|
| 123 | 123 | return $item->getID(); |
| 124 | 124 | } |
| 125 | 125 | } |
@@ -151,9 +151,9 @@ discard block |
||
| 151 | 151 | { |
| 152 | 152 | $items = $this->getAll(); |
| 153 | 153 | |
| 154 | - foreach($items as $item) |
|
| 154 | + foreach ($items as $item) |
|
| 155 | 155 | { |
| 156 | - if($item->getName() === $name) { |
|
| 156 | + if ($item->getName() === $name) { |
|
| 157 | 157 | return true; |
| 158 | 158 | } |
| 159 | 159 | } |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | { |
| 166 | 166 | $class = $this->resolveClassName($id, $type); |
| 167 | 167 | |
| 168 | - if(!class_exists($class)) |
|
| 168 | + if (!class_exists($class)) |
|
| 169 | 169 | { |
| 170 | 170 | throw new Mailcode_Exception( |
| 171 | 171 | 'No such command', |
@@ -187,9 +187,9 @@ discard block |
||
| 187 | 187 | |
| 188 | 188 | $dummy = $this->getDummyCommand($id); |
| 189 | 189 | |
| 190 | - if($dummy->supportsType()) |
|
| 190 | + if ($dummy->supportsType()) |
|
| 191 | 191 | { |
| 192 | - if(empty($type)) |
|
| 192 | + if (empty($type)) |
|
| 193 | 193 | { |
| 194 | 194 | $type = $dummy->getDefaultType(); |
| 195 | 195 | } |
@@ -209,13 +209,13 @@ discard block |
||
| 209 | 209 | */ |
| 210 | 210 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
| 211 | 211 | { |
| 212 | - if(!isset(self::$dummyCommands[$id])) |
|
| 212 | + if (!isset(self::$dummyCommands[$id])) |
|
| 213 | 213 | { |
| 214 | 214 | $class = 'Mailcode\Mailcode_Commands_Command_'.$id; |
| 215 | 215 | self::$dummyCommands[$id] = new $class('__dummy'); |
| 216 | 216 | } |
| 217 | 217 | |
| 218 | - if(self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
| 218 | + if (self::$dummyCommands[$id] instanceof Mailcode_Commands_Command) |
|
| 219 | 219 | { |
| 220 | 220 | return self::$dummyCommands[$id]; |
| 221 | 221 | } |
@@ -27,21 +27,21 @@ discard block |
||
| 27 | 27 | |
| 28 | 28 | const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Commands_Command[] |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Commands_Command[] |
|
| 32 | + */ |
|
| 33 | 33 | private $commands = array(); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string[]Mailcode_Commands_Command |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string[]Mailcode_Commands_Command |
|
| 37 | + */ |
|
| 38 | 38 | private static $dummyCommands = array(); |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Retrieves a list of all available command IDs. |
|
| 42 | - * |
|
| 43 | - * @return string[] |
|
| 44 | - */ |
|
| 40 | + /** |
|
| 41 | + * Retrieves a list of all available command IDs. |
|
| 42 | + * |
|
| 43 | + * @return string[] |
|
| 44 | + */ |
|
| 45 | 45 | public function getIDs() : array |
| 46 | 46 | { |
| 47 | 47 | static $ids = array(); |
@@ -54,13 +54,13 @@ discard block |
||
| 54 | 54 | return $ids; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Retrieves a list of all available commands, sorted by label. |
|
| 59 | - * |
|
| 60 | - * NOTE: These instances are only used for information purposes. |
|
| 61 | - * |
|
| 62 | - * @return Mailcode_Commands_Command[] |
|
| 63 | - */ |
|
| 57 | + /** |
|
| 58 | + * Retrieves a list of all available commands, sorted by label. |
|
| 59 | + * |
|
| 60 | + * NOTE: These instances are only used for information purposes. |
|
| 61 | + * |
|
| 62 | + * @return Mailcode_Commands_Command[] |
|
| 63 | + */ |
|
| 64 | 64 | public function getAll() |
| 65 | 65 | { |
| 66 | 66 | if(!empty($this->commands)) { |
@@ -86,12 +86,12 @@ discard block |
||
| 86 | 86 | return $result; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Gets an available command by its ID. |
|
| 91 | - * |
|
| 92 | - * @param string $id |
|
| 93 | - * @return Mailcode_Commands_Command |
|
| 94 | - */ |
|
| 89 | + /** |
|
| 90 | + * Gets an available command by its ID. |
|
| 91 | + * |
|
| 92 | + * @param string $id |
|
| 93 | + * @return Mailcode_Commands_Command |
|
| 94 | + */ |
|
| 95 | 95 | public function getByID(string $id) : Mailcode_Commands_Command |
| 96 | 96 | { |
| 97 | 97 | static $instances = array(); |
@@ -104,15 +104,15 @@ discard block |
||
| 104 | 104 | return $instances[$id]; |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Retrieves the ID of a command by its name. |
|
| 109 | - * |
|
| 110 | - * @param string $name |
|
| 111 | - * @throws Mailcode_Exception |
|
| 112 | - * @return string |
|
| 113 | - * |
|
| 114 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | - */ |
|
| 107 | + /** |
|
| 108 | + * Retrieves the ID of a command by its name. |
|
| 109 | + * |
|
| 110 | + * @param string $name |
|
| 111 | + * @throws Mailcode_Exception |
|
| 112 | + * @return string |
|
| 113 | + * |
|
| 114 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
| 115 | + */ |
|
| 116 | 116 | public function getIDByName(string $name) : string |
| 117 | 117 | { |
| 118 | 118 | $items = $this->getAll(); |
@@ -141,12 +141,12 @@ discard block |
||
| 141 | 141 | return in_array($id, $ids); |
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - /** |
|
| 145 | - * Checks wether the specified name exists. |
|
| 146 | - * |
|
| 147 | - * @param string $name For example: "showvar". |
|
| 148 | - * @return bool |
|
| 149 | - */ |
|
| 144 | + /** |
|
| 145 | + * Checks wether the specified name exists. |
|
| 146 | + * |
|
| 147 | + * @param string $name For example: "showvar". |
|
| 148 | + * @return bool |
|
| 149 | + */ |
|
| 150 | 150 | public function nameExists(string $name) : bool |
| 151 | 151 | { |
| 152 | 152 | $items = $this->getAll(); |
@@ -200,14 +200,14 @@ discard block |
||
| 200 | 200 | return $class; |
| 201 | 201 | } |
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * Translates the command type to the expected class naming scheme. |
|
| 205 | - * |
|
| 206 | - * Example: not-empty => NotEmpty |
|
| 207 | - * |
|
| 208 | - * @param string $type |
|
| 209 | - * @return string |
|
| 210 | - */ |
|
| 203 | + /** |
|
| 204 | + * Translates the command type to the expected class naming scheme. |
|
| 205 | + * |
|
| 206 | + * Example: not-empty => NotEmpty |
|
| 207 | + * |
|
| 208 | + * @param string $type |
|
| 209 | + * @return string |
|
| 210 | + */ |
|
| 211 | 211 | private function adjustTypeName(string $type) : string |
| 212 | 212 | { |
| 213 | 213 | $type = str_replace('-', ' ', $type); |
@@ -217,13 +217,13 @@ discard block |
||
| 217 | 217 | return $type; |
| 218 | 218 | } |
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Retrieves the dummy command of the specified type, which |
|
| 222 | - * is used to retrieve information on the command's capabilities. |
|
| 223 | - * |
|
| 224 | - * @param string $id |
|
| 225 | - * @return Mailcode_Commands_Command |
|
| 226 | - */ |
|
| 220 | + /** |
|
| 221 | + * Retrieves the dummy command of the specified type, which |
|
| 222 | + * is used to retrieve information on the command's capabilities. |
|
| 223 | + * |
|
| 224 | + * @param string $id |
|
| 225 | + * @return Mailcode_Commands_Command |
|
| 226 | + */ |
|
| 227 | 227 | private function getDummyCommand(string $id) : Mailcode_Commands_Command |
| 228 | 228 | { |
| 229 | 229 | if(!isset(self::$dummyCommands[$id])) |
@@ -20,9 +20,9 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Factory_CommandSets_Set |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var Mailcode_Factory_Instantiator |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var Mailcode_Factory_Instantiator |
|
| 25 | + */ |
|
| 26 | 26 | protected $instantiator; |
| 27 | 27 | |
| 28 | 28 | public function __construct() |
@@ -41,7 +41,7 @@ |
||
| 41 | 41 | |
| 42 | 42 | $this->instantiator->checkCommand($cmd); |
| 43 | 43 | |
| 44 | - if($cmd instanceof Mailcode_Commands_Command_End) |
|
| 44 | + if ($cmd instanceof Mailcode_Commands_Command_End) |
|
| 45 | 45 | { |
| 46 | 46 | return $cmd; |
| 47 | 47 | } |