Mistralys / mailcode

src/Mailcode/Commands/Command/Comment.php

Indentation +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  */
 class Mailcode_Commands_Command_Comment extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $commentString = '';
     
     protected function init() : void

Spacing +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
     
     protected function validateSyntax_comment() : void
     {
-        if(empty($this->commentString))
+        if (empty($this->commentString))
         {
             $this->validationResult->makeError(
                 t('The comment text ist empty.'),

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/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

Braces +1 added lines, -2 removed lines

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

Indentation +36 added lines, -36 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();
@@ -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)

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

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 @@ 
     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;
     
-   /**
-    * @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);
@@ -273,26 +273,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;