Mistralys / mailcode

src/Mailcode/Commands/Command.php

Indentation +106 added lines, -106 removed lines

@@ -37,44 +37,44 @@ 
 
     const META_URL_ENCODING = 'url_encoding';
 
-   /**
-    * @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 OperationResult
-    */
+    /**
+     * @var 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_empty',
         'params_keywords',
@@ -83,24 +83,24 @@ 
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords|NULL
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords|NULL
+     */
     protected $logicKeywords;
     
-   /**
-    * @var Mailcode_Parser_Statement_Validator
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Validator
+     */
     protected $validator;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $validated = false;
 
     /**
@@ -130,13 +130,13 @@ 
         
     }
 
-   /**
-    * Sets the command's parent opening command, if any.
-    * NOTE: This is set automatically by the parser, and
-    * should not be called manually.
-    *
-    * @param Mailcode_Commands_Command $command
-    */
+    /**
+     * Sets the command's parent opening command, if any.
+     * NOTE: This is set automatically by the parser, and
+     * should not be called manually.
+     *
+     * @param Mailcode_Commands_Command $command
+     */
     public function setParent(Mailcode_Commands_Command $command) : void
     {
         $this->parent = $command;
@@ -152,9 +152,9 @@ 
         return $this->parent;
     }
     
-   /**
-    * @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
     {
         // account for commands with types: If_Variable should still return If.
@@ -163,14 +163,14 @@ 
         return array_shift($tokens);
     }
     
-   /**
-    * Sets an optional comment that is not used anywhere, but
-    * can be used by the application to track why a command is
-    * used somewhere. 
-    * 
-    * @param string $comment
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Sets an optional comment that is not used anywhere, but
+     * can be used by the application to track why a command is
+     * used somewhere. 
+     * 
+     * @param string $comment
+     * @return Mailcode_Commands_Command
+     */
     public function setComment(string $comment) : Mailcode_Commands_Command
     {
         $this->comment = $comment;
@@ -178,34 +178,34 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the previously set comment, if any.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the previously set comment, if any.
+     * 
+     * @return string
+     */
     public function getComment() : string
     {
         return $this->comment;
     }
     
-   /**
-    * Checks whether this is a dummy command, which is only
-    * used to access information on the command type. It cannot
-    * be used as an actual live command.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether this is a dummy command, which is only
+     * used to access information on the command type. It cannot
+     * be used as an actual live command.
+     * 
+     * @return bool
+     */
     public function isDummy() : bool
     {
         return $this->type === '__dummy';
     }
     
-   /**
-    * Retrieves a hash of the actual matched command string,
-    * which is used in collections to detect duplicate commands.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a hash of the actual matched command string,
+     * which is used in collections to detect duplicate commands.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         $this->requireNonDummy();
@@ -307,9 +307,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params_empty() : void
@@ -478,12 +478,12 @@ 
 
     abstract public function supportsURLEncoding() : bool;
     
-   /**
-    * Whether the command allows using logic keywords like "and:" or "or:"
-    * in the command parameters.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the command allows using logic keywords like "and:" or "or:"
+     * in the command parameters.
+     * 
+     * @return bool
+     */
     abstract public function supportsLogicKeywords() : bool;
     
     abstract public function generatesContent() : bool;
@@ -529,22 +529,22 @@ 
         return $normalizer->normalize();
     }
     
-   /**
-    * Retrieves the names of all the command's supported types: the part
-    * between the command name and the colon. Example: {command type: params}.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all the command's supported types: the part
+     * between the command name and the colon. Example: {command type: params}.
+     * 
+     * @return string[]
+     */
     public function getSupportedTypes() : array
     {
         return array();
     }
     
-   /**
-    * Retrieves all variable names used in the command.
-    * 
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Retrieves all variable names used in the command.
+     * 
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function getVariables() : Mailcode_Variables_Collection_Regular
     {
         return Mailcode::create()->findVariables($this->paramsString);
@@ -569,26 +569,26 @@ 
         );
     }
 
-   /**
-    * Sets a parameter for the translation backend. The backend can use
-    * these to allow command-specific configurations.
-    *
-    * @param string $name
-    * @param mixed $value
-    * @return $this
-    */
+    /**
+     * Sets a parameter for the translation backend. The backend can use
+     * these to allow command-specific configurations.
+     *
+     * @param string $name
+     * @param mixed $value
+     * @return $this
+     */
     public function setTranslationParam(string $name, $value)
     {
         $this->translationParams[$name] = $value;
         return $this;
     }
 
-   /**
-    * Retrieves a previously set translation parameter.
-    *
-    * @param string $name
-    * @return mixed
-    */
+    /**
+     * Retrieves a previously set translation parameter.
+     *
+     * @param string $name
+     * @return mixed
+     */
     public function getTranslationParam(string $name)
     {
         if(isset($this->translationParams[$name]))

src/Mailcode/Traits/Commands/Validation/Variable.php

Indentation +8 added lines, -8 removed lines

@@ -24,9 +24,9 @@ 
  */
 trait Mailcode_Traits_Commands_Validation_Variable
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     protected $variableToken;
     
     protected function validateSyntax_variable() : void
@@ -60,11 +60,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(isset($this->variableToken))

src/Mailcode/Parser/Statement/Info.php

Indentation +64 added lines, -64 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();
 
     /**
@@ -52,21 +52,21 @@ 
         $this->tokenizer->onTokensChanged(array($this, 'handleTokensChanged'));
     }
     
-   /**
-    * 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
     {
         return $this->variables->isAssignment();
     }
     
-   /**
-    * 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
     {
         return $this->variables->isComparison();
@@ -83,27 +83,27 @@ 
         return $this->variables->getAll();
     }
     
-   /**
-    * 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
     {
         return $this->variables->getByIndex($index);
     }
     
-   /**
-    * 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);
@@ -116,27 +116,27 @@ 
         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
     {
         return $this->keywords->getByIndex($index);
     }
     
-   /**
-    * 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);
@@ -149,14 +149,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]))
@@ -172,19 +172,19 @@ 
         return isset($this->tokens[$index]);
     }
     
-   /**
-    * Retrieves all tokens.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens() : array
     {
         return $this->tokens;
     }
     
-   /**
-    * Retrieves all string literals that were found in the command.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
-    */
+    /**
+     * Retrieves all string literals that were found in the command.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
+     */
     public function getStringLiterals() : array
     {
         $result = array();

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +32 added lines, -32 removed lines

@@ -38,14 +38,14 @@ 
         'ExtractTokens'
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenized;
     
     /**
@@ -53,9 +53,9 @@ 
      */
     protected $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $ids = array();
 
     /**
@@ -70,12 +70,12 @@ 
         $this->tokenize($statement->getStatementString());
     }
 
-   /**
-    * Retrieves all tokens detected in the statement string, in 
-    * the order they were found.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens detected in the statement string, in 
+     * the order they were found.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens()
     {
         return $this->tokensOrdered;
@@ -86,11 +86,11 @@ 
         return !empty($this->tokensOrdered);
     }
     
-   /**
-    * Whether there were any unknown tokens in the statement.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there were any unknown tokens in the statement.
+     * 
+     * @return bool
+     */
     public function hasUnknown() : bool
     {
         $unknown = $this->getUnknown();
@@ -98,11 +98,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown()
     {
         $result = array();
@@ -273,13 +273,13 @@ 
         return $token;
     }
     
-   /**
-    * Generates a unique alphabet-based ID without numbers
-    * to use as token name, to avoid conflicts with the
-    * numbers detection.
-    *
-    * @return string
-    */
+    /**
+     * Generates a unique alphabet-based ID without numbers
+     * to use as token name, to avoid conflicts with the
+     * numbers detection.
+     *
+     * @return string
+     */
     protected function generateID() : string
     {
         static $alphas;

src/Mailcode/Parser.php

Indentation +51 added lines, -51 removed lines

@@ -30,14 +30,14 @@ 
         '{\s*([a-z]+)\s+([a-z-]+)\s*:([^}]*)}'
     );
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var Mailcode_Commands
-    */
+    /**
+     * @var Mailcode_Commands
+     */
     protected $commands;
 
     /**
@@ -51,24 +51,24 @@ 
         $this->commands = $this->mailcode->getCommands();
     }
     
-   /**
-    * Gets the regex format string used to detect commands.
-    * 
-    * @return string
-    */
+    /**
+     * Gets the regex format string used to detect commands.
+     * 
+     * @return string
+     */
     protected static function getRegex() : string
     {
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
     }
     
-   /**
-    * Parses a string to detect all commands within. Returns a
-    * collection instance that contains information on all the 
-    * commands.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection A collection with all unique commands found.
-    */
+    /**
+     * Parses a string to detect all commands within. Returns a
+     * collection instance that contains information on all the 
+     * commands.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection A collection with all unique commands found.
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         $collection = new Mailcode_Collection();
@@ -101,14 +101,14 @@ 
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
     }
     
-   /**
-    * Processes a single match found in the string: creates the command,
-    * and adds it to the collection if it's a valid command, or to the list
-    * of invalid commands otherwise.
-    * 
-    * @param Mailcode_Parser_Match $match
-    * @param Mailcode_Collection $collection
-    */
+    /**
+     * Processes a single match found in the string: creates the command,
+     * and adds it to the collection if it's a valid command, or to the list
+     * of invalid commands otherwise.
+     * 
+     * @param Mailcode_Parser_Match $match
+     * @param Mailcode_Collection $collection
+     */
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
     {
         $name = $match->getName();
@@ -170,14 +170,14 @@ 
         throw new Mailcode_Exception('Not a command', '', self::ERROR_NOT_A_COMMAND);
     }
     
-   /**
-    * Parses a single regex match: determines which named group
-    * matches, and retrieves the according information.
-    * 
-    * @param array[] $matches The regex results array.
-    * @param int $index The matched index.
-    * @return Mailcode_Parser_Match
-    */
+    /**
+     * Parses a single regex match: determines which named group
+     * matches, and retrieves the according information.
+     * 
+     * @param array[] $matches The regex results array.
+     * @param int $index The matched index.
+     * @return Mailcode_Parser_Match
+     */
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
     {
         $name = ''; // the command name, e.g. "showvar"
@@ -215,27 +215,27 @@ 
         );
     }
     
-   /**
-    * Creates an instance of the safeguard tool, which
-    * is used to safeguard commands in a string with placeholders.
-    * 
-    * @param string $subject The string to use to safeguard commands in.
-    * @return Mailcode_Parser_Safeguard
-    * @see Mailcode_Parser_Safeguard
-    */
+    /**
+     * Creates an instance of the safeguard tool, which
+     * is used to safeguard commands in a string with placeholders.
+     * 
+     * @param string $subject The string to use to safeguard commands in.
+     * @return Mailcode_Parser_Safeguard
+     * @see Mailcode_Parser_Safeguard
+     */
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
     {
         return new Mailcode_Parser_Safeguard($this, $subject);
     }
     
-   /**
-    * Creates a statement parser, which is used to validate arbitrary
-    * command statements.
-    * 
-    * @param string $statement
-    * @param bool $freeform
-    * @return Mailcode_Parser_Statement
-    */
+    /**
+     * Creates a statement parser, which is used to validate arbitrary
+     * command statements.
+     * 
+     * @param string $statement
+     * @param bool $freeform
+     * @return Mailcode_Parser_Statement
+     */
     public function createStatement(string $statement, bool $freeform=false) : Mailcode_Parser_Statement
     {
         return new Mailcode_Parser_Statement($statement, $freeform);

src/Mailcode/Parser/Safeguard.php

Indentation +141 added lines, -141 removed lines

@@ -55,45 +55,45 @@ 
     const ERROR_EMPTY_DELIMITER = 47803;
     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)
@@ -102,25 +102,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))
@@ -142,15 +142,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();
@@ -158,16 +158,16 @@ 
         return $this->makeSafePartial();
     }
     
-   /**
-    * Like makeSafe(), but allows partial (invalid) commands: use this
-    * if the subject string may contain only part of the whole set of
-    * commands. 
-    * 
-    * Example: parsing a text with an opening if statement, without the 
-    * matching end statement.
-    * 
-    * @return string
-    */
+    /**
+     * Like makeSafe(), but allows partial (invalid) commands: use this
+     * if the subject string may contain only part of the whole set of
+     * commands. 
+     * 
+     * Example: parsing a text with an opening if statement, without the 
+     * matching end statement.
+     * 
+     * @return string
+     */
     public function makeSafePartial() : string
     {
         $placeholders = $this->getPlaceholders();
@@ -272,13 +272,13 @@ 
         }
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formattings to use for the commands in the subject string.
-    * 
-    * @param Mailcode_StringContainer|string $subject
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * Creates a formatting handler, which can be used to specify
+     * which formattings to use for the commands in the subject string.
+     * 
+     * @param Mailcode_StringContainer|string $subject
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
         if(is_string($subject))
@@ -289,12 +289,12 @@ 
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
     }
     
-   /**
-    * 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))
@@ -370,16 +370,16 @@ 
         return $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
-    */
+    /**
+     * 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
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore(
@@ -389,15 +389,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(
@@ -407,19 +407,19 @@ 
         );
     }
 
-   /**
-    * 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
-    */
+    /**
+     * 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
+     */
     public function makeHighlighted(string $string) : string
     {
         return $this->restore(
@@ -429,15 +429,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(
@@ -447,11 +447,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))
@@ -469,11 +469,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())
@@ -492,11 +492,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))
@@ -523,13 +523,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();
@@ -552,13 +552,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();