Mistralys / mailcode

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();
@@ -228,10 +228,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');
@@ -256,13 +256,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, bool $normalize=false) : array
     {
         $placeholders = $this->getPlaceholders();
@@ -313,12 +313,12 @@ 
         return $placeholder->getReplacementText();
     }
     
-   /**
-    * 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))
@@ -373,17 +373,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(
@@ -393,15 +393,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(
@@ -411,20 +411,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(
@@ -434,15 +434,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(
@@ -452,11 +452,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))
@@ -474,11 +474,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())
@@ -497,11 +497,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))
@@ -528,13 +528,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();
@@ -557,13 +557,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 +25 added lines, -25 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);
         }
@@ -198,7 +198,7 @@ 
     {
         $class = 'Mailcode\Mailcode_Parser_Safeguard_Formatter_'.$formatterID;
         
-        if(class_exists($class))
+        if (class_exists($class))
         {
             $this->formatter = new $class($this);
             
@@ -220,7 +220,7 @@ 
     {
         $formatter = $this->selectFormatter('HTMLHighlighting');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting)
         {
             return $formatter;
         }
@@ -236,7 +236,7 @@ 
     {
         $formatter = $this->selectFormatter('SingleLines');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
         {
             return $formatter;
         }
@@ -263,22 +263,22 @@ 
     * @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
     {
         $placeholders = $this->getPlaceholders();
         
         $replaces = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $replace = '';
             $needle = $placeholder->getReplacementText();
             
-            if($highlighted)
+            if ($highlighted)
             {
                 $formattedNeedle = $this->formatter->getReplaceNeedle($placeholder);
                 
-                if($formattedNeedle !== $needle)
+                if ($formattedNeedle !== $needle)
                 {
                     $replaces[$formattedNeedle] = $placeholder->getHighlightedText();
                     $replace = $placeholder->getNormalizedText();
@@ -288,7 +288,7 @@ 
                     $replace = $placeholder->getHighlightedText();
                 }
             }
-            else if($normalize)
+            else if ($normalize)
             {
                 $replace = $placeholder->getNormalizedText();
             }
@@ -305,7 +305,7 @@ 
     
     protected function getReplaceNeedle(Mailcode_Parser_Safeguard_Placeholder $placeholder) : string
     {
-        if(isset($this->formatter))
+        if (isset($this->formatter))
         {
             return $this->formatter->getReplaceNeedle($placeholder);
         }
@@ -321,7 +321,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -330,7 +330,7 @@ 
         
         $cmds = $this->getCollection()->getGroupedByHash();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -344,9 +344,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();
         }
@@ -355,9 +355,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',
@@ -459,7 +459,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -481,7 +481,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -504,7 +504,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(is_array($this->placeholderStrings))
+        if (is_array($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -513,7 +513,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -539,9 +539,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -568,9 +568,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }

Braces +3 added lines, -6 removed lines

@@ -282,17 +282,14 @@
                 {
                     $replaces[$formattedNeedle] = $placeholder->getHighlightedText();
                     $replace = $placeholder->getNormalizedText();
-                }
-                else
+                } else
                 {
                     $replace = $placeholder->getHighlightedText();
                 }
-            }
-            else if($normalize)
+            } else if($normalize)
             {
                 $replace = $placeholder->getNormalizedText();
-            }
-            else
+            } else
             {
                 $replace = $placeholder->getOriginalText();
             }