Mistralys / mailcode

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::showVar($variableName));

src/Mailcode/Variables.php

Indentation +9 added lines, -9 removed lines

@@ -22,17 +22,17 @@
 {
     const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six';
     
-   /**
-    * @var Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Regular
+     */
     protected $collection;
     
-   /**
-    * Parses the specified string to find all variable names contained within, if any.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Parses the specified string to find all variable names contained within, if any.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function parseString(string $subject) : Mailcode_Variables_Collection_Regular
     {
         $this->collection = new Mailcode_Variables_Collection_Regular();

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,51 +26,51 @@ 
  */
 class 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();
     }
     
-   /**
-    * 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()->parseString($string);
     }
     
-   /**
-    * 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)) 
@@ -81,12 +81,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)) 
@@ -102,12 +102,12 @@ 
         return $this->getParser()->createSafeguard($subject);
     }
     
-   /**
-    * Attempts to find all variables in the target string.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Attempts to find all variables in the target string.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject);
@@ -123,12 +123,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))

src/Mailcode/Parser.php

Indentation +50 added lines, -50 removed lines

@@ -28,14 +28,14 @@ 
         '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]*)}'
     );
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var Mailcode_Commands
-    */
+    /**
+     * @var Mailcode_Commands
+     */
     protected $commands;
     
     public function __construct(Mailcode $mailcode)
@@ -44,24 +44,24 @@ 
         $this->commands = $this->mailcode->getCommands();
     }
     
-   /**
-    * Gets the regex format string used to detect commands.
-    * 
-    * @return string
-    */
+    /**
+     * Gets the regex format string used to detect commands.
+     * 
+     * @return string
+     */
     protected static function getRegex() : string
     {
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
     }
     
-   /**
-    * Parses a string to detect all commands within. Returns a
-    * collection instance that contains information on all the 
-    * commands.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection A collection with all unique commands found.
-    */
+    /**
+     * Parses a string to detect all commands within. Returns a
+     * collection instance that contains information on all the 
+     * commands.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection A collection with all unique commands found.
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         $collection = new Mailcode_Collection();
@@ -94,14 +94,14 @@ 
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
     }
     
-   /**
-    * Processes a single match found in the string: creates the command,
-    * and adds it to the collection if it's a valid command, or to the list
-    * of invalid commands otherwise.
-    * 
-    * @param Mailcode_Parser_Match $match
-    * @param Mailcode_Collection $collection
-    */
+    /**
+     * Processes a single match found in the string: creates the command,
+     * and adds it to the collection if it's a valid command, or to the list
+     * of invalid commands otherwise.
+     * 
+     * @param Mailcode_Parser_Match $match
+     * @param Mailcode_Collection $collection
+     */
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
     {
         $name = $match->getName();
@@ -132,14 +132,14 @@ 
         $collection->addInvalidCommand($cmd);
     }
     
-   /**
-    * Parses a single regex match: determines which named group
-    * matches, and retrieves the according information.
-    * 
-    * @param array[] $matches The regex results array.
-    * @param int $index The matched index.
-    * @return Mailcode_Parser_Match
-    */
+    /**
+     * Parses a single regex match: determines which named group
+     * matches, and retrieves the according information.
+     * 
+     * @param array[] $matches The regex results array.
+     * @param int $index The matched index.
+     * @return Mailcode_Parser_Match
+     */
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
     {
         $name = ''; // the command name, e.g. "showvar"
@@ -177,26 +177,26 @@ 
         );
     }
     
-   /**
-    * Creates an instance of the safeguard tool, which
-    * is used to safeguard commands in a string with placeholders.
-    * 
-    * @param string $subject The string to use to safeguard commands in.
-    * @return Mailcode_Parser_Safeguard
-    * @see Mailcode_Parser_Safeguard
-    */
+    /**
+     * Creates an instance of the safeguard tool, which
+     * is used to safeguard commands in a string with placeholders.
+     * 
+     * @param string $subject The string to use to safeguard commands in.
+     * @return Mailcode_Parser_Safeguard
+     * @see Mailcode_Parser_Safeguard
+     */
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
     {
         return new Mailcode_Parser_Safeguard($this, $subject);
     }
     
-   /**
-    * Creates a statement parser, which is used to validate arbitrary
-    * command statements.
-    * 
-    * @param string $statement
-    * @return Mailcode_Parser_Statement
-    */
+    /**
+     * Creates a statement parser, which is used to validate arbitrary
+     * command statements.
+     * 
+     * @param string $statement
+     * @return Mailcode_Parser_Statement
+     */
     public function createStatement(string $statement) : Mailcode_Parser_Statement
     {
         return new Mailcode_Parser_Statement($statement);

src/Mailcode/Collection.php

Indentation +51 added lines, -51 removed lines

@@ -24,9 +24,9 @@ 
 {
     const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -34,17 +34,17 @@ 
      */
     protected $errors = array();
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected $validationResult;
     
-   /**
-    * Adds a command to the collection.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds a command to the collection.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @return Mailcode_Collection
+     */
     public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection
     {
         $this->commands[] = $command;
@@ -56,21 +56,21 @@ 
         return $this;
     }
     
-   /**
-    * Whether there are any commands in the collection.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there are any commands in the collection.
+     * 
+     * @return bool
+     */
     public function hasCommands() : bool
     {
         return !empty($this->commands);
     }
     
-   /**
-    * Counts the amount of commands in the collection.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of commands in the collection.
+     * 
+     * @return int
+     */
     public function countCommands() : int
     {
         return count($this->commands);
@@ -90,9 +90,9 @@ 
         $this->errors[] = new Mailcode_Collection_Error_Command($command);
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -134,25 +134,25 @@ 
         return empty($errors);
     }
     
-   /**
-    * Retrieves all commands that were detected, in the exact order
-    * they were found.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected, in the exact order
+     * they were found.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
-       return $this->commands;
+        return $this->commands;
     }
     
-   /**
-    * Retrieves all unique commands by their matched
-    * string hash: this ensures only commands that were
-    * written the exact same way (including spacing)
-    * are returned.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all unique commands by their matched
+     * string hash: this ensures only commands that were
+     * written the exact same way (including spacing)
+     * are returned.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getGroupedByHash()
     {
         $hashes = array();
@@ -170,12 +170,12 @@ 
         return array_values($hashes);
     }
 
-   /**
-    * Adds several commands at once.
-    * 
-    * @param Mailcode_Commands_Command[] $commands
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds several commands at once.
+     * 
+     * @param Mailcode_Commands_Command[] $commands
+     * @return Mailcode_Collection
+     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
         foreach($commands as $command)
@@ -234,11 +234,11 @@ 
         return false;
     }
     
-   /**
-    * Retrieves only show variable commands in the collection, if any.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
-    */
+    /**
+     * Retrieves only show variable commands in the collection, if any.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
+     */
     public function getShowVariableCommands()
     {
         $result = array();

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +51 added lines, -51 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_TOKENIZE_METHOD_MISSING = 49801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $operands = array(
         '==',
         '<=',
@@ -40,17 +40,17 @@ 
         '<'
     );
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $keywords = array(
         'in:',
         'insensitive:'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '§§';
     
     /**
@@ -66,19 +66,19 @@ 
         'extract_tokens'
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenized;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokensTemporary = array();
     
     /**
@@ -86,9 +86,9 @@ 
      */
     protected $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $ids = array();
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -98,12 +98,12 @@ 
         $this->tokenize($statement->getStatementString());
     }
 
-   /**
-    * 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()
     {
         return $this->tokensOrdered;
@@ -114,11 +114,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();
@@ -126,11 +126,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown()
     {
         $result = array();
@@ -200,13 +200,13 @@ 
         }
     }
    
-   /**
-    * Registers a token to add in the statement string.
-    * 
-    * @param string $type
-    * @param string $matchedText
-    * @param mixed $subject
-    */
+    /**
+     * Registers a token to add in the statement string.
+     * 
+     * @param string $type
+     * @param string $matchedText
+     * @param mixed $subject
+     */
     protected function registerToken(string $type, string $matchedText, $subject=null) : void
     {
         $tokenID = $this->generateID();
@@ -318,13 +318,13 @@ 
         }
     }
     
-   /**
-    * 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/Translator/Syntax/ApacheVelocity.php

Indentation +7 added lines, -7 removed lines

@@ -20,13 +20,13 @@
  */
 abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command
 {
-   /**
-    * Filters the string for use in an Apache Velocity (Java)
-    * regex string: escapes all special characters.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Filters the string for use in an Apache Velocity (Java)
+     * regex string: escapes all special characters.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function filterRegexString(string $string) : string
     {
         $escape = array(

src/Mailcode/Translator/Syntax.php

Indentation +21 added lines, -21 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_UNKNOWN_COMMAND_TYPE = 50401;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $typeID;
     
     public function __construct(string $typeID)
@@ -33,22 +33,22 @@ 
         $this->typeID = $typeID;
     }
     
-   /**
-    * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
-    * @return string
-    */
+    /**
+     * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
+     * @return string
+     */
     public function getTypeID() : string
     {
         return $this->typeID;
     }
     
-   /**
-    * Translates a single command to the target syntax.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @throws Mailcode_Translator_Exception
-    * @return string
-    */
+    /**
+     * Translates a single command to the target syntax.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @throws Mailcode_Translator_Exception
+     * @return string
+     */
     public function translateCommand(Mailcode_Commands_Command $command) : string
     {
         $translator = $this->createTranslator($command);
@@ -81,13 +81,13 @@ 
         return $translator;
     }
     
-   /**
-    * Translates all safeguarded commands in the subject string to the 
-    * target syntax in one go.
-    * 
-    * @param Mailcode_Parser_Safeguard $safeguard
-    * @return string
-    */
+    /**
+     * Translates all safeguarded commands in the subject string to the 
+     * target syntax in one go.
+     * 
+     * @param Mailcode_Parser_Safeguard $safeguard
+     * @return string
+     */
     public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string
     {
         $subject = $safeguard->makeSafe();

src/Mailcode/Collection/NestingValidator.php

Indentation +9 added lines, -9 removed lines

@@ -29,19 +29,19 @@
     const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103;
     const VALIDATION_UNCLOSED_COMMAND = 49104;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult;
     
-   /**
-    * @var Mailcode_Commands_Command_Type[]
-    */
+    /**
+     * @var Mailcode_Commands_Command_Type[]
+     */
     protected $stack = array();
     
     public function __construct(Mailcode_Collection $collection)