Mistralys / mailcode

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

src/Mailcode/Commands/LogicKeywords/Keyword.php

Indentation +51 added lines, -51 removed lines

@@ -29,39 +29,39 @@ 
     public const VALIDATION_NO_COMMAND_CREATED = 61101;
     public const VALIDATION_INVALID_COMMAND_CREATED = 61102;
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords
+     */
     private $keywords;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $keywordType;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $matchedString;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $params = '';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $paramsSet = false;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     private $collection;
     
     public function __construct(Mailcode_Commands_LogicKeywords $keywords, string $name, string $matchedString, string $type)
@@ -72,10 +72,10 @@ 
         $this->matchedString = $matchedString;
     }
     
-   /**
-    * The keyword name, e.g. "and". Always lowercase.
-    * @return string
-    */
+    /**
+     * The keyword name, e.g. "and". Always lowercase.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
@@ -98,24 +98,24 @@ 
         return $string;
     }
     
-   /**
-    * The full string that was matched in the command's parameters
-    * string. Examples: "and:", "and variable:"...
-    * 
-    * @return string
-    */
+    /**
+     * The full string that was matched in the command's parameters
+     * string. Examples: "and:", "and variable:"...
+     * 
+     * @return string
+     */
     public function getMatchedString() : string
     {
         return $this->matchedString;
     }
     
-   /**
-    * Sets the parameters string matching this logic keyword,
-    * which is used to build the actual sub-command. Set by
-    * the LogicKeywords class instance.
-    * 
-    * @param string $params
-    */
+    /**
+     * Sets the parameters string matching this logic keyword,
+     * which is used to build the actual sub-command. Set by
+     * the LogicKeywords class instance.
+     * 
+     * @param string $params
+     */
     public function setParamsString(string $params) : void
     {
         if($this->paramsSet)
@@ -133,13 +133,13 @@ 
         $this->createCommand();
     }
     
-   /**
-    * Retrieves the full command string used to create 
-    * the actual command. For opening commands like IF,
-    * this includes the closing {end} command.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the full command string used to create 
+     * the actual command. For opening commands like IF,
+     * this includes the closing {end} command.
+     * 
+     * @return string
+     */
     public function getCommandString() : string
     {
         $string = sprintf(
@@ -182,12 +182,12 @@ 
         }
     }
     
-   /**
-    * Retrieves the command for the keyword.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Retrieves the command for the keyword.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Commands_Command
+     */
     public function getCommand() : Mailcode_Commands_Command
     {
         $command = $this->collection->getFirstCommand();

src/Mailcode/Commands/Command.php

Indentation +46 added lines, -46 removed lines

@@ -43,44 +43,44 @@ 
 
     public const META_URL_ENCODING = 'url_encoding';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $paramsString = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash = '';
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult = null;
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $params;
 
-   /**
-    * @var string[] 
-    */
+    /**
+     * @var string[] 
+     */
     protected $validations = array(
         Mailcode_Interfaces_Commands_Validation_EmptyParams::VALIDATION_NAME_EMPTY_PARAMS,
         Mailcode_Interfaces_Commands_Validation_ParamKeywords::VALIDATION_NAME_KEYWORDS,
@@ -89,24 +89,24 @@ 
         Mailcode_Interfaces_Commands_Validation_TypeUnsupported::VALIDATION_NAME_TYPE_UNSUPPORTED
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords|NULL
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords|NULL
+     */
     protected $logicKeywords;
     
-   /**
-    * @var Mailcode_Parser_Statement_Validator
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Validator
+     */
     protected $validator;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $validated = false;
 
     /**
@@ -141,13 +141,13 @@ 
         
     }
 
-   /**
-    * Sets the command's parent opening command, if any.
-    * NOTE: This is set automatically by the parser, and
-    * should not be called manually.
-    *
-    * @param Mailcode_Commands_Command $command
-    */
+    /**
+     * Sets the command's parent opening command, if any.
+     * NOTE: This is set automatically by the parser, and
+     * should not be called manually.
+     *
+     * @param Mailcode_Commands_Command $command
+     */
     public function setParent(Mailcode_Commands_Command $command) : void
     {
         $this->parent = $command;
@@ -289,9 +289,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
 
     protected function _validateNesting() : void

src/Mailcode/Commands/Command/ShowNumber.php

Indentation +22 added lines, -22 removed lines

@@ -31,10 +31,10 @@ 
     public const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209;
     public const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210;
     
-   /**
-    * The default number format string.
-    * @var string
-    */
+    /**
+     * The default number format string.
+     * @var string
+     */
     private $formatString = Mailcode_Number_Info::DEFAULT_FORMAT;
 
     /**
@@ -65,16 +65,16 @@ 
 
     protected function validateSyntax_check_format() : void
     {
-         $tokens = $this->params->getInfo()->getStringLiterals();
+            $tokens = $this->params->getInfo()->getStringLiterals();
          
-         // no format specified? Use the default one.
-         if(empty($tokens))
-         {
-             return;
-         }
-
-         $token = array_pop($tokens);
-         $this->parseFormatString($token->getText());
+            // no format specified? Use the default one.
+            if(empty($tokens))
+            {
+                return;
+            }
+
+            $token = array_pop($tokens);
+            $this->parseFormatString($token->getText());
     }
 
     protected function validateSyntax_absolute() : void
@@ -107,11 +107,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the format string used to format the number.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the format string used to format the number.
+     * 
+     * @return string
+     */
     public function getFormatString() : string
     {
         return $this->formatString;
@@ -132,11 +132,11 @@ 
 
         if($absolute === true && !isset($this->absoluteKeyword))
         {
-             $this->params
-                 ->getInfo()
-                 ->addKeyword(Mailcode_Commands_Keywords::TYPE_ABSOLUTE);
+                $this->params
+                    ->getInfo()
+                    ->addKeyword(Mailcode_Commands_Keywords::TYPE_ABSOLUTE);
 
-             $this->validateSyntax_absolute();
+                $this->validateSyntax_absolute();
         }
 
         return $this;