@@ -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) |
@@ -21,14 +21,14 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class Mailcode_Parser_Statement_Info |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var Mailcode_Parser_Statement_Tokenizer |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var Mailcode_Parser_Statement_Tokenizer |
|
| 26 | + */ |
|
| 27 | 27 | protected $tokenizer; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 31 | + */ |
|
| 32 | 32 | protected $tokens = array(); |
| 33 | 33 | |
| 34 | 34 | public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer) |
@@ -37,11 +37,11 @@ discard block |
||
| 37 | 37 | $this->tokens = $this->tokenizer->getTokens(); |
| 38 | 38 | } |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Whether the whole statement is a variable being assigned a value. |
|
| 42 | - * |
|
| 43 | - * @return bool |
|
| 44 | - */ |
|
| 40 | + /** |
|
| 41 | + * Whether the whole statement is a variable being assigned a value. |
|
| 42 | + * |
|
| 43 | + * @return bool |
|
| 44 | + */ |
|
| 45 | 45 | public function isVariableAssignment() : bool |
| 46 | 46 | { |
| 47 | 47 | $variable = $this->getVariableByIndex(0); |
@@ -56,11 +56,11 @@ discard block |
||
| 56 | 56 | return false; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Whether the whole statement is a variable being compared to something. |
|
| 61 | - * |
|
| 62 | - * @return bool |
|
| 63 | - */ |
|
| 59 | + /** |
|
| 60 | + * Whether the whole statement is a variable being compared to something. |
|
| 61 | + * |
|
| 62 | + * @return bool |
|
| 63 | + */ |
|
| 64 | 64 | public function isVariableComparison() : bool |
| 65 | 65 | { |
| 66 | 66 | $variable = $this->getVariableByIndex(0); |
@@ -75,11 +75,11 @@ discard block |
||
| 75 | 75 | return false; |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Retrieves all variables used in the statement. |
|
| 80 | - * |
|
| 81 | - * @return \Mailcode\Mailcode_Variables_Variable[] |
|
| 82 | - */ |
|
| 78 | + /** |
|
| 79 | + * Retrieves all variables used in the statement. |
|
| 80 | + * |
|
| 81 | + * @return \Mailcode\Mailcode_Variables_Variable[] |
|
| 82 | + */ |
|
| 83 | 83 | public function getVariables() |
| 84 | 84 | { |
| 85 | 85 | $result = array(); |
@@ -30,11 +30,11 @@ discard block |
||
| 30 | 30 | return $this->getOperand(); |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
| 35 | - * |
|
| 36 | - * @return bool |
|
| 37 | - */ |
|
| 33 | + /** |
|
| 34 | + * Whether the operator is comparison related (equals, not equals, smaller, greater...). |
|
| 35 | + * |
|
| 36 | + * @return bool |
|
| 37 | + */ |
|
| 38 | 38 | public function isComparator() : bool |
| 39 | 39 | { |
| 40 | 40 | return |
@@ -46,11 +46,11 @@ discard block |
||
| 46 | 46 | $this->isSmallerOrEquals(); |
| 47 | 47 | } |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
| 51 | - * |
|
| 52 | - * @return bool |
|
| 53 | - */ |
|
| 49 | + /** |
|
| 50 | + * Whether the operator is calculation related (minus, plus, divide, multiply). |
|
| 51 | + * |
|
| 52 | + * @return bool |
|
| 53 | + */ |
|
| 54 | 54 | public function isCalculator() : bool |
| 55 | 55 | { |
| 56 | 56 | return |
@@ -20,26 +20,26 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | abstract class Mailcode_Parser_Statement_Tokenizer_Token |
| 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; |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | { |
| 24 | 24 | const ERROR_TOKENIZE_METHOD_MISSING = 49801; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var string[] |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var string[] |
|
| 28 | + */ |
|
| 29 | 29 | protected $operands = array( |
| 30 | 30 | '==', |
| 31 | 31 | '<=', |
@@ -40,16 +40,16 @@ discard block |
||
| 40 | 40 | '<' |
| 41 | 41 | ); |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var string[] |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var string[] |
|
| 45 | + */ |
|
| 46 | 46 | protected $keywords = array( |
| 47 | 47 | 'in:' |
| 48 | 48 | ); |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $delimiter = '§§'; |
| 54 | 54 | |
| 55 | 55 | /** |
@@ -65,19 +65,19 @@ discard block |
||
| 65 | 65 | 'extract_tokens' |
| 66 | 66 | ); |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @var Mailcode_Parser_Statement |
|
| 70 | - */ |
|
| 68 | + /** |
|
| 69 | + * @var Mailcode_Parser_Statement |
|
| 70 | + */ |
|
| 71 | 71 | protected $statement; |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @var string |
|
| 75 | - */ |
|
| 73 | + /** |
|
| 74 | + * @var string |
|
| 75 | + */ |
|
| 76 | 76 | protected $tokenized; |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 80 | - */ |
|
| 78 | + /** |
|
| 79 | + * @var Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 80 | + */ |
|
| 81 | 81 | protected $tokensTemporary = array(); |
| 82 | 82 | |
| 83 | 83 | /** |
@@ -85,9 +85,9 @@ discard block |
||
| 85 | 85 | */ |
| 86 | 86 | protected $tokensOrdered = array(); |
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * @var string[] |
|
| 90 | - */ |
|
| 88 | + /** |
|
| 89 | + * @var string[] |
|
| 90 | + */ |
|
| 91 | 91 | protected static $ids = array(); |
| 92 | 92 | |
| 93 | 93 | public function __construct(Mailcode_Parser_Statement $statement) |
@@ -97,12 +97,12 @@ discard block |
||
| 97 | 97 | $this->tokenize($statement->getStatementString()); |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * Retrieves all tokens detected in the statement string, in |
|
| 102 | - * the order they were found. |
|
| 103 | - * |
|
| 104 | - * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 105 | - */ |
|
| 100 | + /** |
|
| 101 | + * Retrieves all tokens detected in the statement string, in |
|
| 102 | + * the order they were found. |
|
| 103 | + * |
|
| 104 | + * @return Mailcode_Parser_Statement_Tokenizer_Token[] |
|
| 105 | + */ |
|
| 106 | 106 | public function getTokens() |
| 107 | 107 | { |
| 108 | 108 | return $this->tokensOrdered; |
@@ -113,11 +113,11 @@ discard block |
||
| 113 | 113 | return !empty($this->tokensOrdered); |
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * Whether there were any unknown tokens in the statement. |
|
| 118 | - * |
|
| 119 | - * @return bool |
|
| 120 | - */ |
|
| 116 | + /** |
|
| 117 | + * Whether there were any unknown tokens in the statement. |
|
| 118 | + * |
|
| 119 | + * @return bool |
|
| 120 | + */ |
|
| 121 | 121 | public function hasUnknown() : bool |
| 122 | 122 | { |
| 123 | 123 | $unknown = $this->getUnknown(); |
@@ -125,11 +125,11 @@ discard block |
||
| 125 | 125 | return !empty($unknown); |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Retrieves all unknown content tokens, if any. |
|
| 130 | - * |
|
| 131 | - * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[] |
|
| 132 | - */ |
|
| 128 | + /** |
|
| 129 | + * Retrieves all unknown content tokens, if any. |
|
| 130 | + * |
|
| 131 | + * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[] |
|
| 132 | + */ |
|
| 133 | 133 | public function getUnknown() |
| 134 | 134 | { |
| 135 | 135 | $result = array(); |
@@ -199,13 +199,13 @@ discard block |
||
| 199 | 199 | } |
| 200 | 200 | } |
| 201 | 201 | |
| 202 | - /** |
|
| 203 | - * Registers a token to add in the statement string. |
|
| 204 | - * |
|
| 205 | - * @param string $type |
|
| 206 | - * @param string $matchedText |
|
| 207 | - * @param mixed $subject |
|
| 208 | - */ |
|
| 202 | + /** |
|
| 203 | + * Registers a token to add in the statement string. |
|
| 204 | + * |
|
| 205 | + * @param string $type |
|
| 206 | + * @param string $matchedText |
|
| 207 | + * @param mixed $subject |
|
| 208 | + */ |
|
| 209 | 209 | protected function registerToken(string $type, string $matchedText, $subject=null) : void |
| 210 | 210 | { |
| 211 | 211 | $tokenID = $this->generateID(); |
@@ -317,13 +317,13 @@ discard block |
||
| 317 | 317 | } |
| 318 | 318 | } |
| 319 | 319 | |
| 320 | - /** |
|
| 321 | - * Generates a unique alphabet-based ID without numbers |
|
| 322 | - * to use as token name, to avoid conflicts with the |
|
| 323 | - * numbers detection. |
|
| 324 | - * |
|
| 325 | - * @return string |
|
| 326 | - */ |
|
| 320 | + /** |
|
| 321 | + * Generates a unique alphabet-based ID without numbers |
|
| 322 | + * to use as token name, to avoid conflicts with the |
|
| 323 | + * numbers detection. |
|
| 324 | + * |
|
| 325 | + * @return string |
|
| 326 | + */ |
|
| 327 | 327 | protected function generateID() : string |
| 328 | 328 | { |
| 329 | 329 | static $alphas; |
@@ -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; |
@@ -30,53 +30,53 @@ discard block |
||
| 30 | 30 | const VALIDATION_UNKNOWN_COMMAND_NAME = 48304; |
| 31 | 31 | const VALIDATION_INVALID_PARAMS_STATEMENT = 48305; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | 36 | protected $type = ''; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var string |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var string |
|
| 40 | + */ |
|
| 41 | 41 | protected $paramsString = ''; |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var string |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var string |
|
| 45 | + */ |
|
| 46 | 46 | protected $matchedText = ''; |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * @var string |
|
| 50 | - */ |
|
| 48 | + /** |
|
| 49 | + * @var string |
|
| 50 | + */ |
|
| 51 | 51 | protected $hash = ''; |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * @var \AppUtils\OperationResult |
|
| 55 | - */ |
|
| 53 | + /** |
|
| 54 | + * @var \AppUtils\OperationResult |
|
| 55 | + */ |
|
| 56 | 56 | protected $validationResult = null; |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @var \Mailcode\Mailcode |
|
| 60 | - */ |
|
| 58 | + /** |
|
| 59 | + * @var \Mailcode\Mailcode |
|
| 60 | + */ |
|
| 61 | 61 | protected $mailcode; |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
| 65 | - */ |
|
| 63 | + /** |
|
| 64 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
| 65 | + */ |
|
| 66 | 66 | protected $params; |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @var string[] |
|
| 70 | - */ |
|
| 68 | + /** |
|
| 69 | + * @var string[] |
|
| 70 | + */ |
|
| 71 | 71 | protected $validations = array( |
| 72 | 72 | 'params', |
| 73 | 73 | 'type_supported', |
| 74 | 74 | 'type_unsupported' |
| 75 | 75 | ); |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * @var string |
|
| 79 | - */ |
|
| 77 | + /** |
|
| 78 | + * @var string |
|
| 79 | + */ |
|
| 80 | 80 | protected $comment = ''; |
| 81 | 81 | |
| 82 | 82 | public function __construct(string $type='', string $paramsString='', string $matchedText='') |
@@ -94,23 +94,23 @@ discard block |
||
| 94 | 94 | |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * @return string The ID of the command = the name of the command class file. |
|
| 99 | - */ |
|
| 97 | + /** |
|
| 98 | + * @return string The ID of the command = the name of the command class file. |
|
| 99 | + */ |
|
| 100 | 100 | public function getID() : string |
| 101 | 101 | { |
| 102 | 102 | $tokens = explode('_', get_class($this)); |
| 103 | 103 | return array_pop($tokens); |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Sets an optional comment that is not used anywhere, but |
|
| 108 | - * can be used by the application to track why a command is |
|
| 109 | - * used somewhere. |
|
| 110 | - * |
|
| 111 | - * @param string $comment |
|
| 112 | - * @return Mailcode_Commands_Command |
|
| 113 | - */ |
|
| 106 | + /** |
|
| 107 | + * Sets an optional comment that is not used anywhere, but |
|
| 108 | + * can be used by the application to track why a command is |
|
| 109 | + * used somewhere. |
|
| 110 | + * |
|
| 111 | + * @param string $comment |
|
| 112 | + * @return Mailcode_Commands_Command |
|
| 113 | + */ |
|
| 114 | 114 | public function setComment(string $comment) : Mailcode_Commands_Command |
| 115 | 115 | { |
| 116 | 116 | $this->comment = $comment; |
@@ -118,34 +118,34 @@ discard block |
||
| 118 | 118 | return $this; |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Retrieves the previously set comment, if any. |
|
| 123 | - * |
|
| 124 | - * @return string |
|
| 125 | - */ |
|
| 121 | + /** |
|
| 122 | + * Retrieves the previously set comment, if any. |
|
| 123 | + * |
|
| 124 | + * @return string |
|
| 125 | + */ |
|
| 126 | 126 | public function getComment() : string |
| 127 | 127 | { |
| 128 | 128 | return $this->comment; |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Checks whether this is a dummy command, which is only |
|
| 133 | - * used to access information on the command type. It cannot |
|
| 134 | - * be used as an actual live command. |
|
| 135 | - * |
|
| 136 | - * @return bool |
|
| 137 | - */ |
|
| 131 | + /** |
|
| 132 | + * Checks whether this is a dummy command, which is only |
|
| 133 | + * used to access information on the command type. It cannot |
|
| 134 | + * be used as an actual live command. |
|
| 135 | + * |
|
| 136 | + * @return bool |
|
| 137 | + */ |
|
| 138 | 138 | public function isDummy() : bool |
| 139 | 139 | { |
| 140 | 140 | return $this->type === '__dummy'; |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Retrieves a hash of the actual matched command string, |
|
| 145 | - * which is used in collections to detect duplicate commands. |
|
| 146 | - * |
|
| 147 | - * @return string |
|
| 148 | - */ |
|
| 143 | + /** |
|
| 144 | + * Retrieves a hash of the actual matched command string, |
|
| 145 | + * which is used in collections to detect duplicate commands. |
|
| 146 | + * |
|
| 147 | + * @return string |
|
| 148 | + */ |
|
| 149 | 149 | public function getHash() : string |
| 150 | 150 | { |
| 151 | 151 | $this->requireNonDummy(); |
@@ -237,9 +237,9 @@ discard block |
||
| 237 | 237 | } |
| 238 | 238 | } |
| 239 | 239 | |
| 240 | - /** |
|
| 241 | - * @return string[] |
|
| 242 | - */ |
|
| 240 | + /** |
|
| 241 | + * @return string[] |
|
| 242 | + */ |
|
| 243 | 243 | abstract protected function getValidations() : array; |
| 244 | 244 | |
| 245 | 245 | protected function validateSyntax_params() : void |
@@ -394,22 +394,22 @@ discard block |
||
| 394 | 394 | return implode('', $parts); |
| 395 | 395 | } |
| 396 | 396 | |
| 397 | - /** |
|
| 398 | - * Retrieves the names of all the command's supported types: the part |
|
| 399 | - * between the command name and the colon. Example: {command type: params}. |
|
| 400 | - * |
|
| 401 | - * @return string[] |
|
| 402 | - */ |
|
| 397 | + /** |
|
| 398 | + * Retrieves the names of all the command's supported types: the part |
|
| 399 | + * between the command name and the colon. Example: {command type: params}. |
|
| 400 | + * |
|
| 401 | + * @return string[] |
|
| 402 | + */ |
|
| 403 | 403 | public function getSupportedTypes() : array |
| 404 | 404 | { |
| 405 | 405 | return array(); |
| 406 | 406 | } |
| 407 | 407 | |
| 408 | - /** |
|
| 409 | - * Retrieves all variable names used in the command. |
|
| 410 | - * |
|
| 411 | - * @return Mailcode_Variables_Collection_Regular |
|
| 412 | - */ |
|
| 408 | + /** |
|
| 409 | + * Retrieves all variable names used in the command. |
|
| 410 | + * |
|
| 411 | + * @return Mailcode_Variables_Collection_Regular |
|
| 412 | + */ |
|
| 413 | 413 | public function getVariables() : Mailcode_Variables_Collection_Regular |
| 414 | 414 | { |
| 415 | 415 | return Mailcode::create()->findVariables($this->paramsString); |
@@ -21,17 +21,17 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class Mailcode_Renderer |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var boolean |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var boolean |
|
| 26 | + */ |
|
| 27 | 27 | protected $highlighted = false; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Sets whether to output highlighted commands instead of the default plain text. |
|
| 31 | - * |
|
| 32 | - * @param bool $highlighted |
|
| 33 | - * @return Mailcode_Renderer |
|
| 34 | - */ |
|
| 29 | + /** |
|
| 30 | + * Sets whether to output highlighted commands instead of the default plain text. |
|
| 31 | + * |
|
| 32 | + * @param bool $highlighted |
|
| 33 | + * @return Mailcode_Renderer |
|
| 34 | + */ |
|
| 35 | 35 | public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer |
| 36 | 36 | { |
| 37 | 37 | $this->highlighted = $highlighted; |
@@ -39,12 +39,12 @@ discard block |
||
| 39 | 39 | return $this; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Converts a show variable command to string. |
|
| 44 | - * |
|
| 45 | - * @param string $variableName The variable name, with or without $ sign. |
|
| 46 | - * @return string |
|
| 47 | - */ |
|
| 42 | + /** |
|
| 43 | + * Converts a show variable command to string. |
|
| 44 | + * |
|
| 45 | + * @param string $variableName The variable name, with or without $ sign. |
|
| 46 | + * @return string |
|
| 47 | + */ |
|
| 48 | 48 | public function showVar(string $variableName) : string |
| 49 | 49 | { |
| 50 | 50 | return $this->command2string(Mailcode_Factory::showVar($variableName)); |
@@ -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(); |