Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Placeholder.php

Spacing +3 added lines, -3 removed lines

@@ -69,7 +69,7 @@ 
     
     public function getReplacementText() : string
     {
-        if(!empty($this->replacement))
+        if (!empty($this->replacement))
         {
             return $this->replacement;
         }
@@ -87,7 +87,7 @@ 
         // to total amount of zeroes to pad with to obtain the total length
         $padLength = $this->getLength() - $length - 1; // -1 for the ID separator char
         
-        if($padLength < 0) 
+        if ($padLength < 0) 
         {
             $padLength = 0;
         }
@@ -104,7 +104,7 @@ 
         // separator, there is no ambiguity. It becomes "1*000000000" and
         // "10*00000000", keeping the ID intact.
 
-        $paddedID  = str_pad((string)$this->id.'*', $padLength, '0');
+        $paddedID = str_pad((string)$this->id.'*', $padLength, '0');
         
         $this->replacement = sprintf($format, $paddedID);
 

src/Mailcode/Parser/Safeguard.php

Indentation +145 added lines, -145 removed lines

@@ -56,45 +56,45 @@ 
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
     const ERROR_INVALID_DELIMITER = 47805;
     
-   /**
-    * @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;
 
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -113,29 +113,29 @@ 
         self::$counter = 0;
     }
     
-   /**
-    * 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).
-    *
-    * Minimum characters: 2
-    * Invalid characters: *
-    * Rules: May not end or begin with a number
-    * 
-    * @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).
+     *
+     * Minimum characters: 2
+     * Invalid characters: *
+     * Rules: May not end or begin with a number
+     * 
+     * @param string $delimiter
+     * @return Mailcode_Parser_Safeguard
+     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
         if(empty($delimiter))
@@ -175,15 +175,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();
@@ -191,16 +191,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
     {
         $placeholders = $this->getPlaceholders();
@@ -310,13 +310,13 @@ 
         }
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formattings to use for the commands in the subject string.
-    * 
-    * @param Mailcode_StringContainer|string $subject
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * Creates a formatting handler, which can be used to specify
+     * which formattings to use for the commands in the subject string.
+     * 
+     * @param Mailcode_StringContainer|string $subject
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
         if(is_string($subject))
@@ -327,12 +327,12 @@ 
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
     }
     
-   /**
-    * 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))
@@ -408,16 +408,16 @@ 
         return $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
-    */
+    /**
+     * 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
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore(
@@ -427,15 +427,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(
@@ -445,19 +445,19 @@ 
         );
     }
 
-   /**
-    * 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
-    */
+    /**
+     * 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
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore(
@@ -467,15 +467,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(
@@ -485,11 +485,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))
@@ -507,11 +507,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())
@@ -530,11 +530,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))
@@ -561,13 +561,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();
@@ -590,13 +590,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 +29 added lines, -29 removed lines

@@ -138,7 +138,7 @@ 
     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
-        if(empty($delimiter))
+        if (empty($delimiter))
         {
             throw new Mailcode_Exception(
                 'Empty delimiter',
@@ -147,7 +147,7 @@ 
             );
         }
 
-        if(!preg_match('/\A[^0-9*].*[^0-9*]\z/x', $delimiter))
+        if (!preg_match('/\A[^0-9*].*[^0-9*]\z/x', $delimiter))
         {
             throw new Mailcode_Exception(
                 'The delimiter may not begin or end with a number.',
@@ -156,7 +156,7 @@ 
             );
         }
 
-        if(strstr($delimiter, '*') !== false)
+        if (strstr($delimiter, '*') !== false)
         {
             throw new Mailcode_Exception(
                 'The delimiter may not contain the * character.',
@@ -206,7 +206,7 @@ 
         $placeholders = $this->getPlaceholders();
         $string = $this->originalString;
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $string = $this->makePlaceholderSafe($string, $placeholder);
         }
@@ -236,14 +236,14 @@ 
         $placeholders = $this->getPlaceholders();
         $total = count($placeholders);
 
-        for($i=0; $i < $total; $i++)
+        for ($i = 0; $i < $total; $i++)
         {
             $placeholder = $placeholders[$i];
             $command = $placeholder->getCommand();
 
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
             {
-                $string = $command->protectContent($string, $placeholder, $placeholders[$i+1]);
+                $string = $command->protectContent($string, $placeholder, $placeholders[$i + 1]);
             }
         }
 
@@ -254,7 +254,7 @@ 
     {
         $pos = mb_strpos($string, $placeholder->getOriginalText());
 
-        if($pos === false)
+        if ($pos === false)
         {
             throw new Mailcode_Exception(
                 'Placeholder original text not found',
@@ -286,23 +286,23 @@ 
 
         $placeholders = $this->getPlaceholders();
 
-        foreach($urls as $url)
+        foreach ($urls as $url)
         {
-            if(stristr($url, 'tel:'))
+            if (stristr($url, 'tel:'))
             {
                 continue;
             }
 
-            foreach($placeholders as $placeholder)
+            foreach ($placeholders as $placeholder)
             {
                 $command = $placeholder->getCommand();
 
-                if(!$command->supportsURLEncoding())
+                if (!$command->supportsURLEncoding())
                 {
                     continue;
                 }
 
-                if(strstr($url, $placeholder->getReplacementText()) && !$command->isURLDecoded())
+                if (strstr($url, $placeholder->getReplacementText()) && !$command->isURLDecoded())
                 {
                     $command->setURLEncoding(true);
                 }
@@ -319,7 +319,7 @@ 
     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
-        if(is_string($subject))
+        if (is_string($subject))
         {
             $subject = Mailcode::create()->createString($subject);
         }
@@ -335,7 +335,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -344,7 +344,7 @@ 
         
         $cmds = $this->getCollection()->getCommands();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -365,21 +365,21 @@ 
      * @return string
      * @throws Mailcode_Exception
      */
-    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();
         }
         
         $formatting = $this->createFormatting($string);
 
-        if($partial)
+        if ($partial)
         {
             $formatting->makePartial();
         }
         
-        if($highlighted)
+        if ($highlighted)
         {
             $formatting->replaceWithHTMLHighlighting();
         }
@@ -399,7 +399,7 @@ 
         {
             $command = $placeholder->getCommand();
 
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
             {
                 $string = $command->restoreContent($string);
             }
@@ -492,7 +492,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -514,7 +514,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -537,7 +537,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(is_array($this->placeholderStrings))
+        if (is_array($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -546,7 +546,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -572,9 +572,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -601,9 +601,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }