Mistralys / mailcode

src/Mailcode/Parser/Statement/Tokenizer.php

Spacing +22 added lines, -22 removed lines

@@ -135,9 +135,9 @@ 
     {
         $result = array();
         
-        foreach($this->tokensOrdered as $token)
+        foreach ($this->tokensOrdered as $token)
         {
-            if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Unknown)
+            if ($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Unknown)
             {
                 $result[] = $token;
             }
@@ -150,7 +150,7 @@ 
     {
         $unknown = $this->getUnknown();
         
-        if(!empty($unknown))
+        if (!empty($unknown))
         {
             return array_shift($unknown);
         }
@@ -162,11 +162,11 @@ 
     {
         $parts = array();
         
-        foreach($this->tokensOrdered as $token)
+        foreach ($this->tokensOrdered as $token)
         {
             $string = $token->getNormalized();
             
-            if($string != '')
+            if ($string != '')
             {
                 $parts[] = $string;
             }
@@ -179,11 +179,11 @@ 
     {
         $this->tokenized = trim($statement);
         
-        foreach($this->tokenCategories as $token)
+        foreach ($this->tokenCategories as $token)
         {
             $method = 'tokenize_'.$token;
             
-            if(!method_exists($this, $method))
+            if (!method_exists($this, $method))
             {
                 throw new Mailcode_Exception(
                     'Unknown statement token.',
@@ -207,7 +207,7 @@ 
     * @param string $matchedText
     * @param mixed $subject
     */
-    protected function registerToken(string $type, string $matchedText, $subject=null) : void
+    protected function registerToken(string $type, string $matchedText, $subject = null) : void
     {
         $tokenID = $this->generateID();
         
@@ -224,9 +224,9 @@ 
     
     protected function getTokenByID(string $tokenID) : ?Mailcode_Parser_Statement_Tokenizer_Token
     {
-        foreach($this->tokensTemporary as $token)
+        foreach ($this->tokensTemporary as $token)
         {
-            if($token->getID() === $tokenID)
+            if ($token->getID() === $tokenID)
             {
                 return $token;
             }
@@ -242,9 +242,9 @@ 
     
     protected function tokenize_keywords() : void
     {
-        foreach($this->keywords as $keyword)
+        foreach ($this->keywords as $keyword)
         {
-            if(strstr($this->tokenized, $keyword))
+            if (strstr($this->tokenized, $keyword))
             {
                 $this->registerToken('Keyword', $keyword);
             }
@@ -258,12 +258,12 @@ 
         // over that could not be tokenized.
         $parts = \AppUtils\ConvertHelper::explodeTrim($this->delimiter, $this->tokenized);
 
-        foreach($parts as $part)
+        foreach ($parts as $part)
         {
             $token = $this->getTokenByID($part);
             
             // if the entry is a token, simply add it.
-            if($token)
+            if ($token)
             {
                 $this->tokensOrdered[] = $token;
             }
@@ -279,7 +279,7 @@ 
     {
         $vars = Mailcode::create()->findVariables($this->tokenized)->getGroupedByHash();
         
-        foreach($vars as $var)
+        foreach ($vars as $var)
         {
             $this->registerToken('Variable', $var->getMatchedText(), $var);
         }
@@ -287,9 +287,9 @@ 
     
     protected function tokenize_operands() : void
     {
-        foreach($this->operands as $operand)
+        foreach ($this->operands as $operand)
         {
-            if(strstr($this->tokenized, $operand))
+            if (strstr($this->tokenized, $operand))
             {
                 $this->registerToken('Operand', $operand);
             }
@@ -301,7 +301,7 @@ 
         $matches = array();
         preg_match_all('/"(.*)"/sx', $this->tokenized, $matches, PREG_PATTERN_ORDER);
         
-        foreach($matches[0] as $match)
+        foreach ($matches[0] as $match)
         {
             $this->registerToken('StringLiteral', $match);
         }
@@ -312,7 +312,7 @@ 
         $matches = array();
         preg_match_all('/-*[0-9]+\s*[.,]\s*[0-9]+|-*[0-9]+/sx', $this->tokenized, $matches, PREG_PATTERN_ORDER);
         
-        foreach($matches[0] as $match)
+        foreach ($matches[0] as $match)
         {
             $this->registerToken('Number', $match);
         }
@@ -329,7 +329,7 @@ 
     {
         static $alphas;
         
-        if(!isset($alphas))
+        if (!isset($alphas))
         {
             $alphas = range('A', 'Z');
         }
@@ -338,12 +338,12 @@ 
         
         $result = '';
         
-        for($i=0; $i < $amount; $i++)
+        for ($i = 0; $i < $amount; $i++)
         {
             $result .= $alphas[array_rand($alphas)];
         }
         
-        if(!in_array($result, self::$ids))
+        if (!in_array($result, self::$ids))
         {
             self::$ids[] = $result;
             return $result;

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();
@@ -216,10 +216,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');
@@ -239,13 +239,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();
@@ -276,12 +276,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))
@@ -336,17 +336,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(
@@ -356,15 +356,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(
@@ -374,20 +374,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(
@@ -397,15 +397,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(
@@ -415,11 +415,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))
@@ -437,11 +437,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())
@@ -460,11 +460,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))
@@ -491,13 +491,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();
@@ -520,13 +520,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 +22 added lines, -22 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);
             
@@ -224,7 +224,7 @@ 
     {
         $formatter = $this->selectFormatter('SingleLines');
         
-        if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
+        if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_SingleLines)
         {
             return $formatter;
         }
@@ -246,21 +246,21 @@ 
     * @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 = '';
             
-            if($highlighted)
+            if ($highlighted)
             {
                 $replace = $placeholder->getHighlightedText();
             }
-            else if($normalize)
+            else if ($normalize)
             {
                 $replace = $placeholder->getNormalizedText();
             }
@@ -284,7 +284,7 @@ 
     */
     public function getPlaceholders()
     {
-        if(isset($this->placeholders))
+        if (isset($this->placeholders))
         {
             return $this->placeholders;
         }
@@ -293,7 +293,7 @@ 
         
         $cmds = $this->getCollection()->getGroupedByHash();
         
-        foreach($cmds as $command)
+        foreach ($cmds as $command)
         {
             self::$counter++;
             
@@ -307,9 +307,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();
         }
@@ -318,9 +318,9 @@ 
         
         $placeholderStrings = array_keys($replaces);
         
-        foreach($placeholderStrings as $search)
+        foreach ($placeholderStrings as $search)
         {
-            if(!$partial && !strstr($string, $search))
+            if (!$partial && !strstr($string, $search))
             {
                 throw new Mailcode_Exception(
                     'Command placeholder not found',
@@ -422,7 +422,7 @@ 
     */
     public function getCollection() : Mailcode_Collection
     {
-        if(isset($this->collection))
+        if (isset($this->collection))
         {
             return $this->collection;
         }
@@ -444,7 +444,7 @@ 
     */
     protected function requireValidCollection() : void
     {
-        if($this->getCollection()->isValid())
+        if ($this->getCollection()->isValid())
         {
             return;
         }
@@ -467,7 +467,7 @@ 
     */
     public function getPlaceholderStrings() : array
     {
-        if(is_array($this->placeholderStrings))
+        if (is_array($this->placeholderStrings))
         {
             return $this->placeholderStrings;
         }
@@ -476,7 +476,7 @@ 
         
         $this->placeholderStrings = array();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
             $this->placeholderStrings[] = $placeholder->getReplacementText();
         }
@@ -502,9 +502,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getID() === $id)
+            if ($placeholder->getID() === $id)
             {
                 return $placeholder;
             }
@@ -531,9 +531,9 @@ 
     {
         $placeholders = $this->getPlaceholders();
         
-        foreach($placeholders as $placeholder)
+        foreach ($placeholders as $placeholder)
         {
-            if($placeholder->getReplacementText() === $string)
+            if ($placeholder->getReplacementText() === $string)
             {
                 return $placeholder;
             }

Braces +2 added lines, -4 removed lines

@@ -259,12 +259,10 @@
             if($highlighted)
             {
                 $replace = $placeholder->getHighlightedText();
-            }
-            else if($normalize)
+            } else if($normalize)
             {
                 $replace = $placeholder->getNormalizedText();
-            }
-            else
+            } else
             {
                 $replace = $placeholder->getOriginalText();
             }