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();
@@ -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();

src/Mailcode/Parser/Safeguard/Placeholder.php

Indentation +24 added lines, -24 removed lines

@@ -25,24 +25,24 @@ 
 {
     const ERROR_PLACEHOLDER_TOO_LONG = 47901;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $id;
     
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     protected $safeguard;
 
-   /**
-    * @var Mailcode_Commands_Command
-    */
+    /**
+     * @var Mailcode_Commands_Command
+     */
     protected $command;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $replacement = '';
     
     public function __construct(int $id, Mailcode_Commands_Command $command, Mailcode_Parser_Safeguard $safeguard)
@@ -115,18 +115,18 @@ 
         return $this->command;
     }
     
-   /**
-    * Serializes the placeholder's information into 
-    * an array with the following keys:
-    * 
-    *   - originalText
-    *   - replacementText
-    *   - normalizedText
-    *   - length
-    *   - id
-    * 
-    * @return array<string,string|integer>
-    */
+    /**
+     * Serializes the placeholder's information into 
+     * an array with the following keys:
+     * 
+     *   - originalText
+     *   - replacementText
+     *   - normalizedText
+     *   - length
+     *   - id
+     * 
+     * @return array<string,string|integer>
+     */
     public function serialize() : array
     {
         return array(

src/Mailcode/Parser/Statement/Validator.php

Indentation +16 added lines, -16 removed lines

@@ -28,9 +28,9 @@ 
  */
 class Mailcode_Parser_Statement_Validator
 {
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     private $statement;
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -38,12 +38,12 @@ 
         $this->statement = $statement;
     }
     
-   /**
-    * Creates a variable validator: checks whether a single
-    * variable token is present in the parameters.
-    * 
-    * @return Mailcode_Parser_Statement_Validator_Type_Variable
-    */
+    /**
+     * Creates a variable validator: checks whether a single
+     * variable token is present in the parameters.
+     * 
+     * @return Mailcode_Parser_Statement_Validator_Type_Variable
+     */
     public function createVariable() : Mailcode_Parser_Statement_Validator_Type_Variable
     {
         $validate = new Mailcode_Parser_Statement_Validator_Type_Variable($this->statement);
@@ -51,13 +51,13 @@ 
         return $validate;
     }
     
-   /**
-    * Creates a keyword validator: checks whether a single
-    * keyword token is present in the parameters.
-    * 
-    * @param string $keywordName
-    * @return Mailcode_Parser_Statement_Validator_Type_Keyword
-    */
+    /**
+     * Creates a keyword validator: checks whether a single
+     * keyword token is present in the parameters.
+     * 
+     * @param string $keywordName
+     * @return Mailcode_Parser_Statement_Validator_Type_Keyword
+     */
     public function createKeyword(string $keywordName) : Mailcode_Parser_Statement_Validator_Type_Keyword
     {
         $validate = new Mailcode_Parser_Statement_Validator_Type_Keyword(

src/Mailcode/Parser/Statement/Validator/TokenType.php

Indentation +52 added lines, -52 removed lines

@@ -22,53 +22,53 @@ 
 {
     const VALIDATION_ERROR_COMMAND_WITHOUT_PARAMETERS = 62401;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $searchIndex = -1;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token|NULL
+     */
     protected $token;
     
-   /**
-    * Retrieves the class name of the token type to 
-    * limit the token search to. Only a token of this
-    * type will be stored.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the class name of the token type to 
+     * limit the token search to. Only a token of this
+     * type will be stored.
+     * 
+     * @return string
+     */
     abstract protected function getTokenClass() : string;
     
-   /**
-    * Allows the validator to apply custom search
-    * criteria to the tokens that are searched 
-    * through to find the target token.
-    * 
-    * NOTE: Should return true if there are no
-    * custom criteria to apply.
-    * 
-    * @param Mailcode_Parser_Statement_Tokenizer_Token $token
-    * @return bool
-    */
+    /**
+     * Allows the validator to apply custom search
+     * criteria to the tokens that are searched 
+     * through to find the target token.
+     * 
+     * NOTE: Should return true if there are no
+     * custom criteria to apply.
+     * 
+     * @param Mailcode_Parser_Statement_Tokenizer_Token $token
+     * @return bool
+     */
     abstract protected function _isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token) : bool;
     
-   /**
-    * @return Mailcode_Parser_Statement_Tokenizer_Token
-    */
+    /**
+     * @return Mailcode_Parser_Statement_Tokenizer_Token
+     */
     abstract public function getToken();
     
-   /**
-    * Checks if the specified token matches the current
-    * search criteria (index, type...). If the token is
-    * a match, the `_isMatch()` method is called to allow
-    * the validator class to apply some custom criteria. 
-    * 
-    * @param Mailcode_Parser_Statement_Tokenizer_Token $token
-    * @param int $index
-    * @return bool
-    */
+    /**
+     * Checks if the specified token matches the current
+     * search criteria (index, type...). If the token is
+     * a match, the `_isMatch()` method is called to allow
+     * the validator class to apply some custom criteria. 
+     * 
+     * @param Mailcode_Parser_Statement_Tokenizer_Token $token
+     * @param int $index
+     * @return bool
+     */
     protected function isMatch(Mailcode_Parser_Statement_Tokenizer_Token $token, int $index) : bool
     {
         // filter out tokens of other types
@@ -85,13 +85,13 @@ 
         return $this->_isMatch($token);
     }
     
-   /**
-    * Attempts to find a token in the statement
-    * that matches the current criteria, and the
-    * first one it finds is returned.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
-    */
+    /**
+     * Attempts to find a token in the statement
+     * that matches the current criteria, and the
+     * first one it finds is returned.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
+     */
     protected function findToken() : ?Mailcode_Parser_Statement_Tokenizer_Token
     {
         $tokens = $this->params->getTokens();
@@ -120,14 +120,14 @@ 
         return false;
     }
     
-   /**
-    * Searches for a specific token index.
-    * 
-    * NOTE: only relevant when trying to find a single token.
-    * 
-    * @param int $index
-    * @return $this
-    */
+    /**
+     * Searches for a specific token index.
+     * 
+     * NOTE: only relevant when trying to find a single token.
+     * 
+     * @param int $index
+     * @return $this
+     */
     public function setIndex(int $index) : Mailcode_Parser_Statement_Validator_TokenType
     {
         $this->searchIndex = $index;

src/Mailcode/Parser/Statement/Validator/Type.php

Indentation +12 added lines, -12 removed lines

@@ -20,9 +20,9 @@ 
  */
 abstract class Mailcode_Parser_Statement_Validator_Type
 {
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
     /**
@@ -30,14 +30,14 @@ 
      */
     protected $params;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $valid = true;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $validated = false;
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -53,9 +53,9 @@ 
         
     }
     
-   /**
-    * @return $this
-    */
+    /**
+     * @return $this
+     */
     public function validate() : Mailcode_Parser_Statement_Validator_Type
     {
         if(!$this->validated)

src/Mailcode/Parser/Statement/Validator/Type/Keyword.php

Indentation +4 added lines, -4 removed lines

@@ -22,10 +22,10 @@
 {
     const ERROR_NO_KEYWORD_TOKEN_FOUND = 62701;
     
-   /**
-    * The name of the keyword, with ":" appended.
-    * @var string
-    */
+    /**
+     * The name of the keyword, with ":" appended.
+     * @var string
+     */
     protected $keywordName;
     
     public function __construct(Mailcode_Parser_Statement $statement, string $keywordName)

src/Mailcode/Parser/Statement/Validator/Type/Operand.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 {
     const ERROR_NO_OPERAND_TOKEN_FOUND = 62901;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $sign = '';
     
     protected function getTokenClass() : string

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

Indentation +12 added lines, -12 removed lines

@@ -20,28 +20,28 @@
  */
 class Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral extends Mailcode_Parser_Statement_Tokenizer_Token implements Mailcode_Parser_Statement_Tokenizer_ValueInterface
 {
-   /**
-    * Retrieves the text with the surrounding quotes.
-    * @return string
-    */
+    /**
+     * Retrieves the text with the surrounding quotes.
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->restoreQuotes($this->matchedText);
     }
     
-   /**
-    * 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.
-    * @return string
-    */
+    /**
+     * Retrieves the text without the surrounding quotes.
+     * @return string
+     */
     public function getText() : string
     {
         $quoteless = trim($this->matchedText, '"\'');

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

Indentation +14 added lines, -14 removed lines

@@ -30,10 +30,10 @@ 
         return $this->getSign();
     }
     
-   /**
-    * Retrieves all known comparison operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known comparison operator signs.
+     * @return string[]
+     */
     public static function getComparisonSigns() : array
     {
         return array(
@@ -46,11 +46,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 
@@ -62,11 +62,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