Mistralys / mailcode

src/Mailcode/Traits/Formatting/HTMLHighlighting.php

Indentation +26 added lines, -26 removed lines

@@ -23,25 +23,25 @@ 
  */
 trait Mailcode_Traits_Formatting_HTMLHighlighting
 {
-   /**
-    * Stored this way so we can use isset() instead
-    * of using in_array, which is some magnitudes slower.
-    * The boolean value is not used otherwise.
-    *
-    * @var array<string,bool>
-    */
+    /**
+     * Stored this way so we can use isset() instead
+     * of using in_array, which is some magnitudes slower.
+     * The boolean value is not used otherwise.
+     *
+     * @var array<string,bool>
+     */
     private $excludeTags = array(
         'style' => true, // NOTE: style tags are excluded natively on the parser level.
         'script' => true
     );
     
-   /**
-    * Adds an HTML tag name to the list of tags within which
-    * commands may not be highlighted.
-    *
-    * @param string $tagName Case insensitive.
-    * @return $this
-    */
+    /**
+     * Adds an HTML tag name to the list of tags within which
+     * commands may not be highlighted.
+     *
+     * @param string $tagName Case insensitive.
+     * @return $this
+     */
     public function excludeTag(string $tagName)
     {
         $tagName = strtolower($tagName);
@@ -51,12 +51,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds several exluded tag names at once.
-    *
-    * @param string[] $tagNames
-    * @return $this
-    */
+    /**
+     * Adds several exluded tag names at once.
+     *
+     * @param string[] $tagNames
+     * @return $this
+     */
     public function excludeTags(array $tagNames)
     {
         foreach($tagNames as $tagName)
@@ -67,12 +67,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/Traits/Commands/Validation/CaseSensitive.php

Indentation +6 added lines, -6 removed lines

@@ -26,14 +26,14 @@
  */
 trait Mailcode_Traits_Commands_Validation_CaseSensitive
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $caseInsensitive = false;
 
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     protected $regexToken;
     
     protected function validateSyntax_case_sensitive() : void

src/Mailcode/Parser/Statement/Validator.php

Indentation +16 added lines, -16 removed lines

@@ -28,9 +28,9 @@ 
  */
 class Mailcode_Parser_Statement_Validator
 {
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     private $statement;
     
     public function __construct(Mailcode_Parser_Statement $statement)
@@ -38,24 +38,24 @@ 
         $this->statement = $statement;
     }
     
-   /**
-    * Creates a variable validator: checks whether a single
-    * variable token is present in the parameters.
-    * 
-    * @return Mailcode_Parser_Statement_Validator_Type_Variable
-    */
+    /**
+     * Creates a variable validator: checks whether a single
+     * variable token is present in the parameters.
+     * 
+     * @return Mailcode_Parser_Statement_Validator_Type_Variable
+     */
     public function createVariable() : Mailcode_Parser_Statement_Validator_Type_Variable
     {
         return new Mailcode_Parser_Statement_Validator_Type_Variable($this->statement);
     }
     
-   /**
-    * Creates a keyword validator: checks whether a single
-    * keyword token is present in the parameters.
-    * 
-    * @param string $keywordName
-    * @return Mailcode_Parser_Statement_Validator_Type_Keyword
-    */
+    /**
+     * Creates a keyword validator: checks whether a single
+     * keyword token is present in the parameters.
+     * 
+     * @param string $keywordName
+     * @return Mailcode_Parser_Statement_Validator_Type_Keyword
+     */
     public function createKeyword(string $keywordName) : Mailcode_Parser_Statement_Validator_Type_Keyword
     {
         return new Mailcode_Parser_Statement_Validator_Type_Keyword(

src/Mailcode/Collection.php

Indentation +34 added lines, -34 removed lines

@@ -25,9 +25,9 @@ 
     const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301;
     const ERROR_CANNOT_MODIFY_FINALIZED = 52302;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -35,9 +35,9 @@ 
      */
     protected $errors = array();
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected $validationResult;
 
     /**
@@ -77,21 +77,21 @@ 
         return $this;
     }
     
-   /**
-    * Whether there are any commands in the collection.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there are any commands in the collection.
+     * 
+     * @return bool
+     */
     public function hasCommands() : bool
     {
         return !empty($this->commands);
     }
     
-   /**
-    * Counts the amount of commands in the collection.
-    * 
-    * @return int
-    */
+    /**
+     * Counts the amount of commands in the collection.
+     * 
+     * @return int
+     */
     public function countCommands() : int
     {
         return count($this->commands);
@@ -129,9 +129,9 @@ 
         $this->commands = $keep;
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -173,12 +173,12 @@ 
         return empty($errors);
     }
     
-   /**
-    * Retrieves all commands that were detected, in the exact order
-    * they were found.
-    * 
-    * @return Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected, in the exact order
+     * they were found.
+     * 
+     * @return Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
         $this->validate();
@@ -329,10 +329,10 @@ 
     }
 
     /**
-    * Retrieves only show variable commands in the collection, if any.
-    * 
-    * @return Mailcode_Commands_Command_ShowVariable[]
-    */
+     * Retrieves only show variable commands in the collection, if any.
+     * 
+     * @return Mailcode_Commands_Command_ShowVariable[]
+     */
     public function getShowVariableCommands(): array
     {
         return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class);
@@ -346,11 +346,11 @@ 
         return $this->getCommandsByClass(Mailcode_Commands_Command_For::class);
     }
 
-   /**
-    * Retrieves only show date commands in the collection, if any.
-    *
-    * @return Mailcode_Commands_Command_ShowDate[]
-    */
+    /**
+     * Retrieves only show date commands in the collection, if any.
+     *
+     * @return Mailcode_Commands_Command_ShowDate[]
+     */
     public function getShowDateCommands() : array
     {
         return $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class);

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

Indentation +6 added lines, -6 removed lines

@@ -26,14 +26,14 @@
  */
 trait Mailcode_Traits_Commands_Validation_Multiline
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $multiline = false;
 
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     protected $multilineToken;
     
     protected function validateSyntax_multiline() : void

src/Mailcode/Collection/NestingValidator.php

Indentation +9 added lines, -9 removed lines

@@ -30,19 +30,19 @@
     const VALIDATION_UNCLOSED_COMMAND = 49104;
     const VALIDATION_CLOSING_NON_OPENING_COMMAND = 49105;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult;
     
-   /**
-    * @var Mailcode_Commands_Command_Type[]
-    */
+    /**
+     * @var Mailcode_Commands_Command_Type[]
+     */
     protected $stack = array();
     
     public function __construct(Mailcode_Collection $collection)

src/Mailcode/Factory/CommandSets/Set.php

Indentation +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  */
 abstract class Mailcode_Factory_CommandSets_Set
 {
-   /**
-    * @var Mailcode_Factory_Instantiator
-    */
+    /**
+     * @var Mailcode_Factory_Instantiator
+     */
     protected $instantiator;
 
     /**

src/Mailcode/Parser/Safeguard.php

Indentation +144 added lines, -144 removed lines

@@ -54,45 +54,45 @@ 
     const ERROR_INVALID_COMMANDS = 47801;
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
 
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected $placeholders;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $delimiter = '999';
     
-   /**
-    * @var string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected $placeholderStrings;
 
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -111,28 +111,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);
@@ -148,15 +148,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();
@@ -164,16 +164,16 @@ 
         return $this->makeSafePartial();
     }
     
-   /**
-    * Like makeSafe(), but allows partial (invalid) commands: use this
-    * if the subject string may contain only part of the whole set of
-    * commands. 
-    * 
-    * Example: parsing a text with an opening if statement, without the 
-    * matching end statement.
-    * 
-    * @return string
-    */
+    /**
+     * Like makeSafe(), but allows partial (invalid) commands: use this
+     * if the subject string may contain only part of the whole set of
+     * commands. 
+     * 
+     * Example: parsing a text with an opening if statement, without the 
+     * matching end statement.
+     * 
+     * @return string
+     */
     public function makeSafePartial() : string
     {
         $placeholders = $this->getPlaceholders();
@@ -257,13 +257,13 @@ 
         $analyzer->analyze();
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formattings to use for the commands in the subject string.
-    * 
-    * @param Mailcode_StringContainer|string $subject
-    * @return Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * Creates a formatting handler, which can be used to specify
+     * which formattings to use for the commands in the subject string.
+     * 
+     * @param Mailcode_StringContainer|string $subject
+     * @return Mailcode_Parser_Safeguard_Formatting
+     */
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
     {
         if(is_string($subject))
@@ -274,12 +274,12 @@ 
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
     }
     
-   /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     public function getPlaceholders()
     {
         if(isset($this->placeholders))
@@ -355,16 +355,16 @@ 
         return $string;
     }
     
-   /**
-    * Makes the string whole again after transforming or filtering it,
-    * by replacing the command placeholders with the original commands.
-    *
-    * @param string $string
-    * @return string
-    * @throws Mailcode_Exception
-    *
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
-    */
+    /**
+     * Makes the string whole again after transforming or filtering it,
+     * by replacing the command placeholders with the original commands.
+     *
+     * @param string $string
+     * @return string
+     * @throws Mailcode_Exception
+     *
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
+     */
     public function makeWhole(string $string) : string
     {
         return $this->restore(
@@ -374,15 +374,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(
@@ -392,19 +392,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(
@@ -414,15 +414,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(
@@ -432,11 +432,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))
@@ -454,11 +454,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())
@@ -481,11 +481,11 @@ 
         throw $exception;
     }
     
-   /**
-    * 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))
@@ -512,13 +512,13 @@ 
         return in_array($subject, $ids, true);
     }
     
-   /**
-    * 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();
@@ -541,13 +541,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/Factory.php

Indentation +19 added lines, -19 removed lines

@@ -28,8 +28,8 @@ 
     const URL_ENCODING_DECODE = 'decode';
 
     /**
-    * @var Mailcode_Factory_CommandSets
-    */
+     * @var Mailcode_Factory_CommandSets
+     */
     private static $commandSets;
 
     /**
@@ -83,33 +83,33 @@ 
     }
 
     /**
-    * Creates a renderer instance, which can be used to easily
-    * create and convert commands to strings.
-    * 
-    * @return Mailcode_Renderer
-    */
+     * Creates a renderer instance, which can be used to easily
+     * create and convert commands to strings.
+     * 
+     * @return Mailcode_Renderer
+     */
     public static function createRenderer() : Mailcode_Renderer
     {
         return new Mailcode_Renderer();
     }
     
-   /**
-    * Creates a printer instance, which works like the renderer,
-    * but outputs the generated strings to standard output.
-    * 
-    * @return Mailcode_Printer
-    */
+    /**
+     * Creates a printer instance, which works like the renderer,
+     * but outputs the generated strings to standard output.
+     * 
+     * @return Mailcode_Printer
+     */
     public static function createPrinter() : Mailcode_Printer
     {
         return new Mailcode_Printer();
     }
     
-   /**
-    * Gets/creates the global instance of the date format info
-    * class, used to handle date formatting aspects.
-    * 
-    * @return Mailcode_Date_FormatInfo
-    */
+    /**
+     * Gets/creates the global instance of the date format info
+     * class, used to handle date formatting aspects.
+     * 
+     * @return Mailcode_Date_FormatInfo
+     */
     public static function createDateInfo() : Mailcode_Date_FormatInfo
     {
         return Mailcode_Date_FormatInfo::getInstance();