Mistralys / mailcode

src/Mailcode/Variables.php

Indentation +9 added lines, -9 removed lines

@@ -22,17 +22,17 @@
 {
     const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six';
     
-   /**
-    * @var Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Regular
+     */
     protected $collection;
     
-   /**
-    * Parses the specified string to find all variable names contained within, if any.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Parses the specified string to find all variable names contained within, if any.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function parseString(string $subject) : Mailcode_Variables_Collection_Regular
     {
         $this->collection = new Mailcode_Variables_Collection_Regular();

Spacing +5 added lines, -5 removed lines

@@ -40,14 +40,14 @@ 
         $matches = array();
         preg_match_all(self::REGEX_VARIABLE_NAME, $subject, $matches, PREG_PATTERN_ORDER);
         
-        if(!isset($matches[0]) || empty($matches[0]))
+        if (!isset($matches[0]) || empty($matches[0]))
         {
             return $this->collection;
         }
         
-        foreach($matches[0] as $idx => $matchedText)
+        foreach ($matches[0] as $idx => $matchedText)
         {
-            if(!empty($matches[3][$idx]))
+            if (!empty($matches[3][$idx]))
             {
                 $this->addSingle($matches[3][$idx], $matchedText);
             }
@@ -63,7 +63,7 @@ 
     protected function addSingle(string $name, string $matchedText) : void
     {
         // ignore US style numbers like $451
-        if(is_numeric($name))
+        if (is_numeric($name))
         {
             return;
         }
@@ -74,7 +74,7 @@ 
     protected function addPathed(string $path, string $name, string $matchedText) : void
     {
         // ignore US style numbers like $45.12
-        if(is_numeric($path.'.'.$name))
+        if (is_numeric($path.'.'.$name))
         {
             return;
         }

Braces +1 added lines, -2 removed lines

@@ -50,8 +50,7 @@
             if(!empty($matches[3][$idx]))
             {
                 $this->addSingle($matches[3][$idx], $matchedText);
-            }
-            else 
+            } else 
             {
                 $this->addPathed($matches[1][$idx], $matches[2][$idx], $matchedText);
             }

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,51 +26,51 @@ 
  */
 class Mailcode
 {
-   /**
-    * @var Mailcode_Parser|NULL
-    */
+    /**
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
     }
     
-   /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+    /**
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()->parseString($string);
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -81,12 +81,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -102,12 +102,12 @@ 
         return $this->getParser()->createSafeguard($subject);
     }
     
-   /**
-    * Attempts to find all variables in the target string.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Attempts to find all variables in the target string.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject);
@@ -123,12 +123,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))

Spacing +4 added lines, -4 removed lines

@@ -73,7 +73,7 @@ 
     */
     public function getParser() : Mailcode_Parser
     {
-        if(!isset($this->parser)) 
+        if (!isset($this->parser)) 
         {
             $this->parser = new Mailcode_Parser($this);
         }
@@ -89,7 +89,7 @@ 
     */
     public function getCommands() : Mailcode_Commands
     {
-        if(!isset($this->commands)) 
+        if (!isset($this->commands)) 
         {
             $this->commands = new Mailcode_Commands();
         }
@@ -115,7 +115,7 @@ 
     
     public function createVariables() : Mailcode_Variables
     {
-        if(!isset($this->variables))
+        if (!isset($this->variables))
         {
             $this->variables = new Mailcode_Variables();
         }
@@ -131,7 +131,7 @@ 
     */
     public function createTranslator() : Mailcode_Translator
     {
-        if(!isset($this->translator))
+        if (!isset($this->translator))
         {
             $this->translator = new Mailcode_Translator(); 
         }

src/Mailcode/Commands/Command/Comment.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
         $this->paramsString = trim($this->paramsString);
         
         // automatically quote the parameters, since comments don't require any.
-        if(substr($this->paramsString, 0, 1) != '"')
+        if (substr($this->paramsString, 0, 1) != '"')
         {
             $this->paramsString = '"'.$this->paramsString.'"';
         }

src/Mailcode/Collection.php

Indentation +51 added lines, -51 removed lines

@@ -24,9 +24,9 @@ 
 {
     const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -34,17 +34,17 @@ 
      */
     protected $errors = array();
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected $validationResult;
     
-   /**
-    * Adds a command to the collection.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds a command to the collection.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @return Mailcode_Collection
+     */
     public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection
     {
         $this->commands[] = $command;
@@ -56,21 +56,21 @@ 
         return $this;
     }
     
-   /**
-    * Whether there are any commands in the collection.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there are any commands in the collection.
+     * 
+     * @return bool
+     */
     public function hasCommands() : bool
     {
         return !empty($this->commands);
     }
     
-   /**
-    * Counts the amount of commands in the collection.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of commands in the collection.
+     * 
+     * @return int
+     */
     public function countCommands() : int
     {
         return count($this->commands);
@@ -90,9 +90,9 @@ 
         $this->errors[] = new Mailcode_Collection_Error_Command($command);
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -134,25 +134,25 @@ 
         return empty($errors);
     }
     
-   /**
-    * Retrieves all commands that were detected, in the exact order
-    * they were found.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected, in the exact order
+     * they were found.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
-       return $this->commands;
+        return $this->commands;
     }
     
-   /**
-    * Retrieves all unique commands by their matched
-    * string hash: this ensures only commands that were
-    * written the exact same way (including spacing)
-    * are returned.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all unique commands by their matched
+     * string hash: this ensures only commands that were
+     * written the exact same way (including spacing)
+     * are returned.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getGroupedByHash()
     {
         $hashes = array();
@@ -170,12 +170,12 @@ 
         return array_values($hashes);
     }
 
-   /**
-    * Adds several commands at once.
-    * 
-    * @param Mailcode_Commands_Command[] $commands
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds several commands at once.
+     * 
+     * @param Mailcode_Commands_Command[] $commands
+     * @return Mailcode_Collection
+     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
         foreach($commands as $command)
@@ -234,11 +234,11 @@ 
         return false;
     }
     
-   /**
-    * Retrieves only show variable commands in the collection, if any.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
-    */
+    /**
+     * Retrieves only show variable commands in the collection, if any.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
+     */
     public function getShowVariableCommands()
     {
         $result = array();

Spacing +12 added lines, -12 removed lines

@@ -99,7 +99,7 @@ 
         
         $errors = $this->errors;
         
-        if(!$result->isValid())
+        if (!$result->isValid())
         {
             $errors[] = new Mailcode_Collection_Error_Message(
                 '',
@@ -115,7 +115,7 @@ 
     {
         $errors = $this->getErrors();
         
-        if(!empty($errors))
+        if (!empty($errors))
         {
             return array_shift($errors);
         }
@@ -157,11 +157,11 @@ 
     {
         $hashes = array();
         
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
             $hash = $command->getHash();
             
-            if(!isset($hashes[$hash]))
+            if (!isset($hashes[$hash]))
             {
                 $hashes[$hash] = $command;
             }
@@ -178,7 +178,7 @@ 
     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $this->addCommand($command);
         }
@@ -197,7 +197,7 @@ 
     {
         $collection = new Mailcode_Variables_Collection_Regular();
         
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
             $collection->mergeWith($command->getVariables());
         }
@@ -207,7 +207,7 @@ 
     
     public function getValidationResult() : OperationResult
     {
-        if($this->validationResult instanceof OperationResult)
+        if ($this->validationResult instanceof OperationResult)
         {
             return $this->validationResult;
         }
@@ -223,9 +223,9 @@ 
     {
         $errors = $this->getErrors();
         
-        foreach($errors as $error)
+        foreach ($errors as $error)
         {
-            if($error->getCode() === $code)
+            if ($error->getCode() === $code)
             {
                 return true;
             }
@@ -243,9 +243,9 @@ 
     {
         $result = array();
         
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
-            if($command instanceof Mailcode_Commands_Command_ShowVariable)
+            if ($command instanceof Mailcode_Commands_Command_ShowVariable)
             {
                 $result[] = $command;
             }
@@ -258,7 +258,7 @@ 
     {
         $commands = $this->getCommands();
         
-        if(!empty($commands))
+        if (!empty($commands))
         {
             return array_shift($commands);
         }

src/Mailcode/Translator/Syntax/ApacheVelocity.php

Indentation +7 added lines, -7 removed lines

@@ -20,13 +20,13 @@
  */
 abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command
 {
-   /**
-    * Filters the string for use in an Apache Velocity (Java)
-    * regex string: escapes all special characters.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Filters the string for use in an Apache Velocity (Java)
+     * regex string: escapes all special characters.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function filterRegexString(string $string) : string
     {
         $escape = array(

Spacing +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
             ')'
         );
         
-        foreach($escape as $char)
+        foreach ($escape as $char)
         {
             $string = str_replace($char, '\\'.$char, $string);
         }

src/Mailcode/Translator/Syntax.php

Indentation +21 added lines, -21 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_UNKNOWN_COMMAND_TYPE = 50401;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $typeID;
     
     public function __construct(string $typeID)
@@ -33,22 +33,22 @@ 
         $this->typeID = $typeID;
     }
     
-   /**
-    * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
-    * @return string
-    */
+    /**
+     * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
+     * @return string
+     */
     public function getTypeID() : string
     {
         return $this->typeID;
     }
     
-   /**
-    * Translates a single command to the target syntax.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @throws Mailcode_Translator_Exception
-    * @return string
-    */
+    /**
+     * Translates a single command to the target syntax.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @throws Mailcode_Translator_Exception
+     * @return string
+     */
     public function translateCommand(Mailcode_Commands_Command $command) : string
     {
         $translator = $this->createTranslator($command);
@@ -81,13 +81,13 @@ 
         return $translator;
     }
     
-   /**
-    * Translates all safeguarded commands in the subject string to the 
-    * target syntax in one go.
-    * 
-    * @param Mailcode_Parser_Safeguard $safeguard
-    * @return string
-    */
+    /**
+     * Translates all safeguarded commands in the subject string to the 
+     * target syntax in one go.
+     * 
+     * @param Mailcode_Parser_Safeguard $safeguard
+     * @return string
+     */
     public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string
     {
         $subject = $safeguard->makeSafe();

Spacing +3 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
             $command->getID()
         );
         
-        if(!class_exists($class))
+        if (!class_exists($class))
         {
             throw new Mailcode_Translator_Exception(
                 sprintf('Unknown command %s in translator', $command->getID()),
@@ -92,7 +92,7 @@ 
     {
         $subject = $safeguard->makeSafe();
         
-        if(!$safeguard->hasPlaceholders())
+        if (!$safeguard->hasPlaceholders())
         {
             return $subject;
         }
@@ -101,7 +101,7 @@ 
         
         $replaces = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $replaces[$placeholder->getReplacementText()] = $this->translateCommand($placeholder->getCommand());
         }

src/Mailcode/Commands/Command/SetVariable.php

Indentation +3 added lines, -3 removed lines

@@ -25,9 +25,9 @@
     
     const VALIDATION_NOT_ASSIGNMENT_STATEMENT = 48501;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
+     */
     protected $value;
     
     public function getName() : string

Spacing +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
     {
         $variable = $this->params->getInfo()->getVariableByIndex(0);
         
-        if($variable)
+        if ($variable)
         {
             return $variable->getVariable();
         }
@@ -96,7 +96,7 @@ 
     
     protected function validateSyntax_assignment() : void
     {
-        if($this->params->getInfo()->isVariableAssignment())
+        if ($this->params->getInfo()->isVariableAssignment())
         {
             return;
         }
@@ -113,7 +113,7 @@ 
         
         $value = $info->getTokenByIndex(2);
         
-        if($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value)
+        if ($value instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value)
         {
             $this->value = $value;
             return;

src/Mailcode/Commands/Command/ShowVariable.php

Indentation +30 added lines, -30 removed lines

@@ -26,9 +26,9 @@ 
     
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 48402;
     
-   /**
-    * @var Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Variables_Variable|NULL
+     */
     protected $variable;
     
     public function getName() : string
@@ -56,15 +56,15 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         $this->validate();
@@ -81,15 +81,15 @@ 
         );
     }
     
-   /**
-    * Retrieves the full name of the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the full name of the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return string
+     */
     public function getVariableName() : string
     {
         return $this->getVariable()->getFullName();
@@ -97,19 +97,19 @@ 
 
     protected function validateSyntax_require_variable() : void
     {
-         $vars = $this->getVariables()->getGroupedByName();
-         $amount = count($vars);
+            $vars = $this->getVariables()->getGroupedByName();
+            $amount = count($vars);
          
-         if($amount === 1)
-         {
-             $this->variable = array_pop($vars);
-             return;
-         }
+            if($amount === 1)
+            {
+                $this->variable = array_pop($vars);
+                return;
+            }
          
-         $this->validationResult->makeError(
+            $this->validationResult->makeError(
             t('Command has %1$s variables, %2$s expected.', $amount, 1),
             self::VALIDATION_VARIABLE_COUNT_MISMATCH
-         );
+            );
     }
     
     protected function getValidations() : array

Spacing +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
     {
         $this->validate();
         
-        if($this->variable instanceof Mailcode_Variables_Variable)
+        if ($this->variable instanceof Mailcode_Variables_Variable)
         {
             return $this->variable;
         }
@@ -100,7 +100,7 @@ 
          $vars = $this->getVariables()->getGroupedByName();
          $amount = count($vars);
          
-         if($amount === 1)
+         if ($amount === 1)
          {
              $this->variable = array_pop($vars);
              return;

src/Mailcode/Commands/Command.php

Indentation +70 added lines, -70 removed lines

@@ -31,53 +31,53 @@ 
     const VALIDATION_UNKNOWN_COMMAND_NAME = 48304;
     const VALIDATION_INVALID_PARAMS_STATEMENT = 48305;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $paramsString = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash = '';
     
-   /**
-    * @var \AppUtils\OperationResult
-    */
+    /**
+     * @var \AppUtils\OperationResult
+     */
     protected $validationResult = null;
     
-   /**
-    * @var \Mailcode\Mailcode
-    */
+    /**
+     * @var \Mailcode\Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var \Mailcode\Mailcode_Parser_Statement
-    */
+    /**
+     * @var \Mailcode\Mailcode_Parser_Statement
+     */
     protected $params;
 
-   /**
-    * @var string[] 
-    */
+    /**
+     * @var string[] 
+     */
     protected $validations = array(
         'params',
         'type_supported',
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
@@ -95,9 +95,9 @@ 
         
     }
     
-   /**
-    * @return string The ID of the command = the name of the command class file.
-    */
+    /**
+     * @return string The ID of the command = the name of the command class file.
+     */
     public function getID() : string
     {
         // account for commands with types: If_Variable should still return If.
@@ -106,14 +106,14 @@ 
         return array_shift($tokens);
     }
     
-   /**
-    * Sets an optional comment that is not used anywhere, but
-    * can be used by the application to track why a command is
-    * used somewhere. 
-    * 
-    * @param string $comment
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Sets an optional comment that is not used anywhere, but
+     * can be used by the application to track why a command is
+     * used somewhere. 
+     * 
+     * @param string $comment
+     * @return Mailcode_Commands_Command
+     */
     public function setComment(string $comment) : Mailcode_Commands_Command
     {
         $this->comment = $comment;
@@ -121,34 +121,34 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the previously set comment, if any.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the previously set comment, if any.
+     * 
+     * @return string
+     */
     public function getComment() : string
     {
         return $this->comment;
     }
     
-   /**
-    * Checks whether this is a dummy command, which is only
-    * used to access information on the command type. It cannot
-    * be used as an actual live command.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether this is a dummy command, which is only
+     * used to access information on the command type. It cannot
+     * be used as an actual live command.
+     * 
+     * @return bool
+     */
     public function isDummy() : bool
     {
         return $this->type === '__dummy';
     }
     
-   /**
-    * Retrieves a hash of the actual matched command string,
-    * which is used in collections to detect duplicate commands.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a hash of the actual matched command string,
+     * which is used in collections to detect duplicate commands.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         $this->requireNonDummy();
@@ -240,9 +240,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params() : void
@@ -429,22 +429,22 @@ 
         return implode('', $parts);
     }
     
-   /**
-    * Retrieves the names of all the command's supported types: the part
-    * between the command name and the colon. Example: {command type: params}.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all the command's supported types: the part
+     * between the command name and the colon. Example: {command type: params}.
+     * 
+     * @return string[]
+     */
     public function getSupportedTypes() : array
     {
         return array();
     }
     
-   /**
-    * Retrieves all variable names used in the command.
-    * 
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Retrieves all variable names used in the command.
+     * 
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function getVariables() : Mailcode_Variables_Collection_Regular
     {
         return Mailcode::create()->findVariables($this->paramsString);

Spacing +24 added lines, -24 removed lines

@@ -80,7 +80,7 @@ 
     */
     protected $comment = '';
     
-    public function __construct(string $type='', string $paramsString='', string $matchedText='')
+    public function __construct(string $type = '', string $paramsString = '', string $matchedText = '')
     {
         $this->type = $type;
         $this->paramsString = html_entity_decode($paramsString);
@@ -153,7 +153,7 @@ 
     {
         $this->requireNonDummy();
         
-        if($this->hash === '') {
+        if ($this->hash === '') {
             $this->hash = md5($this->matchedText);
         }
         
@@ -162,7 +162,7 @@ 
     
     protected function requireNonDummy() : void
     {
-        if(!$this->isDummy())
+        if (!$this->isDummy())
         {
             return;
         }
@@ -183,7 +183,7 @@ 
     {
         $this->requireNonDummy();
         
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -197,7 +197,7 @@ 
     
     public function getValidationResult() :  \AppUtils\OperationResult
     {
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -213,11 +213,11 @@ 
     {
         $validations = array_merge($this->validations, $this->getValidations());
         
-        foreach($validations as $validation)
+        foreach ($validations as $validation)
         {
             $method = 'validateSyntax_'.$validation;
             
-            if(!method_exists($this, $method))
+            if (!method_exists($this, $method))
             {
                 throw new Mailcode_Exception(
                     'Missing validation method',
@@ -233,7 +233,7 @@ 
             $this->$method();
             
             // break off at the first validation issue
-            if(!$this->validationResult->isValid())
+            if (!$this->validationResult->isValid())
             {
                 return;
             }
@@ -247,12 +247,12 @@ 
     
     protected function validateSyntax_params() : void
     {
-        if(!$this->requiresParameters())
+        if (!$this->requiresParameters())
         {
             return;
         }
         
-        if(empty($this->paramsString))
+        if (empty($this->paramsString))
         {
             $this->validationResult->makeError(
                 t('Parameters have to be specified.'),
@@ -263,7 +263,7 @@ 
         
         $this->params = $this->mailcode->getParser()->createStatement($this->paramsString);
         
-        if(!$this->params->isValid())
+        if (!$this->params->isValid())
         {
             $error = $this->params->getValidationResult();
             
@@ -276,14 +276,14 @@ 
     
     protected function validateSyntax_type_supported() : void
     {
-        if(!$this->supportsType() || empty($this->type))
+        if (!$this->supportsType() || empty($this->type))
         {
             return;
         }
         
         $types = $this->getSupportedTypes();
 
-        if(!in_array($this->type, $types))
+        if (!in_array($this->type, $types))
         {
             $this->validationResult->makeError(
                 t('The command addon %1$s is not supported.', $this->type).' '.
@@ -297,7 +297,7 @@ 
     
     protected function validateSyntax_type_unsupported() : void
     {
-        if($this->supportsType() || empty($this->type))
+        if ($this->supportsType() || empty($this->type))
         {
             return;
         }
@@ -315,7 +315,7 @@ 
     
     public function getType() : string
     {
-        if($this->supportsType())
+        if ($this->supportsType())
         {
             return $this->type;
         }
@@ -335,7 +335,7 @@ 
     
     public function getHighlighted() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -346,7 +346,7 @@ 
     
     public function getParamsString() : string
     {
-        if($this->requiresParameters())
+        if ($this->requiresParameters())
         {
             return $this->paramsString;
         }
@@ -373,22 +373,22 @@ 
     
     public final function getCommandType() : string
     {
-        if($this instanceof Mailcode_Commands_Command_Type_Closing)
+        if ($this instanceof Mailcode_Commands_Command_Type_Closing)
         {
             return 'Closing';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Opening)
+        if ($this instanceof Mailcode_Commands_Command_Type_Opening)
         {
             return 'Opening';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Sibling)
+        if ($this instanceof Mailcode_Commands_Command_Type_Sibling)
         {
             return 'Sibling';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Standalone)
+        if ($this instanceof Mailcode_Commands_Command_Type_Standalone)
         {
             return 'Standalone';
         }
@@ -405,7 +405,7 @@ 
     
     public function getNormalized() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -413,12 +413,12 @@ 
         $parts = array();
         $parts[] = '{'.$this->getName();
         
-        if($this->supportsType() && $this->hasType())
+        if ($this->supportsType() && $this->hasType())
         {
             $parts[] = ' '.$this->getType();
         }
         
-        if($this->requiresParameters() && isset($this->params))
+        if ($this->requiresParameters() && isset($this->params))
         {
             $parts[] = ': ';
             $parts[] = $this->params->getNormalized();