Mistralys / mailcode

src/Mailcode/Commands.php

Indentation +36 added lines, -36 removed lines

@@ -23,16 +23,16 @@ 
 {
     const ERROR_COMMAND_NAME_DOES_NOT_EXIST = 45901;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     private $commands = array();
     
-   /**
-    * Retrieves a list of all available command IDs.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all available command IDs.
+     * 
+     * @return string[]
+     */
     public function getIDs() : array
     {
         static $ids = array();
@@ -45,13 +45,13 @@ 
         return $ids;
     }
     
-   /**
-    * Retrieves a list of all available commands, sorted by label.
-    * 
-    * NOTE: These instances are only used for information purposes.
-    * 
-    * @return Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves a list of all available commands, sorted by label.
+     * 
+     * NOTE: These instances are only used for information purposes.
+     * 
+     * @return Mailcode_Commands_Command[]
+     */
     public function getAll()
     {
         if(!empty($this->commands)) {
@@ -77,12 +77,12 @@ 
         return $result;
     }
     
-   /**
-    * Gets an available command by its ID.
-    * 
-    * @param string $id
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Gets an available command by its ID.
+     * 
+     * @param string $id
+     * @return Mailcode_Commands_Command
+     */
     public function getByID(string $id) : Mailcode_Commands_Command
     {
         static $instances = array();
@@ -95,15 +95,15 @@ 
         return $instances[$id];
     }
     
-   /**
-    * Retrieves the ID of a command by its name.
-    * 
-    * @param string $name
-    * @throws Mailcode_Exception
-    * @return string
-    * 
-    * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
-    */
+    /**
+     * Retrieves the ID of a command by its name.
+     * 
+     * @param string $name
+     * @throws Mailcode_Exception
+     * @return string
+     * 
+     * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
+     */
     public function getIDByName(string $name) : string
     {
         $items = $this->getAll();
@@ -132,12 +132,12 @@ 
         return in_array($id, $ids);
     }
     
-   /**
-    * Checks wether the specified name exists.
-    * 
-    * @param string $name For example: "showvar".
-    * @return bool
-    */
+    /**
+     * Checks wether the specified name exists.
+     * 
+     * @param string $name For example: "showvar".
+     * @return bool
+     */
     public function nameExists(string $name) : bool
     {
         $items = $this->getAll();

src/Mailcode/Parser/Safeguard/Placeholder.php

Indentation +12 added lines, -12 removed lines

@@ -25,24 +25,24 @@
 {
     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)

src/Mailcode.php

Indentation +36 added lines, -36 removed lines

@@ -26,46 +26,46 @@ 
  */
 class Mailcode
 {
-   /**
-    * @var Mailcode_Parser|NULL
-    */
+    /**
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
     }
     
-   /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+    /**
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()->parseString($string);
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -76,12 +76,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -97,12 +97,12 @@ 
         return $this->getParser()->createSafeguard($subject);
     }
     
-   /**
-    * Attempts to find all variables in the target string.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Attempts to find all variables in the target string.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject);

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 $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 isset($this->invalid) && $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);

src/Mailcode/Collection/NestingValidator.php

Indentation +9 added lines, -9 removed lines

@@ -29,19 +29,19 @@
     const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103;
     const VALIDATION_UNCLOSED_COMMAND = 49104;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $stack = array();
     
     public function __construct(Mailcode_Collection $collection)

src/Mailcode/Variables.php

Indentation +6 added lines, -6 removed lines

@@ -22,12 +22,12 @@
 {
     const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)/sx';
     
-   /**
-    * Parses the specified string to find all variable names contained within, if any.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Parses the specified string to find all variable names contained within, if any.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function parseString(string $subject) : Mailcode_Variables_Collection_Regular
     {
         $collection = new Mailcode_Variables_Collection_Regular();

src/Mailcode/Collection/Error.php

Indentation +9 added lines, -9 removed lines

@@ -20,19 +20,19 @@
  */
 abstract class Mailcode_Collection_Error
 {
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message = '';
     
     public function getCode() : int

src/Mailcode/Factory.php

Indentation +23 added lines, -23 removed lines

@@ -24,12 +24,12 @@ 
     
     const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
     
-   /**
-    * 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 showVariable(string $variableName) : Mailcode_Commands_Command_ShowVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -45,17 +45,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 setVariable(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
     {
         $variableName = self::_filterVariableName($variableName);
@@ -265,12 +265,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).'"';

src/Mailcode/Commands/Command.php

Indentation +49 added lines, -49 removed lines

@@ -30,44 +30,44 @@ 
     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',
@@ -89,33 +89,33 @@ 
         
     }
     
-   /**
-    * @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);
     }
     
-   /**
-    * 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();
@@ -207,9 +207,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params() : void
@@ -364,12 +364,12 @@ 
         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();