@@ -35,14 +35,14 @@ |
||
35 | 35 | |
36 | 36 | protected function validateSyntax_type_supported() : void |
37 | 37 | { |
38 | - if(!$this->supportsType() || empty($this->type)) |
|
38 | + if (!$this->supportsType() || empty($this->type)) |
|
39 | 39 | { |
40 | 40 | return; |
41 | 41 | } |
42 | 42 | |
43 | 43 | $types = $this->getSupportedTypes(); |
44 | 44 | |
45 | - if(!in_array($this->type, $types)) |
|
45 | + if (!in_array($this->type, $types)) |
|
46 | 46 | { |
47 | 47 | $this->validationResult->makeError( |
48 | 48 | t('The command addon %1$s is not supported.', $this->type).' '. |
@@ -31,14 +31,14 @@ |
||
31 | 31 | |
32 | 32 | protected function validateSyntax_params_keywords() : void |
33 | 33 | { |
34 | - if(!$this->supportsLogicKeywords()) |
|
34 | + if (!$this->supportsLogicKeywords()) |
|
35 | 35 | { |
36 | 36 | return; |
37 | 37 | } |
38 | 38 | |
39 | 39 | $this->logicKeywords = new Mailcode_Commands_LogicKeywords($this, $this->paramsString); |
40 | 40 | |
41 | - if(!$this->logicKeywords->isValid()) |
|
41 | + if (!$this->logicKeywords->isValid()) |
|
42 | 42 | { |
43 | 43 | $this->validationResult->makeError( |
44 | 44 | t('Invalid parameters:').' '.$this->logicKeywords->getErrorMessage(), |
@@ -30,7 +30,7 @@ |
||
30 | 30 | |
31 | 31 | protected function validateSyntax_type_unsupported() : void |
32 | 32 | { |
33 | - if($this->supportsType() || empty($this->type)) |
|
33 | + if ($this->supportsType() || empty($this->type)) |
|
34 | 34 | { |
35 | 35 | return; |
36 | 36 | } |
@@ -20,11 +20,11 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Factory_CommandSets_Set_Set extends Mailcode_Factory_CommandSets_Set |
22 | 22 | { |
23 | - public function var(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable |
|
23 | + public function var(string $variableName, string $value, bool $quoteValue = true) : Mailcode_Commands_Command_SetVariable |
|
24 | 24 | { |
25 | 25 | $variableName = $this->instantiator->filterVariableName($variableName); |
26 | 26 | |
27 | - if($quoteValue) |
|
27 | + if ($quoteValue) |
|
28 | 28 | { |
29 | 29 | $value = $this->instantiator->quoteString($value); |
30 | 30 | } |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | |
41 | 41 | $this->instantiator->checkCommand($cmd); |
42 | 42 | |
43 | - if($cmd instanceof Mailcode_Commands_Command_SetVariable) |
|
43 | + if ($cmd instanceof Mailcode_Commands_Command_SetVariable) |
|
44 | 44 | { |
45 | 45 | return $cmd; |
46 | 46 | } |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | * |
54 | 54 | * @return Mailcode_Factory_CommandSets_Set_If |
55 | 55 | */ |
56 | - public static function if() : Mailcode_Factory_CommandSets_Set_If |
|
56 | + public static function if () : Mailcode_Factory_CommandSets_Set_If |
|
57 | 57 | { |
58 | 58 | return self::$commandSets->if(); |
59 | 59 | } |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | * |
64 | 64 | * @return Mailcode_Factory_CommandSets_Set_ElseIf |
65 | 65 | */ |
66 | - public static function elseIf() : Mailcode_Factory_CommandSets_Set_ElseIf |
|
66 | + public static function elseIf () : Mailcode_Factory_CommandSets_Set_ElseIf |
|
67 | 67 | { |
68 | 68 | return self::$commandSets->elseIf(); |
69 | 69 | } |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | |
114 | 114 | public static function init() : void |
115 | 115 | { |
116 | - if(!isset(self::$commandSets)) |
|
116 | + if (!isset(self::$commandSets)) |
|
117 | 117 | { |
118 | 118 | self::$commandSets = new Mailcode_Factory_CommandSets(); |
119 | 119 | } |
@@ -28,8 +28,8 @@ discard block |
||
28 | 28 | const URL_ENCODING_DECODE = 'decode'; |
29 | 29 | |
30 | 30 | /** |
31 | - * @var Mailcode_Factory_CommandSets |
|
32 | - */ |
|
31 | + * @var Mailcode_Factory_CommandSets |
|
32 | + */ |
|
33 | 33 | private static $commandSets; |
34 | 34 | |
35 | 35 | /** |
@@ -83,33 +83,33 @@ discard block |
||
83 | 83 | } |
84 | 84 | |
85 | 85 | /** |
86 | - * Creates a renderer instance, which can be used to easily |
|
87 | - * create and convert commands to strings. |
|
88 | - * |
|
89 | - * @return Mailcode_Renderer |
|
90 | - */ |
|
86 | + * Creates a renderer instance, which can be used to easily |
|
87 | + * create and convert commands to strings. |
|
88 | + * |
|
89 | + * @return Mailcode_Renderer |
|
90 | + */ |
|
91 | 91 | public static function createRenderer() : Mailcode_Renderer |
92 | 92 | { |
93 | 93 | return new Mailcode_Renderer(); |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Creates a printer instance, which works like the renderer, |
|
98 | - * but outputs the generated strings to standard output. |
|
99 | - * |
|
100 | - * @return Mailcode_Printer |
|
101 | - */ |
|
96 | + /** |
|
97 | + * Creates a printer instance, which works like the renderer, |
|
98 | + * but outputs the generated strings to standard output. |
|
99 | + * |
|
100 | + * @return Mailcode_Printer |
|
101 | + */ |
|
102 | 102 | public static function createPrinter() : Mailcode_Printer |
103 | 103 | { |
104 | 104 | return new Mailcode_Printer(); |
105 | 105 | } |
106 | 106 | |
107 | - /** |
|
108 | - * Gets/creates the global instance of the date format info |
|
109 | - * class, used to handle date formatting aspects. |
|
110 | - * |
|
111 | - * @return Mailcode_Date_FormatInfo |
|
112 | - */ |
|
107 | + /** |
|
108 | + * Gets/creates the global instance of the date format info |
|
109 | + * class, used to handle date formatting aspects. |
|
110 | + * |
|
111 | + * @return Mailcode_Date_FormatInfo |
|
112 | + */ |
|
113 | 113 | public static function createDateInfo() : Mailcode_Date_FormatInfo |
114 | 114 | { |
115 | 115 | return Mailcode_Date_FormatInfo::getInstance(); |
@@ -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::show()->var($variableName)); |
@@ -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::show()->snippet($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::set()->var($variableName, $value, $quoteValue)); |
61 | 61 | } |
@@ -65,79 +65,79 @@ discard block |
||
65 | 65 | return $this->command2string(Mailcode_Factory::set()->varString($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()->if($condition, $type)); |
|
70 | + return $this->command2string(Mailcode_Factory::if ()->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 | - return $this->command2string(Mailcode_Factory::if()->var($variable, $operand, $value, $quoteValue)); |
|
75 | + return $this->command2string(Mailcode_Factory::if ()->var($variable, $operand, $value, $quoteValue)); |
|
76 | 76 | } |
77 | 77 | |
78 | 78 | public function ifVarString(string $variable, string $operand, string $value) : string |
79 | 79 | { |
80 | - return $this->command2string(Mailcode_Factory::if()->varString($variable, $operand, $value)); |
|
80 | + return $this->command2string(Mailcode_Factory::if ()->varString($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 | - return $this->command2string(Mailcode_Factory::if()->varEquals($variable, $value, $quoteValue)); |
|
85 | + return $this->command2string(Mailcode_Factory::if ()->varEquals($variable, $value, $quoteValue)); |
|
86 | 86 | } |
87 | 87 | |
88 | 88 | public function ifVarEqualsString(string $variable, string $value) : string |
89 | 89 | { |
90 | - return $this->command2string(Mailcode_Factory::if()->varEqualsString($variable, $value)); |
|
90 | + return $this->command2string(Mailcode_Factory::if ()->varEqualsString($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 | - return $this->command2string(Mailcode_Factory::if()->varNotEquals($variable, $value, $quoteValue)); |
|
95 | + return $this->command2string(Mailcode_Factory::if ()->varNotEquals($variable, $value, $quoteValue)); |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | public function ifVarNotEqualsString(string $variable, string $value) : string |
99 | 99 | { |
100 | - return $this->command2string(Mailcode_Factory::if()->varNotEqualsString($variable, $value)); |
|
100 | + return $this->command2string(Mailcode_Factory::if ()->varNotEqualsString($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()->elseIf($condition, $type)); |
|
105 | + return $this->command2string(Mailcode_Factory::elseIf ()->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 | - return $this->command2string(Mailcode_Factory::elseIf()->var($variable, $operand, $value, $quoteValue)); |
|
110 | + return $this->command2string(Mailcode_Factory::elseIf ()->var($variable, $operand, $value, $quoteValue)); |
|
111 | 111 | } |
112 | 112 | |
113 | 113 | public function elseIfVarString(string $variable, string $operand, string $value) : string |
114 | 114 | { |
115 | - return $this->command2string(Mailcode_Factory::elseIf()->varString($variable, $operand, $value)); |
|
115 | + return $this->command2string(Mailcode_Factory::elseIf ()->varString($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 | - return $this->command2string(Mailcode_Factory::elseIf()->varEquals($variable, $value, $quoteValue)); |
|
120 | + return $this->command2string(Mailcode_Factory::elseIf ()->varEquals($variable, $value, $quoteValue)); |
|
121 | 121 | } |
122 | 122 | |
123 | 123 | public function elseIfVarEqualsString(string $variable, string $value) : string |
124 | 124 | { |
125 | - return $this->command2string(Mailcode_Factory::elseIf()->varEqualsString($variable, $value)); |
|
125 | + return $this->command2string(Mailcode_Factory::elseIf ()->varEqualsString($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 | - return $this->command2string(Mailcode_Factory::elseIf()->varNotEquals($variable, $value, $quoteValue)); |
|
130 | + return $this->command2string(Mailcode_Factory::elseIf ()->varNotEquals($variable, $value, $quoteValue)); |
|
131 | 131 | } |
132 | 132 | |
133 | 133 | public function elseIfVarNotEqualsString(string $variable, string $value) : string |
134 | 134 | { |
135 | - return $this->command2string(Mailcode_Factory::elseIf()->varNotEqualsString($variable, $value)); |
|
135 | + return $this->command2string(Mailcode_Factory::elseIf ()->varNotEqualsString($variable, $value)); |
|
136 | 136 | } |
137 | 137 | |
138 | 138 | public function else() : string |
139 | 139 | { |
140 | - return $this->command2string(Mailcode_Factory::elseIf()->else()); |
|
140 | + return $this->command2string(Mailcode_Factory::elseIf ()->else()); |
|
141 | 141 | } |
142 | 142 | |
143 | 143 | public function end() : string |
@@ -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 | } |
@@ -67,78 +67,108 @@ |
||
67 | 67 | |
68 | 68 | public function if(string $condition, string $type='') : string |
69 | 69 | { |
70 | - return $this->command2string(Mailcode_Factory::if()->if($condition, $type)); |
|
70 | + return $this->command2string(Mailcode_Factory::if() { |
|
71 | + ->if($condition, $type)); |
|
72 | + } |
|
71 | 73 | } |
72 | 74 | |
73 | 75 | public function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
74 | 76 | { |
75 | - return $this->command2string(Mailcode_Factory::if()->var($variable, $operand, $value, $quoteValue)); |
|
77 | + return $this->command2string(Mailcode_Factory::if() { |
|
78 | + ->var($variable, $operand, $value, $quoteValue)); |
|
79 | + } |
|
76 | 80 | } |
77 | 81 | |
78 | 82 | public function ifVarString(string $variable, string $operand, string $value) : string |
79 | 83 | { |
80 | - return $this->command2string(Mailcode_Factory::if()->varString($variable, $operand, $value)); |
|
84 | + return $this->command2string(Mailcode_Factory::if() { |
|
85 | + ->varString($variable, $operand, $value)); |
|
86 | + } |
|
81 | 87 | } |
82 | 88 | |
83 | 89 | public function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : string |
84 | 90 | { |
85 | - return $this->command2string(Mailcode_Factory::if()->varEquals($variable, $value, $quoteValue)); |
|
91 | + return $this->command2string(Mailcode_Factory::if() { |
|
92 | + ->varEquals($variable, $value, $quoteValue)); |
|
93 | + } |
|
86 | 94 | } |
87 | 95 | |
88 | 96 | public function ifVarEqualsString(string $variable, string $value) : string |
89 | 97 | { |
90 | - return $this->command2string(Mailcode_Factory::if()->varEqualsString($variable, $value)); |
|
98 | + return $this->command2string(Mailcode_Factory::if() { |
|
99 | + ->varEqualsString($variable, $value)); |
|
100 | + } |
|
91 | 101 | } |
92 | 102 | |
93 | 103 | public function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string |
94 | 104 | { |
95 | - return $this->command2string(Mailcode_Factory::if()->varNotEquals($variable, $value, $quoteValue)); |
|
105 | + return $this->command2string(Mailcode_Factory::if() { |
|
106 | + ->varNotEquals($variable, $value, $quoteValue)); |
|
107 | + } |
|
96 | 108 | } |
97 | 109 | |
98 | 110 | public function ifVarNotEqualsString(string $variable, string $value) : string |
99 | 111 | { |
100 | - return $this->command2string(Mailcode_Factory::if()->varNotEqualsString($variable, $value)); |
|
112 | + return $this->command2string(Mailcode_Factory::if() { |
|
113 | + ->varNotEqualsString($variable, $value)); |
|
114 | + } |
|
101 | 115 | } |
102 | 116 | |
103 | 117 | public function elseIf(string $condition, string $type='') : string |
104 | 118 | { |
105 | - return $this->command2string(Mailcode_Factory::elseIf()->elseIf($condition, $type)); |
|
119 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
120 | + ->elseIf($condition, $type)); |
|
121 | + } |
|
106 | 122 | } |
107 | 123 | |
108 | 124 | public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string |
109 | 125 | { |
110 | - return $this->command2string(Mailcode_Factory::elseIf()->var($variable, $operand, $value, $quoteValue)); |
|
126 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
127 | + ->var($variable, $operand, $value, $quoteValue)); |
|
128 | + } |
|
111 | 129 | } |
112 | 130 | |
113 | 131 | public function elseIfVarString(string $variable, string $operand, string $value) : string |
114 | 132 | { |
115 | - return $this->command2string(Mailcode_Factory::elseIf()->varString($variable, $operand, $value)); |
|
133 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
134 | + ->varString($variable, $operand, $value)); |
|
135 | + } |
|
116 | 136 | } |
117 | 137 | |
118 | 138 | public function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : string |
119 | 139 | { |
120 | - return $this->command2string(Mailcode_Factory::elseIf()->varEquals($variable, $value, $quoteValue)); |
|
140 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
141 | + ->varEquals($variable, $value, $quoteValue)); |
|
142 | + } |
|
121 | 143 | } |
122 | 144 | |
123 | 145 | public function elseIfVarEqualsString(string $variable, string $value) : string |
124 | 146 | { |
125 | - return $this->command2string(Mailcode_Factory::elseIf()->varEqualsString($variable, $value)); |
|
147 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
148 | + ->varEqualsString($variable, $value)); |
|
149 | + } |
|
126 | 150 | } |
127 | 151 | |
128 | 152 | public function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string |
129 | 153 | { |
130 | - return $this->command2string(Mailcode_Factory::elseIf()->varNotEquals($variable, $value, $quoteValue)); |
|
154 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
155 | + ->varNotEquals($variable, $value, $quoteValue)); |
|
156 | + } |
|
131 | 157 | } |
132 | 158 | |
133 | 159 | public function elseIfVarNotEqualsString(string $variable, string $value) : string |
134 | 160 | { |
135 | - return $this->command2string(Mailcode_Factory::elseIf()->varNotEqualsString($variable, $value)); |
|
161 | + return $this->command2string(Mailcode_Factory::elseIf() { |
|
162 | + ->varNotEqualsString($variable, $value)); |
|
163 | + } |
|
136 | 164 | } |
137 | 165 | |
138 | - public function else() : string |
|
166 | + public function else { |
|
167 | + () : string |
|
139 | 168 | { |
140 | 169 | return $this->command2string(Mailcode_Factory::elseIf()->else()); |
141 | 170 | } |
171 | + } |
|
142 | 172 | |
143 | 173 | public function end() : string |
144 | 174 | { |
@@ -176,27 +176,27 @@ |
||
176 | 176 | * @return array<string,string> |
177 | 177 | * @throws Mailcode_Exception |
178 | 178 | */ |
179 | - private function parseVarName() : array |
|
180 | - { |
|
181 | - $tokens = explode('.', ltrim($this->variable->getFullName(), '$')); |
|
182 | - |
|
183 | - if(count($tokens) === 2) |
|
184 | - { |
|
185 | - return array( |
|
186 | - 'path' => $tokens[0], |
|
187 | - 'name' => $tokens[1] |
|
188 | - ); |
|
189 | - } |
|
190 | - |
|
191 | - throw new Mailcode_Exception( |
|
192 | - 'Invalid variable name for a list property.', |
|
193 | - sprintf( |
|
194 | - 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
195 | - $this->variable->getFullName(), |
|
196 | - count($tokens) |
|
197 | - ), |
|
198 | - self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
199 | - ); |
|
200 | - } |
|
179 | + private function parseVarName() : array |
|
180 | + { |
|
181 | + $tokens = explode('.', ltrim($this->variable->getFullName(), '$')); |
|
182 | + |
|
183 | + if(count($tokens) === 2) |
|
184 | + { |
|
185 | + return array( |
|
186 | + 'path' => $tokens[0], |
|
187 | + 'name' => $tokens[1] |
|
188 | + ); |
|
189 | + } |
|
190 | + |
|
191 | + throw new Mailcode_Exception( |
|
192 | + 'Invalid variable name for a list property.', |
|
193 | + sprintf( |
|
194 | + 'Exactly 2 parts are required, variable [%s] has [%s].', |
|
195 | + $this->variable->getFullName(), |
|
196 | + count($tokens) |
|
197 | + ), |
|
198 | + self::ERROR_INVALID_LIST_VARIABLE_NAME |
|
199 | + ); |
|
200 | + } |
|
201 | 201 | } |
202 | 202 |
@@ -120,8 +120,7 @@ |
||
120 | 120 | if($this->isList()) |
121 | 121 | { |
122 | 122 | $command = $this->renderListCommand($searchTerm); |
123 | - } |
|
124 | - else |
|
123 | + } else |
|
125 | 124 | { |
126 | 125 | $command = $this->renderRegularCommand($searchTerm); |
127 | 126 | } |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | */ |
85 | 85 | public function getSign() : string |
86 | 86 | { |
87 | - if($this->isNotContains()) |
|
87 | + if ($this->isNotContains()) |
|
88 | 88 | { |
89 | 89 | return '!'; |
90 | 90 | } |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | */ |
102 | 102 | public function getConnector() |
103 | 103 | { |
104 | - if($this->isNotContains()) |
|
104 | + if ($this->isNotContains()) |
|
105 | 105 | { |
106 | 106 | return '&&'; |
107 | 107 | } |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | { |
118 | 118 | $parts = array(); |
119 | 119 | |
120 | - foreach($this->searchTerms as $token) |
|
120 | + foreach ($this->searchTerms as $token) |
|
121 | 121 | { |
122 | 122 | $parts[] = $this->renderCommand($token); |
123 | 123 | } |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | */ |
133 | 133 | private function renderCommand(Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral $searchTerm) : string |
134 | 134 | { |
135 | - if($this->isList()) |
|
135 | + if ($this->isList()) |
|
136 | 136 | { |
137 | 137 | $command = $this->renderListCommand($searchTerm); |
138 | 138 | } |
@@ -173,14 +173,14 @@ discard block |
||
173 | 173 | private function renderRegex(Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral $searchTerm) : string |
174 | 174 | { |
175 | 175 | $opts = 's'; |
176 | - if($this->caseSensitive) |
|
176 | + if ($this->caseSensitive) |
|
177 | 177 | { |
178 | 178 | $opts = 'is'; |
179 | 179 | } |
180 | 180 | |
181 | 181 | $filtered = trim($searchTerm->getNormalized(), '"'); |
182 | 182 | |
183 | - if(!$this->regexEnabled) |
|
183 | + if (!$this->regexEnabled) |
|
184 | 184 | { |
185 | 185 | $filtered = $this->translator->filterRegexString($filtered); |
186 | 186 | $filtered = $this->addWildcards($filtered); |
@@ -203,17 +203,17 @@ discard block |
||
203 | 203 | */ |
204 | 204 | private function addWildcards(string $searchTerm) : string |
205 | 205 | { |
206 | - if($this->containsType === 'list-begins-with') |
|
206 | + if ($this->containsType === 'list-begins-with') |
|
207 | 207 | { |
208 | 208 | return $searchTerm.'.*'; |
209 | 209 | } |
210 | 210 | |
211 | - if($this->containsType === 'list-ends-with') |
|
211 | + if ($this->containsType === 'list-ends-with') |
|
212 | 212 | { |
213 | 213 | return '.*'.$searchTerm; |
214 | 214 | } |
215 | 215 | |
216 | - if($this->containsType === 'list-equals') |
|
216 | + if ($this->containsType === 'list-equals') |
|
217 | 217 | { |
218 | 218 | return '\\\A'.$searchTerm.'\\\Z'; |
219 | 219 | } |
@@ -229,7 +229,7 @@ discard block |
||
229 | 229 | { |
230 | 230 | $tokens = explode('.', ltrim($this->variable->getFullName(), '$')); |
231 | 231 | |
232 | - if(count($tokens) === 2) |
|
232 | + if (count($tokens) === 2) |
|
233 | 233 | { |
234 | 234 | return array( |
235 | 235 | 'path' => $tokens[0], |
@@ -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)) |
@@ -129,12 +129,12 @@ discard block |
||
129 | 129 | return $this->variables; |
130 | 130 | } |
131 | 131 | |
132 | - /** |
|
133 | - * Creates the translator, which can be used to convert commands |
|
134 | - * to another supported syntax. |
|
135 | - * |
|
136 | - * @return Mailcode_Translator |
|
137 | - */ |
|
132 | + /** |
|
133 | + * Creates the translator, which can be used to convert commands |
|
134 | + * to another supported syntax. |
|
135 | + * |
|
136 | + * @return Mailcode_Translator |
|
137 | + */ |
|
138 | 138 | public function createTranslator() : Mailcode_Translator |
139 | 139 | { |
140 | 140 | if(!isset($this->translator)) |
@@ -145,12 +145,12 @@ discard block |
||
145 | 145 | return $this->translator; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Creates the styler, which can be used to retrieve the |
|
150 | - * CSS required to style the highlighted commands in HTML. |
|
151 | - * |
|
152 | - * @return Mailcode_Styler |
|
153 | - */ |
|
148 | + /** |
|
149 | + * Creates the styler, which can be used to retrieve the |
|
150 | + * CSS required to style the highlighted commands in HTML. |
|
151 | + * |
|
152 | + * @return Mailcode_Styler |
|
153 | + */ |
|
154 | 154 | public function createStyler() : Mailcode_Styler |
155 | 155 | { |
156 | 156 | return new Mailcode_Styler(); |
@@ -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 | } |
@@ -114,14 +114,14 @@ discard block |
||
114 | 114 | * @param Mailcode_Commands_Command|null $sourceCommand |
115 | 115 | * @return Mailcode_Variables_Collection_Regular |
116 | 116 | */ |
117 | - public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Variables_Collection_Regular |
|
117 | + public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Variables_Collection_Regular |
|
118 | 118 | { |
119 | 119 | return $this->createVariables()->parseString($subject, $sourceCommand); |
120 | 120 | } |
121 | 121 | |
122 | 122 | public function createVariables() : Mailcode_Variables |
123 | 123 | { |
124 | - if(!isset($this->variables)) |
|
124 | + if (!isset($this->variables)) |
|
125 | 125 | { |
126 | 126 | $this->variables = new Mailcode_Variables(); |
127 | 127 | } |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | */ |
138 | 138 | public function createTranslator() : Mailcode_Translator |
139 | 139 | { |
140 | - if(!isset($this->translator)) |
|
140 | + if (!isset($this->translator)) |
|
141 | 141 | { |
142 | 142 | $this->translator = new Mailcode_Translator(); |
143 | 143 | } |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Variables_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Variables_Variable[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Variables_Variable[] |
|
25 | + */ |
|
26 | 26 | protected $variables = array(); |
27 | 27 | |
28 | 28 | public function __construct() |
@@ -52,12 +52,12 @@ discard block |
||
52 | 52 | return count($this->variables); |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Checks whether the collection contains a variable with the specified name. |
|
57 | - * |
|
58 | - * @param string $fullName The variable name, with or without $ sign. |
|
59 | - * @return bool |
|
60 | - */ |
|
55 | + /** |
|
56 | + * Checks whether the collection contains a variable with the specified name. |
|
57 | + * |
|
58 | + * @param string $fullName The variable name, with or without $ sign. |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | 61 | public function hasVariableName(string $fullName) : bool |
62 | 62 | { |
63 | 63 | $fullName = $this->fixName($fullName); |
@@ -73,14 +73,14 @@ discard block |
||
73 | 73 | return false; |
74 | 74 | } |
75 | 75 | |
76 | - /** |
|
77 | - * Retrieves a collection of all variable instances for |
|
78 | - * the specified name (there can be several with differing |
|
79 | - * matched texts because of spacing). |
|
80 | - * |
|
81 | - * @param string $fullName |
|
82 | - * @return Mailcode_Variables_Collection |
|
83 | - */ |
|
76 | + /** |
|
77 | + * Retrieves a collection of all variable instances for |
|
78 | + * the specified name (there can be several with differing |
|
79 | + * matched texts because of spacing). |
|
80 | + * |
|
81 | + * @param string $fullName |
|
82 | + * @return Mailcode_Variables_Collection |
|
83 | + */ |
|
84 | 84 | public function getByFullName(string $fullName) : Mailcode_Variables_Collection |
85 | 85 | { |
86 | 86 | $fullName = $this->fixName($fullName); |
@@ -98,12 +98,12 @@ discard block |
||
98 | 98 | return $collection; |
99 | 99 | } |
100 | 100 | |
101 | - /** |
|
102 | - * Prepends the $ sign to a variable name if it does not have it. |
|
103 | - * |
|
104 | - * @param string $fullName |
|
105 | - * @return string |
|
106 | - */ |
|
101 | + /** |
|
102 | + * Prepends the $ sign to a variable name if it does not have it. |
|
103 | + * |
|
104 | + * @param string $fullName |
|
105 | + * @return string |
|
106 | + */ |
|
107 | 107 | protected function fixName(string $fullName) : string |
108 | 108 | { |
109 | 109 | if(substr($fullName, 0, 1) === '$') |
@@ -114,12 +114,12 @@ discard block |
||
114 | 114 | return '$'.$fullName; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves all variables, grouped by their hash - meaning |
|
119 | - * unique matched strings. |
|
120 | - * |
|
121 | - * @return Mailcode_Variables_Variable[] |
|
122 | - */ |
|
117 | + /** |
|
118 | + * Retrieves all variables, grouped by their hash - meaning |
|
119 | + * unique matched strings. |
|
120 | + * |
|
121 | + * @return Mailcode_Variables_Variable[] |
|
122 | + */ |
|
123 | 123 | public function getGroupedByHash() : array |
124 | 124 | { |
125 | 125 | $entries = array(); |
@@ -132,11 +132,11 @@ discard block |
||
132 | 132 | return $this->sortVariables($entries); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Retrieves all variables, grouped by their name. |
|
137 | - * |
|
138 | - * @return Mailcode_Variables_Variable[] |
|
139 | - */ |
|
135 | + /** |
|
136 | + * Retrieves all variables, grouped by their name. |
|
137 | + * |
|
138 | + * @return Mailcode_Variables_Variable[] |
|
139 | + */ |
|
140 | 140 | public function getGroupedByName() : array |
141 | 141 | { |
142 | 142 | $entries = array(); |
@@ -168,19 +168,19 @@ discard block |
||
168 | 168 | return $this->sortVariables($entries); |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Retrieves all variables, in the order they were addded. |
|
173 | - * @return Mailcode_Variables_Variable[] |
|
174 | - */ |
|
171 | + /** |
|
172 | + * Retrieves all variables, in the order they were addded. |
|
173 | + * @return Mailcode_Variables_Variable[] |
|
174 | + */ |
|
175 | 175 | public function getAll() |
176 | 176 | { |
177 | 177 | return $this->variables; |
178 | 178 | } |
179 | 179 | |
180 | - /** |
|
181 | - * Retrieves the full names of the variables that are present in the collection. |
|
182 | - * @return string[] |
|
183 | - */ |
|
180 | + /** |
|
181 | + * Retrieves the full names of the variables that are present in the collection. |
|
182 | + * @return string[] |
|
183 | + */ |
|
184 | 184 | public function getNames() : array |
185 | 185 | { |
186 | 186 | $result = array(); |
@@ -198,13 +198,13 @@ discard block |
||
198 | 198 | return $result; |
199 | 199 | } |
200 | 200 | |
201 | - /** |
|
202 | - * Takes a list of variables and sorts them, throwing away |
|
203 | - * the source array's keys. |
|
204 | - * |
|
205 | - * @param Mailcode_Variables_Variable[] $entries |
|
206 | - * @return Mailcode_Variables_Variable[] |
|
207 | - */ |
|
201 | + /** |
|
202 | + * Takes a list of variables and sorts them, throwing away |
|
203 | + * the source array's keys. |
|
204 | + * |
|
205 | + * @param Mailcode_Variables_Variable[] $entries |
|
206 | + * @return Mailcode_Variables_Variable[] |
|
207 | + */ |
|
208 | 208 | protected function sortVariables(array $entries) |
209 | 209 | { |
210 | 210 | $result = array_values($entries); |
@@ -217,13 +217,13 @@ discard block |
||
217 | 217 | return $result; |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * Merges the variables collection with the target collection |
|
222 | - * by inheriting all that collection's variables. |
|
223 | - * |
|
224 | - * @param Mailcode_Variables_Collection $collection |
|
225 | - * @return Mailcode_Variables_Collection |
|
226 | - */ |
|
220 | + /** |
|
221 | + * Merges the variables collection with the target collection |
|
222 | + * by inheriting all that collection's variables. |
|
223 | + * |
|
224 | + * @param Mailcode_Variables_Collection $collection |
|
225 | + * @return Mailcode_Variables_Collection |
|
226 | + */ |
|
227 | 227 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
228 | 228 | { |
229 | 229 | $variables = $collection->getGroupedByHash(); |
@@ -62,9 +62,9 @@ discard block |
||
62 | 62 | { |
63 | 63 | $fullName = $this->fixName($fullName); |
64 | 64 | |
65 | - foreach($this->variables as $variable) |
|
65 | + foreach ($this->variables as $variable) |
|
66 | 66 | { |
67 | - if($variable->getFullName() === $fullName) |
|
67 | + if ($variable->getFullName() === $fullName) |
|
68 | 68 | { |
69 | 69 | return true; |
70 | 70 | } |
@@ -87,9 +87,9 @@ discard block |
||
87 | 87 | |
88 | 88 | $collection = new Mailcode_Variables_Collection_Regular(); |
89 | 89 | |
90 | - foreach($this->variables as $variable) |
|
90 | + foreach ($this->variables as $variable) |
|
91 | 91 | { |
92 | - if($variable->getFullName() === $fullName) |
|
92 | + if ($variable->getFullName() === $fullName) |
|
93 | 93 | { |
94 | 94 | $collection->add($variable); |
95 | 95 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | */ |
107 | 107 | protected function fixName(string $fullName) : string |
108 | 108 | { |
109 | - if(substr($fullName, 0, 1) === '$') |
|
109 | + if (substr($fullName, 0, 1) === '$') |
|
110 | 110 | { |
111 | 111 | return $fullName; |
112 | 112 | } |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | { |
125 | 125 | $entries = array(); |
126 | 126 | |
127 | - foreach($this->variables as $variable) |
|
127 | + foreach ($this->variables as $variable) |
|
128 | 128 | { |
129 | 129 | $entries[$variable->getHash()] = $variable; |
130 | 130 | } |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | { |
142 | 142 | $entries = array(); |
143 | 143 | |
144 | - foreach($this->variables as $variable) |
|
144 | + foreach ($this->variables as $variable) |
|
145 | 145 | { |
146 | 146 | $entries[$variable->getFullName()] = $variable; |
147 | 147 | } |
@@ -160,7 +160,7 @@ discard block |
||
160 | 160 | { |
161 | 161 | $entries = array(); |
162 | 162 | |
163 | - foreach($this->variables as $variable) |
|
163 | + foreach ($this->variables as $variable) |
|
164 | 164 | { |
165 | 165 | $entries[$variable->getUniqueName()] = $variable; |
166 | 166 | } |
@@ -185,11 +185,11 @@ discard block |
||
185 | 185 | { |
186 | 186 | $result = array(); |
187 | 187 | |
188 | - foreach($this->variables as $variable) |
|
188 | + foreach ($this->variables as $variable) |
|
189 | 189 | { |
190 | 190 | $name = $variable->getFullName(); |
191 | 191 | |
192 | - if(!in_array($name, $result)) |
|
192 | + if (!in_array($name, $result)) |
|
193 | 193 | { |
194 | 194 | $result[] = $name; |
195 | 195 | } |
@@ -228,7 +228,7 @@ discard block |
||
228 | 228 | { |
229 | 229 | $variables = $collection->getGroupedByHash(); |
230 | 230 | |
231 | - foreach($variables as $variable) |
|
231 | + foreach ($variables as $variable) |
|
232 | 232 | { |
233 | 233 | $this->add($variable); |
234 | 234 | } |
@@ -240,7 +240,7 @@ discard block |
||
240 | 240 | { |
241 | 241 | $variables = $this->getAll(); |
242 | 242 | |
243 | - if(!empty($variables)) |
|
243 | + if (!empty($variables)) |
|
244 | 244 | { |
245 | 245 | return array_shift($variables); |
246 | 246 | } |