Mistralys / mailcode

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

Indentation +44 added lines, -44 removed lines

@@ -24,34 +24,34 @@ 
 {
     public const ERROR_PLACEHOLDER_NOT_FOUND = 66001;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $append = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $prepend = '';
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     protected $placeholder;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder $placeholder)
@@ -67,22 +67,22 @@ 
     
     abstract public function requiresAdjustment() : bool;
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getStartPosition()
     {
         return $this->subject->getSubstrPosition($this->placeholder->getReplacementText());
     }
     
-   /**
-    * Checks whether the specified position within the string
-    * is within another command's placeholder (excluding this
-    * location's placeholder).
-    * 
-    * @param int $position
-    * @return bool
-    */
+    /**
+     * Checks whether the specified position within the string
+     * is within another command's placeholder (excluding this
+     * location's placeholder).
+     * 
+     * @param int $position
+     * @return bool
+     */
     public function isWithinCommand(int $position) : bool
     {
         $placeholders = $this->formatter->getSafeguard()->getPlaceholders();
@@ -114,9 +114,9 @@ 
         return false;
     }
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getEndPosition()
     {
         $start = $this->getStartPosition();
@@ -139,14 +139,14 @@ 
         return $this->placeholder;
     }
     
-   /**
-    * Replaces the placeholder with the specified replacement text.
-    * 
-    * @param string $replacementText
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
-    */
+    /**
+     * Replaces the placeholder with the specified replacement text.
+     * 
+     * @param string $replacementText
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
+     */
     public function replaceWith(string $replacementText) : void
     {
         $needle = $this->placeholder->getReplacementText();
@@ -196,10 +196,10 @@ 
         );
     }
     
-   /**
-    * Retrieves the location's log messages, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the location's log messages, if any.
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

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

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

Indentation +4 added lines, -4 removed lines

@@ -22,10 +22,10 @@
 {
     public 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/Date/FormatInfo/Character.php

Indentation +34 added lines, -34 removed lines

@@ -23,19 +23,19 @@ 
 {
     public const ERROR_UNHANDLED_CHARTYPE = 55601;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $description;
     
     public function __construct(string $type, string $char, string $description)
@@ -45,46 +45,46 @@ 
         $this->description = $description;
     }
     
-   /**
-    * Retrieves the format character (PHP date format).
-    * 
-    * @return string 
-    */
+    /**
+     * Retrieves the format character (PHP date format).
+     * 
+     * @return string 
+     */
     public function getChar() : string
     {
         return $this->char;
     }
     
-   /**
-    * Retrieves a human readable description of the character's role.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a human readable description of the character's role.
+     * 
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * Retrieves the character type ID.
-    * 
-    * @return string
-    * 
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION
-    */
+    /**
+     * Retrieves the character type ID.
+     * 
+     * @return string
+     * 
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION
+     */
     public function getTypeID() : string
     {
         return $this->type;
     }
     
-   /**
-    * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation".
-    * 
-    * @throws Mailcode_Exception If the character type is unknown.
-    * @return string
-    */
+    /**
+     * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation".
+     * 
+     * @throws Mailcode_Exception If the character type is unknown.
+     * @return string
+     */
     public function getTypeLabel() : string
     {
         switch($this->type)

src/Mailcode/Date/FormatInfo.php

Indentation +39 added lines, -39 removed lines

@@ -31,24 +31,24 @@ 
     public const CHARTYPE_TIME = 'time';
     public const CHARTYPE_PUNCTUATION = 'punctuation';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $defaultFormat = "Y/m/d";
     
-   /**
-    * @var Mailcode_Date_FormatInfo_Character[]
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo_Character[]
+     */
     private $formatChars = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     private $allowedChars = array();
     
-   /**
-    * @var Mailcode_Date_FormatInfo|NULL
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo|NULL
+     */
     private static $instance;
     
     private function __construct()
@@ -66,11 +66,11 @@ 
         return self::$instance;
     }
 
-   /**
-    * Initialized the list of allowed date formatting
-    * characters. This is done only once per request
-    * by storing them statically for performance reasons.
-    */
+    /**
+     * Initialized the list of allowed date formatting
+     * characters. This is done only once per request
+     * by storing them statically for performance reasons.
+     */
     private function initCharacters() : void
     {
         $chars = array(
@@ -115,16 +115,16 @@ 
         $this->defaultFormat = $formatString;
     }
     
-   /**
-    * Validates the date format string, by ensuring that
-    * all the characters it is composed of are known.
-    *
-    * @param string $formatString
-    * @return OperationResult
-    * 
-    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
-    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
-    */
+    /**
+     * Validates the date format string, by ensuring that
+     * all the characters it is composed of are known.
+     *
+     * @param string $formatString
+     * @return OperationResult
+     * 
+     * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
+     * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
+     */
     public function validateFormat(string $formatString) : OperationResult
     {
         $result = new OperationResult($this);
@@ -163,23 +163,23 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all characters that are allowed to
-    * be used in a date format string, with information
-    * on each.
-    *
-    * @return Mailcode_Date_FormatInfo_Character[]
-    */
+    /**
+     * Retrieves all characters that are allowed to
+     * be used in a date format string, with information
+     * on each.
+     *
+     * @return Mailcode_Date_FormatInfo_Character[]
+     */
     public function getCharactersList() : array
     {
         return $this->formatChars;
     }
     
-   /**
-    * Retrieves the characters list, grouped by type label.
-    * 
-    * @return array<string, array>
-    */
+    /**
+     * Retrieves the characters list, grouped by type label.
+     * 
+     * @return array<string, array>
+     */
     public function getCharactersGrouped() : array
     {
         $grouped = array();

src/Mailcode/Commands/LogicKeywords.php

Indentation +45 added lines, -45 removed lines

@@ -31,27 +31,27 @@ 
     public const VALIDATION_CANNOT_MIX_LOGIC_KEYWORDS = 60701;
     public const VALIDATION_INVALID_SUB_COMMAND = 60702;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $paramsString;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     private $names = array(
         'and', 
         'or'
     );
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     private $keywords = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $mainParams = '';
     
     public function __construct(Mailcode_Commands_Command $command, string $paramsString)
@@ -137,9 +137,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     private function detectParameters() : array
     {
         $params = $this->paramsString;
@@ -157,13 +157,13 @@ 
         return $stack;
     }
 
-   /**
-    * @param string $params
-    * @param Mailcode_Commands_LogicKeywords_Keyword $keyword
-    * @param string[] $stack
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * @param string $params
+     * @param Mailcode_Commands_LogicKeywords_Keyword $keyword
+     * @param string[] $stack
+     * @throws Mailcode_Exception
+     * @return string
+     */
     private function detectParamsKeyword(string $params, Mailcode_Commands_LogicKeywords_Keyword $keyword, array &$stack) : string
     {
         $search = $keyword->getMatchedString();
@@ -188,22 +188,22 @@ 
         return $params;
     }
     
-   /**
-    * Extracts the parameters string to use for the 
-    * original command itself, omitting all the logic
-    * keywords for the sub-commands.
-    * 
-    * @return string
-    */
+    /**
+     * Extracts the parameters string to use for the 
+     * original command itself, omitting all the logic
+     * keywords for the sub-commands.
+     * 
+     * @return string
+     */
     public function getMainParamsString() : string
     {
         return $this->mainParams;
     }
     
-   /**
-    * Retrieves the detected keyword names.
-    * @return string[]
-    */
+    /**
+     * Retrieves the detected keyword names.
+     * @return string[]
+     */
     public function getDetectedNames() : array
     {
         $names = array();
@@ -221,23 +221,23 @@ 
         return $names;
     }
     
-   /**
-    * Retrieves all keywords that were detected in the
-    * command's parameters string, if any.
-    * 
-    * @return Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * Retrieves all keywords that were detected in the
+     * command's parameters string, if any.
+     * 
+     * @return Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     public function getKeywords() : array
     {
         return $this->keywords;
     }
     
-   /**
-    * Detects any keyword statements in the parameters by keyword name.
-    * 
-    * @param string $name
-    * @return Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * Detects any keyword statements in the parameters by keyword name.
+     * 
+     * @param string $name
+     * @return Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     private function detectKeywords(string $name) : array
     {
         $regex = sprintf('/%1$s\s+([a-z\-0-9]+):|%1$s:/x', $name);