@@ -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 | } |
@@ -22,9 +22,9 @@ |
||
| 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 | 30 | /** |
@@ -34,21 +34,21 @@ discard block |
||
| 34 | 34 | * @param Mailcode_Commands_Command|null $sourceCommand |
| 35 | 35 | * @return Mailcode_Variables_Collection_Regular |
| 36 | 36 | */ |
| 37 | - public function parseString(string $subject, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Variables_Collection_Regular |
|
| 37 | + public function parseString(string $subject, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Variables_Collection_Regular |
|
| 38 | 38 | { |
| 39 | 39 | $this->collection = new Mailcode_Variables_Collection_Regular(); |
| 40 | 40 | |
| 41 | 41 | $matches = array(); |
| 42 | 42 | preg_match_all(self::REGEX_VARIABLE_NAME, $subject, $matches, PREG_PATTERN_ORDER); |
| 43 | 43 | |
| 44 | - if(!isset($matches[0]) || empty($matches[0])) |
|
| 44 | + if (!isset($matches[0]) || empty($matches[0])) |
|
| 45 | 45 | { |
| 46 | 46 | return $this->collection; |
| 47 | 47 | } |
| 48 | 48 | |
| 49 | - foreach($matches[0] as $idx => $matchedText) |
|
| 49 | + foreach ($matches[0] as $idx => $matchedText) |
|
| 50 | 50 | { |
| 51 | - if(!empty($matches[3][$idx])) |
|
| 51 | + if (!empty($matches[3][$idx])) |
|
| 52 | 52 | { |
| 53 | 53 | $this->addSingle($matches[3][$idx], $matchedText, $sourceCommand); |
| 54 | 54 | } |
@@ -61,10 +61,10 @@ discard block |
||
| 61 | 61 | return $this->collection; |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - protected function addSingle(string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand=null) : void |
|
| 64 | + protected function addSingle(string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand = null) : void |
|
| 65 | 65 | { |
| 66 | 66 | // ignore US style numbers like $451 |
| 67 | - if(is_numeric($name)) |
|
| 67 | + if (is_numeric($name)) |
|
| 68 | 68 | { |
| 69 | 69 | return; |
| 70 | 70 | } |
@@ -72,10 +72,10 @@ discard block |
||
| 72 | 72 | $this->collection->add(new Mailcode_Variables_Variable('', $name, $matchedText, $sourceCommand)); |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - protected function addPathed(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand=null) : void |
|
| 75 | + protected function addPathed(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand = null) : void |
|
| 76 | 76 | { |
| 77 | 77 | // ignore US style numbers like $45.12 |
| 78 | - if(is_numeric($path.'.'.$name)) |
|
| 78 | + if (is_numeric($path.'.'.$name)) |
|
| 79 | 79 | { |
| 80 | 80 | return; |
| 81 | 81 | } |
@@ -51,8 +51,7 @@ |
||
| 51 | 51 | if(!empty($matches[3][$idx])) |
| 52 | 52 | { |
| 53 | 53 | $this->addSingle($matches[3][$idx], $matchedText, $sourceCommand); |
| 54 | - } |
|
| 55 | - else |
|
| 54 | + } else |
|
| 56 | 55 | { |
| 57 | 56 | $this->addPathed($matches[1][$idx], $matches[2][$idx], $matchedText, $sourceCommand); |
| 58 | 57 | } |
@@ -20,19 +20,19 @@ 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 | 38 | /** |
@@ -62,20 +62,20 @@ discard block |
||
| 62 | 62 | return $this->sourceCommand; |
| 63 | 63 | } |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 67 | - * @return string |
|
| 68 | - */ |
|
| 65 | + /** |
|
| 66 | + * The ID of the type. i.e. the class name ("Keyword", "StringLiteral"). |
|
| 67 | + * @return string |
|
| 68 | + */ |
|
| 69 | 69 | public function getTypeID() : string |
| 70 | 70 | { |
| 71 | 71 | $parts = explode('_', get_class($this)); |
| 72 | 72 | return array_pop($parts); |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Retrieves a unique ID of the token. |
|
| 77 | - * @return string |
|
| 78 | - */ |
|
| 75 | + /** |
|
| 76 | + * Retrieves a unique ID of the token. |
|
| 77 | + * @return string |
|
| 78 | + */ |
|
| 79 | 79 | public function getID() : string |
| 80 | 80 | { |
| 81 | 81 | return $this->tokenID; |
@@ -46,7 +46,7 @@ |
||
| 46 | 46 | * @param mixed $subject |
| 47 | 47 | * @param Mailcode_Commands_Command|null $sourceCommand |
| 48 | 48 | */ |
| 49 | - public function __construct(string $tokenID, string $matchedText, $subject=null, ?Mailcode_Commands_Command $sourceCommand=null) |
|
| 49 | + public function __construct(string $tokenID, string $matchedText, $subject = null, ?Mailcode_Commands_Command $sourceCommand = null) |
|
| 50 | 50 | { |
| 51 | 51 | $this->tokenID = $tokenID; |
| 52 | 52 | $this->matchedText = $matchedText; |
@@ -10,7 +10,7 @@ |
||
| 10 | 10 | { |
| 11 | 11 | $vars = Mailcode::create()->findVariables($this->tokenized, $this->tokenizer->getSourceCommand())->getGroupedByHash(); |
| 12 | 12 | |
| 13 | - foreach($vars as $var) |
|
| 13 | + foreach ($vars as $var) |
|
| 14 | 14 | { |
| 15 | 15 | $this->registerToken('Variable', $var->getMatchedText(), $var); |
| 16 | 16 | } |
@@ -37,7 +37,7 @@ discard block |
||
| 37 | 37 | // Split the variable name by the dot |
| 38 | 38 | $parts = explode('.', ltrim($var->getFullName(), '$')); |
| 39 | 39 | |
| 40 | - if(count($parts) !== 2) |
|
| 40 | + if (count($parts) !== 2) |
|
| 41 | 41 | { |
| 42 | 42 | $this->validationResult->makeError( |
| 43 | 43 | t('The variable %1$s is not a list property:', '<code>'.$var->getFullName().'</code>').' '. |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | */ |
| 70 | 70 | public function getListVariable() : Mailcode_Variables_Variable |
| 71 | 71 | { |
| 72 | - if(isset($this->listVariable)) |
|
| 72 | + if (isset($this->listVariable)) |
|
| 73 | 73 | { |
| 74 | 74 | return $this->listVariable; |
| 75 | 75 | } |
@@ -36,44 +36,44 @@ discard block |
||
| 36 | 36 | |
| 37 | 37 | const META_URL_ENCODING = 'url_encoding'; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var string |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var string |
|
| 41 | + */ |
|
| 42 | 42 | protected $type = ''; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var string |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var string |
|
| 46 | + */ |
|
| 47 | 47 | protected $paramsString = ''; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | 52 | protected $matchedText = ''; |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var string |
|
| 56 | - */ |
|
| 54 | + /** |
|
| 55 | + * @var string |
|
| 56 | + */ |
|
| 57 | 57 | protected $hash = ''; |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @var OperationResult |
|
| 61 | - */ |
|
| 59 | + /** |
|
| 60 | + * @var OperationResult |
|
| 61 | + */ |
|
| 62 | 62 | protected $validationResult = null; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var \Mailcode\Mailcode |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var \Mailcode\Mailcode |
|
| 66 | + */ |
|
| 67 | 67 | protected $mailcode; |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var \Mailcode\Mailcode_Parser_Statement |
|
| 71 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var \Mailcode\Mailcode_Parser_Statement |
|
| 71 | + */ |
|
| 72 | 72 | protected $params; |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @var string[] |
|
| 76 | - */ |
|
| 74 | + /** |
|
| 75 | + * @var string[] |
|
| 76 | + */ |
|
| 77 | 77 | protected $validations = array( |
| 78 | 78 | 'params_empty', |
| 79 | 79 | 'params_keywords', |
@@ -82,24 +82,24 @@ discard block |
||
| 82 | 82 | 'type_unsupported' |
| 83 | 83 | ); |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * @var string |
|
| 87 | - */ |
|
| 85 | + /** |
|
| 86 | + * @var string |
|
| 87 | + */ |
|
| 88 | 88 | protected $comment = ''; |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @var Mailcode_Commands_LogicKeywords|NULL |
|
| 92 | - */ |
|
| 90 | + /** |
|
| 91 | + * @var Mailcode_Commands_LogicKeywords|NULL |
|
| 92 | + */ |
|
| 93 | 93 | protected $logicKeywords; |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @var Mailcode_Parser_Statement_Validator |
|
| 97 | - */ |
|
| 95 | + /** |
|
| 96 | + * @var Mailcode_Parser_Statement_Validator |
|
| 97 | + */ |
|
| 98 | 98 | protected $validator; |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * @var boolean |
|
| 102 | - */ |
|
| 100 | + /** |
|
| 101 | + * @var boolean |
|
| 102 | + */ |
|
| 103 | 103 | private $validated = false; |
| 104 | 104 | |
| 105 | 105 | /** |
@@ -134,13 +134,13 @@ discard block |
||
| 134 | 134 | |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Sets the command's parent opening command, if any. |
|
| 139 | - * NOTE: This is set automatically by the parser, and |
|
| 140 | - * should not be called manually. |
|
| 141 | - * |
|
| 142 | - * @param Mailcode_Commands_Command $command |
|
| 143 | - */ |
|
| 137 | + /** |
|
| 138 | + * Sets the command's parent opening command, if any. |
|
| 139 | + * NOTE: This is set automatically by the parser, and |
|
| 140 | + * should not be called manually. |
|
| 141 | + * |
|
| 142 | + * @param Mailcode_Commands_Command $command |
|
| 143 | + */ |
|
| 144 | 144 | public function setParent(Mailcode_Commands_Command $command) : void |
| 145 | 145 | { |
| 146 | 146 | $this->parent = $command; |
@@ -282,9 +282,9 @@ discard block |
||
| 282 | 282 | return $this->validationResult->isValid(); |
| 283 | 283 | } |
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * @return string[] |
|
| 287 | - */ |
|
| 285 | + /** |
|
| 286 | + * @return string[] |
|
| 287 | + */ |
|
| 288 | 288 | abstract protected function getValidations() : array; |
| 289 | 289 | |
| 290 | 290 | protected function _validateNesting() : void |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | */ |
| 119 | 119 | private $nestingValidated = false; |
| 120 | 120 | |
| 121 | - public function __construct(string $type='', string $paramsString='', string $matchedText='') |
|
| 121 | + public function __construct(string $type = '', string $paramsString = '', string $matchedText = '') |
|
| 122 | 122 | { |
| 123 | 123 | $this->type = $type; |
| 124 | 124 | $this->paramsString = html_entity_decode($paramsString); |
@@ -185,7 +185,7 @@ discard block |
||
| 185 | 185 | { |
| 186 | 186 | $this->requireNonDummy(); |
| 187 | 187 | |
| 188 | - if($this->hash === '') { |
|
| 188 | + if ($this->hash === '') { |
|
| 189 | 189 | $this->hash = md5($this->matchedText); |
| 190 | 190 | } |
| 191 | 191 | |
@@ -194,7 +194,7 @@ discard block |
||
| 194 | 194 | |
| 195 | 195 | protected function requireNonDummy() : void |
| 196 | 196 | { |
| 197 | - if(!$this->isDummy()) |
|
| 197 | + if (!$this->isDummy()) |
|
| 198 | 198 | { |
| 199 | 199 | return; |
| 200 | 200 | } |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | |
| 214 | 214 | protected function validate() : OperationResult |
| 215 | 215 | { |
| 216 | - if(!$this->validated) |
|
| 216 | + if (!$this->validated) |
|
| 217 | 217 | { |
| 218 | 218 | $this->requireNonDummy(); |
| 219 | 219 | $this->validateSyntax(); |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | |
| 227 | 227 | public function getValidationResult() : OperationResult |
| 228 | 228 | { |
| 229 | - if(isset($this->validationResult)) |
|
| 229 | + if (isset($this->validationResult)) |
|
| 230 | 230 | { |
| 231 | 231 | return $this->validationResult; |
| 232 | 232 | } |
@@ -242,10 +242,10 @@ discard block |
||
| 242 | 242 | { |
| 243 | 243 | $validations = $this->resolveValidations(); |
| 244 | 244 | |
| 245 | - foreach($validations as $validation) |
|
| 245 | + foreach ($validations as $validation) |
|
| 246 | 246 | { |
| 247 | 247 | // break off at the first validation issue |
| 248 | - if(!$this->validateSyntaxMethod($validation)) |
|
| 248 | + if (!$this->validateSyntaxMethod($validation)) |
|
| 249 | 249 | { |
| 250 | 250 | return; |
| 251 | 251 | } |
@@ -264,7 +264,7 @@ discard block |
||
| 264 | 264 | { |
| 265 | 265 | $method = 'validateSyntax_'.$validation; |
| 266 | 266 | |
| 267 | - if(!method_exists($this, $method)) |
|
| 267 | + if (!method_exists($this, $method)) |
|
| 268 | 268 | { |
| 269 | 269 | throw new Mailcode_Exception( |
| 270 | 270 | 'Missing validation method ['.$validation.']', |
@@ -294,7 +294,7 @@ discard block |
||
| 294 | 294 | |
| 295 | 295 | public function validateNesting() : OperationResult |
| 296 | 296 | { |
| 297 | - if($this->nestingValidated) |
|
| 297 | + if ($this->nestingValidated) |
|
| 298 | 298 | { |
| 299 | 299 | return $this->validationResult; |
| 300 | 300 | } |
@@ -318,7 +318,7 @@ discard block |
||
| 318 | 318 | |
| 319 | 319 | public function getType() : string |
| 320 | 320 | { |
| 321 | - if($this->supportsType()) |
|
| 321 | + if ($this->supportsType()) |
|
| 322 | 322 | { |
| 323 | 323 | return $this->type; |
| 324 | 324 | } |
@@ -338,7 +338,7 @@ discard block |
||
| 338 | 338 | |
| 339 | 339 | public function getHighlighted() : string |
| 340 | 340 | { |
| 341 | - if(!$this->isValid()) |
|
| 341 | + if (!$this->isValid()) |
|
| 342 | 342 | { |
| 343 | 343 | return ''; |
| 344 | 344 | } |
@@ -349,7 +349,7 @@ discard block |
||
| 349 | 349 | |
| 350 | 350 | public function getParamsString() : string |
| 351 | 351 | { |
| 352 | - if($this->requiresParameters()) |
|
| 352 | + if ($this->requiresParameters()) |
|
| 353 | 353 | { |
| 354 | 354 | return $this->paramsString; |
| 355 | 355 | } |
@@ -380,22 +380,22 @@ discard block |
||
| 380 | 380 | |
| 381 | 381 | public final function getCommandType() : string |
| 382 | 382 | { |
| 383 | - if($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
| 383 | + if ($this instanceof Mailcode_Commands_Command_Type_Closing) |
|
| 384 | 384 | { |
| 385 | 385 | return 'Closing'; |
| 386 | 386 | } |
| 387 | 387 | |
| 388 | - if($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
| 388 | + if ($this instanceof Mailcode_Commands_Command_Type_Opening) |
|
| 389 | 389 | { |
| 390 | 390 | return 'Opening'; |
| 391 | 391 | } |
| 392 | 392 | |
| 393 | - if($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
| 393 | + if ($this instanceof Mailcode_Commands_Command_Type_Sibling) |
|
| 394 | 394 | { |
| 395 | 395 | return 'Sibling'; |
| 396 | 396 | } |
| 397 | 397 | |
| 398 | - if($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
| 398 | + if ($this instanceof Mailcode_Commands_Command_Type_Standalone) |
|
| 399 | 399 | { |
| 400 | 400 | return 'Standalone'; |
| 401 | 401 | } |
@@ -434,7 +434,7 @@ discard block |
||
| 434 | 434 | |
| 435 | 435 | public function getLogicKeywords() : Mailcode_Commands_LogicKeywords |
| 436 | 436 | { |
| 437 | - if($this->supportsLogicKeywords() && isset($this->logicKeywords)) |
|
| 437 | + if ($this->supportsLogicKeywords() && isset($this->logicKeywords)) |
|
| 438 | 438 | { |
| 439 | 439 | return $this->logicKeywords; |
| 440 | 440 | } |
@@ -454,7 +454,7 @@ discard block |
||
| 454 | 454 | |
| 455 | 455 | public function getTranslationParam(string $name) |
| 456 | 456 | { |
| 457 | - if(isset($this->translationParams[$name])) |
|
| 457 | + if (isset($this->translationParams[$name])) |
|
| 458 | 458 | { |
| 459 | 459 | return $this->translationParams[$name]; |
| 460 | 460 | } |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | return null; |
| 463 | 463 | } |
| 464 | 464 | |
| 465 | - public function setURLEncoding(bool $encoding=true) |
|
| 465 | + public function setURLEncoding(bool $encoding = true) |
|
| 466 | 466 | { |
| 467 | 467 | $this->requireURLEncoding(); |
| 468 | 468 | |
@@ -471,7 +471,7 @@ discard block |
||
| 471 | 471 | return $this; |
| 472 | 472 | } |
| 473 | 473 | |
| 474 | - public function setURLDecoding(bool $decode=true) |
|
| 474 | + public function setURLDecoding(bool $decode = true) |
|
| 475 | 475 | { |
| 476 | 476 | $this->requireURLEncoding(); |
| 477 | 477 | |
@@ -482,7 +482,7 @@ discard block |
||
| 482 | 482 | |
| 483 | 483 | protected function requireURLEncoding() : void |
| 484 | 484 | { |
| 485 | - if($this->supportsURLEncoding()) { |
|
| 485 | + if ($this->supportsURLEncoding()) { |
|
| 486 | 486 | return; |
| 487 | 487 | } |
| 488 | 488 | |
@@ -31,19 +31,19 @@ |
||
| 31 | 31 | const VALIDATION_VARIABLE_NAME_WITH_DOT = 49704; |
| 32 | 32 | const VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT = 49705; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 36 | + */ |
|
| 37 | 37 | private $loopVar; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL |
|
| 41 | + */ |
|
| 42 | 42 | private $sourceVar; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL |
|
| 46 | + */ |
|
| 47 | 47 | private $keyword; |
| 48 | 48 | |
| 49 | 49 | public function getName() : string |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | |
| 100 | 100 | public function getSourceVariable() : Mailcode_Variables_Variable |
| 101 | 101 | { |
| 102 | - if(isset($this->sourceVar)) |
|
| 102 | + if (isset($this->sourceVar)) |
|
| 103 | 103 | { |
| 104 | 104 | return $this->sourceVar->getVariable(); |
| 105 | 105 | } |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | |
| 114 | 114 | public function getLoopVariable() : Mailcode_Variables_Variable |
| 115 | 115 | { |
| 116 | - if(isset($this->loopVar)) |
|
| 116 | + if (isset($this->loopVar)) |
|
| 117 | 117 | { |
| 118 | 118 | return $this->loopVar->getVariable(); |
| 119 | 119 | } |
@@ -133,7 +133,7 @@ discard block |
||
| 133 | 133 | $this->keyword = $info->getKeywordByIndex(1); |
| 134 | 134 | $this->sourceVar = $info->getVariableByIndex(2); |
| 135 | 135 | |
| 136 | - if(!$this->loopVar || !$this->keyword || !$this->sourceVar) |
|
| 136 | + if (!$this->loopVar || !$this->keyword || !$this->sourceVar) |
|
| 137 | 137 | { |
| 138 | 138 | $this->validationResult->makeError( |
| 139 | 139 | t('Not a valid for loop.').' '.t('Is the %1$s keyword missing?', 'in:'), |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | |
| 147 | 147 | protected function validateSyntax_keyword() : void |
| 148 | 148 | { |
| 149 | - if($this->keyword->isForIn()) |
|
| 149 | + if ($this->keyword->isForIn()) |
|
| 150 | 150 | { |
| 151 | 151 | return; |
| 152 | 152 | } |
@@ -159,7 +159,7 @@ discard block |
||
| 159 | 159 | |
| 160 | 160 | protected function validateSyntax_variable_names() : void |
| 161 | 161 | { |
| 162 | - if($this->sourceVar->getVariable()->getFullName() !== $this->loopVar->getVariable()->getFullName()) |
|
| 162 | + if ($this->sourceVar->getVariable()->getFullName() !== $this->loopVar->getVariable()->getFullName()) |
|
| 163 | 163 | { |
| 164 | 164 | return; |
| 165 | 165 | } |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | |
| 177 | 177 | $parts = explode('.', $name); |
| 178 | 178 | |
| 179 | - if(count($parts) === 1) { |
|
| 179 | + if (count($parts) === 1) { |
|
| 180 | 180 | return; |
| 181 | 181 | } |
| 182 | 182 | |
@@ -193,7 +193,7 @@ discard block |
||
| 193 | 193 | |
| 194 | 194 | $parts = explode('.', $name); |
| 195 | 195 | |
| 196 | - if(count($parts) === 1) { |
|
| 196 | + if (count($parts) === 1) { |
|
| 197 | 197 | return; |
| 198 | 198 | } |
| 199 | 199 | |
@@ -56,23 +56,23 @@ |
||
| 56 | 56 | |
| 57 | 57 | private function analyzeURL(string $url) : void |
| 58 | 58 | { |
| 59 | - if(stristr($url, 'tel:') !== false) |
|
| 59 | + if (stristr($url, 'tel:') !== false) |
|
| 60 | 60 | { |
| 61 | 61 | return; |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | 64 | $placeholders = $this->safeguard->getPlaceholders(); |
| 65 | 65 | |
| 66 | - foreach($placeholders as $placeholder) |
|
| 66 | + foreach ($placeholders as $placeholder) |
|
| 67 | 67 | { |
| 68 | 68 | $command = $placeholder->getCommand(); |
| 69 | 69 | |
| 70 | - if(!$command->supportsURLEncoding()) |
|
| 70 | + if (!$command->supportsURLEncoding()) |
|
| 71 | 71 | { |
| 72 | 72 | continue; |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - if(strstr($url, $placeholder->getReplacementText()) !== false && !$command->isURLDecoded()) |
|
| 75 | + if (strstr($url, $placeholder->getReplacementText()) !== false && !$command->isURLDecoded()) |
|
| 76 | 76 | { |
| 77 | 77 | $command->setURLEncoding(true); |
| 78 | 78 | break; |
@@ -23,25 +23,25 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | trait Mailcode_Traits_Formatting_HTMLHighlighting |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * Stored this way so we can use isset() instead |
|
| 28 | - * of using in_array, which is some magnitudes slower. |
|
| 29 | - * The boolean value is not used otherwise. |
|
| 30 | - * |
|
| 31 | - * @var array<string,bool> |
|
| 32 | - */ |
|
| 26 | + /** |
|
| 27 | + * Stored this way so we can use isset() instead |
|
| 28 | + * of using in_array, which is some magnitudes slower. |
|
| 29 | + * The boolean value is not used otherwise. |
|
| 30 | + * |
|
| 31 | + * @var array<string,bool> |
|
| 32 | + */ |
|
| 33 | 33 | private $excludeTags = array( |
| 34 | 34 | 'style' => true, // NOTE: style tags are excluded natively on the parser level. |
| 35 | 35 | 'script' => true |
| 36 | 36 | ); |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Adds an HTML tag name to the list of tags within which |
|
| 40 | - * commands may not be highlighted. |
|
| 41 | - * |
|
| 42 | - * @param string $tagName Case insensitive. |
|
| 43 | - * @return $this |
|
| 44 | - */ |
|
| 38 | + /** |
|
| 39 | + * Adds an HTML tag name to the list of tags within which |
|
| 40 | + * commands may not be highlighted. |
|
| 41 | + * |
|
| 42 | + * @param string $tagName Case insensitive. |
|
| 43 | + * @return $this |
|
| 44 | + */ |
|
| 45 | 45 | public function excludeTag(string $tagName) |
| 46 | 46 | { |
| 47 | 47 | $tagName = strtolower($tagName); |
@@ -51,12 +51,12 @@ discard block |
||
| 51 | 51 | return $this; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Adds several exluded tag names at once. |
|
| 56 | - * |
|
| 57 | - * @param string[] $tagNames |
|
| 58 | - * @return $this |
|
| 59 | - */ |
|
| 54 | + /** |
|
| 55 | + * Adds several exluded tag names at once. |
|
| 56 | + * |
|
| 57 | + * @param string[] $tagNames |
|
| 58 | + * @return $this |
|
| 59 | + */ |
|
| 60 | 60 | public function excludeTags(array $tagNames) |
| 61 | 61 | { |
| 62 | 62 | foreach($tagNames as $tagName) |
@@ -67,12 +67,12 @@ discard block |
||
| 67 | 67 | return $this; |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Whether the specified tag name is in the exlusion list. |
|
| 72 | - * |
|
| 73 | - * @param string $tagName |
|
| 74 | - * @return bool |
|
| 75 | - */ |
|
| 70 | + /** |
|
| 71 | + * Whether the specified tag name is in the exlusion list. |
|
| 72 | + * |
|
| 73 | + * @param string $tagName |
|
| 74 | + * @return bool |
|
| 75 | + */ |
|
| 76 | 76 | public function isTagExcluded(string $tagName) : bool |
| 77 | 77 | { |
| 78 | 78 | $tagName = strtolower($tagName); |
@@ -59,7 +59,7 @@ |
||
| 59 | 59 | */ |
| 60 | 60 | public function excludeTags(array $tagNames) |
| 61 | 61 | { |
| 62 | - foreach($tagNames as $tagName) |
|
| 62 | + foreach ($tagNames as $tagName) |
|
| 63 | 63 | { |
| 64 | 64 | $this->excludeTag((string)$tagName); |
| 65 | 65 | } |