Mistralys / mailcode

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,41 +26,41 @@ 
  */
 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()
@@ -68,11 +68,11 @@ 
             ->getCollection();
     }
     
-   /**
-    * 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)) 
@@ -83,12 +83,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)) 
@@ -131,12 +131,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))
@@ -147,12 +147,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();

src/Mailcode/Variables/Collection/Regular.php

Indentation +17 added lines, -17 removed lines

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

src/Mailcode/Variables/Collection/Invalid.php

Spacing +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 
     public function add(Mailcode_Variables_Variable $variable) : Mailcode_Variables_Collection
     {
-        if($variable->isValid())
+        if ($variable->isValid())
         {
             return $this;
         }
@@ -38,7 +38,7 @@ 
     {
         $first = $this->getFirst();
 
-        if($first)
+        if ($first)
         {
             return $first->getValidationResult();
         }

src/Mailcode/Variables/Variable.php

Indentation +18 added lines, -18 removed lines

@@ -32,34 +32,34 @@
     public const VALIDATION_ERROR_PATH_UNDERSCORE = 48203;
     public const VALIDATION_ERROR_NAME_UNDERSCORE = 48204;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $matchedText;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $hash = '';
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected ?OperationResult $validationResult = null;
     
-   /**
-    * @var array<string>
-    */
+    /**
+     * @var array<string>
+     */
     protected $validations = array(
         'number_path',
         'number_name',

Spacing +10 added lines, -10 removed lines

@@ -72,7 +72,7 @@ 
      */
     private ?Mailcode_Commands_Command $command;
 
-    public function __construct(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand=null)
+    public function __construct(string $path, string $name, string $matchedText, ?Mailcode_Commands_Command $sourceCommand = null)
     {
         $this->path = $path;
         $this->name = $name;
@@ -95,7 +95,7 @@ 
     
     public function getFullName() : string
     {
-        if(empty($this->path))
+        if (empty($this->path))
         {
             return '$'.$this->name;
         }
@@ -113,7 +113,7 @@ 
      */
     public function getUniqueName() : string
     {
-        if(isset($this->command))
+        if (isset($this->command))
         {
             return $this->getFullName().'/'.$this->command->getHash();
         }
@@ -138,7 +138,7 @@ 
     
     public function getHash() : string
     {
-        if(empty($this->hash))
+        if (empty($this->hash))
         {
             $this->hash = md5($this->matchedText);
         }
@@ -157,7 +157,7 @@ 
      */
     public function getValidationResult() : OperationResult
     {
-        if(isset($this->validationResult))
+        if (isset($this->validationResult))
         {
             return $this->validationResult;
         }
@@ -171,11 +171,11 @@ 
 
     protected function validate(OperationResult $result) : void
     {
-        foreach($this->validations as $validation)
+        foreach ($this->validations as $validation)
         {
             $method = 'validate_'.$validation;
             
-            if(!method_exists($this, $method))
+            if (!method_exists($this, $method))
             {
                 throw new Mailcode_Exception(
                     'Unknown validation method',
@@ -220,7 +220,7 @@ 
     
     protected function validateNumber(string $value, int $errorCode) : void
     {
-        if(!is_numeric(substr($value, 0, 1)))
+        if (!is_numeric(substr($value, 0, 1)))
         {
             return;
         }
@@ -238,7 +238,7 @@ 
     protected function validateUnderscore(string $value, int $errorCode) : void
     {
         // allow empty paths
-        if(empty($value))
+        if (empty($value))
         {
             return;
         }
@@ -246,7 +246,7 @@ 
         $length = strlen($value);
         
         // trimming underscores does not change the length: no underscores at start or end of string.
-        if(strlen(trim($value, '_')) === $length)
+        if (strlen(trim($value, '_')) === $length)
         {
             return;
         }

src/Mailcode/Variables/Collection.php

Indentation +56 added lines, -56 removed lines

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

src/Mailcode/Parser/PreParser.php

Spacing +12 added lines, -12 removed lines

@@ -111,7 +111,7 @@ 
      */
     public static function getContent(int $id) : string
     {
-        if(isset(self::$contents[$id]))
+        if (isset(self::$contents[$id]))
         {
             return self::$contents[$id];
         }
@@ -134,7 +134,7 @@ 
      */
     public static function clearContent(int $id) : void
     {
-        if(isset(self::$contents[$id]))
+        if (isset(self::$contents[$id]))
         {
             unset(self::$contents[$id]);
         }
@@ -155,7 +155,7 @@ 
 
         $names = $this->getContentCommandNames();
 
-        foreach($names as $name)
+        foreach ($names as $name)
         {
             $this->collapseContentCommand($name);
         }
@@ -174,7 +174,7 @@ 
         $commands = Mailcode::create()->getCommands()->getContentCommands();
         $result = array();
 
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $result[] = $command->getName();
         }
@@ -245,7 +245,7 @@ 
     {
         $this->commands = $this->detectCommands($name);
 
-        foreach($this->commands as $commandDef)
+        foreach ($this->commands as $commandDef)
         {
             $this->processCommand($commandDef);
         }
@@ -255,9 +255,9 @@ 
 
     private function validateCommandContents() : void
     {
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
-            if(!$command->validateContent($this, $this->collection))
+            if (!$command->validateContent($this, $this->collection))
             {
                 return;
             }
@@ -271,14 +271,14 @@ 
     {
         $openingCommands = $this->detectOpeningCommands($name);
 
-        if(empty($openingCommands))
+        if (empty($openingCommands))
         {
             return array();
         }
 
         $closingCommands = $this->detectClosingCommands($name);
 
-        if(count($closingCommands) !== count($openingCommands))
+        if (count($closingCommands) !== count($openingCommands))
         {
             $this->addClosingError($name);
             return array();
@@ -286,7 +286,7 @@ 
 
         $result = array();
 
-        foreach($openingCommands as $idx => $def)
+        foreach ($openingCommands as $idx => $def)
         {
             $result[] = new Mailcode_PreParser_CommandDef(
                 $name,
@@ -328,7 +328,7 @@ 
      */
     private function debugOpeningCommands(array $matches) : void
     {
-        if($this->debug === false)
+        if ($this->debug === false)
         {
             return;
         }
@@ -382,7 +382,7 @@ 
 
     private function debugCommandDef(Mailcode_PreParser_CommandDef $commandDef) : void
     {
-        if($this->debug === true)
+        if ($this->debug === true)
         {
             echo 'Command definition:'.PHP_EOL;
             print_r($commandDef->toArray());

src/Mailcode/Parser/Statement.php

Indentation +13 added lines, -13 removed lines

@@ -26,24 +26,24 @@ 
     public const VALIDATION_EMPTY = 48801;
     public const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected OperationResult $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected Mailcode_Parser_Statement_Tokenizer $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected ?Mailcode_Parser_Statement_Info $info = null;
 
     /**
@@ -138,7 +138,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 +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
      */
     private ?Mailcode_Commands_Command $sourceCommand = null;
 
-    public function __construct(string $statement, bool $freeform=false, ?Mailcode_Commands_Command $sourceCommand=null)
+    public function __construct(string $statement, bool $freeform = false, ?Mailcode_Commands_Command $sourceCommand = null)
     {
         $this->sourceCommand = $sourceCommand;
         $this->statement = $this->prepareStatement($statement);
@@ -106,7 +106,7 @@ 
     
     public function getInfo() : Mailcode_Parser_Statement_Info
     {
-        if($this->info instanceof Mailcode_Parser_Statement_Info)
+        if ($this->info instanceof Mailcode_Parser_Statement_Info)
         {
             return $this->info; 
         }
@@ -118,12 +118,12 @@ 
     
     protected function validate() : void
     {
-        if($this->freeform)
+        if ($this->freeform)
         {
             return;
         }
 
-        if(!$this->tokenizer->hasTokens())
+        if (!$this->tokenizer->hasTokens())
         {
             $this->result->makeError(
                 t('Empty statement'),
@@ -135,7 +135,7 @@ 
         
         $unknown = $this->tokenizer->getFirstUnknown();
         
-        if($unknown)
+        if ($unknown)
         {
             $this->result->makeError(
                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',

src/Mailcode/Parser/PreParser/CommandDef.php

Spacing +2 added lines, -2 removed lines

@@ -139,11 +139,11 @@
         $commands = $parser->getCommands();
         $content = $this->getContent();
 
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $string = $command->getOpeningText();
 
-            if(strpos($content, $string) !== false)
+            if (strpos($content, $string) !== false)
             {
                 $this->addEscapeError($command, $collection);
                 return false;

src/Mailcode/Parser/Safeguard.php

Indentation +146 added lines, -146 removed lines

@@ -54,40 +54,40 @@ 
     public const ERROR_NO_PLACEHOLDER_FOR_COMMAND = 47805;
     public const ERROR_NO_FIRST_PLACEHOLDER = 47806;
 
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected Mailcode_Parser $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static int $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
+     */
     protected ?Mailcode_Parser_Safeguard_PlaceholderCollection $placeholders = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $delimiter = '999';
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -106,28 +106,28 @@ 
         self::$counter = 0;
     }
     
-   /**
-    * Retrieves the string the safeguard was created for.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string the safeguard was created for.
+     * 
+     * @return string
+     */
     public function getOriginalString() : string
     {
         return $this->originalString;
     }
     
-   /**
-    * Sets the delimiter character sequence used to prepend
-    * and append to the placeholders.
-    * 
-    * The delimiter's default is "999".
-    *
-    * Minimum characters: 2
-    * Invalid characters: Any characters that get URL encoded
-    *
-    * @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 "999".
+     *
+     * Minimum characters: 2
+     * Invalid characters: Any characters that get URL encoded
+     *
+     * @param string $delimiter
+     * @return Mailcode_Parser_Safeguard
+     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
         $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter);
@@ -143,15 +143,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();
@@ -159,16 +159,16 @@ 
         return $this->makeSafePartial();
     }
     
-   /**
-    * Like makeSafe(), but allows partial (invalid) commands: use this
-    * if the subject string may contain only part of the whole set of
-    * commands. 
-    * 
-    * Example: parsing a text with an opening if statement, without the 
-    * matching end statement.
-    * 
-    * @return string
-    */
+    /**
+     * Like makeSafe(), but allows partial (invalid) commands: use this
+     * if the subject string may contain only part of the whole set of
+     * commands. 
+     * 
+     * Example: parsing a text with an opening if statement, without the 
+     * matching end statement.
+     * 
+     * @return string
+     */
     public function makeSafePartial() : string
     {
         $placeholders = $this->getPlaceholdersCollection()->getAll();
@@ -218,13 +218,13 @@ 
         $analyzer->analyze();
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formatting to use for the commands in the subject string.
-    * 
-    * @param Mailcode_StringContainer|string $subject
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * Creates a formatting handler, which can be used to specify
+     * which formatting to use for the commands in the subject string.
+     * 
+     * @param Mailcode_StringContainer|string $subject
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
         if(is_string($subject))
@@ -249,11 +249,11 @@ 
     }
 
     /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return Mailcode_Parser_Safeguard_PlaceholderCollection
-    */
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return Mailcode_Parser_Safeguard_PlaceholderCollection
+     */
     public function getPlaceholdersCollection() : Mailcode_Parser_Safeguard_PlaceholderCollection
     {
         if(isset($this->placeholders))
@@ -313,16 +313,16 @@ 
         return $formatting->toString();
     }
 
-   /**
-    * 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
-    */
+    /**
+     * 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
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore(
@@ -332,15 +332,15 @@ 
         );
     }
     
-   /**
-    * Like `makeWhole()`, but ignores missing command placeholders.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Like `makeWhole()`, but ignores missing command placeholders.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeWholePartial(string $string) : string
     {
         return $this->restore(
@@ -350,19 +350,19 @@ 
         );
     }
 
-   /**
-    * 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
-    */
+    /**
+     * 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
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore(
@@ -372,15 +372,15 @@ 
         );
     }
     
-   /**
-    * Like `makeHighlighted()`, but ignores missing command placeholders.
-    * 
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Like `makeHighlighted()`, but ignores missing command placeholders.
+     * 
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeHighlightedPartial(string $string) : string
     {
         return $this->restore(
@@ -390,11 +390,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the command collection contained in the string.
-    * 
-    * @return Mailcode_Collection
-    */
+    /**
+     * Retrieves the command collection contained in the string.
+     * 
+     * @return Mailcode_Collection
+     */
     public function getCollection() : Mailcode_Collection
     {
         if(isset($this->collection))
@@ -418,11 +418,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())
@@ -445,13 +445,13 @@ 
         throw $exception;
     }
     
-   /**
-    * Retrieves a list of all placeholder IDs used in the text.
-    * 
-    * @return string[]
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a list of all placeholder IDs used in the text.
+     * 
+     * @return string[]
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderStrings() : array
     {
         return $this->getPlaceholdersCollection()->getStrings();
@@ -462,29 +462,29 @@ 
         return $this->getPlaceholdersCollection()->isStringPlaceholder($subject);
     }
     
-   /**
-    * Retrieves a placeholder instance by its ID.
-    * 
-    * @param int $id
-    * @throws Mailcode_Exception If the placeholder was not found.
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its ID.
+     * 
+     * @param int $id
+     * @throws Mailcode_Exception If the placeholder was not found.
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByID($id);
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByString($string);

Spacing +11 added lines, -11 removed lines

@@ -174,7 +174,7 @@ 
         $placeholders = $this->getPlaceholdersCollection()->getAll();
         $string = $this->originalString;
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $string = $this->makePlaceholderSafe($string, $placeholder);
         }
@@ -188,7 +188,7 @@ 
     {
         $pos = mb_strpos($string, $placeholder->getOriginalText());
 
-        if($pos === false)
+        if ($pos === false)
         {
             throw new Mailcode_Exception(
                 'Placeholder original text not found',
@@ -227,7 +227,7 @@ 
     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
-        if(is_string($subject))
+        if (is_string($subject))
         {
             $subject = Mailcode::create()->createString($subject);
         }
@@ -256,7 +256,7 @@ 
     */
     public function getPlaceholdersCollection() : Mailcode_Parser_Safeguard_PlaceholderCollection
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -264,7 +264,7 @@ 
         $placeholders = array();
         $commands = $this->getCollection()->getCommands();
         
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             self::$counter++;
             
@@ -287,21 +287,21 @@ 
      * @return string
      * @throws Mailcode_Exception
      */
-    protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string
+    protected function restore(string $string, bool $partial = false, bool $highlighted = false) : string
     {
-        if(!$partial)
+        if (!$partial)
         {
             $this->requireValidCollection();
         }
         
         $formatting = $this->createFormatting($string);
 
-        if($partial)
+        if ($partial)
         {
             $formatting->makePartial();
         }
         
-        if($highlighted)
+        if ($highlighted)
         {
             $formatting->replaceWithHTMLHighlighting();
         }
@@ -397,7 +397,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -425,7 +425,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }