Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Restorer.php

Indentation +15 added lines, -15 removed lines

@@ -22,24 +22,24 @@ 
  */
 class Mailcode_Parser_Safeguard_Restorer
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     private $safeguard;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     private $highlighted;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     private $normalize;
     
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     private $replaces = array();
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, bool $highlighted, bool $normalize)
@@ -49,9 +49,9 @@ 
         $this->normalize = $normalize;
     }
     
-   /**
-    * @return array<string,string>
-    */
+    /**
+     * @return array<string,string>
+     */
     public function getReplaces() : array
     {
         $placeholders = $this->safeguard->getPlaceholders();

src/Mailcode/Parser/Safeguard.php

Indentation +150 added lines, -150 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();
@@ -169,16 +169,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
     {
         $replaces = $this->getReplaces();
@@ -233,10 +233,10 @@ 
         throw $this->exceptionWrongFormatter(Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting::class);
     }
     
-   /**
-    * 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');
@@ -261,25 +261,25 @@ 
         );
     }
     
-   /**
-    * 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, bool $normalize=false) : array
     {
         $restorer = new Mailcode_Parser_Safeguard_Restorer($this, $highlighted, $normalize);
         return $restorer->getReplaces();
     }
     
-   /**
-    * 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))
@@ -334,17 +334,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(
@@ -354,15 +354,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(
@@ -372,20 +372,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(
@@ -395,15 +395,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(
@@ -413,11 +413,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))
@@ -435,11 +435,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())
@@ -458,11 +458,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))
@@ -489,13 +489,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();
@@ -518,13 +518,13 @@ 
         );
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         $placeholders = $this->getPlaceholders();

src/Mailcode/Parser/Safeguard/Placeholder/Locator/Replacer.php

Indentation +32 added lines, -32 removed lines

@@ -32,49 +32,49 @@ 
     const ERROR_COULD_NOT_FIND_PLACEHOLDER_TEXT = 63502;
     const ERROR_PLACEHOLDER_POSITION_ERRONEOUS = 63503;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $replacementText;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator
+     */
     private $locator;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location
+     */
     private $origin;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $placeholderText;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $offset = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $placeholderOffset = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $placeholderLength = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $lengthDifference = 0;
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator $locator, Mailcode_Parser_Safeguard_Placeholder_Locator_Location $origin, string $replacementText, string $subject)
@@ -93,11 +93,11 @@ 
         $this->adjustPositions();
     }
     
-   /**
-    * Adjusts the positions of all locations that come after 
-    * this one, to account for the added string length of the
-    * placeholder that has been replaced.
-    */
+    /**
+     * Adjusts the positions of all locations that come after 
+     * this one, to account for the added string length of the
+     * placeholder that has been replaced.
+     */
     private function adjustPositions() : void
     {
         $locations = $this->origin->getNextAll();

src/Mailcode/Parser/Safeguard/Placeholder/Locator/Location.php

Indentation +34 added lines, -34 removed lines

@@ -23,29 +23,29 @@ 
  */
 class Mailcode_Parser_Safeguard_Placeholder_Locator_Location
 {
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     private $placeholder;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $startPos;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $length;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $index;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator
+     */
     private $locator;
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator $locator, Mailcode_Parser_Safeguard_Placeholder $placeholder, int $index, int $startPos, int $length)
@@ -117,31 +117,31 @@ 
         return $this->getPrevious() !== null;
     }
     
-   /**
-    * Retrieves the placeholder location right after this one, if any.
-    * 
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
-    */
+    /**
+     * Retrieves the placeholder location right after this one, if any.
+     * 
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
+     */
     public function getNext() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location
     {
         return $this->locator->getLocationByIndex(($this->index-1));
     }
     
-   /**
-    * Retrieves the placeholder location right before this one, if any.
-    * 
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
-    */
+    /**
+     * Retrieves the placeholder location right before this one, if any.
+     * 
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
+     */
     public function getPrevious() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location
     {
         return $this->locator->getLocationByIndex(($this->index+1));
     }
     
-   /**
-    * Retrieves all placeholder locations that come after this one, if any.
-    * 
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
-    */
+    /**
+     * Retrieves all placeholder locations that come after this one, if any.
+     * 
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
+     */
     public function getNextAll() : array
     {
         $locations = $this->locator->getLocations();
@@ -149,10 +149,10 @@ 
         return array_slice($locations, $this->index+1);
     }
     
-   /**
-    * Called when the location has been moved in the subject string.
-    * @param int $offset
-    */
+    /**
+     * Called when the location has been moved in the subject string.
+     * @param int $offset
+     */
     public function updatePositionByOffset(int $offset) : void
     {
         $this->startPos += $offset;

src/Mailcode/Parser/Safeguard/Placeholder/Locator.php

Indentation +42 added lines, -42 removed lines

@@ -29,19 +29,19 @@ 
  */
 class Mailcode_Parser_Safeguard_Placeholder_Locator
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $subject;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     private $placeholder;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
+     */
     private $instances = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder $placeholder, string $subject)
@@ -52,11 +52,11 @@ 
         $this->localizeInstances();
     }
     
-   /**
-    * Attempts to find the placeholder's instances in the
-    * target string, and returns a location instance for
-    * each, which allows accessing their exact position.
-    */
+    /**
+     * Attempts to find the placeholder's instances in the
+     * target string, and returns a location instance for
+     * each, which allows accessing their exact position.
+     */
     private function localizeInstances() : void
     {
         $lastPos = 0;
@@ -81,21 +81,21 @@ 
         }
     }
     
-   /**
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
-    */
+    /**
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[]
+     */
     public function getLocations() : array
     {
         return $this->instances;
     }
     
-   /**
-    * Retrieves a location by its index in the locations list (in 
-    * ascending order as found in the subject string, zero based.)
-    * 
-    * @param int $index
-    * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
-    */
+    /**
+     * Retrieves a location by its index in the locations list (in 
+     * ascending order as found in the subject string, zero based.)
+     * 
+     * @param int $index
+     * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL
+     */
     public function getLocationByIndex(int $index) : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location
     {
         if(isset($this->instances[$index]))
@@ -106,19 +106,19 @@ 
         return null;
     }
     
-   /**
-    * Replaces the placeholder at the location with the specified
-    * replacement text.
-    * 
-    * NOTE: The replacement text MUST contain the original placeholder
-    * for this to work. An exception will be triggered otherwise.
-    * 
-    * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location
-    * @param string $replacementText
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING
-    */
+    /**
+     * Replaces the placeholder at the location with the specified
+     * replacement text.
+     * 
+     * NOTE: The replacement text MUST contain the original placeholder
+     * for this to work. An exception will be triggered otherwise.
+     * 
+     * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location
+     * @param string $replacementText
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING
+     */
     public function replaceWith(Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location, string $replacementText) : void
     {
         $replacer = new Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer(
@@ -136,11 +136,11 @@ 
         $this->subject = $subject;
     }
     
-   /**
-    * Retrieves the subject string, with all changes that were made, if any. 
-    *  
-    * @return string
-    */
+    /**
+     * Retrieves the subject string, with all changes that were made, if any. 
+     *  
+     * @return string
+     */
     public function getSubjectString() : string
     {
         return $this->subject;