Mistralys / mailcode

src/Mailcode/Parser/Statement/Info.php

Indentation +65 added lines, -65 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();
@@ -95,14 +95,14 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves a variable by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    * 
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * Retrieves a variable by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     * 
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable
     {
         $token = $this->getTokenByIndex($index);
@@ -115,14 +115,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a string literal by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
-    */
+    /**
+     * Retrieves a string literal by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
+     */
     public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
     {
         $token = $this->getTokenByIndex($index);
@@ -135,14 +135,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a keyword by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * Retrieves a keyword by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
     {
         $token = $this->getTokenByIndex($index);
@@ -155,14 +155,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves an operand by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
-    */
+    /**
+     * Retrieves an operand by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
+     */
     public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand
     {
         $token = $this->getTokenByIndex($index);
@@ -175,14 +175,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a parameter token by its position in the command's parameters,
-    * regardless of its type. Returns null if there is no parameter at the 
-    * specified index.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
-    */
+    /**
+     * Retrieves a parameter token by its position in the command's parameters,
+     * regardless of its type. Returns null if there is no parameter at the 
+     * specified index.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
+     */
     public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token
     {
         if(isset($this->tokens[$index]))
@@ -198,10 +198,10 @@ 
         return isset($this->tokens[$index]);
     }
     
-   /**
-    * Retrieves all string literals that were found in the command.
-    * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
-    */
+    /**
+     * Retrieves all string literals that were found in the command.
+     * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
+     */
     public function getStringLiterals()
     {
         $result = array();

src/Mailcode/Commands/Command/ShowDate.php

Indentation +36 added lines, -36 removed lines

@@ -22,15 +22,15 @@ 
 {
     const VALIDATION_NOT_A_FORMAT_STRING = 55401;
     
-   /**
-    * The date format string.
-    * @var string
-    */
+    /**
+     * The date format string.
+     * @var string
+     */
     private $formatString = "Y/m/d";
     
-   /**
-    * @var Mailcode_Date_FormatInfo
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo
+     */
     private $formatInfo;
     
     public function getName() : string
@@ -53,46 +53,46 @@ 
     
     protected function validateSyntax_check_format() : void
     {
-         $token = $this->params->getInfo()->getTokenByIndex(1);
+            $token = $this->params->getInfo()->getTokenByIndex(1);
          
-         // no format specified? Use the default one.
-         if($token === null)
-         {
-             return;
-         }
+            // no format specified? Use the default one.
+            if($token === null)
+            {
+                return;
+            }
          
-         if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral)
-         {
-             $format = $token->getText();
+            if($token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral)
+            {
+                $format = $token->getText();
              
-             $result = $this->formatInfo->validateFormat($format);
+                $result = $this->formatInfo->validateFormat($format);
              
-             if($result->isValid())
-             {
+                if($result->isValid())
+                {
                 $this->formatString = $format;
-             }
-             else
-             {
-                 $this->validationResult->makeError(
-                     $result->getErrorMessage(), 
-                     $result->getCode()
-                 );
-             }
+                }
+                else
+                {
+                    $this->validationResult->makeError(
+                        $result->getErrorMessage(), 
+                        $result->getCode()
+                    );
+                }
              
-             return;
-         }
+                return;
+            }
          
-         $this->validationResult->makeError(
+            $this->validationResult->makeError(
             t('The second parameter must be a date format string.'),
             self::VALIDATION_NOT_A_FORMAT_STRING
-         );
+            );
     }
     
-   /**
-    * Retrieves the format string used to format the date.
-    * 
-    * @return string A PHP compatible date format string.
-    */
+    /**
+     * Retrieves the format string used to format the date.
+     * 
+     * @return string A PHP compatible date format string.
+     */
     public function getFormatString() : string
     {
         return $this->formatString;

src/Mailcode/Factory.php

Indentation +58 added lines, -58 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);
@@ -99,12 +99,12 @@ 
     }
     
 
-   /**
-    * Creates a ShowSnippet command.
-    *
-    * @param string $snippetName A snippet name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowSnippet
-    */
+    /**
+     * Creates a ShowSnippet command.
+     *
+     * @param string $snippetName A snippet name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowSnippet
+     */
     public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
     {
         $snippetName = self::_filterVariableName($snippetName);
@@ -126,17 +126,17 @@ 
         throw self::_exceptionUnexpectedType('ShowSnippet', $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);
@@ -165,14 +165,14 @@ 
         throw self::_exceptionUnexpectedType('SetVariable', $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);
@@ -504,12 +504,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).'"';
@@ -542,34 +542,34 @@ 
         );
     }
     
-   /**
-    * 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();
     }
     
-   /**
-    * Gets/creates the global instance of the date format info
-    * class, used to handle date formatting aspects.
-    * 
-    * @return Mailcode_Date_FormatInfo
-    */
+    /**
+     * Gets/creates the global instance of the date format info
+     * class, used to handle date formatting aspects.
+     * 
+     * @return Mailcode_Date_FormatInfo
+     */
     public static function createDateInfo() : Mailcode_Date_FormatInfo
     {
         return Mailcode_Date_FormatInfo::getInstance();

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
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     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:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
+                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
             );
         }

src/Mailcode/Commands.php

Indentation +46 added lines, -46 removed lines

@@ -27,21 +27,21 @@ 
     
     const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     private $commands = array();
     
-   /**
-    * @var string[]Mailcode_Commands_Command
-    */
+    /**
+     * @var string[]Mailcode_Commands_Command
+     */
     private static $dummyCommands = 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();
@@ -54,13 +54,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)) {
@@ -86,12 +86,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();
@@ -104,15 +104,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();
@@ -141,12 +141,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();
@@ -200,13 +200,13 @@ 
         return $class;
     }
     
-   /**
-    * Retrieves the dummy command of the specified type, which
-    * is used to retrieve information on the command's capabilities.
-    *  
-    * @param string $id
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Retrieves the dummy command of the specified type, which
+     * is used to retrieve information on the command's capabilities.
+     *  
+     * @param string $id
+     * @return Mailcode_Commands_Command
+     */
     private function getDummyCommand(string $id) : Mailcode_Commands_Command
     {
         if(!isset(self::$dummyCommands[$id]))

src/Mailcode/Traits/Commands/IfVariable.php

Indentation +24 added lines, -24 removed lines

@@ -23,19 +23,19 @@ 
  */
 trait Mailcode_Traits_Commands_IfVariable
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     protected $variableToken;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
+     */
     protected $comparisonToken;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Type_Value|NULL
+     */
     protected $valueToken;
     
     protected function getValidations() : array
@@ -123,11 +123,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the variable being compared.
-    *
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable being compared.
+     *
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)
@@ -142,12 +142,12 @@ 
         );
     }
     
-   /**
-    * Retrieves the comparison operator sign.
-    * 
-    * @throws Mailcode_Exception
-    * @return string The comparison string, e.g. "==", "!=", etc.
-    */
+    /**
+     * Retrieves the comparison operator sign.
+     * 
+     * @throws Mailcode_Exception
+     * @return string The comparison string, e.g. "==", "!=", etc.
+     */
     public function getComparator() : string
     {
         if($this->comparisonToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Operand)
@@ -162,10 +162,10 @@ 
         );
     }
     
-   /**
-    * Retrieves the unquoted value 
-    * @return string
-    */
+    /**
+     * Retrieves the unquoted value 
+     * @return string
+     */
     public function getValue() : string
     {
         if($this->valueToken instanceof Mailcode_Parser_Statement_Tokenizer_Type_Value)

src/Mailcode/Traits/Commands/IfContains.php

Indentation +11 added lines, -11 removed lines

@@ -28,14 +28,14 @@ 
      */
     protected $variableToken;
 
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
+     */
     protected $stringToken;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $caseInsensitive = false;
     
     protected function getValidations() : array
@@ -131,11 +131,11 @@ 
         );
     }
 
-   /**
-    * Retrieves the variable being compared.
-    *
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable being compared.
+     *
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)

src/Mailcode/Parser/Safeguard.php

Indentation +140 added lines, -140 removed lines

@@ -61,50 +61,50 @@ 
     
     const ERROR_NOT_A_SINGLE_LINES_FORMATTER = 47806;
     
-   /**
-    * @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;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -113,25 +113,25 @@ 
         $this->originalString = $subject;
     }
     
-   /**
-    * Retrieves the string the safeguard was created for.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string the safeguard was created for.
+     * 
+     * @return string
+     */
     public function getOriginalString() : string
     {
         return $this->originalString;
     }
     
-   /**
-    * 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))
@@ -153,15 +153,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();
@@ -201,10 +201,10 @@ 
         );
     }
     
-   /**
-    * Enables the formatter that ensures that all commands that
-    * @return Mailcode_Parser_Safeguard_Formatter_SingleLines
-    */
+    /**
+     * Enables the formatter that ensures that all commands that
+     * @return Mailcode_Parser_Safeguard_Formatter_SingleLines
+     */
     public function selectSingleLinesFormatter() : Mailcode_Parser_Safeguard_Formatter_SingleLines
     {
         $formatter = $this->selectFormatter('SingleLines');
@@ -224,13 +224,13 @@ 
         );
     }
     
-   /**
-    * Retrieves an associative array with pairs of
-    * [placeholder string => replacement text]. 
-    * 
-    * @param bool $highlighted
-    * @return string[]string
-    */
+    /**
+     * Retrieves an associative array with pairs of
+     * [placeholder string => replacement text]. 
+     * 
+     * @param bool $highlighted
+     * @return string[]string
+     */
     protected function getReplaces(bool $highlighted=false) : array
     {
         $placeholders = $this->getPlaceholders();
@@ -257,12 +257,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))
@@ -314,17 +314,17 @@ 
         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(
@@ -334,15 +334,15 @@ 
         );
     }
     
-   /**
-    * Like `makeWhole()`, but ignores missing command placeholders.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Like `makeWhole()`, but ignores missing command placeholders.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeWholePartial(string $string) : string
     {
         return $this->restore(
@@ -352,20 +352,20 @@ 
         );
     }
 
-   /**
-    * 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(
@@ -375,15 +375,15 @@ 
         );
     }
     
-   /**
-    * Like `makeHighlighted()`, but ignores missing command placeholders.
-    * 
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Like `makeHighlighted()`, but ignores missing command placeholders.
+     * 
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeHighlightedPartial(string $string) : string
     {
         return $this->restore(
@@ -393,11 +393,11 @@ 
         );
     }
     
-   /**
-    * 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))
@@ -415,11 +415,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())
@@ -438,11 +438,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(is_array($this->placeholderStrings))
@@ -469,13 +469,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();
@@ -498,13 +498,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();