Mistralys / mailcode

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,24 +38,24 @@ 
         $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
     {
         return new Mailcode_Parser_Statement_Validator_Type_Variable($this->statement);
     }
     
-   /**
-    * 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
     {
         return new Mailcode_Parser_Statement_Validator_Type_Keyword(

src/Mailcode/Traits/Commands/Validation/Multiline.php

Indentation +6 added lines, -6 removed lines

@@ -26,14 +26,14 @@
  */
 trait Mailcode_Traits_Commands_Validation_Multiline
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $multiline = false;
 
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     protected $multilineToken;
     
     protected function validateSyntax_multiline() : void

src/Mailcode/Commands/Command/ShowDate.php

Indentation +12 added lines, -12 removed lines

@@ -20,15 +20,15 @@ 
  */
 class Mailcode_Commands_Command_ShowDate extends Mailcode_Commands_ShowBase
 {
-   /**
-    * The date format string.
-    * @var string
-    */
+    /**
+     * The date format string.
+     * @var string
+     */
     private $formatString;
     
-   /**
-    * @var Mailcode_Date_FormatInfo
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo
+     */
     private $formatInfo;
 
     public function getName() : string
@@ -88,11 +88,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the format string used to format the date.
-    * 
-    * @return string A PHP compatible date format string.
-    */
+    /**
+     * Retrieves the format string used to format the date.
+     * 
+     * @return string A PHP compatible date format string.
+     */
     public function getFormatString() : string
     {
         return $this->formatString;

src/Mailcode/Collection/NestingValidator.php

Indentation +9 added lines, -9 removed lines

@@ -30,19 +30,19 @@
     public const VALIDATION_UNCLOSED_COMMAND = 49104;
     public const VALIDATION_CLOSING_NON_OPENING_COMMAND = 49105;
     
-   /**
-    * @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)

src/Mailcode/Parser/Safeguard/Formatting.php

Indentation +67 added lines, -67 removed lines

@@ -32,29 +32,29 @@ 
     public const ERROR_TOO_MANY_REPLACERS = 65902;
     public const ERROR_NO_FORMATTERS_ADDED = 65903;
     
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     private $safeguard;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter[]
+     */
     private $formatters = array();
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     private $subject;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $applied = false;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $partial = false;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject)
@@ -96,17 +96,17 @@ 
         return $formatter;
     }
     
-   /**
-    * Adds a formatter that will surround all variables with
-    * markup to highlight them independently of command syntax
-    * highlighting.
-    * 
-    * This is used to mark variables visually even after commands
-    * have been replaced by the target system's post processing.
-    * Can be combined with a replacer and other formats.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
-    */
+    /**
+     * Adds a formatter that will surround all variables with
+     * markup to highlight them independently of command syntax
+     * highlighting.
+     * 
+     * This is used to mark variables visually even after commands
+     * have been replaced by the target system's post processing.
+     * Can be combined with a replacer and other formats.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
+     */
     public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
     {
         $formatter = $this->createMarkVariables();
@@ -200,11 +200,11 @@ 
         }
     }
     
-   /**
-    * Counts the amount of replacer formatters that have been added.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of replacer formatters that have been added.
+     * 
+     * @return int
+     */
     private function countReplacers() : int
     {
         $count = 0;
@@ -220,37 +220,37 @@ 
         return $count;
     }
 
-   /**
-    * Creates a formatter that adds HTML syntax highlighting
-    * for all commands in the specified string, intelligently
-    * checking the location of the commands to ensure that they
-    * can be syntax highlighted.
-    * 
-    * For example, commands in HTML attributes will not be
-    * highlighted, as this would break the HTML.
-    *  
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
-    */
+    /**
+     * Creates a formatter that adds HTML syntax highlighting
+     * for all commands in the specified string, intelligently
+     * checking the location of the commands to ensure that they
+     * can be syntax highlighted.
+     * 
+     * For example, commands in HTML attributes will not be
+     * highlighted, as this would break the HTML.
+     *  
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
+     */
     public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this);
     }
 
-   /**
-    * Creates the formatter that ensures that all commands
-    * are placed on a separate line in the subject string.
-    */
+    /**
+     * Creates the formatter that ensures that all commands
+     * are placed on a separate line in the subject string.
+     */
     public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this);
     }
     
-   /**
-    * Creates the formatter that replaces all commands by
-    * their normalized variants.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
-    */
+    /**
+     * Creates the formatter that replaces all commands by
+     * their normalized variants.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
+     */
     public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this);
@@ -278,26 +278,26 @@ 
         return $this->subject->getString();
     }
 
-   /**
-    * Whether the formatting is done partially: missing placeholders
-    * will simply be ignored.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the formatting is done partially: missing placeholders
+     * will simply be ignored.
+     * 
+     * @return bool
+     */
     public function isPartial() : bool
     {
         return $this->partial;
     }
     
-   /**
-    * The formatting will ignore missing placeholders. Use this if the
-    * formatting will be done on a text that may not contain all of the
-    * initial placeholders anymore.
-    * 
-    * This is like the safeguard's makeWholePartial() method.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * The formatting will ignore missing placeholders. Use this if the
+     * formatting will be done on a text that may not contain all of the
+     * initial placeholders anymore.
+     * 
+     * This is like the safeguard's makeWholePartial() method.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function makePartial() : Mailcode_Parser_Safeguard_Formatting
     {
         $this->partial = true;

src/Mailcode/Parser/Safeguard/Formatter/Type/HTMLHighlighting/Location.php

Indentation +36 added lines, -36 removed lines

@@ -24,14 +24,14 @@ 
 {
     public const COMMAND_MARKER = '__MAILCODE_COMMAND__';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $ancestryChecked = false;
     
-   /**
-    * @var array<int,array<int,string>>
-    */
+    /**
+     * @var array<int,array<int,string>>
+     */
     private $tagAncestry = array();
     
     protected function init() : void
@@ -43,12 +43,12 @@ 
         return !$this->isInTagAttributes() && !$this->isInExcludedTag();
     }
     
-   /**
-    * Retrieves the part of the subject string that comes
-    * before the command.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the part of the subject string that comes
+     * before the command.
+     * 
+     * @return string
+     */
     private function getHaystackBefore() : string
     {
         $pos = $this->getStartPosition();
@@ -65,12 +65,12 @@ 
         return $this->subject->getSubstr(0, $pos).self::COMMAND_MARKER.'>';
     }
     
-   /**
-    * Whether the command is nested in one of the tags
-    * that have been added to the list of excluded tags.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the command is nested in one of the tags
+     * that have been added to the list of excluded tags.
+     * 
+     * @return bool
+     */
     protected function isInExcludedTag() : bool
     {
         $tagNames = $this->getParentTags();
@@ -86,12 +86,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of the command's parent HTML tags, from
-    * highest to lowest.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of the command's parent HTML tags, from
+     * highest to lowest.
+     * 
+     * @return string[]
+     */
     private function getParentTags() : array
     {
         $tags = $this->getTagAncestry();
@@ -116,12 +116,12 @@ 
         return $stack;
     }
     
-   /**
-    * Checks whether the command is located within the attributes
-    * of an HTML tag.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether the command is located within the attributes
+     * of an HTML tag.
+     * 
+     * @return bool
+     */
     protected function isInTagAttributes() : bool
     {
         $tags = $this->getTagAncestry();
@@ -139,12 +139,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of tag names that come as parents 
-    * above the command.
-    * 
-    * @return array<int,array<int,string>>
-    */
+    /**
+     * Retrieves a list of tag names that come as parents 
+     * above the command.
+     * 
+     * @return array<int,array<int,string>>
+     */
     private function getTagAncestry() : array
     {
         if($this->ancestryChecked)

src/Mailcode/Parser/Safeguard/Placeholder.php

Indentation +24 added lines, -24 removed lines

@@ -25,24 +25,24 @@ 
 {
     public 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)
@@ -104,18 +104,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/TokenType.php

Indentation +52 added lines, -52 removed lines

@@ -22,53 +22,53 @@ 
 {
     public 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/Operand.php

Indentation +3 added lines, -3 removed lines

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