Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +26 added lines, -26 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)
@@ -36,13 +36,13 @@ 
     
     abstract public function format(string $subject) : string;
     
-   /**
-    * Resolves a list of positions of needle in the haystack.
-    * 
-    * @param string $needle
-    * @param string $haystack
-    * @return int[]
-    */
+    /**
+     * Resolves a list of positions of needle in the haystack.
+     * 
+     * @param string $needle
+     * @param string $haystack
+     * @return int[]
+     */
     protected function resolvePositions(string $needle, string $haystack) : array
     {
         $lastPos = 0;
@@ -57,12 +57,12 @@ 
         return $positions;
     }
     
-   /**
-    * 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);
@@ -75,13 +75,13 @@ 
         return PHP_EOL;
     }
     
-   /**
-    * Resolves the list of placeholder strings that need
-    * to be formatted. This includes only commands that
-    * do not generate content.
-    *  
-    * @return string[]
-    */
+    /**
+     * Resolves the list of placeholder strings that need
+     * to be formatted. This includes only commands that
+     * do not generate content.
+     *  
+     * @return string[]
+     */
     protected function resolvePlaceholderStrings() : array
     {
         $placeholders = $this->filterPlaceholders();
@@ -96,9 +96,9 @@ 
         return $result;
     }
     
-   /**
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         return $this->safeguard->getPlaceholders();

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         $lastPos = 0;
         $positions = array();
         
-        while (($lastPos = mb_strpos($haystack, $needle, $lastPos))!== false)
+        while (($lastPos = mb_strpos($haystack, $needle, $lastPos)) !== false)
         {
             $positions[] = $lastPos;
             $lastPos = $lastPos + mb_strlen($needle);
@@ -67,7 +67,7 @@ 
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
         
-        if($eol)
+        if ($eol)
         {
             return $eol->getCharacter();
         }
@@ -88,7 +88,7 @@ 
         
         $result = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $result[] = $placeholder->getReplacementText();
         }

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

Indentation +26 added lines, -26 removed lines

@@ -21,39 +21,39 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines_Placeholder
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $subject;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
+     */
     protected $formatter;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $prepend = false;
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $append = false;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $placeholderLength;
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter_SingleLines $formatter, string $subject, int $placeholderLength, int $position)
@@ -67,11 +67,11 @@ 
         $this->analyzeAppend($subject);
     }
     
-   /**
-    * Whether an EOL character needs to be appended or prepended.
-    *  
-    * @return bool
-    */
+    /**
+     * Whether an EOL character needs to be appended or prepended.
+     *  
+     * @return bool
+     */
     public function requiresAdjustment() : bool
     {
         return $this->requiresAppend() || $this->requiresPrepend();

Spacing +6 added lines, -6 removed lines

@@ -90,21 +90,21 @@ 
     protected function analyzePrepend(string $subject) : void
     {
         // we're at the beginning of the string
-        if($this->position == 0)
+        if ($this->position == 0)
         {
             return;
         }
         
         $prevPos = $this->position - $this->eolLength;
         
-        if($prevPos < 0)
+        if ($prevPos < 0)
         {
             $prevPos = 0;
         }
         
         $prev = mb_substr($subject, $prevPos, $this->eolLength);
         
-        if($prev !== $this->formatter->getEOLChar())
+        if ($prev !== $this->formatter->getEOLChar())
         {
             $this->prepend = true;
         }
@@ -117,21 +117,21 @@ 
         $position = $this->position + $this->placeholderLength;
         
         // we're at the end of the string
-        if($position >= $subjectLength)
+        if ($position >= $subjectLength)
         {
             return;
         }
         
         $nextPos = $position + $this->eolLength;
         
-        if($nextPos > $subjectLength)
+        if ($nextPos > $subjectLength)
         {
             $nextPos = $subjectLength - $this->eolLength;
         }
         
         $next = mb_substr($subject, $nextPos, $this->eolLength);
         
-        if($next !== $this->formatter->getEOLChar())
+        if ($next !== $this->formatter->getEOLChar())
         {
             $this->append = true;
         }

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

Indentation +13 added lines, -13 removed lines

@@ -23,14 +23,14 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
     public function format(string $subject) : string
@@ -119,13 +119,13 @@ 
         return $prepend.$placeholder.$append;
     }
     
-   /**
-    * We only use placeholders that contain commands that do
-    * not generate contents, since these are the only ones
-    * that may need adjusting.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * We only use placeholders that contain commands that do
+     * not generate contents, since these are the only ones
+     * that may need adjusting.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         $placeholders = $this->safeguard->getPlaceholders();

Spacing +7 added lines, -7 removed lines

@@ -42,7 +42,7 @@ 
         
         $total = count($placeholders);
         
-        for($i=0; $i < $total; $i++)
+        for ($i = 0; $i < $total; $i++)
         {
             $subject = $this->process($placeholders[$i], $subject);
         }
@@ -66,7 +66,7 @@ 
         $phLength = mb_strlen($placeholder);
         $offset = 0;
         
-        foreach($positions as $position)
+        foreach ($positions as $position)
         {
             // adjust the position if previous changes made the subject longer
             $position += $offset;
@@ -78,7 +78,7 @@ 
                 $position
             );
             
-            if(!$info->requiresAdjustment())
+            if (!$info->requiresAdjustment())
             {
                 continue;
             }
@@ -106,12 +106,12 @@ 
         $prepend = '';
         $append = '';
         
-        if($info->requiresPrepend())
+        if ($info->requiresPrepend())
         {
             $prepend = $this->eol;
         }
         
-        if($info->requiresAppend())
+        if ($info->requiresAppend())
         {
             $append = $this->eol;
         }
@@ -132,9 +132,9 @@ 
         
         $result = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if(!$placeholder->getCommand()->generatesContent())
+            if (!$placeholder->getCommand()->generatesContent())
             {
                 $result[] = $placeholder;
             }

src/Mailcode/Parser/Safeguard.php

Indentation +122 added lines, -122 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();
@@ -201,10 +201,10 @@ 
         );
     }
     
-   /**
-    * 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');
@@ -224,13 +224,13 @@ 
         );
     }
     
-   /**
-    * 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) : array
     {
         $placeholders = $this->getPlaceholders();
@@ -257,12 +257,12 @@ 
     }
     
     
-   /**
-    * 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))
@@ -314,46 +314,46 @@ 
         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($string, false);
     }
 
-   /**
-    * 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($string, true);
     }
     
-   /**
-    * 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))
@@ -371,11 +371,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())
@@ -394,11 +394,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(isset($this->placeholderStrings))
@@ -425,13 +425,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();
@@ -454,13 +454,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',
@@ -171,7 +171,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);
         }
@@ -183,7 +183,7 @@ 
     {
         $class = 'Mailcode\Mailcode_Parser_Safeguard_Formatter_'.$formatterID;
         
-        if(class_exists($class))
+        if (class_exists($class))
         {
             $this->formatter = new $class($this);
             
@@ -209,7 +209,7 @@ 
     {
         $formatter = $this->selectFormatter('SingleLines');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
         {
             return $formatter;
         }
@@ -231,17 +231,17 @@ 
     * @param bool $highlighted
     * @return string[]string
     */
-    protected function getReplaces(bool $highlighted=false) : array
+    protected function getReplaces(bool $highlighted = false) : array
     {
         $placeholders = $this->getPlaceholders();
         
         $replaces = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $replace = '';
             
-            if($highlighted)
+            if ($highlighted)
             {
                 $replace = $placeholder->getHighlightedText();
             }
@@ -265,7 +265,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -274,7 +274,7 @@ 
         
         $cmds = $this->getCollection()->getGroupedByHash();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -288,7 +288,7 @@ 
         return $this->placeholders;
     }
     
-    protected function restore(string $string, bool $highlighted=false) : string
+    protected function restore(string $string, bool $highlighted = false) : string
     {
         $this->requireValidCollection();
         
@@ -296,9 +296,9 @@ 
         
         $placeholderStrings = array_keys($replaces);
         
-        foreach($placeholderStrings as $search)
+        foreach ($placeholderStrings as $search)
         {
-            if(!strstr($string, $search))
+            if (!strstr($string, $search))
             {
                 throw new Mailcode_Exception(
                     'Command placeholder not found',
@@ -356,7 +356,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -378,7 +378,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -401,7 +401,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(isset($this->placeholderStrings))
+        if (isset($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -410,7 +410,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -436,9 +436,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -465,9 +465,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }