Mistralys / mailcode

src/Mailcode/Factory.php

Indentation +46 added lines, -46 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,17 +50,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);
@@ -83,14 +83,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);
@@ -355,12 +355,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).'"';
@@ -393,23 +393,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();

Spacing +29 added lines, -29 removed lines

@@ -61,11 +61,11 @@ 
     * 
     * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
     */
-    public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
+    public static function setVar(string $variableName, string $value, bool $quoteValue = true) : Mailcode_Commands_Command_SetVariable
     {
         $variableName = self::_filterVariableName($variableName);
         
-        if($quoteValue)
+        if ($quoteValue)
         {
             $value = self::_quoteString($value);
         }
@@ -138,11 +138,11 @@ 
         return $cmd;
     }
     
-    protected static function _buildIf(string $cmd, string $condition, string $type='') : Mailcode_Commands_Command
+    protected static function _buildIf(string $cmd, string $condition, string $type = '') : Mailcode_Commands_Command
     {
         $stringType = $type;
         
-        if(!empty($type))
+        if (!empty($type))
         {
             $stringType = ' '.$type;
         }
@@ -165,9 +165,9 @@ 
         return $cmd;
     }
   
-    protected static function _buildIfVar(string $cmd, string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command
+    protected static function _buildIfVar(string $cmd, string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command
     {
-        if($quoteValue)
+        if ($quoteValue)
         {
             $value = self::_quoteString($value);
         }
@@ -182,11 +182,11 @@ 
         return self::_buildIf($cmd, $condition, 'variable');
     }
     
-    public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If
+    public static function if (string $condition, string $type = '') : Mailcode_Commands_Command_If
     {
         $cmd = self::_buildIf('If', $condition, $type);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -194,11 +194,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If
+    public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If
     {
         $cmd = self::_buildIfVar('If', $variable, $operand, $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -210,7 +210,7 @@ 
     {
         $cmd = self::_buildIfVar('If', $variable, $operand, $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -218,11 +218,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If
+    public static function ifVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If
     {
         $cmd = self::_buildIfVar('If', $variable, '==', $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -234,7 +234,7 @@ 
     {
         $cmd = self::_buildIfVar('If', $variable, '==', $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -242,11 +242,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If
+    public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_If
     {
         $cmd = self::_buildIfVar('If', $variable, '!=', $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -258,7 +258,7 @@ 
     {
         $cmd = self::_buildIfVar('If', $variable, '!=', $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_If)
+        if ($cmd instanceof Mailcode_Commands_Command_If)
         {
             return $cmd;
         }
@@ -266,11 +266,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function elseIf(string $condition, string $type='') : Mailcode_Commands_Command_ElseIf
+    public static function elseIf (string $condition, string $type = '') : Mailcode_Commands_Command_ElseIf
     {
         $cmd = self::_buildIf('ElseIf', $condition, $type);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -278,11 +278,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf
+    public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, $operand, $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -294,7 +294,7 @@ 
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, $operand, $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -302,11 +302,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf
+    public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, '==', $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -318,7 +318,7 @@ 
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, '==', $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -326,11 +326,11 @@ 
         throw self::_exceptionUnexpectedType($cmd);
     }
     
-    public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf
+    public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue = false) : Mailcode_Commands_Command_ElseIf
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, '!=', $value, $quoteValue);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -342,7 +342,7 @@ 
     {
         $cmd = self::_buildIfVar('ElseIf', $variable, '!=', $value, true);
         
-        if($cmd instanceof Mailcode_Commands_Command_ElseIf)
+        if ($cmd instanceof Mailcode_Commands_Command_ElseIf)
         {
             return $cmd;
         }
@@ -368,7 +368,7 @@ 
     
     protected static function _checkCommand(Mailcode_Commands_Command $command) : void
     {
-        if($command->isValid())
+        if ($command->isValid())
         {
             return;
         }

src/Mailcode/Commands/Command.php

Indentation +70 added lines, -70 removed lines

@@ -30,53 +30,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='')
@@ -94,23 +94,23 @@ 
         
     }
     
-   /**
-    * @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);
     }
     
-   /**
-    * 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;
@@ -118,34 +118,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();
@@ -237,9 +237,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params() : void
@@ -394,22 +394,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 +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 = $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/Parser/Safeguard.php

Indentation +107 added lines, -107 removed lines

@@ -57,45 +57,45 @@ 
     
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
     
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected $placeholders;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '__';
     
-   /**
-    * @var array|NULL
-    */
+    /**
+     * @var array|NULL
+     */
     protected $placeholderStrings;
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -104,15 +104,15 @@ 
         $this->originalString = $subject;
     }
     
-   /**
-    * Sets the delimiter character sequence used to prepend
-    * and append to the placeholders.
-    * 
-    * The delimiter's default is "__" (two underscores).
-    * 
-    * @param string $delimiter
-    * @return Mailcode_Parser_Safeguard
-    */
+    /**
+     * Sets the delimiter character sequence used to prepend
+     * and append to the placeholders.
+     * 
+     * The delimiter's default is "__" (two underscores).
+     * 
+     * @param string $delimiter
+     * @return Mailcode_Parser_Safeguard
+     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
         if(empty($delimiter))
@@ -134,15 +134,15 @@ 
         return $this->delimiter;
     }
     
-   /**
-    * Retrieves the safe string in which all commands have been replaced
-    * by placeholder strings.
-    * 
-    * @return string
-    * @throws Mailcode_Exception 
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Retrieves the safe string in which all commands have been replaced
+     * by placeholder strings.
+     * 
+     * @return string
+     * @throws Mailcode_Exception 
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeSafe() : string
     {
         $this->requireValidCollection();
@@ -152,10 +152,10 @@ 
         return str_replace(array_values($replaces), array_keys($replaces), $this->originalString);
     }
     
-   /**
-    * @param bool $highlighted
-    * @return string[]string
-    */
+    /**
+     * @param bool $highlighted
+     * @return string[]string
+     */
     protected function getReplaces(bool $highlighted=false) : array
     {
         $placeholders = $this->getPlaceholders();
@@ -182,12 +182,12 @@ 
     }
     
     
-   /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     public function getPlaceholders()
     {
         if(isset($this->placeholders))
@@ -239,46 +239,46 @@ 
         return str_replace($placeholderStrings, array_values($replaces), $string);
     }
     
-   /**
-    * Makes the string whole again after transforming or filtering it,
-    * by replacing the command placeholders with the original commands.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Makes the string whole again after transforming or filtering it,
+     * by replacing the command placeholders with the original commands.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore($string, false);
     }
 
-   /**
-    * Like makeWhole(), but replaces the commands with a syntax
-    * highlighted version, meant for human readable texts only.
-    * 
-    * Note: the commands lose their functionality (They cannot be 
-    * parsed from that string again).
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Like makeWhole(), but replaces the commands with a syntax
+     * highlighted version, meant for human readable texts only.
+     * 
+     * Note: the commands lose their functionality (They cannot be 
+     * parsed from that string again).
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore($string, true);
     }
     
-   /**
-    * Retrieves the commands collection contained in the string.
-    * 
-    * @return Mailcode_Collection
-    */
+    /**
+     * Retrieves the commands collection contained in the string.
+     * 
+     * @return Mailcode_Collection
+     */
     public function getCollection() : Mailcode_Collection
     {
         if(isset($this->collection))
@@ -296,11 +296,11 @@ 
         return $this->getCollection()->isValid();
     }
     
-   /**
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     protected function requireValidCollection() : void
     {
         if($this->getCollection()->isValid())
@@ -318,11 +318,11 @@ 
         );
     }
     
-   /**
-    * Retrieves a list of all placeholder IDs used in the text.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all placeholder IDs used in the text.
+     * 
+     * @return string[]
+     */
     public function getPlaceholderStrings() : array
     {
         if(isset($this->placeholderStrings))
@@ -349,13 +349,13 @@ 
         return in_array($subject, $ids);
     }
     
-   /**
-    * Retrieves a placeholder instance by its ID.
-    * 
-    * @param int $id
-    * @throws Mailcode_Exception If the placeholder was not found.
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * Retrieves a placeholder instance by its ID.
+     * 
+     * @param int $id
+     * @throws Mailcode_Exception If the placeholder was not found.
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     */
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
     {
         $placeholders = $this->getPlaceholders();
@@ -378,13 +378,13 @@ 
         );
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         $placeholders = $this->getPlaceholders();

Spacing +17 added lines, -17 removed lines

@@ -115,7 +115,7 @@ 
     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
-        if(empty($delimiter))
+        if (empty($delimiter))
         {
             throw new Mailcode_Exception(
                 'Empty delimiter',
@@ -156,17 +156,17 @@ 
     * @param bool $highlighted
     * @return string[]string
     */
-    protected function getReplaces(bool $highlighted=false) : array
+    protected function getReplaces(bool $highlighted = false) : array
     {
         $placeholders = $this->getPlaceholders();
         
         $replaces = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $replace = '';
             
-            if($highlighted)
+            if ($highlighted)
             {
                 $replace = $placeholder->getHighlightedText();
             }
@@ -190,7 +190,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -199,7 +199,7 @@ 
         
         $cmds = $this->getCollection()->getGroupedByHash();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -213,7 +213,7 @@ 
         return $this->placeholders;
     }
     
-    protected function restore(string $string, bool $highlighted=false) : string
+    protected function restore(string $string, bool $highlighted = false) : string
     {
         $this->requireValidCollection();
         
@@ -221,9 +221,9 @@ 
         
         $placeholderStrings = array_keys($replaces);
         
-        foreach($placeholderStrings as $search)
+        foreach ($placeholderStrings as $search)
         {
-            if(!strstr($string, $search))
+            if (!strstr($string, $search))
             {
                 throw new Mailcode_Exception(
                     'Command placeholder not found',
@@ -281,7 +281,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -303,7 +303,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -325,7 +325,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(isset($this->placeholderStrings))
+        if (isset($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -334,7 +334,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -360,9 +360,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -389,9 +389,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }

src/Mailcode/Collection.php

Indentation +51 added lines, -51 removed lines

@@ -22,9 +22,9 @@ 
  */
 class Mailcode_Collection
 {
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -32,17 +32,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;
@@ -54,21 +54,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);
@@ -88,9 +88,9 @@ 
         $this->errors[] = new Mailcode_Collection_Error_Command($command);
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -116,25 +116,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();
@@ -152,12 +152,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)
@@ -216,11 +216,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 +10 added lines, -10 removed lines

@@ -97,7 +97,7 @@ 
         
         $errors = $this->errors;
         
-        if(!$result->isValid())
+        if (!$result->isValid())
         {
             $errors[] = new Mailcode_Collection_Error_Message(
                 '',
@@ -139,11 +139,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;
             }
@@ -160,7 +160,7 @@ 
     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $this->addCommand($command);
         }
@@ -179,7 +179,7 @@ 
     {
         $collection = new Mailcode_Variables_Collection_Regular();
         
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
             $collection->mergeWith($command->getVariables());
         }
@@ -189,7 +189,7 @@ 
     
     public function getValidationResult() : OperationResult
     {
-        if(isset($this->validationResult))
+        if (isset($this->validationResult))
         {
             return $this->validationResult;
         }
@@ -205,9 +205,9 @@ 
     {
         $errors = $this->getErrors();
         
-        foreach($errors as $error)
+        foreach ($errors as $error)
         {
-            if($error->getCode() === $code)
+            if ($error->getCode() === $code)
             {
                 return true;
             }
@@ -225,9 +225,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;
             }

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::showVar($variableName));

Spacing +6 added lines, -6 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;
         
@@ -60,9 +60,9 @@ 
         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) : string
@@ -95,9 +95,9 @@ 
         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) : string
@@ -147,7 +147,7 @@ 
     
     protected function command2string(Mailcode_Commands_Command $command) : string
     {
-        if($this->highlighted)
+        if ($this->highlighted)
         {
             return $command->getHighlighted();
         }

Braces +9 added lines, -3 removed lines

@@ -62,7 +62,9 @@ 
     
     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) : string
@@ -97,7 +99,9 @@ 
     
     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) : string
@@ -130,10 +134,12 @@ 
         return $this->command2string(Mailcode_Factory::elseIfVarNotEqualsString($variable, $value));
     }
     
-    public function else() : string
+    public function else {
+        () : string
     {
         return $this->command2string(Mailcode_Factory::else());
     }
+    }
     
     public function end() : string
     {