Mistralys / mailcode

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

Indentation +13 added lines, -13 removed lines

@@ -29,24 +29,24 @@ 
     
     const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer|NULL
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected $info;
     
     public function __construct(string $statement)
@@ -102,7 +102,7 @@ 
         if($unknown)
         {
             $this->result->makeError(
-               t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
+                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
             );
         }

Spacing +3 added lines, -3 removed lines

@@ -75,7 +75,7 @@ 
     
     public function getInfo() : Mailcode_Parser_Statement_Info
     {
-        if(isset($this->info))
+        if (isset($this->info))
         {
             return $this->info; 
         }
@@ -87,7 +87,7 @@ 
     
     protected function validate() : void
     {
-        if(!$this->tokenizer->hasTokens())
+        if (!$this->tokenizer->hasTokens())
         {
             $this->result->makeError(
                 t('Empty statement'),
@@ -99,7 +99,7 @@ 
         
         $unknown = $this->tokenizer->getFirstUnknown();
         
-        if($unknown)
+        if ($unknown)
         {
             $this->result->makeError(
                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',

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/Commands/Command/ShowSnippet.php

Indentation +30 added lines, -30 removed lines

@@ -24,9 +24,9 @@ 
     
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 52001;
     
-   /**
-    * @var Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Variables_Variable|NULL
+     */
     protected $variable;
     
     public function getName() : string
@@ -49,15 +49,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();
@@ -74,15 +74,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();
@@ -90,19 +90,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

@@ -62,7 +62,7 @@ 
     {
         $this->validate();
         
-        if(isset($this->variable))
+        if (isset($this->variable))
         {
             return $this->variable;
         }
@@ -93,7 +93,7 @@ 
          $vars = $this->getVariables()->getGroupedByName();
          $amount = count($vars);
          
-         if($amount === 1)
+         if ($amount === 1)
          {
              $this->variable = array_pop($vars);
              return;

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(isset($this->validationResult))
+        if (isset($this->validationResult))
         {
             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);
         }