Mistralys / mailcode

src/Mailcode/Collection.php

Indentation +51 added lines, -51 removed lines

@@ -22,9 +22,9 @@ 
  */
 class Mailcode_Collection
 {
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -32,17 +32,17 @@ 
      */
     protected $errors = array();
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected $validationResult;
     
-   /**
-    * Adds a command to the collection.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds a command to the collection.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @return Mailcode_Collection
+     */
     public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection
     {
         $this->commands[] = $command;
@@ -54,21 +54,21 @@ 
         return $this;
     }
     
-   /**
-    * Whether there are any commands in the collection.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there are any commands in the collection.
+     * 
+     * @return bool
+     */
     public function hasCommands() : bool
     {
         return !empty($this->commands);
     }
     
-   /**
-    * Counts the amount of commands in the collection.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of commands in the collection.
+     * 
+     * @return int
+     */
     public function countCommands() : int
     {
         return count($this->commands);
@@ -88,9 +88,9 @@ 
         $this->errors[] = new Mailcode_Collection_Error_Command($command);
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -116,25 +116,25 @@ 
         return empty($errors);
     }
     
-   /**
-    * Retrieves all commands that were detected, in the exact order
-    * they were found.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected, in the exact order
+     * they were found.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
-       return $this->commands;
+        return $this->commands;
     }
     
-   /**
-    * Retrieves all unique commands by their matched
-    * string hash: this ensures only commands that were
-    * written the exact same way (including spacing)
-    * are returned.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all unique commands by their matched
+     * string hash: this ensures only commands that were
+     * written the exact same way (including spacing)
+     * are returned.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getGroupedByHash()
     {
         $hashes = array();
@@ -152,12 +152,12 @@ 
         return array_values($hashes);
     }
 
-   /**
-    * Adds several commands at once.
-    * 
-    * @param Mailcode_Commands_Command[] $commands
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds several commands at once.
+     * 
+     * @param Mailcode_Commands_Command[] $commands
+     * @return Mailcode_Collection
+     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
         foreach($commands as $command)
@@ -216,11 +216,11 @@ 
         return false;
     }
     
-   /**
-    * Retrieves only show variable commands in the collection, if any.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
-    */
+    /**
+     * Retrieves only show variable commands in the collection, if any.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command_ShowVariable[]
+     */
     public function getShowVariableCommands()
     {
         $result = array();

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::showVar($variableName));

src/Mailcode/Parser/Safeguard.php

Indentation +107 added lines, -107 removed lines

@@ -57,45 +57,45 @@ 
     
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
     
-   /**
-    * @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 = '__';
     
-   /**
-    * @var string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected $placeholderStrings;
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -104,15 +104,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))
@@ -134,15 +134,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();
@@ -152,10 +152,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();
@@ -182,12 +182,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))
@@ -239,46 +239,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))
@@ -296,11 +296,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())
@@ -318,11 +318,11 @@ 
         );
     }
     
-   /**
-    * Retrieves a list of all placeholder IDs used in the text.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all placeholder IDs used in the text.
+     * 
+     * @return string[]
+     */
     public function getPlaceholderStrings() : array
     {
         if(isset($this->placeholderStrings))
@@ -349,13 +349,13 @@ 
         return in_array($subject, $ids);
     }
     
-   /**
-    * Retrieves a placeholder instance by its ID.
-    * 
-    * @param int $id
-    * @throws Mailcode_Exception If the placeholder was not found.
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * Retrieves a placeholder instance by its ID.
+     * 
+     * @param int $id
+     * @throws Mailcode_Exception If the placeholder was not found.
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     */
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
     {
         $placeholders = $this->getPlaceholders();
@@ -378,13 +378,13 @@ 
         );
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         $placeholders = $this->getPlaceholders();

src/Mailcode/Variables.php

Indentation +9 added lines, -9 removed lines

@@ -22,17 +22,17 @@
 {
     const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six';
     
-   /**
-    * @var Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Regular
+     */
     protected $collection;
     
-   /**
-    * 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
     {
         $this->collection = new Mailcode_Variables_Collection_Regular();

src/Mailcode/Translator/Syntax.php

Indentation +18 added lines, -18 removed lines

@@ -23,10 +23,10 @@ 
 {
     const ERROR_UNKNOWN_COMMAND_TYPE = 50401;
     
-   /**
-    * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
-    * @return string
-    */
+    /**
+     * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
+     * @return string
+     */
     public function getTypeID() : string
     {
         $parts = explode('_', get_class($this));
@@ -34,13 +34,13 @@ 
         return array_pop($parts);
     }
     
-   /**
-    * Translates a single command to the target syntax.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @throws Mailcode_Translator_Exception
-    * @return string
-    */
+    /**
+     * Translates a single command to the target syntax.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @throws Mailcode_Translator_Exception
+     * @return string
+     */
     public function translateCommand(Mailcode_Commands_Command $command) : string
     {
         $id = $command->getID();
@@ -63,13 +63,13 @@ 
         return $this->$method($command);
     }
     
-   /**
-    * Translates all safeguarded commands in the subject string to the 
-    * target syntax in one go.
-    * 
-    * @param Mailcode_Parser_Safeguard $safeguard
-    * @return string
-    */
+    /**
+     * Translates all safeguarded commands in the subject string to the 
+     * target syntax in one go.
+     * 
+     * @param Mailcode_Parser_Safeguard $safeguard
+     * @return string
+     */
     public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string
     {
         $subject = $safeguard->makeSafe();

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,51 +26,51 @@ 
  */
 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;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = 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)) 
@@ -81,12 +81,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)) 
@@ -102,12 +102,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);
@@ -123,12 +123,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))