Mistralys / mailcode

src/Mailcode/Variables/Collection.php

Indentation +56 added lines, -56 removed lines

@@ -20,9 +20,9 @@ 
  */
 abstract class Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Variable[]
-    */
+    /**
+     * @var Mailcode_Variables_Variable[]
+     */
     protected array $variables = array();
     
     public function __construct()
@@ -52,12 +52,12 @@ 
         return count($this->variables);
     }
     
-   /**
-    * Checks whether the collection contains a variable with the specified name.
-    * 
-    * @param string $fullName The variable name, with or without $ sign.
-    * @return bool
-    */
+    /**
+     * Checks whether the collection contains a variable with the specified name.
+     * 
+     * @param string $fullName The variable name, with or without $ sign.
+     * @return bool
+     */
     public function hasVariableName(string $fullName) : bool
     {
         $fullName = $this->fixName($fullName);
@@ -73,14 +73,14 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a collection of all variable instances for
-    * the specified name (there can be several with differing
-    * matched texts because of spacing).
-    * 
-    * @param string $fullName
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     * Retrieves a collection of all variable instances for
+     * the specified name (there can be several with differing
+     * matched texts because of spacing).
+     * 
+     * @param string $fullName
+     * @return Mailcode_Variables_Collection
+     */
     public function getByFullName(string $fullName) : Mailcode_Variables_Collection
     {
         $fullName = $this->fixName($fullName);
@@ -98,23 +98,23 @@ 
         return $collection;
     }
     
-   /**
-    * Prepends the $ sign to a variable name if it does not have it.
-    * 
-    * @param string $fullName
-    * @return string
-    */
+    /**
+     * Prepends the $ sign to a variable name if it does not have it.
+     * 
+     * @param string $fullName
+     * @return string
+     */
     protected function fixName(string $fullName) : string
     {
         return dollarize($fullName);
     }
     
-   /**
-    * Retrieves all variables, grouped by their hash - meaning
-    * unique matched strings.
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their hash - meaning
+     * unique matched strings.
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByHash() : array
     {
         $entries = array();
@@ -127,11 +127,11 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, grouped by their name. 
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their name. 
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByName() : array
     {
         $entries = array();
@@ -163,19 +163,19 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, in the order they were addded.
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, in the order they were addded.
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getAll()
     {
         return $this->variables;
     }
     
-   /**
-    * Retrieves the full names of the variables that are present in the collection.
-    * @return string[]
-    */
+    /**
+     * Retrieves the full names of the variables that are present in the collection.
+     * @return string[]
+     */
     public function getNames() : array
     {
         $result = array();
@@ -193,13 +193,13 @@ 
         return $result;
     }
     
-   /**
-    * Takes a list of variables and sorts them, throwing away
-    * the source array's keys.
-    * 
-    * @param Mailcode_Variables_Variable[] $entries
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Takes a list of variables and sorts them, throwing away
+     * the source array's keys.
+     * 
+     * @param Mailcode_Variables_Variable[] $entries
+     * @return Mailcode_Variables_Variable[]
+     */
     protected function sortVariables(array $entries)
     {
         $result = array_values($entries);
@@ -212,13 +212,13 @@ 
         return $result;
     }
 
-   /**
-    *  Merges the variables collection with the target collection
-    *  by inheriting all that collection's variables.
-    *  
-    * @param Mailcode_Variables_Collection $collection
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     *  Merges the variables collection with the target collection
+     *  by inheriting all that collection's variables.
+     *  
+     * @param Mailcode_Variables_Collection $collection
+     * @return Mailcode_Variables_Collection
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         $variables = $collection->getGroupedByHash();

src/Mailcode/Translator/Syntax/ApacheVelocity/Contains/StatementBuilder.php

Indentation +22 added lines, -22 removed lines

@@ -225,27 +225,27 @@
      * @return array<string,string>
      * @throws Mailcode_Exception
      */
-     private function parseVarName() : array
-     {
-         $tokens = explode('.', undollarize($this->variable->getFullName()));
-
-         if(count($tokens) === 2)
-         {
-             return array(
-                 'path' => $tokens[0],
-                 'name' => $tokens[1]
-             );
-         }
-
-         throw new Mailcode_Exception(
-             'Invalid variable name for a list property.',
-             sprintf(
-                 'Exactly 2 parts are required, variable [%s] has [%s].',
-                 $this->variable->getFullName(),
-                 count($tokens)
-             ),
-             self::ERROR_INVALID_LIST_VARIABLE_NAME
-         );
-     }
+        private function parseVarName() : array
+        {
+            $tokens = explode('.', undollarize($this->variable->getFullName()));
+
+            if(count($tokens) === 2)
+            {
+                return array(
+                    'path' => $tokens[0],
+                    'name' => $tokens[1]
+                );
+            }
+
+            throw new Mailcode_Exception(
+                'Invalid variable name for a list property.',
+                sprintf(
+                    'Exactly 2 parts are required, variable [%s] has [%s].',
+                    $this->variable->getFullName(),
+                    count($tokens)
+                ),
+                self::ERROR_INVALID_LIST_VARIABLE_NAME
+            );
+        }
 }
 

src/Mailcode/Collection/Error.php

Indentation +9 added lines, -9 removed lines

@@ -20,19 +20,19 @@
  */
 abstract class Mailcode_Collection_Error
 {
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected int $code = 0;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $message = '';
 
     protected ?Mailcode_Commands_Command $command = null;

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +32 added lines, -32 removed lines

@@ -51,14 +51,14 @@ 
         Mailcode_Parser_Statement_Tokenizer_Process_SetNames::class,
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected Mailcode_Parser_Statement $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $tokenized = '';
     
     /**
@@ -66,9 +66,9 @@ 
      */
     protected array $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static array $ids = array();
 
     /**
@@ -91,12 +91,12 @@ 
         return $this->statement->getSourceCommand();
     }
 
-   /**
-    * Retrieves all tokens detected in the statement string, in 
-    * the order they were found.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens detected in the statement string, in 
+     * the order they were found.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens() : array
     {
         return $this->tokensOrdered;
@@ -107,11 +107,11 @@ 
         return !empty($this->tokensOrdered);
     }
     
-   /**
-    * Whether there were any unknown tokens in the statement.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there were any unknown tokens in the statement.
+     * 
+     * @return bool
+     */
     public function hasUnknown() : bool
     {
         $unknown = $this->getUnknown();
@@ -119,11 +119,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown() : array
     {
         $result = array();
@@ -410,13 +410,13 @@ 
         return $this;
     }
     
-   /**
-    * Generates a unique alphabet-based ID without numbers
-    * to use as token name, to avoid conflicts with the
-    * numbers detection.
-    *
-    * @return string
-    */
+    /**
+     * Generates a unique alphabet-based ID without numbers
+     * to use as token name, to avoid conflicts with the
+     * numbers detection.
+     *
+     * @return string
+     */
     protected function generateID() : string
     {
         static $alphas;

src/Mailcode/Parser/Statement/Tokenizer/Token/StringLiteral.php

Indentation +15 added lines, -15 removed lines

@@ -35,11 +35,11 @@ 
     }
 
     /**
-    * Retrieves the text with the surrounding quotes,
-    * and special characters escaped for Mailcode.
-    *
-    * @return string
-    */
+     * Retrieves the text with the surrounding quotes,
+     * and special characters escaped for Mailcode.
+     *
+     * @return string
+     */
     public function getNormalized() : string
     {
         return '"'.SpecialChars::escape($this->text).'"';
@@ -50,21 +50,21 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the text with the surrounding quotes.
-    * @return string
-    */
+    /**
+     * Retrieves the text with the surrounding quotes.
+     * @return string
+     */
     public function getValue() : string
     {
         return $this->getNormalized();
     }
     
-   /**
-    * Retrieves the text without the surrounding quotes,
-    * and special Mailcode characters not escaped.
-    *
-    * @return string
-    */
+    /**
+     * Retrieves the text without the surrounding quotes,
+     * and special Mailcode characters not escaped.
+     *
+     * @return string
+     */
     public function getText() : string
     {
         return SpecialChars::decode($this->text);

src/Mailcode/Parser/Statement/Tokenizer/Token/Operand.php

Indentation +18 added lines, -18 removed lines

@@ -35,10 +35,10 @@ 
         return true;
     }
     
-   /**
-    * Retrieves all known comparison operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known comparison operator signs.
+     * @return string[]
+     */
     public static function getComparisonSigns() : array
     {
         return array(
@@ -51,10 +51,10 @@ 
         );
     }
     
-   /**
-    * Retrieves all known arithmetic operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known arithmetic operator signs.
+     * @return string[]
+     */
     public static function getArithmeticSigns() : array
     {
         return array(
@@ -65,11 +65,11 @@ 
         );
     }
     
-   /**
-    * Whether the operator is comparison related (equals, not equals, smaller, greater...).
-    *  
-    * @return bool
-    */
+    /**
+     * Whether the operator is comparison related (equals, not equals, smaller, greater...).
+     *  
+     * @return bool
+     */
     public function isComparator() : bool
     {
         return 
@@ -81,11 +81,11 @@ 
         $this->isSmallerOrEquals();
     }
     
-   /**
-    * Whether the operator is calculation related (minus, plus, divide, multiply).
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the operator is calculation related (minus, plus, divide, multiply).
+     * 
+     * @return bool
+     */
     public function isCalculator() : bool
     {
         return 

src/Mailcode/Traits/Formatting/HTMLHighlighting.php

Indentation +26 added lines, -26 removed lines

@@ -23,25 +23,25 @@ 
  */
 trait Mailcode_Traits_Formatting_HTMLHighlighting
 {
-   /**
-    * Stored this way, so we can use isset() instead
-    * of using in_array, which is some magnitudes slower.
-    * The boolean value is not used otherwise.
-    *
-    * @var array<string,bool>
-    */
+    /**
+     * Stored this way, so we can use isset() instead
+     * of using in_array, which is some magnitudes slower.
+     * The boolean value is not used otherwise.
+     *
+     * @var array<string,bool>
+     */
     private array $excludeTags = array(
         'style' => true, // NOTE: style tags are excluded natively on the parser level.
         'script' => true
     );
     
-   /**
-    * Adds an HTML tag name to the list of tags within which
-    * commands may not be highlighted.
-    *
-    * @param string $tagName Case-insensitive.
-    * @return $this
-    */
+    /**
+     * Adds an HTML tag name to the list of tags within which
+     * commands may not be highlighted.
+     *
+     * @param string $tagName Case-insensitive.
+     * @return $this
+     */
     public function excludeTag(string $tagName) : self
     {
         $tagName = strtolower($tagName);
@@ -51,12 +51,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds several excluded tag names at once.
-    *
-    * @param string[] $tagNames
-    * @return $this
-    */
+    /**
+     * Adds several excluded tag names at once.
+     *
+     * @param string[] $tagNames
+     * @return $this
+     */
     public function excludeTags(array $tagNames) : self
     {
         foreach($tagNames as $tagName)
@@ -67,12 +67,12 @@ 
         return $this;
     }
     
-   /**
-    * Whether the specified tag name is in the exclusion list.
-    *
-    * @param string $tagName
-    * @return bool
-    */
+    /**
+     * Whether the specified tag name is in the exclusion list.
+     *
+     * @param string $tagName
+     * @return bool
+     */
     public function isTagExcluded(string $tagName) : bool
     {
         $tagName = strtolower($tagName);

src/Mailcode.php

Indentation +43 added lines, -43 removed lines

@@ -31,29 +31,29 @@ 
     public const PACKAGE_NAME = 'Mailcode';
 
     /**
-    * @var Mailcode_Parser|NULL
-    */
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
@@ -65,11 +65,11 @@ 
     }
 
     /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()
@@ -77,11 +77,11 @@ 
             ->getCollection();
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -92,12 +92,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -140,12 +140,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))
@@ -156,12 +156,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();