@@ -20,11 +20,11 @@ discard block |
||
20 | 20 | */ |
21 | 21 | abstract class Mailcode_Variables_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * Stores variables by their hash. |
|
25 | - * |
|
26 | - * @var array[string]Mailcode_Variables_Variable |
|
27 | - */ |
|
23 | + /** |
|
24 | + * Stores variables by their hash. |
|
25 | + * |
|
26 | + * @var array[string]Mailcode_Variables_Variable |
|
27 | + */ |
|
28 | 28 | protected $variables = array(); |
29 | 29 | |
30 | 30 | public function __construct() |
@@ -56,12 +56,12 @@ discard block |
||
56 | 56 | return count($this->variables); |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Checks whether the collection contains a variable with the specified name. |
|
61 | - * |
|
62 | - * @param string $fullName The variable name, with or without $ sign. |
|
63 | - * @return bool |
|
64 | - */ |
|
59 | + /** |
|
60 | + * Checks whether the collection contains a variable with the specified name. |
|
61 | + * |
|
62 | + * @param string $fullName The variable name, with or without $ sign. |
|
63 | + * @return bool |
|
64 | + */ |
|
65 | 65 | public function hasVariableName(string $fullName) : bool |
66 | 66 | { |
67 | 67 | $fullName = $this->fixName($fullName); |
@@ -77,14 +77,14 @@ discard block |
||
77 | 77 | return false; |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Retrieves a collection of all variable instances for |
|
82 | - * the specified name (there can be several with differing |
|
83 | - * matched texts because of spacing). |
|
84 | - * |
|
85 | - * @param string $fullName |
|
86 | - * @return Mailcode_Variables_Collection |
|
87 | - */ |
|
80 | + /** |
|
81 | + * Retrieves a collection of all variable instances for |
|
82 | + * the specified name (there can be several with differing |
|
83 | + * matched texts because of spacing). |
|
84 | + * |
|
85 | + * @param string $fullName |
|
86 | + * @return Mailcode_Variables_Collection |
|
87 | + */ |
|
88 | 88 | public function getByFullName(string $fullName) : Mailcode_Variables_Collection |
89 | 89 | { |
90 | 90 | $fullName = $this->fixName($fullName); |
@@ -102,12 +102,12 @@ discard block |
||
102 | 102 | return $collection; |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Prepends the $ sign to a variable name if it does not have it. |
|
107 | - * |
|
108 | - * @param string $fullName |
|
109 | - * @return string |
|
110 | - */ |
|
105 | + /** |
|
106 | + * Prepends the $ sign to a variable name if it does not have it. |
|
107 | + * |
|
108 | + * @param string $fullName |
|
109 | + * @return string |
|
110 | + */ |
|
111 | 111 | protected function fixName(string $fullName) : string |
112 | 112 | { |
113 | 113 | if(substr($fullName, 0, 1) === '$') |
@@ -118,22 +118,22 @@ discard block |
||
118 | 118 | return '$'.$fullName; |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Retrieves all variables, grouped by their hash - meaning |
|
123 | - * unique matched strings. |
|
124 | - * |
|
125 | - * @return Mailcode_Variables_Variable[] |
|
126 | - */ |
|
121 | + /** |
|
122 | + * Retrieves all variables, grouped by their hash - meaning |
|
123 | + * unique matched strings. |
|
124 | + * |
|
125 | + * @return Mailcode_Variables_Variable[] |
|
126 | + */ |
|
127 | 127 | public function getGroupedByHash() |
128 | 128 | { |
129 | 129 | return $this->sortVariables($this->variables); |
130 | 130 | } |
131 | 131 | |
132 | - /** |
|
133 | - * Retrieves all variables, grouped by their name. |
|
134 | - * |
|
135 | - * @return Mailcode_Variables_Variable[] |
|
136 | - */ |
|
132 | + /** |
|
133 | + * Retrieves all variables, grouped by their name. |
|
134 | + * |
|
135 | + * @return Mailcode_Variables_Variable[] |
|
136 | + */ |
|
137 | 137 | public function getGroupedByName() |
138 | 138 | { |
139 | 139 | $entries = array(); |
@@ -146,10 +146,10 @@ discard block |
||
146 | 146 | return $this->sortVariables($entries); |
147 | 147 | } |
148 | 148 | |
149 | - /** |
|
150 | - * Retrieves the full names of the variables that are present in the collection. |
|
151 | - * @return string[] |
|
152 | - */ |
|
149 | + /** |
|
150 | + * Retrieves the full names of the variables that are present in the collection. |
|
151 | + * @return string[] |
|
152 | + */ |
|
153 | 153 | public function getNames() : array |
154 | 154 | { |
155 | 155 | $result = array(); |
@@ -167,13 +167,13 @@ discard block |
||
167 | 167 | return $result; |
168 | 168 | } |
169 | 169 | |
170 | - /** |
|
171 | - * Takes a list of variables and sorts them, throwing away |
|
172 | - * the source array's keys. |
|
173 | - * |
|
174 | - * @param array $entries |
|
175 | - * @return Mailcode_Variables_Variable[] |
|
176 | - */ |
|
170 | + /** |
|
171 | + * Takes a list of variables and sorts them, throwing away |
|
172 | + * the source array's keys. |
|
173 | + * |
|
174 | + * @param array $entries |
|
175 | + * @return Mailcode_Variables_Variable[] |
|
176 | + */ |
|
177 | 177 | protected function sortVariables(array $entries) |
178 | 178 | { |
179 | 179 | $result = array_values($entries); |
@@ -186,13 +186,13 @@ discard block |
||
186 | 186 | return $result; |
187 | 187 | } |
188 | 188 | |
189 | - /** |
|
190 | - * Merges the variables collection with the target collection |
|
191 | - * by inheriting all that collection's variables. |
|
192 | - * |
|
193 | - * @param Mailcode_Variables_Collection $collection |
|
194 | - * @return Mailcode_Variables_Collection |
|
195 | - */ |
|
189 | + /** |
|
190 | + * Merges the variables collection with the target collection |
|
191 | + * by inheriting all that collection's variables. |
|
192 | + * |
|
193 | + * @param Mailcode_Variables_Collection $collection |
|
194 | + * @return Mailcode_Variables_Collection |
|
195 | + */ |
|
196 | 196 | public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection |
197 | 197 | { |
198 | 198 | $variables = $collection->getGroupedByHash(); |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command[] |
|
25 | + */ |
|
26 | 26 | protected $commands = array(); |
27 | 27 | |
28 | 28 | /** |
@@ -30,12 +30,12 @@ discard block |
||
30 | 30 | */ |
31 | 31 | protected $errors = array(); |
32 | 32 | |
33 | - /** |
|
34 | - * Adds a command to the collection. |
|
35 | - * |
|
36 | - * @param Mailcode_Commands_Command $command |
|
37 | - * @return Mailcode_Collection |
|
38 | - */ |
|
33 | + /** |
|
34 | + * Adds a command to the collection. |
|
35 | + * |
|
36 | + * @param Mailcode_Commands_Command $command |
|
37 | + * @return Mailcode_Collection |
|
38 | + */ |
|
39 | 39 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
40 | 40 | { |
41 | 41 | $hash = $command->getHash(); |
@@ -47,21 +47,21 @@ discard block |
||
47 | 47 | return $this; |
48 | 48 | } |
49 | 49 | |
50 | - /** |
|
51 | - * Whether there are any commands in the collection. |
|
52 | - * |
|
53 | - * @return bool |
|
54 | - */ |
|
50 | + /** |
|
51 | + * Whether there are any commands in the collection. |
|
52 | + * |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | 55 | public function hasCommands() : bool |
56 | 56 | { |
57 | 57 | return !empty($this->commands); |
58 | 58 | } |
59 | 59 | |
60 | - /** |
|
61 | - * Counts the amount of commands in the collection. |
|
62 | - * |
|
63 | - * @return int |
|
64 | - */ |
|
60 | + /** |
|
61 | + * Counts the amount of commands in the collection. |
|
62 | + * |
|
63 | + * @return int |
|
64 | + */ |
|
65 | 65 | public function countCommands() : int |
66 | 66 | { |
67 | 67 | return count($this->commands); |
@@ -81,9 +81,9 @@ discard block |
||
81 | 81 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * @return Mailcode_Collection_Error[] |
|
86 | - */ |
|
84 | + /** |
|
85 | + * @return Mailcode_Collection_Error[] |
|
86 | + */ |
|
87 | 87 | public function getErrors() |
88 | 88 | { |
89 | 89 | return $this->errors; |
@@ -94,14 +94,14 @@ discard block |
||
94 | 94 | return empty($this->errors); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Retrieves all commands that were detected. |
|
99 | - * |
|
100 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
101 | - */ |
|
97 | + /** |
|
98 | + * Retrieves all commands that were detected. |
|
99 | + * |
|
100 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
101 | + */ |
|
102 | 102 | public function getCommands() |
103 | 103 | { |
104 | - return $this->commands; |
|
104 | + return $this->commands; |
|
105 | 105 | } |
106 | 106 | |
107 | 107 | public function addCommands(array $commands) : Mailcode_Collection |
@@ -22,12 +22,12 @@ |
||
22 | 22 | { |
23 | 23 | const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9]+)\s*\.\s*([A-Z0-9]+)/sx'; |
24 | 24 | |
25 | - /** |
|
26 | - * Parses the specified string to find all variable names contained within, if any. |
|
27 | - * |
|
28 | - * @param string $subject |
|
29 | - * @return Mailcode_Variables_Collection_Regular |
|
30 | - */ |
|
25 | + /** |
|
26 | + * Parses the specified string to find all variable names contained within, if any. |
|
27 | + * |
|
28 | + * @param string $subject |
|
29 | + * @return Mailcode_Variables_Collection_Regular |
|
30 | + */ |
|
31 | 31 | public function parseString(string $subject) : Mailcode_Variables_Collection_Regular |
32 | 32 | { |
33 | 33 | $collection = new Mailcode_Variables_Collection_Regular(); |