Mistralys / mailcode

src/Mailcode/Factory.php

Indentation +52 added lines, -52 removed lines

@@ -24,17 +24,17 @@ 
     
     const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
     
-   /**
-    * @var Mailcode_Renderer
-    */
+    /**
+     * @var Mailcode_Renderer
+     */
     protected static $renderer;
     
-   /**
-    * Creates a ShowVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowVariable
-    */
+    /**
+     * Creates a ShowVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowVariable
+     */
     public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -50,12 +50,12 @@ 
         return $cmd;
     }
 
-   /**
-    * Creates a ShowSnippet command.
-    *
-    * @param string $snippetName A snippet name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowSnippet
-    */
+    /**
+     * Creates a ShowSnippet command.
+     *
+     * @param string $snippetName A snippet name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowSnippet
+     */
     public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
     {
         $snippetName = self::_filterVariableName($snippetName);
@@ -71,17 +71,17 @@ 
         return $cmd;
     }
     
-   /**
-    * Creates a SetVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @param string $value
-    * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
-    * @return Mailcode_Commands_Command_SetVariable
-    * @throws Mailcode_Factory_Exception
-    * 
-    * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
-    */
+    /**
+     * Creates a SetVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @param string $value
+     * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
+     * @return Mailcode_Commands_Command_SetVariable
+     * @throws Mailcode_Factory_Exception
+     * 
+     * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
+     */
     public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -104,14 +104,14 @@ 
         return $cmd;
     }
     
-   /**
-    * Like setVar(), but treats the value as a string literal
-    * and automatically adds quotes to it.
-    * 
-    * @param string $variableName
-    * @param string $value
-    * @return Mailcode_Commands_Command_SetVariable
-    */
+    /**
+     * Like setVar(), but treats the value as a string literal
+     * and automatically adds quotes to it.
+     * 
+     * @param string $variableName
+     * @param string $value
+     * @return Mailcode_Commands_Command_SetVariable
+     */
     public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
     {
         return self::setVar($variableName, $value, true);
@@ -378,12 +378,12 @@ 
         return '$'.ltrim($name, '$');
     }
     
-   /**
-    * Quotes a string literal: adds the quotes, and escapes any quotes already present in it.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Quotes a string literal: adds the quotes, and escapes any quotes already present in it.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected static function _quoteString(string $string) : string
     {
         return '"'.str_replace('"', '\"', $string).'"';
@@ -416,23 +416,23 @@ 
         );
     }
     
-   /**
-    * Creates a renderer instance, which can be used to easily
-    * create and convert commands to strings.
-    * 
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Creates a renderer instance, which can be used to easily
+     * create and convert commands to strings.
+     * 
+     * @return Mailcode_Renderer
+     */
     public static function createRenderer() : Mailcode_Renderer
     {
         return new Mailcode_Renderer();
     }
     
-   /**
-    * Creates a printer instance, which works like the renderer,
-    * but outputs the generated strings to standard output.
-    * 
-    * @return Mailcode_Printer
-    */
+    /**
+     * Creates a printer instance, which works like the renderer,
+     * but outputs the generated strings to standard output.
+     * 
+     * @return Mailcode_Printer
+     */
     public static function createPrinter() : Mailcode_Printer
     {
         return new Mailcode_Printer();

src/Mailcode/Renderer.php

Spacing +13 added lines, -13 removed lines

@@ -32,7 +32,7 @@ 
     * @param bool $highlighted
     * @return Mailcode_Renderer
     */
-    public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
+    public function setOutputHighlighted(bool $highlighted = true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
         
@@ -55,7 +55,7 @@ 
         return $this->command2string(Mailcode_Factory::showSnippet($snippetName));
     }
     
-    public function setVar(string $variableName, string $value, bool $quoteValue=false) : string
+    public function setVar(string $variableName, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::setVar($variableName, $value, $quoteValue));
     }
@@ -65,12 +65,12 @@ 
         return $this->command2string(Mailcode_Factory::setVarString($variableName, $value));
     }
     
-    public function if(string $condition, string $type='') : string
+    public function if (string $condition, string $type = '') : string
     {
-        return $this->command2string(Mailcode_Factory::if($condition, $type));
+        return $this->command2string(Mailcode_Factory::if ($condition, $type));
     }
     
-    public function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string
+    public function ifVar(string $variable, string $operand, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::ifVar($variable, $operand, $value, $quoteValue));
     }
@@ -80,7 +80,7 @@ 
         return $this->command2string(Mailcode_Factory::ifVarString($variable, $operand, $value));
     }
     
-    public function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : string
+    public function ifVarEquals(string $variable, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::ifVarEquals($variable, $value, $quoteValue));
     }
@@ -90,7 +90,7 @@ 
         return $this->command2string(Mailcode_Factory::ifVarEqualsString($variable, $value));    
     }
     
-    public function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string
+    public function ifVarNotEquals(string $variable, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::ifVarNotEquals($variable, $value, $quoteValue));
     }
@@ -100,12 +100,12 @@ 
         return $this->command2string(Mailcode_Factory::ifVarNotEqualsString($variable, $value));
     }
     
-    public function elseIf(string $condition, string $type='') : string
+    public function elseIf (string $condition, string $type = '') : string
     {
-        return $this->command2string(Mailcode_Factory::elseIf($condition, $type));
+        return $this->command2string(Mailcode_Factory::elseIf ($condition, $type));
     }
     
-    public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : string
+    public function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::elseIfVar($variable, $operand, $value, $quoteValue));
     }
@@ -115,7 +115,7 @@ 
         return $this->command2string(Mailcode_Factory::elseIfVarString($variable, $operand, $value));
     }
     
-    public function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : string
+    public function elseIfVarEquals(string $variable, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::elseIfVarEquals($variable, $value, $quoteValue));
     }
@@ -125,7 +125,7 @@ 
         return $this->command2string(Mailcode_Factory::elseIfVarEqualsString($variable, $value));
     }
     
-    public function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : string
+    public function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue = false) : string
     {
         return $this->command2string(Mailcode_Factory::elseIfVarNotEquals($variable, $value, $quoteValue));
     }
@@ -152,7 +152,7 @@ 
     
     protected function command2string(Mailcode_Commands_Command $command) : string
     {
-        if($this->highlighted)
+        if ($this->highlighted)
         {
             return $command->getHighlighted();
         }

src/Mailcode/Commands/Command.php

Spacing +20 added lines, -20 removed lines

@@ -79,7 +79,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);
@@ -150,7 +150,7 @@ 
     {
         $this->requireNonDummy();
         
-        if($this->hash === '') {
+        if ($this->hash === '') {
             $this->hash = md5($this->matchedText);
         }
         
@@ -159,7 +159,7 @@ 
     
     protected function requireNonDummy() : void
     {
-        if(!$this->isDummy())
+        if (!$this->isDummy())
         {
             return;
         }
@@ -180,7 +180,7 @@ 
     {
         $this->requireNonDummy();
         
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -194,7 +194,7 @@ 
     
     public function getValidationResult() :  \AppUtils\OperationResult
     {
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -210,11 +210,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',
@@ -230,7 +230,7 @@ 
             $this->$method();
             
             // break off at the first validation issue
-            if(!$this->validationResult->isValid())
+            if (!$this->validationResult->isValid())
             {
                 return;
             }
@@ -244,12 +244,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.'),
@@ -260,7 +260,7 @@ 
         
         $this->params = $this->mailcode->getParser()->createStatement($this->paramsString);
         
-        if(!$this->params->isValid())
+        if (!$this->params->isValid())
         {
             $error = $this->params->getValidationResult();
             
@@ -273,14 +273,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).' '.
@@ -294,7 +294,7 @@ 
     
     protected function validateSyntax_type_unsupported() : void
     {
-        if($this->supportsType() || empty($this->type))
+        if ($this->supportsType() || empty($this->type))
         {
             return;
         }
@@ -312,7 +312,7 @@ 
     
     public function getType() : string
     {
-        if($this->supportsType())
+        if ($this->supportsType())
         {
             return $this->type;
         }
@@ -332,7 +332,7 @@ 
     
     public function getHighlighted() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -343,7 +343,7 @@ 
     
     public function getParamsString() : string
     {
-        if($this->requiresParameters())
+        if ($this->requiresParameters())
         {
             return $this->paramsString;
         }
@@ -370,7 +370,7 @@ 
     
     public function getNormalized() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -378,12 +378,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();

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);
         }