Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +12 added lines, -12 removed lines

@@ -24,9 +24,9 @@ 
  */
 abstract class Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     protected $safeguard;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard)
@@ -88,12 +88,12 @@ 
         return $locator->getSubjectString();
     }
     
-   /**
-    * 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);
@@ -106,9 +106,9 @@ 
         return PHP_EOL;
     }
     
-   /**
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         return $this->safeguard->getPlaceholders();

Spacing +4 added lines, -4 removed lines

@@ -62,7 +62,7 @@ 
         
         $total = count($placeholders);
         
-        for($i=0; $i < $total; $i++)
+        for ($i = 0; $i < $total; $i++)
         {
             $subject = $this->process($placeholders[$i], $subject);
         }
@@ -75,11 +75,11 @@ 
         $locator = $placeholder->createLocator($subject);
         $positions = $locator->getLocations();
         
-        foreach($positions as $position)
+        foreach ($positions as $position)
         {
             $replace = $this->resolveReplacementText($position);
             
-            if($replace !== $position->getPlaceholderString())
+            if ($replace !== $position->getPlaceholderString())
             {
                 $locator->replaceWith($position, $replace);
             }
@@ -98,7 +98,7 @@ 
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
         
-        if($eol)
+        if ($eol)
         {
             return $eol->getCharacter();
         }

src/Mailcode/Parser/Safeguard/Placeholder/Locator.php

Spacing +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
         $needle = $this->placeholder->getReplacementText();
         $index = 0;
         
-        while(($lastPos = mb_strpos($this->subject, $needle, $lastPos)) !== false)
+        while (($lastPos = mb_strpos($this->subject, $needle, $lastPos)) !== false)
         {
             $length = mb_strlen($needle);
             
@@ -98,7 +98,7 @@ 
     */
     public function getLocationByIndex(int $index) : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location
     {
-        if(isset($this->instances[$index]))
+        if (isset($this->instances[$index]))
         {
             return $this->instances[$index];
         }

Indentation +42 added lines, -42 removed lines

@@ -29,19 +29,19 @@ 
  */
 class Mailcode_Parser_Safeguard_Placeholder_Locator
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     private $placeholder;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
+     */
     private $instances = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder $placeholder, string $subject)
@@ -52,11 +52,11 @@ 
         $this->localizeInstances();
     }
     
-   /**
-    * Attempts to find the placeholder's instances in the
-    * target string, and returns a location instance for
-    * each, which allows accessing their exact position.
-    */
+    /**
+     * Attempts to find the placeholder's instances in the
+     * target string, and returns a location instance for
+     * each, which allows accessing their exact position.
+     */
     private function localizeInstances() : void
     {
         $lastPos = 0;
@@ -81,21 +81,21 @@ 
         }
     }
     
-   /**
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
-    */
+    /**
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
+     */
     public function getLocations() : array
     {
         return $this->instances;
     }
     
-   /**
-    * Retrieves a location by its index in the locations list (in 
-    * ascending order as found in the subject string, zero based.)
-    * 
-    * @param int $index
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
-    */
+    /**
+     * Retrieves a location by its index in the locations list (in 
+     * ascending order as found in the subject string, zero based.)
+     * 
+     * @param int $index
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
+     */
     public function getLocationByIndex(int $index) : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location
     {
         if(isset($this->instances[$index]))
@@ -106,19 +106,19 @@ 
         return null;
     }
     
-   /**
-    * Replaces the placeholder at the location with the specified
-    * replacement text.
-    * 
-    * NOTE: The replacement text MUST contain the original placeholder
-    * for this to work. An exception will be triggered otherwise.
-    * 
-    * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location
-    * @param string $replacementText
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING
-    */
+    /**
+     * Replaces the placeholder at the location with the specified
+     * replacement text.
+     * 
+     * NOTE: The replacement text MUST contain the original placeholder
+     * for this to work. An exception will be triggered otherwise.
+     * 
+     * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location
+     * @param string $replacementText
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING
+     */
     public function replaceWith(Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location, string $replacementText) : void
     {
         $replacer = new Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer(
@@ -136,11 +136,11 @@ 
         $this->subject = $subject;
     }
     
-   /**
-    * Retrieves the subject string, with all changes that were made, if any. 
-    *  
-    * @return string
-    */
+    /**
+     * Retrieves the subject string, with all changes that were made, if any. 
+     *  
+     * @return string
+     */
     public function getSubjectString() : string
     {
         return $this->subject;

src/Mailcode/Parser/Safeguard/FormatterLocation.php

Indentation +18 added lines, -18 removed lines

@@ -22,14 +22,14 @@ 
  */
 abstract class Mailcode_Parser_Safeguard_FormatterLocation
 {
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
+     */
     protected $location;
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location)
@@ -42,22 +42,22 @@ 
     
     abstract protected function init() : void; 
     
-   /**
-    * Whether this specific placeholder location needs to be adjusted.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether this specific placeholder location needs to be adjusted.
+     * 
+     * @return bool
+     */
     abstract public function requiresAdjustment() : bool;
     
     abstract protected function getAdjustedText() : string;
     
-   /**
-    * Retrieves the placeholder text, adjusted as needed by the
-    * formatter. If no adjustments are required, this will simply
-    * return the vanilla placeholder string.
-    *  
-    * @return string
-    */
+    /**
+     * Retrieves the placeholder text, adjusted as needed by the
+     * formatter. If no adjustments are required, this will simply
+     * return the vanilla placeholder string.
+     *  
+     * @return string
+     */
     public function getPlaceholderText() : string
     {
         if($this->requiresAdjustment())

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
     */
     public function getPlaceholderText() : string
     {
-        if($this->requiresAdjustment())
+        if ($this->requiresAdjustment())
         {
             $text = $this->getAdjustedText();
             

src/Mailcode/Parser/Statement/Tokenizer/Token/Operand.php

Indentation +18 added lines, -18 removed lines

@@ -30,10 +30,10 @@ 
         return $this->getSign();
     }
     
-   /**
-    * Retrieves all known comparison operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known comparison operator signs.
+     * @return string[]
+     */
     public static function getComparisonSigns() : array
     {
         return array(
@@ -46,10 +46,10 @@ 
         );
     }
     
-   /**
-    * Retrieves all known arithmetic operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known arithmetic operator signs.
+     * @return string[]
+     */
     public static function getArithmeticSigns() : array
     {
         return array(
@@ -60,11 +60,11 @@ 
         );
     }
     
-   /**
-    * Whether the operator is comparison related (equals, not equals, smaller, greater...).
-    *  
-    * @return bool
-    */
+    /**
+     * Whether the operator is comparison related (equals, not equals, smaller, greater...).
+     *  
+     * @return bool
+     */
     public function isComparator() : bool
     {
         return 
@@ -76,11 +76,11 @@ 
         $this->isSmallerOrEquals();
     }
     
-   /**
-    * Whether the operator is calculation related (minus, plus, divide, multiply).
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the operator is calculation related (minus, plus, divide, multiply).
+     * 
+     * @return bool
+     */
     public function isCalculator() : bool
     {
         return 

src/Mailcode/Factory/CommandSets/Set/Misc.php

Spacing +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
     
         $this->instantiator->checkCommand($cmd);
         
-        if($cmd instanceof Mailcode_Commands_Command_Comment)
+        if ($cmd instanceof Mailcode_Commands_Command_Comment)
         {
             return $cmd;
         }
@@ -42,7 +42,7 @@ 
         throw $this->instantiator->exceptionUnexpectedType('Comment', $cmd);
     }
     
-    public function for(string $sourceVariable, string $loopVariable) : Mailcode_Commands_Command_For
+    public function for (string $sourceVariable, string $loopVariable) : Mailcode_Commands_Command_For
     {
         $sourceVariable = '$'.ltrim($sourceVariable, '$');
         $loopVariable = '$'.ltrim($loopVariable, '$');
@@ -64,7 +64,7 @@ 
         
         $this->instantiator->checkCommand($cmd);
         
-        if($cmd instanceof Mailcode_Commands_Command_For)
+        if ($cmd instanceof Mailcode_Commands_Command_For)
         {
             return $cmd;
         }

src/Mailcode/Commands/Command/For.php

Indentation +9 added lines, -9 removed lines

@@ -27,19 +27,19 @@
     const VALIDATION_WRONG_KEYWORD = 49702;
     const VALIDATION_VARIABLE_NAME_IS_THE_SAME = 49703;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private $loopVar;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private $sourceVar;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     private $keyword;
     
     public function getName() : string

Spacing +5 added lines, -5 removed lines

@@ -88,7 +88,7 @@ 
     
     public function getSourceVariable() : Mailcode_Variables_Variable
     {
-        if(isset($this->sourceVar))
+        if (isset($this->sourceVar))
         {
             return $this->sourceVar->getVariable();
         }
@@ -102,7 +102,7 @@ 
     
     public function getLoopVariable() : Mailcode_Variables_Variable
     {
-        if(isset($this->loopVar))
+        if (isset($this->loopVar))
         {
             return $this->loopVar->getVariable();
         }
@@ -122,7 +122,7 @@ 
         $this->keyword = $info->getKeywordByIndex(1);
         $this->sourceVar = $info->getVariableByIndex(2);
         
-        if(!$this->loopVar || !$this->keyword || !$this->sourceVar)
+        if (!$this->loopVar || !$this->keyword || !$this->sourceVar)
         {
             $this->validationResult->makeError(
                 t('Not a valid for loop.').' '.t('Is the %1$s keyword missing?', 'in:'),
@@ -135,7 +135,7 @@ 
     
     protected function validateSyntax_keyword() : void
     {
-        if($this->keyword->isForIn())
+        if ($this->keyword->isForIn())
         {
             return;
         }
@@ -148,7 +148,7 @@ 
     
     protected function validateSyntax_variable_names() : void
     {
-        if($this->sourceVar->getVariable()->getFullName() !== $this->loopVar->getVariable()->getFullName())
+        if ($this->sourceVar->getVariable()->getFullName() !== $this->loopVar->getVariable()->getFullName())
         {
             return;
         }

src/Mailcode/Parser/Safeguard/Restorer.php

Indentation +15 added lines, -15 removed lines

@@ -22,24 +22,24 @@ 
  */
 class Mailcode_Parser_Safeguard_Restorer
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     private $safeguard;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     private $highlighted;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     private $normalize;
     
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     private $replaces = array();
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, bool $highlighted, bool $normalize)
@@ -49,9 +49,9 @@ 
         $this->normalize = $normalize;
     }
     
-   /**
-    * @return array<string,string>
-    */
+    /**
+     * @return array<string,string>
+     */
     public function getReplaces() : array
     {
         $placeholders = $this->safeguard->getPlaceholders();

Spacing +5 added lines, -5 removed lines

@@ -58,7 +58,7 @@ 
         
         $this->replaces = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->processPlaceholder($placeholder);
         }
@@ -71,11 +71,11 @@ 
         $replace = '';
         $needle = $placeholder->getReplacementText();
         
-        if($this->highlighted)
+        if ($this->highlighted)
         {
             $replace = $this->processPlaceholder_highlighted($placeholder, $needle);
         }
-        else if($this->normalize)
+        else if ($this->normalize)
         {
             $replace = $placeholder->getNormalizedText();
         }
@@ -91,14 +91,14 @@ 
     {
         $formatter = $this->safeguard->getFormatter();
         
-        if(!$formatter)
+        if (!$formatter)
         {
             return $placeholder->getHighlightedText();
         }
         
         $formattedNeedle = $formatter->getReplaceNeedle($placeholder);
         
-        if($formattedNeedle !== $needle)
+        if ($formattedNeedle !== $needle)
         {
             $this->replaces[$formattedNeedle] = $placeholder->getHighlightedText();
             

Braces +2 added lines, -4 removed lines

@@ -74,12 +74,10 @@
         if($this->highlighted)
         {
             $replace = $this->processPlaceholder_highlighted($placeholder, $needle);
-        }
-        else if($this->normalize)
+        } else if($this->normalize)
         {
             $replace = $placeholder->getNormalizedText();
-        }
-        else
+        } else
         {
             $replace = $placeholder->getOriginalText();
         }

src/Mailcode/Parser/Safeguard.php

Indentation +150 added lines, -150 removed lines

@@ -61,50 +61,50 @@ 
     
     const ERROR_NOT_A_SINGLE_LINES_FORMATTER = 47806;
     
-   /**
-    * @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_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -113,25 +113,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))
@@ -153,15 +153,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();
@@ -169,16 +169,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
     {
         $replaces = $this->getReplaces();
@@ -233,10 +233,10 @@ 
         throw $this->exceptionWrongFormatter(Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting::class);
     }
     
-   /**
-    * Enables the formatter that ensures that all commands that
-    * @return Mailcode_Parser_Safeguard_Formatter_SingleLines
-    */
+    /**
+     * Enables the formatter that ensures that all commands that
+     * @return Mailcode_Parser_Safeguard_Formatter_SingleLines
+     */
     public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines
     {
         $formatter = $this->selectFormatter('SingleLines');
@@ -261,25 +261,25 @@ 
         );
     }
     
-   /**
-    * Retrieves an associative array with pairs of
-    * [placeholder string => replacement text]. 
-    * 
-    * @param bool $highlighted
-    * @return string[]string
-    */
+    /**
+     * Retrieves an associative array with pairs of
+     * [placeholder string => replacement text]. 
+     * 
+     * @param bool $highlighted
+     * @return string[]string
+     */
     protected function getReplaces(bool $highlighted=false, bool $normalize=false) : array
     {
         $restorer = new Mailcode_Parser_Safeguard_Restorer($this, $highlighted, $normalize);
         return $restorer->getReplaces();
     }
     
-   /**
-    * 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))
@@ -334,17 +334,17 @@ 
         return str_replace($placeholderStrings, array_values($replaces), $string);
     }
     
-   /**
-    * Makes the string whole again after transforming or filtering it,
-    * by replacing the command placeholders with the original commands.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Makes the string whole again after transforming or filtering it,
+     * by replacing the command placeholders with the original commands.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore(
@@ -354,15 +354,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(
@@ -372,20 +372,20 @@ 
         );
     }
 
-   /**
-    * Like `makeWhole()`, but replaces the commands with a syntax
-    * highlighted version, meant for human readable texts only.
-    * 
-    * Note: the commands lose their functionality (They cannot be 
-    * parsed from that string again).
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Like `makeWhole()`, but replaces the commands with a syntax
+     * highlighted version, meant for human readable texts only.
+     * 
+     * Note: the commands lose their functionality (They cannot be 
+     * parsed from that string again).
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore(
@@ -395,15 +395,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(
@@ -413,11 +413,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))
@@ -435,11 +435,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())
@@ -458,11 +458,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))
@@ -489,13 +489,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();
@@ -518,13 +518,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 +20 added lines, -20 removed lines

@@ -134,7 +134,7 @@ 
     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
-        if(empty($delimiter))
+        if (empty($delimiter))
         {
             throw new Mailcode_Exception(
                 'Empty delimiter',
@@ -186,7 +186,7 @@ 
         $safe = str_replace(array_values($replaces), array_keys($replaces), $this->originalString);
 
         // If a formatter has been selected, let it modify the string.
-        if(isset($this->formatter))
+        if (isset($this->formatter))
         {
             $safe = $this->formatter->format($safe);
         }
@@ -203,7 +203,7 @@ 
     {
         $class = 'Mailcode\Mailcode_Parser_Safeguard_Formatter_'.$formatterID;
         
-        if(class_exists($class))
+        if (class_exists($class))
         {
             $this->formatter = new $class($this);
             
@@ -225,7 +225,7 @@ 
     {
         $formatter = $this->selectFormatter('HTMLHighlighting');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting)
         {
             return $formatter;
         }
@@ -241,7 +241,7 @@ 
     {
         $formatter = $this->selectFormatter('SingleLines');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
         {
             return $formatter;
         }
@@ -268,7 +268,7 @@ 
     * @param bool $highlighted
     * @return string[]string
     */
-    protected function getReplaces(bool $highlighted=false, bool $normalize=false) : array
+    protected function getReplaces(bool $highlighted = false, bool $normalize = false) : array
     {
         $restorer = new Mailcode_Parser_Safeguard_Restorer($this, $highlighted, $normalize);
         return $restorer->getReplaces();
@@ -282,7 +282,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -291,7 +291,7 @@ 
         
         $cmds = $this->getCollection()->getGroupedByHash();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -305,9 +305,9 @@ 
         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();
         }
@@ -316,9 +316,9 @@ 
         
         $placeholderStrings = array_keys($replaces);
         
-        foreach($placeholderStrings as $search)
+        foreach ($placeholderStrings as $search)
         {
-            if(!$partial && !$highlighted && !strstr($string, $search))
+            if (!$partial && !$highlighted && !strstr($string, $search))
             {
                 throw new Mailcode_Exception(
                     'Command placeholder not found',
@@ -420,7 +420,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -442,7 +442,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -465,7 +465,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(is_array($this->placeholderStrings))
+        if (is_array($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -474,7 +474,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -500,9 +500,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -529,9 +529,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }

src/Mailcode/Parser/Safeguard/Placeholder/Locator/Replacer.php

Indentation +32 added lines, -32 removed lines

@@ -32,49 +32,49 @@ 
     const ERROR_COULD_NOT_FIND_PLACEHOLDER_TEXT = 63502;
     const ERROR_PLACEHOLDER_POSITION_ERRONEOUS = 63503;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $replacementText;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator
+     */
     private $locator;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
+     */
     private $origin;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $placeholderText;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $offset = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $placeholderOffset = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $placeholderLength = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $lengthDifference = 0;
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator $locator, Mailcode_Parser_Safeguard_Placeholder_Locator_Location $origin, string $replacementText, string $subject)
@@ -93,11 +93,11 @@ 
         $this->adjustPositions();
     }
     
-   /**
-    * Adjusts the positions of all locations that come after 
-    * this one, to account for the added string length of the
-    * placeholder that has been replaced.
-    */
+    /**
+     * Adjusts the positions of all locations that come after 
+     * this one, to account for the added string length of the
+     * placeholder that has been replaced.
+     */
     private function adjustPositions() : void
     {
         $locations = $this->origin->getNextAll();

Spacing +3 added lines, -3 removed lines

@@ -103,7 +103,7 @@ 
         $locations = $this->origin->getNextAll();
         $offset = $this->lengthDifference;
 
-        foreach($locations as $location)
+        foreach ($locations as $location)
         {
             $location->updatePositionByOffset($offset);
         }
@@ -113,7 +113,7 @@ 
     {
         $length = mb_strpos($this->replacementText, $this->placeholderText);
         
-        if($length === false)
+        if ($length === false)
         {
             throw new Mailcode_Exception(
                 'Replacement text does not contain placeholder string.',
@@ -149,7 +149,7 @@ 
         // Failsafe check: the calculated new position
         // in the subject string should still equal the
         // placeholder string.
-        if($placeholder != $this->placeholderText)
+        if ($placeholder != $this->placeholderText)
         {
             throw new Mailcode_Exception(
                 'Localizing a safeguard placeholder failed.',