@@ -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) |
@@ -24,7 +24,7 @@ |
||
24 | 24 | |
25 | 25 | public function getVariable() : Mailcode_Variables_Variable |
26 | 26 | { |
27 | - if($this->subject instanceof Mailcode_Variables_Variable) |
|
27 | + if ($this->subject instanceof Mailcode_Variables_Variable) |
|
28 | 28 | { |
29 | 29 | return $this->subject; |
30 | 30 | } |
@@ -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 |
@@ -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)); |
@@ -62,7 +62,9 @@ discard block |
||
62 | 62 | |
63 | 63 | public function if(string $condition, string $type='') : string |
64 | 64 | { |
65 | - return $this->command2string(Mailcode_Factory::if($condition, $type)); |
|
65 | + return $this->command2string(Mailcode_Factory::if($condition, $type) { |
|
66 | + ); |
|
67 | + } |
|
66 | 68 | } |
67 | 69 | |
68 | 70 | public function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
@@ -97,7 +99,9 @@ discard block |
||
97 | 99 | |
98 | 100 | public function elseIf(string $condition, string $type='') : string |
99 | 101 | { |
100 | - return $this->command2string(Mailcode_Factory::elseIf($condition, $type)); |
|
102 | + return $this->command2string(Mailcode_Factory::elseIf($condition, $type) { |
|
103 | + ); |
|
104 | + } |
|
101 | 105 | } |
102 | 106 | |
103 | 107 | public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
@@ -130,10 +134,12 @@ discard block |
||
130 | 134 | return $this->command2string(Mailcode_Factory::elseIfVarNotEqualsString($variable, $value)); |
131 | 135 | } |
132 | 136 | |
133 | - public function else() : string |
|
137 | + public function else { |
|
138 | + () : string |
|
134 | 139 | { |
135 | 140 | return $this->command2string(Mailcode_Factory::else()); |
136 | 141 | } |
142 | + } |
|
137 | 143 | |
138 | 144 | public function end() : string |
139 | 145 | { |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | * @param bool $highlighted |
33 | 33 | * @return Mailcode_Renderer |
34 | 34 | */ |
35 | - public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer |
|
35 | + public function setOutputHighlighted(bool $highlighted = true) : Mailcode_Renderer |
|
36 | 36 | { |
37 | 37 | $this->highlighted = $highlighted; |
38 | 38 | |
@@ -55,7 +55,7 @@ discard block |
||
55 | 55 | return $this->command2string(Mailcode_Factory::showSnippet($snippetName)); |
56 | 56 | } |
57 | 57 | |
58 | - public function setVar(string $variableName, string $value, bool $quoteValue=false) : string |
|
58 | + public function setVar(string $variableName, string $value, bool $quoteValue = false) : string |
|
59 | 59 | { |
60 | 60 | return $this->command2string(Mailcode_Factory::setVar($variableName, $value, $quoteValue)); |
61 | 61 | } |
@@ -65,12 +65,12 @@ discard block |
||
65 | 65 | return $this->command2string(Mailcode_Factory::setVarString($variableName, $value)); |
66 | 66 | } |
67 | 67 | |
68 | - public function if(string $condition, string $type='') : string |
|
68 | + public function if (string $condition, string $type = '') : string |
|
69 | 69 | { |
70 | - return $this->command2string(Mailcode_Factory::if($condition, $type)); |
|
70 | + return $this->command2string(Mailcode_Factory::if ($condition, $type)); |
|
71 | 71 | } |
72 | 72 | |
73 | - public function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
|
73 | + public function ifVar(string $variable, string $operand, string $value, bool $quoteValue = false) : string |
|
74 | 74 | { |
75 | 75 | return $this->command2string(Mailcode_Factory::ifVar($variable, $operand, $value, $quoteValue)); |
76 | 76 | } |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | return $this->command2string(Mailcode_Factory::ifVarString($variable, $operand, $value)); |
81 | 81 | } |
82 | 82 | |
83 | - public function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : string |
|
83 | + public function ifVarEquals(string $variable, string $value, bool $quoteValue = false) : string |
|
84 | 84 | { |
85 | 85 | return $this->command2string(Mailcode_Factory::ifVarEquals($variable, $value, $quoteValue)); |
86 | 86 | } |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | return $this->command2string(Mailcode_Factory::ifVarEqualsString($variable, $value)); |
91 | 91 | } |
92 | 92 | |
93 | - public function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string |
|
93 | + public function ifVarNotEquals(string $variable, string $value, bool $quoteValue = false) : string |
|
94 | 94 | { |
95 | 95 | return $this->command2string(Mailcode_Factory::ifVarNotEquals($variable, $value, $quoteValue)); |
96 | 96 | } |
@@ -100,12 +100,12 @@ discard block |
||
100 | 100 | return $this->command2string(Mailcode_Factory::ifVarNotEqualsString($variable, $value)); |
101 | 101 | } |
102 | 102 | |
103 | - public function elseIf(string $condition, string $type='') : string |
|
103 | + public function elseIf (string $condition, string $type = '') : string |
|
104 | 104 | { |
105 | - return $this->command2string(Mailcode_Factory::elseIf($condition, $type)); |
|
105 | + return $this->command2string(Mailcode_Factory::elseIf ($condition, $type)); |
|
106 | 106 | } |
107 | 107 | |
108 | - public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
|
108 | + public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue = false) : string |
|
109 | 109 | { |
110 | 110 | return $this->command2string(Mailcode_Factory::elseIfVar($variable, $operand, $value, $quoteValue)); |
111 | 111 | } |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | return $this->command2string(Mailcode_Factory::elseIfVarString($variable, $operand, $value)); |
116 | 116 | } |
117 | 117 | |
118 | - public function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : string |
|
118 | + public function elseIfVarEquals(string $variable, string $value, bool $quoteValue = false) : string |
|
119 | 119 | { |
120 | 120 | return $this->command2string(Mailcode_Factory::elseIfVarEquals($variable, $value, $quoteValue)); |
121 | 121 | } |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | return $this->command2string(Mailcode_Factory::elseIfVarEqualsString($variable, $value)); |
126 | 126 | } |
127 | 127 | |
128 | - public function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string |
|
128 | + public function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue = false) : string |
|
129 | 129 | { |
130 | 130 | return $this->command2string(Mailcode_Factory::elseIfVarNotEquals($variable, $value, $quoteValue)); |
131 | 131 | } |
@@ -152,7 +152,7 @@ discard block |
||
152 | 152 | |
153 | 153 | protected function command2string(Mailcode_Commands_Command $command) : string |
154 | 154 | { |
155 | - if($this->highlighted) |
|
155 | + if ($this->highlighted) |
|
156 | 156 | { |
157 | 157 | return $command->getHighlighted(); |
158 | 158 | } |
@@ -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(); |
@@ -24,9 +24,9 @@ discard block |
||
24 | 24 | { |
25 | 25 | const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301; |
26 | 26 | |
27 | - /** |
|
28 | - * @var Mailcode_Commands_Command[] |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var Mailcode_Commands_Command[] |
|
29 | + */ |
|
30 | 30 | protected $commands = array(); |
31 | 31 | |
32 | 32 | /** |
@@ -34,17 +34,17 @@ discard block |
||
34 | 34 | */ |
35 | 35 | protected $errors = array(); |
36 | 36 | |
37 | - /** |
|
38 | - * @var OperationResult|NULL |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var OperationResult|NULL |
|
39 | + */ |
|
40 | 40 | protected $validationResult; |
41 | 41 | |
42 | - /** |
|
43 | - * Adds a command to the collection. |
|
44 | - * |
|
45 | - * @param Mailcode_Commands_Command $command |
|
46 | - * @return Mailcode_Collection |
|
47 | - */ |
|
42 | + /** |
|
43 | + * Adds a command to the collection. |
|
44 | + * |
|
45 | + * @param Mailcode_Commands_Command $command |
|
46 | + * @return Mailcode_Collection |
|
47 | + */ |
|
48 | 48 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
49 | 49 | { |
50 | 50 | $this->commands[] = $command; |
@@ -56,21 +56,21 @@ discard block |
||
56 | 56 | return $this; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Whether there are any commands in the collection. |
|
61 | - * |
|
62 | - * @return bool |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Whether there are any commands in the collection. |
|
61 | + * |
|
62 | + * @return bool |
|
63 | + */ |
|
64 | 64 | public function hasCommands() : bool |
65 | 65 | { |
66 | 66 | return !empty($this->commands); |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Counts the amount of commands in the collection. |
|
71 | - * |
|
72 | - * @return int |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Counts the amount of commands in the collection. |
|
71 | + * |
|
72 | + * @return int |
|
73 | + */ |
|
74 | 74 | public function countCommands() : int |
75 | 75 | { |
76 | 76 | return count($this->commands); |
@@ -90,9 +90,9 @@ discard block |
||
90 | 90 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * @return Mailcode_Collection_Error[] |
|
95 | - */ |
|
93 | + /** |
|
94 | + * @return Mailcode_Collection_Error[] |
|
95 | + */ |
|
96 | 96 | public function getErrors() |
97 | 97 | { |
98 | 98 | $result = $this->getValidationResult(); |
@@ -134,25 +134,25 @@ discard block |
||
134 | 134 | return empty($errors); |
135 | 135 | } |
136 | 136 | |
137 | - /** |
|
138 | - * Retrieves all commands that were detected, in the exact order |
|
139 | - * they were found. |
|
140 | - * |
|
141 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | - */ |
|
137 | + /** |
|
138 | + * Retrieves all commands that were detected, in the exact order |
|
139 | + * they were found. |
|
140 | + * |
|
141 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
142 | + */ |
|
143 | 143 | public function getCommands() |
144 | 144 | { |
145 | - return $this->commands; |
|
145 | + return $this->commands; |
|
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Retrieves all unique commands by their matched |
|
150 | - * string hash: this ensures only commands that were |
|
151 | - * written the exact same way (including spacing) |
|
152 | - * are returned. |
|
153 | - * |
|
154 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Retrieves all unique commands by their matched |
|
150 | + * string hash: this ensures only commands that were |
|
151 | + * written the exact same way (including spacing) |
|
152 | + * are returned. |
|
153 | + * |
|
154 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
155 | + */ |
|
156 | 156 | public function getGroupedByHash() |
157 | 157 | { |
158 | 158 | $hashes = array(); |
@@ -170,12 +170,12 @@ discard block |
||
170 | 170 | return array_values($hashes); |
171 | 171 | } |
172 | 172 | |
173 | - /** |
|
174 | - * Adds several commands at once. |
|
175 | - * |
|
176 | - * @param Mailcode_Commands_Command[] $commands |
|
177 | - * @return Mailcode_Collection |
|
178 | - */ |
|
173 | + /** |
|
174 | + * Adds several commands at once. |
|
175 | + * |
|
176 | + * @param Mailcode_Commands_Command[] $commands |
|
177 | + * @return Mailcode_Collection |
|
178 | + */ |
|
179 | 179 | public function addCommands(array $commands) : Mailcode_Collection |
180 | 180 | { |
181 | 181 | foreach($commands as $command) |
@@ -234,11 +234,11 @@ discard block |
||
234 | 234 | return false; |
235 | 235 | } |
236 | 236 | |
237 | - /** |
|
238 | - * Retrieves only show variable commands in the collection, if any. |
|
239 | - * |
|
240 | - * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[] |
|
241 | - */ |
|
237 | + /** |
|
238 | + * Retrieves only show variable commands in the collection, if any. |
|
239 | + * |
|
240 | + * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[] |
|
241 | + */ |
|
242 | 242 | public function getShowVariableCommands() |
243 | 243 | { |
244 | 244 | $result = array(); |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | |
100 | 100 | $errors = $this->errors; |
101 | 101 | |
102 | - if(!$result->isValid()) |
|
102 | + if (!$result->isValid()) |
|
103 | 103 | { |
104 | 104 | $errors[] = new Mailcode_Collection_Error_Message( |
105 | 105 | '', |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | { |
116 | 116 | $errors = $this->getErrors(); |
117 | 117 | |
118 | - if(!empty($errors)) |
|
118 | + if (!empty($errors)) |
|
119 | 119 | { |
120 | 120 | return array_shift($errors); |
121 | 121 | } |
@@ -157,11 +157,11 @@ discard block |
||
157 | 157 | { |
158 | 158 | $hashes = array(); |
159 | 159 | |
160 | - foreach($this->commands as $command) |
|
160 | + foreach ($this->commands as $command) |
|
161 | 161 | { |
162 | 162 | $hash = $command->getHash(); |
163 | 163 | |
164 | - if(!isset($hashes[$hash])) |
|
164 | + if (!isset($hashes[$hash])) |
|
165 | 165 | { |
166 | 166 | $hashes[$hash] = $command; |
167 | 167 | } |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | */ |
179 | 179 | public function addCommands(array $commands) : Mailcode_Collection |
180 | 180 | { |
181 | - foreach($commands as $command) |
|
181 | + foreach ($commands as $command) |
|
182 | 182 | { |
183 | 183 | $this->addCommand($command); |
184 | 184 | } |
@@ -197,7 +197,7 @@ discard block |
||
197 | 197 | { |
198 | 198 | $collection = new Mailcode_Variables_Collection_Regular(); |
199 | 199 | |
200 | - foreach($this->commands as $command) |
|
200 | + foreach ($this->commands as $command) |
|
201 | 201 | { |
202 | 202 | $collection->mergeWith($command->getVariables()); |
203 | 203 | } |
@@ -207,7 +207,7 @@ discard block |
||
207 | 207 | |
208 | 208 | public function getValidationResult() : OperationResult |
209 | 209 | { |
210 | - if($this->validationResult instanceof OperationResult) |
|
210 | + if ($this->validationResult instanceof OperationResult) |
|
211 | 211 | { |
212 | 212 | return $this->validationResult; |
213 | 213 | } |
@@ -223,9 +223,9 @@ discard block |
||
223 | 223 | { |
224 | 224 | $errors = $this->getErrors(); |
225 | 225 | |
226 | - foreach($errors as $error) |
|
226 | + foreach ($errors as $error) |
|
227 | 227 | { |
228 | - if($error->getCode() === $code) |
|
228 | + if ($error->getCode() === $code) |
|
229 | 229 | { |
230 | 230 | return true; |
231 | 231 | } |
@@ -243,9 +243,9 @@ discard block |
||
243 | 243 | { |
244 | 244 | $result = array(); |
245 | 245 | |
246 | - foreach($this->commands as $command) |
|
246 | + foreach ($this->commands as $command) |
|
247 | 247 | { |
248 | - if($command instanceof Mailcode_Commands_Command_ShowVariable) |
|
248 | + if ($command instanceof Mailcode_Commands_Command_ShowVariable) |
|
249 | 249 | { |
250 | 250 | $result[] = $command; |
251 | 251 | } |
@@ -258,7 +258,7 @@ discard block |
||
258 | 258 | { |
259 | 259 | $commands = $this->getCommands(); |
260 | 260 | |
261 | - if(!empty($commands)) |
|
261 | + if (!empty($commands)) |
|
262 | 262 | { |
263 | 263 | return array_shift($commands); |
264 | 264 | } |
@@ -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,7 +101,7 @@ discard block |
||
101 | 101 | |
102 | 102 | $replaces = array(); |
103 | 103 | |
104 | - foreach($placeholders as $placeholder) |
|
104 | + foreach ($placeholders as $placeholder) |
|
105 | 105 | { |
106 | 106 | $replaces[$placeholder->getReplacementText()] = $this->translateCommand($placeholder->getCommand()); |
107 | 107 | } |