Mistralys / mailcode

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