Mistralys / mailcode

src/Mailcode/StringContainer.php

Indentation +66 added lines, -66 removed lines

@@ -26,39 +26,39 @@ 
     public const ERROR_INVALID_CALLABLE = 65701;
     public const ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION = 65702;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $listenerCounter = 0;
     
-   /**
-    * @var callable[]
-    */
+    /**
+     * @var callable[]
+     */
     private $listeners = array();
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $updating = false;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $idCounter = 0;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $id;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $length;
     
     public function __construct(string $subject)
@@ -75,16 +75,16 @@ 
         return $this->id;
     }
     
-   /**
-    * Updates the string with the specified string.
-    * Notifies all listeners of the change.
-    * 
-    * @param string $subject
-    * @throws Mailcode_Exception
-    * @return bool Whether the string had modifications.
-    * 
-    * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
-    */
+    /**
+     * Updates the string with the specified string.
+     * Notifies all listeners of the change.
+     * 
+     * @param string $subject
+     * @throws Mailcode_Exception
+     * @return bool Whether the string had modifications.
+     * 
+     * @see Mailcode_StringContainer::ERROR_UPDATE_CALLED_DURING_UPDATE_OPERATION
+     */
     public function updateString(string $subject) : bool
     {
         // avoid triggering an update if there are no changes in the string
@@ -117,27 +117,27 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the stored string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the stored string.
+     * 
+     * @return string
+     */
     public function getString() : string
     {
         return $this->subject;
     }
     
-   /**
-    * Adds a listener that will be informed every time the string is modified.
-    * The callback gets the string container instance as parameter.
-    * 
-    * @param callable $callback
-    * @throws Mailcode_Exception If it is not a valid callable.
-    * @return int The listener number, to be able to remove it using `removeListener()`.
-    * 
-    * @see Mailcode_StringContainer::removeListener()
-    * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
-    */
+    /**
+     * Adds a listener that will be informed every time the string is modified.
+     * The callback gets the string container instance as parameter.
+     * 
+     * @param callable $callback
+     * @throws Mailcode_Exception If it is not a valid callable.
+     * @return int The listener number, to be able to remove it using `removeListener()`.
+     * 
+     * @see Mailcode_StringContainer::removeListener()
+     * @see Mailcode_StringContainer::ERROR_INVALID_CALLABLE
+     */
     public function addListener($callback) : int
     {
         self::$listenerCounter++;
@@ -164,12 +164,12 @@ 
         return $this->length;
     }
     
-   /**
-    * Removes an existing listener by its ID.
-    * Has no effect if it does not exist, or has already been removed.
-    * 
-    * @param int $listenerID
-    */
+    /**
+     * Removes an existing listener by its ID.
+     * Has no effect if it does not exist, or has already been removed.
+     * 
+     * @param int $listenerID
+     */
     public function removeListener(int $listenerID) : void
     {
         if(isset($this->listeners[$listenerID]))
@@ -178,13 +178,13 @@ 
         }
     }
     
-   /**
-    * Replaces all substrings matching needle with the replacement text.
-    *  
-    * @param string $needle
-    * @param string $replacement
-    * @return bool
-    */
+    /**
+     * Replaces all substrings matching needle with the replacement text.
+     *  
+     * @param string $needle
+     * @param string $replacement
+     * @return bool
+     */
     public function replaceSubstrings(string $needle, string $replacement) : bool
     {
         $string = str_replace($needle, $replacement, $this->subject);
@@ -192,12 +192,12 @@ 
         return $this->updateString($string);
     }
 
-   /**
-    * Get the position of a substring in the string.
-    * 
-    * @param string $needle
-    * @return int|bool The zero-based position, or false if not found.
-    */
+    /**
+     * Get the position of a substring in the string.
+     * 
+     * @param string $needle
+     * @return int|bool The zero-based position, or false if not found.
+     */
     public function getSubstrPosition(string $needle)
     {
         return mb_strpos($this->subject, $needle);

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,41 +26,41 @@ 
  */
 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()
@@ -68,11 +68,11 @@ 
             ->getCollection();
     }
     
-   /**
-    * 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)) 
@@ -83,12 +83,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)) 
@@ -131,12 +131,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))
@@ -147,12 +147,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();

src/Mailcode/Variables/Collection/Regular.php

Indentation +17 added lines, -17 removed lines

@@ -20,9 +20,9 @@ 
  */
 class Mailcode_Variables_Collection_Regular extends Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Invalid
+     */
     protected Mailcode_Variables_Collection_Invalid $invalid;
 
     protected function init() : void
@@ -47,30 +47,30 @@ 
         return $this;
     }
 
-   /**
-    * Whether any of the variables in the collection are invalid.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether any of the variables in the collection are invalid.
+     * 
+     * @return bool
+     */
     public function hasInvalid() : bool
     {
         return $this->invalid->hasVariables();
     }
     
-   /**
-    * Retrieves the collection of invalid variables, if any.
-    * Behaves like a variables collection.
-    * 
-    * @return Mailcode_Variables_Collection_Invalid
-    */
+    /**
+     * Retrieves the collection of invalid variables, if any.
+     * Behaves like a variables collection.
+     * 
+     * @return Mailcode_Variables_Collection_Invalid
+     */
     public function getInvalid() : Mailcode_Variables_Collection_Invalid
     {
         return $this->invalid;
     }
     
-   /**
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         parent::mergeWith($collection);

src/Mailcode/Variables/Variable.php

Indentation +18 added lines, -18 removed lines

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

src/Mailcode/Parser/Statement.php

Indentation +13 added lines, -13 removed lines

@@ -26,24 +26,24 @@ 
     public const VALIDATION_EMPTY = 48801;
     public const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected OperationResult $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected Mailcode_Parser_Statement_Tokenizer $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected ?Mailcode_Parser_Statement_Info $info = null;
 
     /**
@@ -138,7 +138,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/Parser/Safeguard.php

Indentation +146 added lines, -146 removed lines

@@ -54,40 +54,40 @@ 
     public const ERROR_NO_PLACEHOLDER_FOR_COMMAND = 47805;
     public const ERROR_NO_FIRST_PLACEHOLDER = 47806;
 
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected Mailcode_Parser $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static int $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
+     */
     protected ?Mailcode_Parser_Safeguard_PlaceholderCollection $placeholders = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $delimiter = '999';
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -106,28 +106,28 @@ 
         self::$counter = 0;
     }
     
-   /**
-    * 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 "999".
-    *
-    * Minimum characters: 2
-    * Invalid characters: Any characters that get URL encoded
-    *
-    * @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 "999".
+     *
+     * Minimum characters: 2
+     * Invalid characters: Any characters that get URL encoded
+     *
+     * @param string $delimiter
+     * @return Mailcode_Parser_Safeguard
+     */
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
     {
         $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter);
@@ -143,15 +143,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();
@@ -159,16 +159,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->getPlaceholdersCollection()->getAll();
@@ -218,13 +218,13 @@ 
         $analyzer->analyze();
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formatting 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 formatting 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))
@@ -249,11 +249,11 @@ 
     }
 
     /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return Mailcode_Parser_Safeguard_PlaceholderCollection
-    */
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return Mailcode_Parser_Safeguard_PlaceholderCollection
+     */
     public function getPlaceholdersCollection() : Mailcode_Parser_Safeguard_PlaceholderCollection
     {
         if(isset($this->placeholders))
@@ -313,16 +313,16 @@ 
         return $formatting->toString();
     }
 
-   /**
-    * 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(
@@ -332,15 +332,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(
@@ -350,19 +350,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(
@@ -372,15 +372,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(
@@ -390,11 +390,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the command collection contained in the string.
-    * 
-    * @return Mailcode_Collection
-    */
+    /**
+     * Retrieves the command collection contained in the string.
+     * 
+     * @return Mailcode_Collection
+     */
     public function getCollection() : Mailcode_Collection
     {
         if(isset($this->collection))
@@ -418,11 +418,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())
@@ -445,13 +445,13 @@ 
         throw $exception;
     }
     
-   /**
-    * Retrieves a list of all placeholder IDs used in the text.
-    * 
-    * @return string[]
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a list of all placeholder IDs used in the text.
+     * 
+     * @return string[]
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderStrings() : array
     {
         return $this->getPlaceholdersCollection()->getStrings();
@@ -462,29 +462,29 @@ 
         return $this->getPlaceholdersCollection()->isStringPlaceholder($subject);
     }
     
-   /**
-    * Retrieves a placeholder instance by its ID.
-    * 
-    * @param int $id
-    * @throws Mailcode_Exception If the placeholder was not found.
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its ID.
+     * 
+     * @param int $id
+     * @throws Mailcode_Exception If the placeholder was not found.
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByID($id);
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByString($string);

src/Mailcode/Parser/Safeguard/Formatter/Location.php

Indentation +44 added lines, -44 removed lines

@@ -24,34 +24,34 @@ 
 {
     public const ERROR_PLACEHOLDER_NOT_FOUND = 66001;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $append = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $prepend = '';
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     protected $placeholder;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder $placeholder)
@@ -67,22 +67,22 @@ 
     
     abstract public function requiresAdjustment() : bool;
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getStartPosition()
     {
         return $this->subject->getSubstrPosition($this->placeholder->getReplacementText());
     }
     
-   /**
-    * Checks whether the specified position within the string
-    * is within another command's placeholder (excluding this
-    * location's placeholder).
-    * 
-    * @param int $position
-    * @return bool
-    */
+    /**
+     * Checks whether the specified position within the string
+     * is within another command's placeholder (excluding this
+     * location's placeholder).
+     * 
+     * @param int $position
+     * @return bool
+     */
     public function isWithinCommand(int $position) : bool
     {
         $placeholders = $this->formatter->getSafeguard()->getPlaceholdersCollection()->getAll();
@@ -114,9 +114,9 @@ 
         return false;
     }
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getEndPosition()
     {
         $start = $this->getStartPosition();
@@ -139,14 +139,14 @@ 
         return $this->placeholder;
     }
     
-   /**
-    * Replaces the placeholder with the specified replacement text.
-    * 
-    * @param string $replacementText
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
-    */
+    /**
+     * Replaces the placeholder with the specified replacement text.
+     * 
+     * @param string $replacementText
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
+     */
     public function replaceWith(string $replacementText) : void
     {
         $needle = $this->placeholder->getReplacementText();
@@ -196,10 +196,10 @@ 
         );
     }
     
-   /**
-    * Retrieves the location's log messages, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the location's log messages, if any.
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +24 added lines, -24 removed lines

@@ -27,19 +27,19 @@ 
 {
     public const ERROR_INVALID_LOCATION_INSTANCE = 65601;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatting
+     */
     protected $formatting;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatting $formatting)
@@ -98,12 +98,12 @@ 
         );
     }
     
-   /**
-    * Retrieves all formatter-specific placeholder locations 
-    * in the subject string.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Location[]
-    */
+    /**
+     * Retrieves all formatter-specific placeholder locations 
+     * in the subject string.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Location[]
+     */
     protected function resolveLocations() : array
     {
         $placeholders = $this->formatting->getSafeguard()->getPlaceholdersCollection()->getAll();
@@ -118,12 +118,12 @@ 
         return $result;
     }
     
-   /**
-    * Resolves the newline character used in the string.
-    * 
-    * @param string $subject
-    * @return string
-    */
+    /**
+     * Resolves the newline character used in the string.
+     * 
+     * @param string $subject
+     * @return string
+     */
     protected function resolveNewlineChar(string $subject) : string
     {
         $eol = ConvertHelper::detectEOLCharacter($subject);
@@ -155,9 +155,9 @@ 
         );
     }
  
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

src/Mailcode/Factory/CommandSets.php

Indentation +6 added lines, -6 removed lines

@@ -35,14 +35,14 @@
      */
     private ?Mailcode_Factory_CommandSets_Set_Misc $misc = null;
     
-   /**
-    * @var Mailcode_Factory_CommandSets_Set_Set|NULL
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets_Set_Set|NULL
+     */
     private ?Mailcode_Factory_CommandSets_Set_Set $set = null;
     
-   /**
-    * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL
+     */
     private ?Mailcode_Factory_CommandSets_Set_ElseIf $elseIf = null;
     
     public function if() : Mailcode_Factory_CommandSets_Set_If