Mistralys / mailcode

src/Mailcode.php

Indentation +51 added lines, -51 removed lines

@@ -26,51 +26,51 @@ 
  */
 class Mailcode
 {
-   /**
-    * @var Mailcode_Parser|NULL
-    */
+    /**
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
     }
     
-   /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+    /**
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()->parseString($string);
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -81,12 +81,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -107,12 +107,12 @@ 
         return new Mailcode_StringContainer($subject);
     }
     
-   /**
-    * Attempts to find all variables in the target string.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Attempts to find all variables in the target string.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject);
@@ -128,12 +128,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))
@@ -144,12 +144,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();

src/Mailcode/Traits/Formatting/HTMLHighlighting.php

Indentation +19 added lines, -19 removed lines

@@ -31,13 +31,13 @@ 
         'script'
     );
     
-   /**
-    * Adds an HTML tag name to the list of tags within which
-    * commands may not be highlighted.
-    *
-    * @param string $tagName Case insensitive.
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
-    */
+    /**
+     * Adds an HTML tag name to the list of tags within which
+     * commands may not be highlighted.
+     *
+     * @param string $tagName Case insensitive.
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
+     */
     public function excludeTag(string $tagName) : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
         $tagName = strtolower($tagName);
@@ -50,12 +50,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds several exluded tag names at once.
-    *
-    * @param string[] $tagNames
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
-    */
+    /**
+     * Adds several exluded tag names at once.
+     *
+     * @param string[] $tagNames
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
+     */
     public function excludeTags(array $tagNames) : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
         foreach($tagNames as $tagName)
@@ -66,12 +66,12 @@ 
         return $this;
     }
     
-   /**
-    * Whether the specified tag name is in the exlusion list.
-    *
-    * @param string $tagName
-    * @return bool
-    */
+    /**
+     * Whether the specified tag name is in the exlusion list.
+     *
+     * @param string $tagName
+     * @return bool
+     */
     public function isTagExcluded(string $tagName) : bool
     {
         $tagName = strtolower($tagName);

Spacing +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
     {
         $tagName = strtolower($tagName);
         
-        if(!in_array($tagName, $this->excludeTags))
+        if (!in_array($tagName, $this->excludeTags))
         {
             $this->excludeTags[] = $tagName;
         }
@@ -58,7 +58,7 @@ 
     */
     public function excludeTags(array $tagNames) : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
-        foreach($tagNames as $tagName)
+        foreach ($tagNames as $tagName)
         {
             $this->excludeTag((string)$tagName);
         }

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));
         }
@@ -44,7 +44,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 +7 added lines, -7 removed lines

@@ -54,26 +54,26 @@ 
         $position = $this->getStartPosition();
         
         // we're at the beginning of the string
-        if($position === false || $position === 0)
+        if ($position === false || $position === 0)
         {
             return;
         }
         
         $prevPos = $position - $this->eolLength;
         
-        if($prevPos < 0)
+        if ($prevPos < 0)
         {
             $prevPos = 0;
         }
         
-        if($this->isWithinCommand($prevPos))
+        if ($this->isWithinCommand($prevPos))
         {
             return;
         }
         
         $prev = $this->subject->getSubstr($prevPos, $this->eolLength);
         
-        if($prev !== $this->formatter->getEOLChar())
+        if ($prev !== $this->formatter->getEOLChar())
         {
             $this->prepend = $this->eol;
         }
@@ -86,21 +86,21 @@ 
         $position = $this->getEndPosition();
         
         // we're at the end of the string
-        if($position === false || $position >= $subjectLength)
+        if ($position === false || $position >= $subjectLength)
         {
             return;
         }
         
         $nextPos = $position + $this->eolLength;
         
-        if($nextPos > $subjectLength)
+        if ($nextPos > $subjectLength)
         {
             $nextPos = $subjectLength - $this->eolLength;
         }
         
         $next = $this->subject->getSubstr($nextPos, $this->eolLength);
         
-        if($next !== $this->formatter->getEOLChar())
+        if ($next !== $this->formatter->getEOLChar())
         {
             $this->append = $this->eol;
         }

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

Spacing +1 added lines, -1 removed lines

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

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

Indentation +30 added lines, -30 removed lines

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

Spacing +8 added lines, -8 removed lines

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

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

Indentation +3 added lines, -3 removed lines

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

Spacing +1 added lines, -1 removed lines

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

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

Indentation +5 added lines, -5 removed lines

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

Spacing +1 added lines, -1 removed lines

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