Mistralys / mailcode

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +56 added lines, -56 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_TOKENIZE_METHOD_MISSING = 49801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $operands = array(
         '==',
         '<=',
@@ -40,17 +40,17 @@ 
         '<'
     );
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $keywords = array(
         'in:',
         'insensitive:'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '§§';
     
     /**
@@ -67,19 +67,19 @@ 
         'extract_tokens'
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenized;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokensTemporary = array();
     
     /**
@@ -87,9 +87,9 @@ 
      */
     protected $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $ids = array();
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -99,12 +99,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;
@@ -115,11 +115,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();
@@ -127,11 +127,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown()
     {
         $result = array();
@@ -201,13 +201,13 @@ 
         }
     }
    
-   /**
-    * Registers a token to add in the statement string.
-    * 
-    * @param string $type
-    * @param string $matchedText
-    * @param mixed $subject
-    */
+    /**
+     * Registers a token to add in the statement string.
+     * 
+     * @param string $type
+     * @param string $matchedText
+     * @param mixed $subject
+     */
     protected function registerToken(string $type, string $matchedText, $subject=null) : void
     {
         $tokenID = $this->generateID();
@@ -236,11 +236,11 @@ 
         return null;
     }
     
-   /**
-    * Some WYSIWYG editors like using pretty quotes instead
-    * of the usual double quotes. This simply replaces all
-    * occurrences with the regular variant.
-    */
+    /**
+     * Some WYSIWYG editors like using pretty quotes instead
+     * of the usual double quotes. This simply replaces all
+     * occurrences with the regular variant.
+     */
     protected function tokenize_normalize_quotes() : void
     {
         $this->tokenized = str_replace(array('“', '”'), '"', $this->tokenized);
@@ -329,13 +329,13 @@ 
         }
     }
     
-   /**
-    * 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/Safeguard/Formatter/SingleLines.php

Indentation +13 added lines, -13 removed lines

@@ -23,14 +23,14 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $eol;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $eolLength;
     
     protected function initFormatting(string $subject) : string
@@ -51,13 +51,13 @@ 
         return $this->eolLength;
     }
 
-   /**
-    * We only use placeholders that contain commands that do
-    * not generate contents, since these are the only ones
-    * that may need adjusting.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * We only use placeholders that contain commands that do
+     * not generate contents, since these are the only ones
+     * that may need adjusting.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         $placeholders = $this->safeguard->getPlaceholders();

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

Indentation +17 added lines, -17 removed lines

@@ -23,24 +23,24 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines_Location extends Mailcode_Parser_Safeguard_FormatterLocation
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $prepend = false;
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $append = false;
     
     protected function init() : void
@@ -52,11 +52,11 @@ 
         $this->analyzeAppend();
     }
     
-   /**
-    * Whether an EOL character needs to be appended or prepended.
-    *  
-    * @return bool
-    */
+    /**
+     * Whether an EOL character needs to be appended or prepended.
+     *  
+     * @return bool
+     */
     public function requiresAdjustment() : bool
     {
         return $this->requiresAppend() || $this->requiresPrepend();

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

Indentation +28 added lines, -28 removed lines

@@ -24,9 +24,9 @@ 
 {
     const COMMAND_MARKER = '__MAILCODE_COMMAND__';
     
-   /**
-    * @var array<int,array<int,string>>
-    */
+    /**
+     * @var array<int,array<int,string>>
+     */
     private $tagAncestry;
     
     protected function init() : void
@@ -49,18 +49,18 @@ 
     {
         if($this->isInTagAttributes() || $this->isInExcludedTag()) 
         {
-           return false; 
+            return false; 
         }
         
         return true;
     }
     
-   /**
-    * 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->location->getStartPosition();
@@ -80,12 +80,12 @@ 
         return mb_substr($subject, 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
+     */
     private function isInExcludedTag() : bool
     {
         $tagNames = $this->getParentTags();
@@ -101,12 +101,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
     {
         // Create a stack of all direct parent tags of the command.
@@ -129,12 +129,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
+     */
     private function isInTagAttributes() : bool
     {
         // This check is easy: if the command is in the attribute

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

Indentation +22 added lines, -22 removed lines

@@ -22,9 +22,9 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting extends Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     private $excludeTags = array(
         'style', // NOTE: style tags are excluded natively on the parser level.
         'script'
@@ -35,13 +35,13 @@ 
         return $subject;
     }
     
-   /**
-    * Adds an HTML tag name to the list of tags within which
-    * commands may not be highlighted.
-    * 
-    * @param string $tagName Case insensitive.
-    * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
-    */
+    /**
+     * Adds an HTML tag name to the list of tags within which
+     * commands may not be highlighted.
+     * 
+     * @param string $tagName Case insensitive.
+     * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
+     */
     public function excludeTag(string $tagName) : Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
     {
         $tagName = strtolower($tagName);
@@ -54,12 +54,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds several exluded tag names at once.
-    * 
-    * @param string[] $tagNames
-    * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
-    */
+    /**
+     * Adds several exluded tag names at once.
+     * 
+     * @param string[] $tagNames
+     * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
+     */
     public function excludeTags(array $tagNames) : Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting
     {
         foreach($tagNames as $tagName)
@@ -70,12 +70,12 @@ 
         return $this;
     }
     
-   /**
-    * Whether the specified tag name is in the exlusion list.
-    * 
-    * @param string $tagName
-    * @return bool
-    */
+    /**
+     * Whether the specified tag name is in the exlusion list.
+     * 
+     * @param string $tagName
+     * @return bool
+     */
     public function isTagExcluded(string $tagName) : bool
     {
         $tagName = strtolower($tagName);

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +12 added lines, -12 removed lines

@@ -24,9 +24,9 @@ 
  */
 abstract class Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     protected $safeguard;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard)
@@ -88,12 +88,12 @@ 
         return $locator->getSubjectString();
     }
     
-   /**
-    * 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);
@@ -106,9 +106,9 @@ 
         return PHP_EOL;
     }
     
-   /**
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         return $this->safeguard->getPlaceholders();

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

Indentation +32 added lines, -32 removed lines

@@ -29,49 +29,49 @@ 
     const ERROR_PLACEHOLDER_STRING_MISSING = 63501;
     const ERROR_COULD_NOT_FIND_PLACEHOLDER_TEXT = 63502;
     
-   /**
-    * @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 $prefixLength = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $placeholderLength = 0;
 
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private $lengthDifference = 0;
     
     public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator_Location $origin, string $replacementText, string $subject)
@@ -91,11 +91,11 @@ 
         return $this->subject;
     }
     
-   /**
-    * 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 +30 added lines, -30 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)
@@ -112,31 +112,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();

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(
@@ -130,11 +130,11 @@ 
         $this->subject = $replacer->replace();
     }
     
-   /**
-    * 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;