@@ -22,19 +22,19 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class Mailcode_Parser_Statement_Info_Pruner |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var Mailcode_Parser_Statement_Info |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var Mailcode_Parser_Statement_Info |
|
| 27 | + */ |
|
| 28 | 28 | private $info; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var string[] |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var string[] |
|
| 32 | + */ |
|
| 33 | 33 | private $exclude = array(); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string[] |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string[] |
|
| 37 | + */ |
|
| 38 | 38 | private $classNames = array(); |
| 39 | 39 | |
| 40 | 40 | public function __construct(Mailcode_Parser_Statement_Info $info) |
@@ -74,12 +74,12 @@ discard block |
||
| 74 | 74 | return $this; |
| 75 | 75 | } |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Retrieves all tokens in the statement matching the |
|
| 79 | - * current criteria. |
|
| 80 | - * |
|
| 81 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 82 | - */ |
|
| 77 | + /** |
|
| 78 | + * Retrieves all tokens in the statement matching the |
|
| 79 | + * current criteria. |
|
| 80 | + * |
|
| 81 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 82 | + */ |
|
| 83 | 83 | public function getTokens() : array |
| 84 | 84 | { |
| 85 | 85 | $tokens = $this->info->getTokens(); |
@@ -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; |
@@ -28,9 +28,9 @@ discard block |
||
| 28 | 28 | use Mailcode_Traits_Commands_Validation_Variable; |
| 29 | 29 | use Mailcode_Traits_Commands_Validation_CaseSensitive; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 33 | + */ |
|
| 34 | 34 | protected $searchTerms = array(); |
| 35 | 35 | |
| 36 | 36 | protected function getValidations() : array |
@@ -66,10 +66,10 @@ discard block |
||
| 66 | 66 | } |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Retrieves all search terms. |
|
| 71 | - * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 72 | - */ |
|
| 69 | + /** |
|
| 70 | + * Retrieves all search terms. |
|
| 71 | + * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[] |
|
| 72 | + */ |
|
| 73 | 73 | public function getSearchTerms() : array |
| 74 | 74 | { |
| 75 | 75 | return $this->searchTerms; |
@@ -24,14 +24,14 @@ |
||
| 24 | 24 | */ |
| 25 | 25 | trait Mailcode_Traits_Commands_Validation_CaseSensitive |
| 26 | 26 | { |
| 27 | - /** |
|
| 28 | - * @var boolean |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var boolean |
|
| 29 | + */ |
|
| 30 | 30 | protected $caseInsensitive = false; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 34 | + */ |
|
| 35 | 35 | protected $caseToken; |
| 36 | 36 | |
| 37 | 37 | protected function validateSyntax_case_sensitive() : void |
@@ -20,9 +20,9 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | class Mailcode_Commands_Command_Comment extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | 26 | private $commentString = ''; |
| 27 | 27 | |
| 28 | 28 | protected function init() : void |
@@ -30,10 +30,10 @@ discard block |
||
| 30 | 30 | return $this->getSign(); |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Retrieves all known comparison operator signs. |
|
| 35 | - * @return string[] |
|
| 36 | - */ |
|
| 33 | + /** |
|
| 34 | + * Retrieves all known comparison operator signs. |
|
| 35 | + * @return string[] |
|
| 36 | + */ |
|
| 37 | 37 | public static function getComparisonSigns() : array |
| 38 | 38 | { |
| 39 | 39 | return array( |
@@ -46,10 +46,10 @@ discard block |
||
| 46 | 46 | ); |
| 47 | 47 | } |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Retrieves all known arithmetic operator signs. |
|
| 51 | - * @return string[] |
|
| 52 | - */ |
|
| 49 | + /** |
|
| 50 | + * Retrieves all known arithmetic operator signs. |
|
| 51 | + * @return string[] |
|
| 52 | + */ |
|
| 53 | 53 | public static function getArithmeticSigns() : array |
| 54 | 54 | { |
| 55 | 55 | return array( |
@@ -60,11 +60,11 @@ discard block |
||
| 60 | 60 | ); |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
| 65 | - * |
|
| 66 | - * @return bool |
|
| 67 | - */ |
|
| 63 | + /** |
|
| 64 | + * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
| 65 | + * |
|
| 66 | + * @return bool |
|
| 67 | + */ |
|
| 68 | 68 | public function isComparator() : bool |
| 69 | 69 | { |
| 70 | 70 | return |
@@ -76,11 +76,11 @@ discard block |
||
| 76 | 76 | $this->isSmallerOrEquals(); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
| 81 | - * |
|
| 82 | - * @return bool |
|
| 83 | - */ |
|
| 79 | + /** |
|
| 80 | + * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
| 81 | + * |
|
| 82 | + * @return bool |
|
| 83 | + */ |
|
| 84 | 84 | public function isCalculator() : bool |
| 85 | 85 | { |
| 86 | 86 | return |
@@ -27,19 +27,19 @@ |
||
| 27 | 27 | const VALIDATION_WRONG_KEYWORD = 49702; |
| 28 | 28 | const VALIDATION_VARIABLE_NAME_IS_THE_SAME = 49703; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 32 | + */ |
|
| 33 | 33 | private $loopVar; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 37 | + */ |
|
| 38 | 38 | private $sourceVar; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 42 | + */ |
|
| 43 | 43 | private $keyword; |
| 44 | 44 | |
| 45 | 45 | public function getName() : string |
@@ -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(); |
@@ -35,13 +35,13 @@ |
||
| 35 | 35 | } |
| 36 | 36 | } |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Resolves the string with which this location needs to be |
|
| 40 | - * replaced. |
|
| 41 | - * |
|
| 42 | - * @param Mailcode_Parser_Safeguard_Formatter_Location $location |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 38 | + /** |
|
| 39 | + * Resolves the string with which this location needs to be |
|
| 40 | + * replaced. |
|
| 41 | + * |
|
| 42 | + * @param Mailcode_Parser_Safeguard_Formatter_Location $location |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | 45 | private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string |
| 46 | 46 | { |
| 47 | 47 | if($location->requiresAdjustment()) |