Mistralys / mailcode

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

Braces +1 added lines, -2 removed lines

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

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;
             }
@@ -147,7 +147,7 @@ 
     */
     private function getTagAncestry() : array
     {
-        if($this->ancestryChecked)
+        if ($this->ancestryChecked)
         {
             return $this->tagAncestry;
         }

Indentation +36 added lines, -36 removed lines

@@ -24,14 +24,14 @@ 
 {
     public 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();
@@ -139,12 +139,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of tag names that come as parents 
-    * above the command.
-    * 
-    * @return array<int,array<int,string>>
-    */
+    /**
+     * Retrieves a list of tag names that come as parents 
+     * above the command.
+     * 
+     * @return array<int,array<int,string>>
+     */
     private function getTagAncestry() : array
     {
         if($this->ancestryChecked)

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

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

Indentation +67 added lines, -67 removed lines

@@ -32,29 +32,29 @@ 
     public const ERROR_TOO_MANY_REPLACERS = 65902;
     public 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;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $partial = false;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject)
@@ -96,17 +96,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();
@@ -200,11 +200,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;
@@ -220,37 +220,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);
@@ -278,26 +278,26 @@ 
         return $this->subject->getString();
     }
 
-   /**
-    * Whether the formatting is done partially: missing placeholders
-    * will simply be ignored.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the formatting is done partially: missing placeholders
+     * will simply be ignored.
+     * 
+     * @return bool
+     */
     public function isPartial() : bool
     {
         return $this->partial;
     }
     
-   /**
-    * The formatting will ignore missing placeholders. Use this if the
-    * formatting will be done on a text that may not contain all of the
-    * initial placeholders anymore.
-    * 
-    * This is like the safeguard's makeWholePartial() method.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * The formatting will ignore missing placeholders. Use this if the
+     * formatting will be done on a text that may not contain all of the
+     * initial placeholders anymore.
+     * 
+     * This is like the safeguard's makeWholePartial() method.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function makePartial() : Mailcode_Parser_Safeguard_Formatting
     {
         $this->partial = true;

src/Mailcode/Parser/Safeguard.php

Braces +1 added lines, -2 removed lines

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

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

src/Mailcode/StringContainer.php

Spacing +6 added lines, -6 removed lines

@@ -88,12 +88,12 @@ 
     public function updateString(string $subject) : bool
     {
         // avoid triggering an update if there are no changes in the string
-        if($subject === $this->subject)
+        if ($subject === $this->subject)
         {
             return false;
         }
         
-        if($this->updating)
+        if ($this->updating)
         {
             throw new Mailcode_Exception(
                 'Cannot modify subject string during update',
@@ -107,7 +107,7 @@ 
         $this->subject = $subject;
         $this->length = mb_strlen($this->subject);
         
-        foreach($this->listeners as $listener)
+        foreach ($this->listeners as $listener)
         {
             $listener($this);
         }
@@ -142,7 +142,7 @@ 
     {
         self::$listenerCounter++;
         
-        if(!is_callable($callback))
+        if (!is_callable($callback))
         {
             throw new Mailcode_Exception(
                 'Not a valid callable',
@@ -172,7 +172,7 @@ 
     */
     public function removeListener(int $listenerID) : void
     {
-        if(isset($this->listeners[$listenerID]))
+        if (isset($this->listeners[$listenerID]))
         {
             unset($this->listeners[$listenerID]);
         }
@@ -203,7 +203,7 @@ 
         return mb_strpos($this->subject, $needle);
     }
     
-    public function getSubstr(int $start, ?int $length=null) : string
+    public function getSubstr(int $start, ?int $length = null) : string
     {
         return mb_substr($this->subject, $start, $length);
     }

Indentation +66 added lines, -66 removed lines

@@ -26,39 +26,39 @@ 
     public const ERROR_INVALID_CALLABLE = 65701;
     public const ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION = 65702;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $listenerCounter = 0;
     
-   /**
-    * @var callable[]
-    */
+    /**
+     * @var callable[]
+     */
     private $listeners = array();
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $updating = false;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $idCounter = 0;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $id;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $length;
     
     public function __construct(string $subject)
@@ -75,16 +75,16 @@ 
         return $this->id;
     }
     
-   /**
-    * Updates the string with the specified string.
-    * Notifies all listeners of the change.
-    * 
-    * @param string $subject
-    * @throws Mailcode_Exception
-    * @return bool Whether the string had modifications.
-    * 
-    * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
-    */
+    /**
+     * Updates the string with the specified string.
+     * Notifies all listeners of the change.
+     * 
+     * @param string $subject
+     * @throws Mailcode_Exception
+     * @return bool Whether the string had modifications.
+     * 
+     * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
+     */
     public function updateString(string $subject) : bool
     {
         // avoid triggering an update if there are no changes in the string
@@ -117,27 +117,27 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the stored string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the stored string.
+     * 
+     * @return string
+     */
     public function getString() : string
     {
         return $this->subject;
     }
     
-   /**
-    * Adds a listener that will be informed every time the string is modified.
-    * The callback gets the string container instance as parameter.
-    * 
-    * @param callable $callback
-    * @throws Mailcode_Exception If it is not a valid callable.
-    * @return int The listener number, to be able to remove it using `removeListener()`.
-    * 
-    * @see Mailcode_StringContainer::removeListener()
-    * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
-    */
+    /**
+     * Adds a listener that will be informed every time the string is modified.
+     * The callback gets the string container instance as parameter.
+     * 
+     * @param callable $callback
+     * @throws Mailcode_Exception If it is not a valid callable.
+     * @return int The listener number, to be able to remove it using `removeListener()`.
+     * 
+     * @see Mailcode_StringContainer::removeListener()
+     * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
+     */
     public function addListener($callback) : int
     {
         self::$listenerCounter++;
@@ -164,12 +164,12 @@ 
         return $this->length;
     }
     
-   /**
-    * Removes an existing listener by its ID.
-    * Has no effect if it does not exist, or has already been removed.
-    * 
-    * @param int $listenerID
-    */
+    /**
+     * Removes an existing listener by its ID.
+     * Has no effect if it does not exist, or has already been removed.
+     * 
+     * @param int $listenerID
+     */
     public function removeListener(int $listenerID) : void
     {
         if(isset($this->listeners[$listenerID]))
@@ -178,13 +178,13 @@ 
         }
     }
     
-   /**
-    * Replaces all substrings matching needle with the replacement text.
-    *  
-    * @param string $needle
-    * @param string $replacement
-    * @return bool
-    */
+    /**
+     * Replaces all substrings matching needle with the replacement text.
+     *  
+     * @param string $needle
+     * @param string $replacement
+     * @return bool
+     */
     public function replaceSubstrings(string $needle, string $replacement) : bool
     {
         $string = str_replace($needle, $replacement, $this->subject);
@@ -192,12 +192,12 @@ 
         return $this->updateString($string);
     }
 
-   /**
-    * Get the position of a substring in the string.
-    * 
-    * @param string $needle
-    * @return int|bool The zero-based position, or false if not found.
-    */
+    /**
+     * Get the position of a substring in the string.
+     * 
+     * @param string $needle
+     * @return int|bool The zero-based position, or false if not found.
+     */
     public function getSubstrPosition(string $needle)
     {
         return mb_strpos($this->subject, $needle);

src/Mailcode/Parser/Safeguard/Formatter.php

Spacing +3 added lines, -3 removed lines

@@ -77,7 +77,7 @@ 
         
         $instance = new $class($this, $placeholder);
         
-        if($instance instanceof Mailcode_Parser_Safeguard_Formatter_Location)
+        if ($instance instanceof Mailcode_Parser_Safeguard_Formatter_Location)
         {
             return $instance;
         }
@@ -105,7 +105,7 @@ 
         
         $result = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $result[] = $this->createLocation($placeholder);
         }
@@ -123,7 +123,7 @@ 
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
         
-        if($eol)
+        if ($eol)
         {
             $this->log(sprintf(
                 'Detected EOL character: %s.', 

Indentation +24 added lines, -24 removed lines

@@ -27,19 +27,19 @@ 
 {
     public const ERROR_INVALID_LOCATION_INSTANCE = 65601;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatting
+     */
     protected $formatting;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatting $formatting)
@@ -98,12 +98,12 @@ 
         );
     }
     
-   /**
-    * Retrieves all formatter-specific placeholder locations 
-    * in the subject string.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Location[]
-    */
+    /**
+     * Retrieves all formatter-specific placeholder locations 
+     * in the subject string.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Location[]
+     */
     protected function resolveLocations() : array
     {
         $placeholders = $this->formatting->getSafeguard()->getPlaceholdersCollection()->getAll();
@@ -118,12 +118,12 @@ 
         return $result;
     }
     
-   /**
-    * Resolves the newline character used in the string.
-    * 
-    * @param string $subject
-    * @return string
-    */
+    /**
+     * Resolves the newline character used in the string.
+     * 
+     * @param string $subject
+     * @return string
+     */
     protected function resolveNewlineChar(string $subject) : string
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
@@ -155,9 +155,9 @@ 
         );
     }
  
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;