Mistralys / mailcode

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

Indentation +7 added lines, -7 removed lines

@@ -35,13 +35,13 @@
         }
     }
     
-   /**
-    * Resolves the string with which this location needs to be
-    * replaced.
-    * 
-    * @param Mailcode_Parser_Safeguard_Formatter_Location $location
-    * @return string
-    */
+    /**
+     * Resolves the string with which this location needs to be
+     * replaced.
+     * 
+     * @param Mailcode_Parser_Safeguard_Formatter_Location $location
+     * @return string
+     */
     private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string
     {
         if($location->requiresAdjustment())

src/Mailcode/Parser/Safeguard/Formatter/Type/SingleLines.php

Indentation +6 added lines, -6 removed lines

@@ -23,14 +23,14 @@
  */
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines extends Mailcode_Parser_Safeguard_Formatter_FormatType
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $eol;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $eolLength;
     
     protected function initFormatting() : void

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

Indentation +6 added lines, -6 removed lines

@@ -25,14 +25,14 @@
  */
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines_Location extends Mailcode_Parser_Safeguard_Formatter_Location
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol;
     
     protected function init() : void

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

Indentation +5 added lines, -5 removed lines

@@ -25,11 +25,11 @@
         return PHP_INT_MAX;
     }
 
-   /**
-    * Formats the specified string according to the formatter.
-    * Retrieve the updated string from the string container used
-    * to create the formatter, or use `getSubjectString()`.
-    */
+    /**
+     * Formats the specified string according to the formatter.
+     * Retrieve the updated string from the string container used
+     * to create the formatter, or use `getSubjectString()`.
+     */
     public function format() : void
     {
         $locations = $this->resolveLocations();

src/Mailcode/StringContainer.php

Indentation +66 added lines, -66 removed lines

@@ -26,39 +26,39 @@ 
     const ERROR_INVALID_CALLABLE = 65701;
     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/Parser/Safeguard/Formatter/Location.php

Indentation +44 added lines, -44 removed lines

@@ -24,34 +24,34 @@ 
 {
     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()->getPlaceholders();
@@ -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();
@@ -189,10 +189,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 @@ 
 {
     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)
@@ -93,12 +93,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()->getPlaceholders();
@@ -113,12 +113,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);
@@ -150,9 +150,9 @@ 
         );
     }
  
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

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

Indentation +36 added lines, -36 removed lines

@@ -24,14 +24,14 @@ 
 {
     const COMMAND_MARKER = '__MAILCODE_COMMAND__';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $ancestryChecked = false;
     
-   /**
-    * @var array<int,array<int,string>>
-    */
+    /**
+     * @var array<int,array<int,string>>
+     */
     private $tagAncestry = array();
     
     protected function init() : void
@@ -43,12 +43,12 @@ 
         return !$this->isInTagAttributes() && !$this->isInExcludedTag();
     }
     
-   /**
-    * Retrieves the part of the subject string that comes
-    * before the command.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the part of the subject string that comes
+     * before the command.
+     * 
+     * @return string
+     */
     private function getHaystackBefore() : string
     {
         $pos = $this->getStartPosition();
@@ -65,12 +65,12 @@ 
         return $this->subject->getSubstr(0, $pos).self::COMMAND_MARKER.'>';
     }
     
-   /**
-    * Whether the command is nested in one of the tags
-    * that have been added to the list of excluded tags.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the command is nested in one of the tags
+     * that have been added to the list of excluded tags.
+     * 
+     * @return bool
+     */
     protected function isInExcludedTag() : bool
     {
         $tagNames = $this->getParentTags();
@@ -86,12 +86,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of the command's parent HTML tags, from
-    * highest to lowest.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of the command's parent HTML tags, from
+     * highest to lowest.
+     * 
+     * @return string[]
+     */
     private function getParentTags() : array
     {
         $tags = $this->getTagAncestry();
@@ -116,12 +116,12 @@ 
         return $stack;
     }
     
-   /**
-    * Checks whether the command is located within the attributes
-    * of an HTML tag.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether the command is located within the attributes
+     * of an HTML tag.
+     * 
+     * @return bool
+     */
     protected function isInTagAttributes() : bool
     {
         $tags = $this->getTagAncestry();
@@ -139,12 +139,12 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a list of tag names that come as parents 
-    * above the command.
-    * 
-    * @return array<int,array<int,string>>
-    */
+    /**
+     * Retrieves a list of tag names that come as parents 
+     * above the command.
+     * 
+     * @return array<int,array<int,string>>
+     */
     private function getTagAncestry() : array
     {
         if($this->ancestryChecked)

src/Mailcode/Parser/Safeguard/Formatting.php

Indentation +67 added lines, -67 removed lines

@@ -32,29 +32,29 @@ 
     const ERROR_TOO_MANY_REPLACERS = 65902;
     const ERROR_NO_FORMATTERS_ADDED = 65903;
     
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     private $safeguard;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter[]
+     */
     private $formatters = array();
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     private $subject;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $applied = false;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $partial = false;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject)
@@ -96,17 +96,17 @@ 
         return $formatter;
     }
     
-   /**
-    * Adds a formatter that will surround all variables with
-    * markup to highlight them independently of command syntax
-    * highlighting.
-    * 
-    * This is used to mark variables visually even after commands
-    * have been replaced by the target system's post processing.
-    * Can be combined with a replacer and other formats.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
-    */
+    /**
+     * Adds a formatter that will surround all variables with
+     * markup to highlight them independently of command syntax
+     * highlighting.
+     * 
+     * This is used to mark variables visually even after commands
+     * have been replaced by the target system's post processing.
+     * Can be combined with a replacer and other formats.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
+     */
     public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
     {
         $formatter = $this->createMarkVariables();
@@ -200,11 +200,11 @@ 
         }
     }
     
-   /**
-    * Counts the amount of replacer formatters that have been added.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of replacer formatters that have been added.
+     * 
+     * @return int
+     */
     private function countReplacers() : int
     {
         $count = 0;
@@ -220,37 +220,37 @@ 
         return $count;
     }
 
-   /**
-    * Creates a formatter that adds HTML syntax highlighting
-    * for all commands in the specified string, intelligently
-    * checking the location of the commands to ensure that they
-    * can be syntax highlighted.
-    * 
-    * For example, commands in HTML attributes will not be
-    * highlighted, as this would break the HTML.
-    *  
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
-    */
+    /**
+     * Creates a formatter that adds HTML syntax highlighting
+     * for all commands in the specified string, intelligently
+     * checking the location of the commands to ensure that they
+     * can be syntax highlighted.
+     * 
+     * For example, commands in HTML attributes will not be
+     * highlighted, as this would break the HTML.
+     *  
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
+     */
     public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this);
     }
 
-   /**
-    * Creates the formatter that ensures that all commands
-    * are placed on a separate line in the subject string.
-    */
+    /**
+     * Creates the formatter that ensures that all commands
+     * are placed on a separate line in the subject string.
+     */
     public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this);
     }
     
-   /**
-    * Creates the formatter that replaces all commands by
-    * their normalized variants.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
-    */
+    /**
+     * Creates the formatter that replaces all commands by
+     * their normalized variants.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
+     */
     public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized
     {
         return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this);
@@ -273,26 +273,26 @@ 
         return $this->subject->getString();
     }
 
-   /**
-    * Whether the formatting is done partially: missing placeholders
-    * will simply be ignored.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the formatting is done partially: missing placeholders
+     * will simply be ignored.
+     * 
+     * @return bool
+     */
     public function isPartial() : bool
     {
         return $this->partial;
     }
     
-   /**
-    * The formatting will ignore missing placeholders. Use this if the
-    * formatting will be done on a text that may not contain all of the
-    * initial placeholders anymore.
-    * 
-    * This is like the safeguard's makeWholePartial() method.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * The formatting will ignore missing placeholders. Use this if the
+     * formatting will be done on a text that may not contain all of the
+     * initial placeholders anymore.
+     * 
+     * This is like the safeguard's makeWholePartial() method.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function makePartial() : Mailcode_Parser_Safeguard_Formatting
     {
         $this->partial = true;