Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Formatter/ReplacerType.php

Indentation +7 added lines, -7 removed lines

@@ -35,13 +35,13 @@
         }
     }
     
-   /**
-    * Resolves the string with which this location needs to be
-    * replaced.
-    * 
-    * @param Mailcode_Parser_Safeguard_Formatter_Location $location
-    * @return string
-    */
+    /**
+     * Resolves the string with which this location needs to be
+     * replaced.
+     * 
+     * @param Mailcode_Parser_Safeguard_Formatter_Location $location
+     * @return string
+     */
     private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string
     {
         if($location->requiresAdjustment())

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
     {
         $locations = $this->resolveLocations();
         
-        foreach($locations as $location)
+        foreach ($locations as $location)
         {
             $location->replaceWith($this->resolveReplacement($location));
             
@@ -46,7 +46,7 @@ 
     */
     private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string
     {
-        if($location->requiresAdjustment())
+        if ($location->requiresAdjustment())
         {
             return $this->getReplaceString($location);
         }

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

Indentation +6 added lines, -6 removed lines

@@ -23,14 +23,14 @@
  */
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines extends Mailcode_Parser_Safeguard_Formatter_FormatType
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $eol;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $eolLength;
     
     protected function initFormatting() : void

src/Mailcode/Parser/Safeguard/Formatter/Type/SingleLines/Location.php

Indentation +6 added lines, -6 removed lines

@@ -25,14 +25,14 @@
  */
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines_Location extends Mailcode_Parser_Safeguard_Formatter_Location
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol;
     
     protected function init() : void

Spacing +8 added lines, -8 removed lines

@@ -55,7 +55,7 @@ 
         $position = $this->getStartPosition();
         
         // we're at the beginning of the string
-        if($position === false || $position === 0)
+        if ($position === false || $position === 0)
         {
             $this->log(sprintf(
                 'Prepend: NO | Position: [%s] | Not found, or at beginning of string.', 
@@ -67,7 +67,7 @@ 
         
         $prevPos = $position - $this->eolLength;
         
-        if($prevPos < 0)
+        if ($prevPos < 0)
         {
             $prevPos = 0;
         }
@@ -77,7 +77,7 @@ 
     
     protected function checkPreviousPosition(int $prevPos) : void
     {
-        if($this->isWithinCommand($prevPos))
+        if ($this->isWithinCommand($prevPos))
         {
             $this->log(sprintf(
                 'Prepend: NO | Position: [%s] | Is within a mailcode command.', 
@@ -89,7 +89,7 @@ 
         
         $match = $this->subject->getSubstr($prevPos, $this->eolLength);
         
-        if($match !== $this->formatter->getEOLChar())
+        if ($match !== $this->formatter->getEOLChar())
         {
             $this->log(sprintf(
                 'Prepend: YES | Position: [%s] | Characters: [%s] | Do not match the EOL character.',
@@ -108,7 +108,7 @@ 
         $position = $this->getEndPosition();
         
         // we're at the end of the string
-        if($position === false || $position >= $subjectLength)
+        if ($position === false || $position >= $subjectLength)
         {
             $this->log(sprintf(
                 'Append: NO | Position: [%s] | End of string, or too long | Subject length: [%s]',
@@ -121,7 +121,7 @@ 
         
         $nextPos = $position + $this->eolLength;
         
-        if($nextPos > $subjectLength)
+        if ($nextPos > $subjectLength)
         {
             $nextPos = $subjectLength - $this->eolLength;
         }
@@ -131,7 +131,7 @@ 
     
     protected function checkNextPosition(int $nextPos) : void
     {
-        if($this->isWithinCommand($nextPos))
+        if ($this->isWithinCommand($nextPos))
         {
             $this->log(sprintf(
                 'Append: YES | Position: [%s] | Is within a mailcode command.',
@@ -145,7 +145,7 @@ 
         
         $next = $this->subject->getSubstr($nextPos, $this->eolLength);
         
-        if($next !== $this->formatter->getEOLChar())
+        if ($next !== $this->formatter->getEOLChar())
         {
             $this->log(sprintf(
                 'Append: YES | Position: [%s] | Next characters: [%s] | Do not match the EOL character.',

src/Mailcode/Parser/Safeguard/Formatter/Type/MarkVariables/Location.php

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     
     public function requiresAdjustment(): bool
     {
-        if(!parent::requiresAdjustment())
+        if (!parent::requiresAdjustment())
         {
             return false;
         }

src/Mailcode/Parser/Safeguard/Formatter/Type/HTMLHighlighting/Location.php

Indentation +30 added lines, -30 removed lines

@@ -24,14 +24,14 @@ 
 {
     const COMMAND_MARKER = '__MAILCODE_COMMAND__';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $ancestryChecked = false;
     
-   /**
-    * @var array<int,array<int,string>>
-    */
+    /**
+     * @var array<int,array<int,string>>
+     */
     private $tagAncestry = array();
     
     protected function init() : void
@@ -43,12 +43,12 @@ 
         return !$this->isInTagAttributes() && !$this->isInExcludedTag();
     }
     
-   /**
-    * Retrieves the part of the subject string that comes
-    * before the command.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the part of the subject string that comes
+     * before the command.
+     * 
+     * @return string
+     */
     private function getHaystackBefore() : string
     {
         $pos = $this->getStartPosition();
@@ -65,12 +65,12 @@ 
         return $this->subject->getSubstr(0, $pos).self::COMMAND_MARKER.'>';
     }
     
-   /**
-    * Whether the command is nested in one of the tags
-    * that have been added to the list of excluded tags.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the command is nested in one of the tags
+     * that have been added to the list of excluded tags.
+     * 
+     * @return bool
+     */
     protected function isInExcludedTag() : bool
     {
         $tagNames = $this->getParentTags();
@@ -86,12 +86,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of the command's parent HTML tags, from
-    * highest to lowest.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of the command's parent HTML tags, from
+     * highest to lowest.
+     * 
+     * @return string[]
+     */
     private function getParentTags() : array
     {
         $tags = $this->getTagAncestry();
@@ -116,12 +116,12 @@ 
         return $stack;
     }
     
-   /**
-    * Checks whether the command is located within the attributes
-    * of an HTML tag.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether the command is located within the attributes
+     * of an HTML tag.
+     * 
+     * @return bool
+     */
     protected function isInTagAttributes() : bool
     {
         $tags = $this->getTagAncestry();

Spacing +8 added lines, -8 removed lines

@@ -53,7 +53,7 @@ 
     {
         $pos = $this->getStartPosition();
         
-        if(is_bool($pos))
+        if (is_bool($pos))
         {
             return '';
         }
@@ -75,9 +75,9 @@ 
     {
         $tagNames = $this->getParentTags();
         
-        foreach($tagNames as $tagName)
+        foreach ($tagNames as $tagName)
         {
-            if($this->formatter->isTagExcluded($tagName))
+            if ($this->formatter->isTagExcluded($tagName))
             {
                 return true;
             }
@@ -99,11 +99,11 @@ 
         // Create a stack of all direct parent tags of the command.
         // Handles closing tags as well.
         $stack = array();
-        foreach($tags[2] as $idx => $tagName)
+        foreach ($tags[2] as $idx => $tagName)
         {
             $closing = $tags[1][$idx] === '/';
             
-            if($closing)
+            if ($closing)
             {
                 array_pop($stack);
             }
@@ -128,9 +128,9 @@ 
         
         // This check is easy: if the command is in the attribute
         // of any of the tags, we will find the command marker in there.
-        foreach($tags[3] as $attributes)
+        foreach ($tags[3] as $attributes)
         {
-            if(strstr($attributes, self::COMMAND_MARKER))
+            if (strstr($attributes, self::COMMAND_MARKER))
             {
                 return true;
             }
@@ -141,7 +141,7 @@ 
     
     private function getTagAncestry() : array
     {
-        if($this->ancestryChecked)
+        if ($this->ancestryChecked)
         {
             return $this->tagAncestry;
         }

Braces +1 added lines, -2 removed lines

@@ -119,8 +119,7 @@
             if($closing)
             {
                 array_pop($stack);
-            }
-            else
+            } else
             {
                 $stack[] = $tagName;
             }

src/Mailcode/Parser/Safeguard/Formatter/Type/MarkVariables.php

Indentation +3 added lines, -3 removed lines

@@ -29,9 +29,9 @@
     
     const ERROR_INVALID_TAG_TEMPLATE = 66101;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $tagTemplate = '<span class="mailcode-marked-variable">%s</span>';
     
     protected function initFormatting() : void

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     
     public function setTemplate(string $template) : void
     {
-        if(substr_count($template, '%s') !== 1)
+        if (substr_count($template, '%s') !== 1)
         {
             throw new Mailcode_Exception(
                 'Invalid tag template',

src/Mailcode/Parser/Safeguard/Formatter/FormatType.php

Indentation +5 added lines, -5 removed lines

@@ -25,11 +25,11 @@
         return PHP_INT_MAX;
     }
 
-   /**
-    * Formats the specified string according to the formatter.
-    * Retrieve the updated string from the string container used
-    * to create the formatter, or use `getSubjectString()`.
-    */
+    /**
+     * Formats the specified string according to the formatter.
+     * Retrieve the updated string from the string container used
+     * to create the formatter, or use `getSubjectString()`.
+     */
     public function format() : void
     {
         $locations = $this->resolveLocations();

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
     {
         $locations = $this->resolveLocations();
         
-        foreach($locations as $location)
+        foreach ($locations as $location)
         {
             $location->format();
             

src/Mailcode/Parser/Safeguard/Formatting.php

Indentation +49 added lines, -49 removed lines

@@ -32,24 +32,24 @@ 
     const ERROR_TOO_MANY_REPLACERS = 65902;
     const ERROR_NO_FORMATTERS_ADDED = 65903;
     
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     private $safeguard;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter[]
+     */
     private $formatters = array();
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     private $subject;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $applied = false;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject)
@@ -91,17 +91,17 @@ 
         return $formatter;
     }
     
-   /**
-    * Adds a formatter that will surround all variables with
-    * markup to highlight them independently of command syntax
-    * highlighting.
-    * 
-    * This is used to mark variables visually even after commands
-    * have been replaced by the target system's post processing.
-    * Can be combined with a replacer and other formats.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
-    */
+    /**
+     * Adds a formatter that will surround all variables with
+     * markup to highlight them independently of command syntax
+     * highlighting.
+     * 
+     * This is used to mark variables visually even after commands
+     * have been replaced by the target system's post processing.
+     * Can be combined with a replacer and other formats.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
+     */
     public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
     {
         $formatter = $this->createMarkVariables();
@@ -195,11 +195,11 @@ 
         }
     }
     
-   /**
-    * Counts the amount of replacer formatters that have been added.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of replacer formatters that have been added.
+     * 
+     * @return int
+     */
     private function countReplacers() : int
     {
         $count = 0;
@@ -215,37 +215,37 @@ 
         return $count;
     }
 
-   /**
-    * Creates a formatter that adds HTML syntax highlighting
-    * for all commands in the specified string, intelligently
-    * checking the location of the commands to ensure that they
-    * can be syntax highlighted.
-    * 
-    * For example, commands in HTML attributes will not be
-    * highlighted, as this would break the HTML.
-    *  
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
-    */
+    /**
+     * Creates a formatter that adds HTML syntax highlighting
+     * for all commands in the specified string, intelligently
+     * checking the location of the commands to ensure that they
+     * can be syntax highlighted.
+     * 
+     * For example, commands in HTML attributes will not be
+     * highlighted, as this would break the HTML.
+     *  
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
+     */
     public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this);
     }
 
-   /**
-    * Creates the formatter that ensures that all commands
-    * are placed on a separate line in the subject string.
-    */
+    /**
+     * Creates the formatter that ensures that all commands
+     * are placed on a separate line in the subject string.
+     */
     public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this);
     }
     
-   /**
-    * Creates the formatter that replaces all commands by
-    * their normalized variants.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
-    */
+    /**
+     * Creates the formatter that replaces all commands by
+     * their normalized variants.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
+     */
     public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this);

Spacing +10 added lines, -10 removed lines

@@ -131,7 +131,7 @@ 
     
     public function applyFormatting() : void
     {
-        if($this->applied)
+        if ($this->applied)
         {
             return;
         }
@@ -146,9 +146,9 @@ 
 
     private function applyFormatTypes() : void
     {
-        foreach($this->formatters as $formatter)
+        foreach ($this->formatters as $formatter)
         {
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType)
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType)
             {
                 $formatter->format();
             }
@@ -157,9 +157,9 @@ 
     
     private function applyReplaceTypes() : void
     {
-        foreach($this->formatters as $formatter)
+        foreach ($this->formatters as $formatter)
         {
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
             {
                 $formatter->replace();
             }
@@ -168,7 +168,7 @@ 
     
     private function validateFormatters() : void
     {
-        if(empty($this->formatters))
+        if (empty($this->formatters))
         {
             throw new Mailcode_Exception(
                 'No formatters selected',
@@ -179,7 +179,7 @@ 
         
         $amount = $this->countReplacers();
         
-        if($amount > 1) 
+        if ($amount > 1) 
         {
             throw new Mailcode_Exception(
                 'More than one replacer formatter selected',
@@ -189,7 +189,7 @@ 
         }
         
         // by default, at minimum the normalized formatter must be selected.
-        if($amount === 0)
+        if ($amount === 0)
         {
             $this->replaceWithNormalized();
         }
@@ -204,9 +204,9 @@ 
     {
         $count = 0;
         
-        foreach($this->formatters as $formatter)
+        foreach ($this->formatters as $formatter)
         {
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
             {
                 $count++;
             }

src/Mailcode/Parser/Safeguard.php

Indentation +144 added lines, -144 removed lines

@@ -53,50 +53,50 @@ 
     const ERROR_EMPTY_DELIMITER = 47803;
     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 string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected $placeholderStrings;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatting|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatting|NULL
+     */
     private $formatting = null;
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -105,25 +105,25 @@ 
         $this->originalString = $subject;
     }
     
-   /**
-    * 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 "__" (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))
@@ -145,15 +145,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();
@@ -161,16 +161,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->getPlaceholders();
@@ -200,13 +200,13 @@ 
         return $string;
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formattings 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 formattings 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))
@@ -217,12 +217,12 @@ 
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
     }
     
-   /**
-    * 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))
@@ -269,16 +269,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(
@@ -288,15 +288,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(
@@ -306,19 +306,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(
@@ -328,15 +328,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(
@@ -346,11 +346,11 @@ 
         );
     }
     
-   /**
-    * 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))
@@ -368,11 +368,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())
@@ -391,11 +391,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(is_array($this->placeholderStrings))
@@ -422,13 +422,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();
@@ -451,13 +451,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

@@ -126,7 +126,7 @@ 
     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
-        if(empty($delimiter))
+        if (empty($delimiter))
         {
             throw new Mailcode_Exception(
                 'Empty delimiter',
@@ -176,11 +176,11 @@ 
         $placeholders = $this->getPlaceholders();
         $string = $this->originalString;
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $pos = mb_strpos($string, $placeholder->getOriginalText());
             
-            if($pos === false)
+            if ($pos === false)
             {
                 throw new Mailcode_Exception(
                     'Placeholder original text not found',
@@ -209,7 +209,7 @@ 
     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
-        if(is_string($subject))
+        if (is_string($subject))
         {
             $subject = Mailcode::create()->createString($subject);
         }
@@ -225,7 +225,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -234,7 +234,7 @@ 
         
         $cmds = $this->getCollection()->getCommands();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -248,16 +248,16 @@ 
         return $this->placeholders;
     }
     
-    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($highlighted)
+        if ($highlighted)
         {
             $formatting->replaceWithHTMLHighlighting();
         }
@@ -353,7 +353,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -375,7 +375,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -398,7 +398,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(is_array($this->placeholderStrings))
+        if (is_array($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -407,7 +407,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -433,9 +433,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -462,9 +462,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }

Braces +1 added lines, -2 removed lines

@@ -260,8 +260,7 @@
         if($highlighted)
         {
             $formatting->replaceWithHTMLHighlighting();
-        }
-        else 
+        } else 
         {
             $formatting->replaceWithNormalized();
         }