Mistralys / mailcode

src/Mailcode.php

Indentation +36 added lines, -36 removed lines

@@ -26,46 +26,46 @@ 
  */
 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;
     
-   /**
-    * 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)) 
@@ -76,12 +76,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)) 
@@ -97,12 +97,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);

Spacing +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
     */
     public function getParser() : Mailcode_Parser
     {
-        if(!isset($this->parser)) 
+        if (!isset($this->parser)) 
         {
             $this->parser = new Mailcode_Parser($this);
         }
@@ -84,7 +84,7 @@ 
     */
     public function getCommands() : Mailcode_Commands
     {
-        if(!isset($this->commands)) 
+        if (!isset($this->commands)) 
         {
             $this->commands = new Mailcode_Commands();
         }
@@ -110,7 +110,7 @@ 
     
     public function createVariables() : Mailcode_Variables
     {
-        if(!isset($this->variables))
+        if (!isset($this->variables))
         {
             $this->variables = new Mailcode_Variables();
         }

src/Mailcode/Commands/Command.php

Indentation +31 added lines, -31 removed lines

@@ -34,29 +34,29 @@ 
     
     const VALIDATION_UNKNOWN_COMMAND_NAME = 48304;
     
-   /**
-    * @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;
     
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
@@ -66,33 +66,33 @@ 
         $this->matchedText = $matchedText;
     }
     
-   /**
-    * @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
     {
         $tokens = explode('_', get_class($this));
         return array_pop($tokens);
     }
     
-   /**
-    * 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();

Spacing +15 added lines, -15 removed lines

@@ -59,7 +59,7 @@ 
     */
     protected $validationResult = null;
     
-    public function __construct(string $type='', string $paramsString='', string $matchedText='')
+    public function __construct(string $type = '', string $paramsString = '', string $matchedText = '')
     {
         $this->type = $type;
         $this->paramsString = $paramsString;
@@ -97,7 +97,7 @@ 
     {
         $this->requireNonDummy();
         
-        if($this->hash === '') {
+        if ($this->hash === '') {
             $this->hash = md5($this->matchedText);
         }
         
@@ -106,7 +106,7 @@ 
     
     protected function requireNonDummy() : void
     {
-        if(!$this->isDummy())
+        if (!$this->isDummy())
         {
             return;
         }
@@ -127,7 +127,7 @@ 
     {
         $this->requireNonDummy();
         
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -141,7 +141,7 @@ 
     
     public function getValidationResult() :  \AppUtils\OperationResult
     {
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -164,11 +164,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',
@@ -184,7 +184,7 @@ 
             $this->$method();
             
             // break off at the first validation issue
-            if(!$this->validationResult->isValid())
+            if (!$this->validationResult->isValid())
             {
                 return;
             }
@@ -195,7 +195,7 @@ 
     
     protected function validateSyntax_params()
     {
-        if($this->requiresParameters() && empty($this->paramsString))
+        if ($this->requiresParameters() && empty($this->paramsString))
         {
             $this->validationResult->makeError(
                 t('Parameters have to be specified.'),
@@ -207,14 +207,14 @@ 
     
     protected function validateSyntax_type_supported()
     {
-        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).' '.
@@ -228,7 +228,7 @@ 
     
     protected function validateSyntax_type_unsupported()
     {
-        if($this->supportsType() || empty($this->type))
+        if ($this->supportsType() || empty($this->type))
         {
             return;
         }
@@ -243,7 +243,7 @@ 
     {
         $vars = $this->getVariables();
         
-        if(!$vars->hasInvalid()) 
+        if (!$vars->hasInvalid()) 
         {
             return;
         }
@@ -263,7 +263,7 @@ 
     
     public function getType() : string
     {
-        if($this->supportsType())
+        if ($this->supportsType())
         {
             return $this->type;
         }
@@ -289,7 +289,7 @@ 
     
     public function getParamsString() : string
     {
-        if($this->requiresParameters())
+        if ($this->requiresParameters())
         {
             return $this->paramsString;
         }

src/Mailcode/Commands/Command/ShowVariable.php

Indentation +7 added lines, -7 removed lines

@@ -45,17 +45,17 @@
 
     protected function validateSyntax_require_variable()
     {
-         $amount = $this->getVariables()->countVariables();
+            $amount = $this->getVariables()->countVariables();
          
-         if($amount === 1)
-         {
-             return;
-         }
+            if($amount === 1)
+            {
+                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 +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     {
          $amount = $this->getVariables()->countVariables();
          
-         if($amount === 1)
+         if ($amount === 1)
          {
              return;
          }

src/Mailcode/Variables/Variable.php

Indentation +15 added lines, -15 removed lines

@@ -29,29 +29,29 @@
     
     const VALIDATION_ERROR_NAME_NUMERIC = 48202;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash = '';
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult = null;
     
     public function __construct(string $path, string $name, string $matchedText)

Spacing +4 added lines, -4 removed lines

@@ -83,7 +83,7 @@ 
     
     public function getHash() : string
     {
-        if(empty($this->hash))
+        if (empty($this->hash))
         {
             $this->hash = md5($this->matchedText);
         }
@@ -107,14 +107,14 @@ 
     
     protected function validate() : void
     {
-        if(isset($this->validationResult))
+        if (isset($this->validationResult))
         {
             return;
         }
         
         $this->validationResult = new OperationResult($this);
         
-        if(is_numeric(substr($this->path, 0, 1))) 
+        if (is_numeric(substr($this->path, 0, 1))) 
         {
             $this->validationResult->makeError(
                 t(
@@ -126,7 +126,7 @@ 
             );
         }
         
-        if(is_numeric(substr($this->name, 0, 1)))
+        if (is_numeric(substr($this->name, 0, 1)))
         {
             $this->validationResult->makeError(
                 t(

src/Mailcode/Variables/Collection/Regular.php

Indentation +17 added lines, -17 removed lines

@@ -20,9 +20,9 @@ 
  */
 class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Invalid
+     */
     protected $invalid;
 
     protected function init() : void
@@ -47,30 +47,30 @@ 
         return $this;
     }
 
-   /**
-    * Whether any of the variables in the collection are invalid.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether any of the variables in the collection are invalid.
+     * 
+     * @return bool
+     */
     public function hasInvalid() : bool
     {
         return isset($this->invalid) && $this->invalid->hasVariables();
     }
     
-   /**
-    * Retrieves the collection of invalid variables, if any.
-    * Behaves like a variables collection.
-    * 
-    * @return Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * Retrieves the collection of invalid variables, if any.
+     * Behaves like a variables collection.
+     * 
+     * @return Mailcode_Variables_Collection_Invalid
+     */
     public function getInvalid() : Mailcode_Variables_Collection_Invalid
     {
         return $this->invalid;
     }
     
-   /**
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         parent::mergeWith($collection);

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     
     public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection
     {
-        if(!$variable->isValid())
+        if (!$variable->isValid())
         {
             return $this->addInvalid($variable);
         }
@@ -76,7 +76,7 @@ 
         parent::mergeWith($collection);
         
         // also inherit any invalid variables
-        if($collection instanceof Mailcode_Variables_Collection_Regular)
+        if ($collection instanceof Mailcode_Variables_Collection_Regular)
         {
             $invalid = $collection->getInvalid();
             

src/Mailcode/Variables/Collection/Invalid.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 {
     public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection
     {
-        if($variable->isValid())
+        if ($variable->isValid())
         {
             return $this;
         }

src/Mailcode/Variables/Collection.php

Indentation +54 added lines, -54 removed lines

@@ -20,11 +20,11 @@ 
  */
 abstract class Mailcode_Variables_Collection
 {
-   /**
-    * Stores variables by their hash.
-    * 
-    * @var array[string]Mailcode_Variables_Variable
-    */
+    /**
+     * Stores variables by their hash.
+     * 
+     * @var array[string]Mailcode_Variables_Variable
+     */
     protected $variables = array();
     
     public function __construct()
@@ -56,12 +56,12 @@ 
         return count($this->variables);
     }
     
-   /**
-    * Checks whether the collection contains a variable with the specified name.
-    * 
-    * @param string $fullName The variable name, with or without $ sign.
-    * @return bool
-    */
+    /**
+     * Checks whether the collection contains a variable with the specified name.
+     * 
+     * @param string $fullName The variable name, with or without $ sign.
+     * @return bool
+     */
     public function hasVariableName(string $fullName) : bool
     {
         $fullName = $this->fixName($fullName);
@@ -77,14 +77,14 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a collection of all variable instances for
-    * the specified name (there can be several with differing
-    * matched texts because of spacing).
-    * 
-    * @param string $fullName
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     * Retrieves a collection of all variable instances for
+     * the specified name (there can be several with differing
+     * matched texts because of spacing).
+     * 
+     * @param string $fullName
+     * @return Mailcode_Variables_Collection
+     */
     public function getByFullName(string $fullName) : Mailcode_Variables_Collection
     {
         $fullName = $this->fixName($fullName);
@@ -102,12 +102,12 @@ 
         return $collection;
     }
     
-   /**
-    * Prepends the $ sign to a variable name if it does not have it.
-    * 
-    * @param string $fullName
-    * @return string
-    */
+    /**
+     * Prepends the $ sign to a variable name if it does not have it.
+     * 
+     * @param string $fullName
+     * @return string
+     */
     protected function fixName(string $fullName) : string
     {
         if(substr($fullName, 0, 1) === '$')
@@ -118,22 +118,22 @@ 
         return '$'.$fullName;
     }
     
-   /**
-    * Retrieves all variables, grouped by their hash - meaning
-    * unique matched strings.
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their hash - meaning
+     * unique matched strings.
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByHash()
     {
         return $this->sortVariables($this->variables);
     }
     
-   /**
-    * Retrieves all variables, grouped by their name. 
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their name. 
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByName()
     {
         $entries = array();
@@ -146,10 +146,10 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves the full names of the variables that are present in the collection.
-    * @return string[]
-    */
+    /**
+     * Retrieves the full names of the variables that are present in the collection.
+     * @return string[]
+     */
     public function getNames() : array
     {
         $result = array();
@@ -167,13 +167,13 @@ 
         return $result;
     }
     
-   /**
-    * Takes a list of variables and sorts them, throwing away
-    * the source array's keys.
-    * 
-    * @param array $entries
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Takes a list of variables and sorts them, throwing away
+     * the source array's keys.
+     * 
+     * @param array $entries
+     * @return Mailcode_Variables_Variable[]
+     */
     protected function sortVariables(array $entries)
     {
         $result = array_values($entries);
@@ -186,13 +186,13 @@ 
         return $result;
     }
 
-   /**
-    *  Merges the variables collection with the target collection
-    *  by inheriting all that collection's variables.
-    *  
-    * @param Mailcode_Variables_Collection $collection
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     *  Merges the variables collection with the target collection
+     *  by inheriting all that collection's variables.
+     *  
+     * @param Mailcode_Variables_Collection $collection
+     * @return Mailcode_Variables_Collection
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         $variables = $collection->getGroupedByHash();

Spacing +9 added lines, -9 removed lines

@@ -66,9 +66,9 @@ 
     {
         $fullName = $this->fixName($fullName);
         
-        foreach($this->variables as $variable)
+        foreach ($this->variables as $variable)
         {
-            if($variable->getFullName() === $fullName)
+            if ($variable->getFullName() === $fullName)
             {
                 return true;
             }
@@ -91,9 +91,9 @@ 
         
         $collection = new Mailcode_Variables_Collection_Regular();
         
-        foreach($this->variables as $variable)
+        foreach ($this->variables as $variable)
         {
-            if($variable->getFullName() === $fullName)
+            if ($variable->getFullName() === $fullName)
             {
                 $collection->add($variable);
             }
@@ -110,7 +110,7 @@ 
     */
     protected function fixName(string $fullName) : string
     {
-        if(substr($fullName, 0, 1) === '$')
+        if (substr($fullName, 0, 1) === '$')
         {
             return $fullName;
         }
@@ -138,7 +138,7 @@ 
     {
         $entries = array();
         
-        foreach($this->variables as $variable)
+        foreach ($this->variables as $variable)
         {
             $entries[$variable->getFullName()] = $variable;
         }
@@ -154,11 +154,11 @@ 
     {
         $result = array();
         
-        foreach($this->variables as $variable)
+        foreach ($this->variables as $variable)
         {
             $name = $variable->getFullName();
             
-            if(!in_array($name, $result))
+            if (!in_array($name, $result))
             {
                 $result[] = $name;
             }
@@ -197,7 +197,7 @@ 
     {
         $variables = $collection->getGroupedByHash();
         
-        foreach($variables as $variable)
+        foreach ($variables as $variable)
         {
             $this->add($variable);
         }

src/Mailcode/Collection.php

Indentation +28 added lines, -28 removed lines

@@ -20,9 +20,9 @@ 
  */
 class Mailcode_Collection
 {
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -30,12 +30,12 @@ 
      */
     protected $errors = array();
     
-   /**
-    * 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
     {
         $hash = $command->getHash();
@@ -47,21 +47,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);
@@ -81,9 +81,9 @@ 
         $this->errors[] = new Mailcode_Collection_Error_Command($command);
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         return $this->errors;
@@ -94,14 +94,14 @@ 
         return empty($this->errors);
     }
     
-   /**
-    * Retrieves all commands that were detected.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
-       return $this->commands;
+        return $this->commands;
     }
     
     public function addCommands(array $commands) : Mailcode_Collection

Spacing +3 added lines, -3 removed lines

@@ -40,7 +40,7 @@ 
     {
         $hash = $command->getHash();
         
-        if(!isset($this->commands[$hash])) {
+        if (!isset($this->commands[$hash])) {
             $this->commands[$hash] = $command;
         }
         
@@ -106,7 +106,7 @@ 
     
     public function addCommands(array $commands) : Mailcode_Collection
     {
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $this->addCommand($command);
         }
@@ -125,7 +125,7 @@ 
     {
         $collection = new Mailcode_Variables_Collection_Regular();
         
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
             $collection->mergeWith($command->getVariables());
         }

src/Mailcode/Variables.php

Indentation +6 added lines, -6 removed lines

@@ -22,12 +22,12 @@
 {
     const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9]+)\s*\.\s*([A-Z0-9]+)/sx';
     
-   /**
-    * 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
     {
         $collection = new Mailcode_Variables_Collection_Regular();

Spacing +2 added lines, -2 removed lines

@@ -35,12 +35,12 @@
         $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 $collection;
         }
         
-        foreach($matches[0] as $idx => $matchedText)
+        foreach ($matches[0] as $idx => $matchedText)
         {
             $path = $matches[1][$idx];
             $name = $matches[2][$idx];