Mistralys / mailcode

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

src/Mailcode/Commands/Command/ShowVariable.php

Indentation +30 added lines, -30 removed lines

@@ -24,9 +24,9 @@ 
     
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 48401;
     
-   /**
-    * @var Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Variables_Variable|NULL
+     */
     protected $variable;
     
     public function getName() : string
@@ -49,15 +49,15 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         $this->validate();
@@ -74,15 +74,15 @@ 
         );
     }
     
-   /**
-    * Retrieves the full name of the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the full name of the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return string
+     */
     public function getVariableName() : string
     {
         return $this->getVariable()->getFullName();
@@ -90,19 +90,19 @@ 
 
     protected function validateSyntax_require_variable() : void
     {
-         $vars = $this->getVariables()->getGroupedByName();
-         $amount = count($vars);
+            $vars = $this->getVariables()->getGroupedByName();
+            $amount = count($vars);
          
-         if($amount === 1)
-         {
-             $this->variable = array_pop($vars);
-             return;
-         }
+            if($amount === 1)
+            {
+                $this->variable = array_pop($vars);
+                return;
+            }
          
-         $this->validationResult->makeError(
+            $this->validationResult->makeError(
             t('Command has %1$s variables, %2$s expected.', $amount, 1),
             self::VALIDATION_VARIABLE_COUNT_MISMATCH
-         );
+            );
     }
     
     protected function getValidations() : array

src/Mailcode/Commands/Command/If.php

Indentation +8 added lines, -8 removed lines

@@ -22,9 +22,9 @@ 
 {
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 49201;
     
-   /**
-    * @var Mailcode_Variables_Variable
-    */
+    /**
+     * @var Mailcode_Variables_Variable
+     */
     protected $variable;
     
     public function getName() : string
@@ -57,11 +57,11 @@ 
         return $this->type === 'variable';
     }
     
-   /**
-    * Available only if the command is of type "variable".
-    * 
-    * @return Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * Available only if the command is of type "variable".
+     * 
+     * @return Mailcode_Variables_Variable|NULL
+     */
     public function getVariable() : ?Mailcode_Variables_Variable
     {
         if(isset($this->variable))

src/Mailcode/Commands/Highlighter.php

Indentation +12 added lines, -12 removed lines

@@ -20,19 +20,19 @@ 
  */
 class Mailcode_Commands_Highlighter
 {
-   /**
-    * @var Mailcode_Commands_Command
-    */
+    /**
+     * @var Mailcode_Commands_Command
+     */
     protected $command;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $parts = array();
     
     public function __construct(Mailcode_Commands_Command $command)
     {
-       $this->command = $command;
+        $this->command = $command;
     }
     
     public function highlight() : string
@@ -68,11 +68,11 @@ 
         }
     }
     
-   /**
-    * @param string[] $classes
-    * @param string $content
-    * @return string
-    */
+    /**
+     * @param string[] $classes
+     * @param string $content
+     * @return string
+     */
     protected function renderTag(array $classes, string $content) : string
     {
         $parts = array();

src/Mailcode/Variables/Variable.php

Indentation +18 added lines, -18 removed lines

@@ -32,34 +32,34 @@
     const VALIDATION_ERROR_PATH_UNDERSCORE = 48203;
     const VALIDATION_ERROR_NAME_UNDERSCORE = 48204;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash = '';
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult = null;
     
-   /**
-    * @var array<string>
-    */
+    /**
+     * @var array<string>
+     */
     protected $validations = array(
         'number_path',
         'number_name',

src/Mailcode/Variables/Collection.php

Indentation +56 added lines, -56 removed lines

@@ -20,9 +20,9 @@ 
  */
 abstract class Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Variable[]
-    */
+    /**
+     * @var Mailcode_Variables_Variable[]
+     */
     protected $variables = array();
     
     public function __construct()
@@ -52,12 +52,12 @@ 
         return count($this->variables);
     }
     
-   /**
-    * Checks whether the collection contains a variable with the specified name.
-    * 
-    * @param string $fullName The variable name, with or without $ sign.
-    * @return bool
-    */
+    /**
+     * Checks whether the collection contains a variable with the specified name.
+     * 
+     * @param string $fullName The variable name, with or without $ sign.
+     * @return bool
+     */
     public function hasVariableName(string $fullName) : bool
     {
         $fullName = $this->fixName($fullName);
@@ -73,14 +73,14 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a collection of all variable instances for
-    * the specified name (there can be several with differing
-    * matched texts because of spacing).
-    * 
-    * @param string $fullName
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     * Retrieves a collection of all variable instances for
+     * the specified name (there can be several with differing
+     * matched texts because of spacing).
+     * 
+     * @param string $fullName
+     * @return Mailcode_Variables_Collection
+     */
     public function getByFullName(string $fullName) : Mailcode_Variables_Collection
     {
         $fullName = $this->fixName($fullName);
@@ -98,12 +98,12 @@ 
         return $collection;
     }
     
-   /**
-    * Prepends the $ sign to a variable name if it does not have it.
-    * 
-    * @param string $fullName
-    * @return string
-    */
+    /**
+     * Prepends the $ sign to a variable name if it does not have it.
+     * 
+     * @param string $fullName
+     * @return string
+     */
     protected function fixName(string $fullName) : string
     {
         if(substr($fullName, 0, 1) === '$')
@@ -114,12 +114,12 @@ 
         return '$'.$fullName;
     }
     
-   /**
-    * Retrieves all variables, grouped by their hash - meaning
-    * unique matched strings.
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their hash - meaning
+     * unique matched strings.
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByHash()
     {
         $entries = array();
@@ -132,11 +132,11 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, grouped by their name. 
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their name. 
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByName()
     {
         $entries = array();
@@ -149,19 +149,19 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, in the order they were addded.
-    * @return \Mailcode\Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, in the order they were addded.
+     * @return \Mailcode\Mailcode_Variables_Variable[]
+     */
     public function getAll()
     {
         return $this->variables;
     }
     
-   /**
-    * Retrieves the full names of the variables that are present in the collection.
-    * @return string[]
-    */
+    /**
+     * Retrieves the full names of the variables that are present in the collection.
+     * @return string[]
+     */
     public function getNames() : array
     {
         $result = array();
@@ -179,13 +179,13 @@ 
         return $result;
     }
     
-   /**
-    * Takes a list of variables and sorts them, throwing away
-    * the source array's keys.
-    * 
-    * @param Mailcode_Variables_Variable[] $entries
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Takes a list of variables and sorts them, throwing away
+     * the source array's keys.
+     * 
+     * @param Mailcode_Variables_Variable[] $entries
+     * @return Mailcode_Variables_Variable[]
+     */
     protected function sortVariables(array $entries)
     {
         $result = array_values($entries);
@@ -198,13 +198,13 @@ 
         return $result;
     }
 
-   /**
-    *  Merges the variables collection with the target collection
-    *  by inheriting all that collection's variables.
-    *  
-    * @param Mailcode_Variables_Collection $collection
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     *  Merges the variables collection with the target collection
+     *  by inheriting all that collection's variables.
+     *  
+     * @param Mailcode_Variables_Collection $collection
+     * @return Mailcode_Variables_Collection
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         $variables = $collection->getGroupedByHash();

src/Mailcode/Parser/Safeguard.php

Indentation +85 added lines, -85 removed lines

@@ -55,40 +55,40 @@ 
     
     const ERROR_EMPTY_DELIMITER = 47803;
     
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected $placeholders;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '__';
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -97,15 +97,15 @@ 
         $this->originalString = $subject;
     }
     
-   /**
-    * Sets the delimiter character sequence used to prepend
-    * and append to the placeholders.
-    * 
-    * The delimiter's default is "__" (two underscores).
-    * 
-    * @param string $delimiter
-    * @return Mailcode_Parser_Safeguard
-    */
+    /**
+     * Sets the delimiter character sequence used to prepend
+     * and append to the placeholders.
+     * 
+     * The delimiter's default is "__" (two underscores).
+     * 
+     * @param string $delimiter
+     * @return Mailcode_Parser_Safeguard
+     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
         if(empty($delimiter))
@@ -127,15 +127,15 @@ 
         return $this->delimiter;
     }
     
-   /**
-    * Retrieves the safe string in which all commands have been replaced
-    * by placeholder strings.
-    * 
-    * @return string
-    * @throws Mailcode_Exception 
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Retrieves the safe string in which all commands have been replaced
+     * by placeholder strings.
+     * 
+     * @return string
+     * @throws Mailcode_Exception 
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeSafe() : string
     {
         $this->requireValidCollection();
@@ -145,10 +145,10 @@ 
         return str_replace(array_values($replaces), array_keys($replaces), $this->originalString);
     }
     
-   /**
-    * @param bool $highlighted
-    * @return string[]string
-    */
+    /**
+     * @param bool $highlighted
+     * @return string[]string
+     */
     protected function getReplaces(bool $highlighted=false) : array
     {
         $placeholders = $this->getPlaceholders();
@@ -175,12 +175,12 @@ 
     }
     
     
-   /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     public function getPlaceholders()
     {
         if(isset($this->placeholders))
@@ -232,46 +232,46 @@ 
         return str_replace($placeholderStrings, array_values($replaces), $string);
     }
     
-   /**
-    * Makes the string whole again after transforming or filtering it,
-    * by replacing the command placeholders with the original commands.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Makes the string whole again after transforming or filtering it,
+     * by replacing the command placeholders with the original commands.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore($string, false);
     }
 
-   /**
-    * Like makeWhole(), but replaces the commands with a syntax
-    * highlighted version, meant for human readable texts only.
-    * 
-    * Note: the commands lose their functionality (They cannot be 
-    * parsed from that string again).
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
-    */
+    /**
+     * Like makeWhole(), but replaces the commands with a syntax
+     * highlighted version, meant for human readable texts only.
+     * 
+     * Note: the commands lose their functionality (They cannot be 
+     * parsed from that string again).
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore($string, true);
     }
     
-   /**
-    * Retrieves the commands collection contained in the string.
-    * 
-    * @return Mailcode_Collection
-    */
+    /**
+     * Retrieves the commands collection contained in the string.
+     * 
+     * @return Mailcode_Collection
+     */
     public function getCollection() : Mailcode_Collection
     {
         if(isset($this->collection))
@@ -289,11 +289,11 @@ 
         return $this->getCollection()->isValid();
     }
     
-   /**
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     protected function requireValidCollection() : void
     {
         if($this->getCollection()->isValid())