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/Parser/Safeguard/Formatter.php

Indentation +26 added lines, -26 removed lines

@@ -24,9 +24,9 @@ 
  */
 abstract class Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     protected $safeguard;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard)
@@ -36,13 +36,13 @@ 
     
     abstract public function format(string $subject) : string;
     
-   /**
-    * Resolves a list of positions of needle in the haystack.
-    * 
-    * @param string $needle
-    * @param string $haystack
-    * @return int[]
-    */
+    /**
+     * Resolves a list of positions of needle in the haystack.
+     * 
+     * @param string $needle
+     * @param string $haystack
+     * @return int[]
+     */
     protected function resolvePositions(string $needle, string $haystack) : array
     {
         $lastPos = 0;
@@ -57,12 +57,12 @@ 
         return $positions;
     }
     
-   /**
-    * Resolves the newline character used in the string.
-    * 
-    * @param string $subject
-    * @return string
-    */
+    /**
+     * Resolves the newline character used in the string.
+     * 
+     * @param string $subject
+     * @return string
+     */
     protected function resolveNewlineChar(string $subject) : string
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
@@ -75,13 +75,13 @@ 
         return PHP_EOL;
     }
     
-   /**
-    * Resolves the list of placeholder strings that need
-    * to be formatted. This includes only commands that
-    * do not generate content.
-    *  
-    * @return string[]
-    */
+    /**
+     * Resolves the list of placeholder strings that need
+     * to be formatted. This includes only commands that
+     * do not generate content.
+     *  
+     * @return string[]
+     */
     protected function resolvePlaceholderStrings() : array
     {
         $placeholders = $this->filterPlaceholders();
@@ -96,9 +96,9 @@ 
         return $result;
     }
     
-   /**
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         return $this->safeguard->getPlaceholders();

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         $lastPos = 0;
         $positions = array();
         
-        while (($lastPos = mb_strpos($haystack, $needle, $lastPos))!== false)
+        while (($lastPos = mb_strpos($haystack, $needle, $lastPos)) !== false)
         {
             $positions[] = $lastPos;
             $lastPos = $lastPos + mb_strlen($needle);
@@ -67,7 +67,7 @@ 
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
         
-        if($eol)
+        if ($eol)
         {
             return $eol->getCharacter();
         }
@@ -88,7 +88,7 @@ 
         
         $result = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $result[] = $placeholder->getReplacementText();
         }

src/Mailcode/Parser/Safeguard/Formatter/SingleLines/Placeholder.php

Indentation +26 added lines, -26 removed lines

@@ -21,39 +21,39 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines_Placeholder
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $subject;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
+     */
     protected $formatter;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $prepend = false;
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $append = false;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $placeholderLength;
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter_SingleLines $formatter, string $subject, int $placeholderLength, int $position)
@@ -67,11 +67,11 @@ 
         $this->analyzeAppend($subject);
     }
     
-   /**
-    * Whether an EOL character needs to be appended or prepended.
-    *  
-    * @return bool
-    */
+    /**
+     * Whether an EOL character needs to be appended or prepended.
+     *  
+     * @return bool
+     */
     public function requiresAdjustment() : bool
     {
         return $this->requiresAppend() || $this->requiresPrepend();

Spacing +6 added lines, -6 removed lines

@@ -90,21 +90,21 @@ 
     protected function analyzePrepend(string $subject) : void
     {
         // we're at the beginning of the string
-        if($this->position == 0)
+        if ($this->position == 0)
         {
             return;
         }
         
         $prevPos = $this->position - $this->eolLength;
         
-        if($prevPos < 0)
+        if ($prevPos < 0)
         {
             $prevPos = 0;
         }
         
         $prev = mb_substr($subject, $prevPos, $this->eolLength);
         
-        if($prev !== $this->formatter->getEOLChar())
+        if ($prev !== $this->formatter->getEOLChar())
         {
             $this->prepend = true;
         }
@@ -117,21 +117,21 @@ 
         $position = $this->position + $this->placeholderLength;
         
         // we're at the end of the string
-        if($position >= $subjectLength)
+        if ($position >= $subjectLength)
         {
             return;
         }
         
         $nextPos = $position + $this->eolLength;
         
-        if($nextPos > $subjectLength)
+        if ($nextPos > $subjectLength)
         {
             $nextPos = $subjectLength - $this->eolLength;
         }
         
         $next = mb_substr($subject, $nextPos, $this->eolLength);
         
-        if($next !== $this->formatter->getEOLChar())
+        if ($next !== $this->formatter->getEOLChar())
         {
             $this->append = true;
         }