Mistralys / mailcode

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/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/StringContainer.php

Indentation +66 added lines, -66 removed lines

@@ -26,39 +26,39 @@ 
     public const ERROR_INVALID_CALLABLE = 65701;
     public const ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION = 65702;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $listenerCounter = 0;
     
-   /**
-    * @var callable[]
-    */
+    /**
+     * @var callable[]
+     */
     private $listeners = array();
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $updating = false;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $idCounter = 0;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $id;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $length;
     
     public function __construct(string $subject)
@@ -75,16 +75,16 @@ 
         return $this->id;
     }
     
-   /**
-    * Updates the string with the specified string.
-    * Notifies all listeners of the change.
-    * 
-    * @param string $subject
-    * @throws Mailcode_Exception
-    * @return bool Whether the string had modifications.
-    * 
-    * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
-    */
+    /**
+     * Updates the string with the specified string.
+     * Notifies all listeners of the change.
+     * 
+     * @param string $subject
+     * @throws Mailcode_Exception
+     * @return bool Whether the string had modifications.
+     * 
+     * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
+     */
     public function updateString(string $subject) : bool
     {
         // avoid triggering an update if there are no changes in the string
@@ -117,27 +117,27 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the stored string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the stored string.
+     * 
+     * @return string
+     */
     public function getString() : string
     {
         return $this->subject;
     }
     
-   /**
-    * Adds a listener that will be informed every time the string is modified.
-    * The callback gets the string container instance as parameter.
-    * 
-    * @param callable $callback
-    * @throws Mailcode_Exception If it is not a valid callable.
-    * @return int The listener number, to be able to remove it using `removeListener()`.
-    * 
-    * @see Mailcode_StringContainer::removeListener()
-    * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
-    */
+    /**
+     * Adds a listener that will be informed every time the string is modified.
+     * The callback gets the string container instance as parameter.
+     * 
+     * @param callable $callback
+     * @throws Mailcode_Exception If it is not a valid callable.
+     * @return int The listener number, to be able to remove it using `removeListener()`.
+     * 
+     * @see Mailcode_StringContainer::removeListener()
+     * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
+     */
     public function addListener($callback) : int
     {
         self::$listenerCounter++;
@@ -164,12 +164,12 @@ 
         return $this->length;
     }
     
-   /**
-    * Removes an existing listener by its ID.
-    * Has no effect if it does not exist, or has already been removed.
-    * 
-    * @param int $listenerID
-    */
+    /**
+     * Removes an existing listener by its ID.
+     * Has no effect if it does not exist, or has already been removed.
+     * 
+     * @param int $listenerID
+     */
     public function removeListener(int $listenerID) : void
     {
         if(isset($this->listeners[$listenerID]))
@@ -178,13 +178,13 @@ 
         }
     }
     
-   /**
-    * Replaces all substrings matching needle with the replacement text.
-    *  
-    * @param string $needle
-    * @param string $replacement
-    * @return bool
-    */
+    /**
+     * Replaces all substrings matching needle with the replacement text.
+     *  
+     * @param string $needle
+     * @param string $replacement
+     * @return bool
+     */
     public function replaceSubstrings(string $needle, string $replacement) : bool
     {
         $string = str_replace($needle, $replacement, $this->subject);
@@ -192,12 +192,12 @@ 
         return $this->updateString($string);
     }
 
-   /**
-    * Get the position of a substring in the string.
-    * 
-    * @param string $needle
-    * @return int|bool The zero-based position, or false if not found.
-    */
+    /**
+     * Get the position of a substring in the string.
+     * 
+     * @param string $needle
+     * @return int|bool The zero-based position, or false if not found.
+     */
     public function getSubstrPosition(string $needle)
     {
         return mb_strpos($this->subject, $needle);

src/Mailcode/Variables/Collection/Regular.php

Indentation +17 added lines, -17 removed lines

@@ -20,9 +20,9 @@ 
  */
 class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Invalid
+     */
     protected Mailcode_Variables_Collection_Invalid $invalid;
 
     protected function init() : void
@@ -47,30 +47,30 @@ 
         return $this;
     }
 
-   /**
-    * Whether any of the variables in the collection are invalid.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether any of the variables in the collection are invalid.
+     * 
+     * @return bool
+     */
     public function hasInvalid() : bool
     {
         return $this->invalid->hasVariables();
     }
     
-   /**
-    * Retrieves the collection of invalid variables, if any.
-    * Behaves like a variables collection.
-    * 
-    * @return Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * Retrieves the collection of invalid variables, if any.
+     * Behaves like a variables collection.
+     * 
+     * @return Mailcode_Variables_Collection_Invalid
+     */
     public function getInvalid() : Mailcode_Variables_Collection_Invalid
     {
         return $this->invalid;
     }
     
-   /**
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         parent::mergeWith($collection);