Mistralys / mailcode

src/Mailcode/Parser/Match.php

Indentation +12 added lines, -12 removed lines

@@ -21,24 +21,24 @@
  */
 class Mailcode_Parser_Match
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $params;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedString;
     
     public function __construct(string $name, string $type, string $params, string $matchedString)

src/Mailcode/Parser/Statement/Info.php

Indentation +21 added lines, -21 removed lines

@@ -21,14 +21,14 @@ 
  */
 class Mailcode_Parser_Statement_Info
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokens = array();
     
     public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer)
@@ -37,11 +37,11 @@ 
         $this->tokens = $this->tokenizer->getTokens(); 
     }
     
-   /**
-    * Whether the whole statement is a variable being assigned a value.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being assigned a value.
+     * 
+     * @return bool
+     */
     public function isVariableAssignment() : bool
     {
         $variable = $this->getVariableByIndex(0);
@@ -56,11 +56,11 @@ 
         return false;
     }
     
-   /**
-    * Whether the whole statement is a variable being compared to something.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being compared to something.
+     * 
+     * @return bool
+     */
     public function isVariableComparison() : bool
     {
         $variable = $this->getVariableByIndex(0);
@@ -75,11 +75,11 @@ 
         return false;
     }
     
-   /**
-    * Retrieves all variables used in the statement.
-    * 
-    * @return \Mailcode\Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables used in the statement.
+     * 
+     * @return \Mailcode\Mailcode_Variables_Variable[]
+     */
     public function getVariables()
     {
         $result = array();

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

Indentation +10 added lines, -10 removed lines

@@ -30,11 +30,11 @@ 
         return $this->getOperand();
     }
     
-   /**
-    * 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 
@@ -46,11 +46,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 

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

Indentation +14 added lines, -14 removed lines

@@ -20,26 +20,26 @@
  */
 abstract class Mailcode_Parser_Statement_Tokenizer_Token
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenID;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $subject;
     
-   /**
-    * @param string $tokenID
-    * @param string $matchedText
-    * @param mixed $subject
-    */
+    /**
+     * @param string $tokenID
+     * @param string $matchedText
+     * @param mixed $subject
+     */
     public function __construct(string $tokenID, string $matchedText, $subject=null)
     {
         $this->tokenID = $tokenID;

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +51 added lines, -51 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_TOKENIZE_METHOD_MISSING = 49801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $operands = array(
         '==',
         '<=',
@@ -40,16 +40,16 @@ 
         '<'
     );
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $keywords = array(
         'in:'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '§§';
     
     /**
@@ -65,19 +65,19 @@ 
         'extract_tokens'
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenized;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokensTemporary = array();
     
     /**
@@ -85,9 +85,9 @@ 
      */
     protected $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $ids = array();
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -97,12 +97,12 @@ 
         $this->tokenize($statement->getStatementString());
     }
 
-   /**
-    * Retrieves all tokens detected in the statement string, in 
-    * the order they were found.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens detected in the statement string, in 
+     * the order they were found.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens()
     {
         return $this->tokensOrdered;
@@ -113,11 +113,11 @@ 
         return !empty($this->tokensOrdered);
     }
     
-   /**
-    * Whether there were any unknown tokens in the statement.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there were any unknown tokens in the statement.
+     * 
+     * @return bool
+     */
     public function hasUnknown() : bool
     {
         $unknown = $this->getUnknown();
@@ -125,11 +125,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown()
     {
         $result = array();
@@ -199,13 +199,13 @@ 
         }
     }
    
-   /**
-    * Registers a token to add in the statement string.
-    * 
-    * @param string $type
-    * @param string $matchedText
-    * @param mixed $subject
-    */
+    /**
+     * Registers a token to add in the statement string.
+     * 
+     * @param string $type
+     * @param string $matchedText
+     * @param mixed $subject
+     */
     protected function registerToken(string $type, string $matchedText, $subject=null) : void
     {
         $tokenID = $this->generateID();
@@ -317,13 +317,13 @@ 
         }
     }
     
-   /**
-    * Generates a unique alphabet-based ID without numbers
-    * to use as token name, to avoid conflicts with the
-    * numbers detection.
-    * 
-    * @return string
-    */
+    /**
+     * Generates a unique alphabet-based ID without numbers
+     * to use as token name, to avoid conflicts with the
+     * numbers detection.
+     * 
+     * @return string
+     */
     protected function generateID() : string
     {
         static $alphas;

src/Mailcode/Parser/Statement.php

Indentation +13 added lines, -13 removed lines

@@ -29,24 +29,24 @@ 
     
     const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer|NULL
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected $info;
     
     public function __construct(string $statement)
@@ -102,7 +102,7 @@ 
         if($unknown)
         {
             $this->result->makeError(
-               t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')',
+                t('Unquoted string literal found:').' ('.$unknown->getMatchedText().')',
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
             );
         }

src/Mailcode/Factory/Exception.php

Indentation +15 added lines, -15 removed lines

@@ -20,18 +20,18 @@ 
  */
 class Mailcode_Factory_Exception extends Mailcode_Exception
 {
-   /**
-    * @var Mailcode_Commands_Command|NULL
-    */
+    /**
+     * @var Mailcode_Commands_Command|NULL
+     */
     protected $command;
     
-   /**
-    * @param string $message
-    * @param string|NULL $details
-    * @param int|NULL $code
-    * @param \Exception|NULL $previous
-    * @param Mailcode_Commands_Command|NULL $command
-    */
+    /**
+     * @param string $message
+     * @param string|NULL $details
+     * @param int|NULL $code
+     * @param \Exception|NULL $previous
+     * @param Mailcode_Commands_Command|NULL $command
+     */
     public function __construct(string $message, $details=null, $code=null, $previous=null, Mailcode_Commands_Command $command=null)
     {
         parent::__construct($message, $details, $code, $previous);
@@ -39,11 +39,11 @@ 
         $this->command = $command;
     }
     
-   /**
-    * Retrieves the erroneous command, if any.
-    * 
-    * @return Mailcode_Commands_Command|NULL
-    */
+    /**
+     * Retrieves the erroneous command, if any.
+     * 
+     * @return Mailcode_Commands_Command|NULL
+     */
     public function getCommand() : ?Mailcode_Commands_Command
     {
         return $this->command;

src/Mailcode/Factory.php

Indentation +46 added lines, -46 removed lines

@@ -24,17 +24,17 @@ 
     
     const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
     
-   /**
-    * @var Mailcode_Renderer
-    */
+    /**
+     * @var Mailcode_Renderer
+     */
     protected static $renderer;
     
-   /**
-    * Creates a ShowVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowVariable
-    */
+    /**
+     * Creates a ShowVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowVariable
+     */
     public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -50,17 +50,17 @@ 
         return $cmd;
     }
     
-   /**
-    * Creates a SetVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @param string $value
-    * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
-    * @return Mailcode_Commands_Command_SetVariable
-    * @throws Mailcode_Factory_Exception
-    * 
-    * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
-    */
+    /**
+     * Creates a SetVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @param string $value
+     * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
+     * @return Mailcode_Commands_Command_SetVariable
+     * @throws Mailcode_Factory_Exception
+     * 
+     * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
+     */
     public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -83,14 +83,14 @@ 
         return $cmd;
     }
     
-   /**
-    * Like setVar(), but treats the value as a string literal
-    * and automatically adds quotes to it.
-    * 
-    * @param string $variableName
-    * @param string $value
-    * @return Mailcode_Commands_Command_SetVariable
-    */
+    /**
+     * Like setVar(), but treats the value as a string literal
+     * and automatically adds quotes to it.
+     * 
+     * @param string $variableName
+     * @param string $value
+     * @return Mailcode_Commands_Command_SetVariable
+     */
     public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
     {
         return self::setVar($variableName, $value, true);
@@ -355,12 +355,12 @@ 
         return '$'.ltrim($name, '$');
     }
     
-   /**
-    * Quotes a string literal: adds the quotes, and escapes any quotes already present in it.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Quotes a string literal: adds the quotes, and escapes any quotes already present in it.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected static function _quoteString(string $string) : string
     {
         return '"'.str_replace('"', '\"', $string).'"';
@@ -393,23 +393,23 @@ 
         );
     }
     
-   /**
-    * Creates a renderer instance, which can be used to easily
-    * create and convert commands to strings.
-    * 
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Creates a renderer instance, which can be used to easily
+     * create and convert commands to strings.
+     * 
+     * @return Mailcode_Renderer
+     */
     public static function createRenderer() : Mailcode_Renderer
     {
         return new Mailcode_Renderer();
     }
     
-   /**
-    * Creates a printer instance, which works like the renderer,
-    * but outputs the generated strings to standard output.
-    * 
-    * @return Mailcode_Printer
-    */
+    /**
+     * Creates a printer instance, which works like the renderer,
+     * but outputs the generated strings to standard output.
+     * 
+     * @return Mailcode_Printer
+     */
     public static function createPrinter() : Mailcode_Printer
     {
         return new Mailcode_Printer();

src/Mailcode/Commands/Command.php

Indentation +70 added lines, -70 removed lines

@@ -30,53 +30,53 @@ 
     const VALIDATION_UNKNOWN_COMMAND_NAME = 48304;
     const VALIDATION_INVALID_PARAMS_STATEMENT = 48305;
 
-   /**
-    * @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 \AppUtils\OperationResult
-    */
+    /**
+     * @var \AppUtils\OperationResult
+     */
     protected $validationResult = null;
     
-   /**
-    * @var \Mailcode\Mailcode
-    */
+    /**
+     * @var \Mailcode\Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var \Mailcode\Mailcode_Parser_Statement
-    */
+    /**
+     * @var \Mailcode\Mailcode_Parser_Statement
+     */
     protected $params;
 
-   /**
-    * @var string[] 
-    */
+    /**
+     * @var string[] 
+     */
     protected $validations = array(
         'params',
         'type_supported',
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
@@ -94,23 +94,23 @@ 
         
     }
     
-   /**
-    * @return string The ID of the command = the name of the command class file.
-    */
+    /**
+     * @return string The ID of the command = the name of the command class file.
+     */
     public function getID() : string
     {
         $tokens = explode('_', get_class($this));
         return array_pop($tokens);
     }
     
-   /**
-    * Sets an optional comment that is not used anywhere, but
-    * can be used by the application to track why a command is
-    * used somewhere. 
-    * 
-    * @param string $comment
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Sets an optional comment that is not used anywhere, but
+     * can be used by the application to track why a command is
+     * used somewhere. 
+     * 
+     * @param string $comment
+     * @return Mailcode_Commands_Command
+     */
     public function setComment(string $comment) : Mailcode_Commands_Command
     {
         $this->comment = $comment;
@@ -118,34 +118,34 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the previously set comment, if any.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the previously set comment, if any.
+     * 
+     * @return string
+     */
     public function getComment() : string
     {
         return $this->comment;
     }
     
-   /**
-    * Checks whether this is a dummy command, which is only
-    * used to access information on the command type. It cannot
-    * be used as an actual live command.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether this is a dummy command, which is only
+     * used to access information on the command type. It cannot
+     * be used as an actual live command.
+     * 
+     * @return bool
+     */
     public function isDummy() : bool
     {
         return $this->type === '__dummy';
     }
     
-   /**
-    * Retrieves a hash of the actual matched command string,
-    * which is used in collections to detect duplicate commands.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a hash of the actual matched command string,
+     * which is used in collections to detect duplicate commands.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         $this->requireNonDummy();
@@ -237,9 +237,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params() : void
@@ -394,22 +394,22 @@ 
         return implode('', $parts);
     }
     
-   /**
-    * Retrieves the names of all the command's supported types: the part
-    * between the command name and the colon. Example: {command type: params}.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all the command's supported types: the part
+     * between the command name and the colon. Example: {command type: params}.
+     * 
+     * @return string[]
+     */
     public function getSupportedTypes() : array
     {
         return array();
     }
     
-   /**
-    * Retrieves all variable names used in the command.
-    * 
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Retrieves all variable names used in the command.
+     * 
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function getVariables() : Mailcode_Variables_Collection_Regular
     {
         return Mailcode::create()->findVariables($this->paramsString);