Mistralys / mailcode

src/Mailcode/Parser/Statement/Tokenizer/Token/Operand.php

Indentation +18 added lines, -18 removed lines

@@ -30,10 +30,10 @@ 
         return $this->getSign();
     }
     
-   /**
-    * Retrieves all known comparison operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known comparison operator signs.
+     * @return string[]
+     */
     public static function getComparisonSigns() : array
     {
         return array(
@@ -46,10 +46,10 @@ 
         );
     }
     
-   /**
-    * Retrieves all known arithmetic operator signs.
-    * @return string[]
-    */
+    /**
+     * Retrieves all known arithmetic operator signs.
+     * @return string[]
+     */
     public static function getArithmeticSigns() : array
     {
         return array(
@@ -60,11 +60,11 @@ 
         );
     }
     
-   /**
-    * Whether the operator is comparison related (equals, not equals, smaller, greater...).
-    *  
-    * @return bool
-    */
+    /**
+     * Whether the operator is comparison related (equals, not equals, smaller, greater...).
+     *  
+     * @return bool
+     */
     public function isComparator() : bool
     {
         return 
@@ -76,11 +76,11 @@ 
         $this->isSmallerOrEquals();
     }
     
-   /**
-    * Whether the operator is calculation related (minus, plus, divide, multiply).
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the operator is calculation related (minus, plus, divide, multiply).
+     * 
+     * @return bool
+     */
     public function isCalculator() : bool
     {
         return 

src/Mailcode/Commands/Command/For.php

Indentation +9 added lines, -9 removed lines

@@ -27,19 +27,19 @@
     const VALIDATION_WRONG_KEYWORD = 49702;
     const VALIDATION_VARIABLE_NAME_IS_THE_SAME = 49703;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private $loopVar;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private $sourceVar;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     private $keyword;
     
     public function getName() : string

src/Mailcode/Factory.php

Indentation +68 added lines, -68 removed lines

@@ -23,17 +23,17 @@ 
     const ERROR_INVALID_COMMAND_CREATED = 50001;
     const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
 
-   /**
-    * @var Mailcode_Factory_CommandSets
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets
+     */
     private static $commandSets;
     
-   /**
-    * Creates a ShowVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowVariable
-    */
+    /**
+     * Creates a ShowVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowVariable
+     */
     public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
     {
         return self::$commandSets->show()->showVar($variableName);
@@ -52,41 +52,41 @@ 
         return self::$commandSets->show()->showDate($variableName, $formatString);
     }
 
-   /**
-    * Creates a ShowSnippet command.
-    *
-    * @param string $snippetName A snippet name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowSnippet
-    */
+    /**
+     * Creates a ShowSnippet command.
+     *
+     * @param string $snippetName A snippet name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowSnippet
+     */
     public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
     {
         return self::$commandSets->show()->showSnippet($snippetName);
     }
     
-   /**
-    * Creates a SetVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @param string $value
-    * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
-    * @return Mailcode_Commands_Command_SetVariable
-    * @throws Mailcode_Factory_Exception
-    * 
-    * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
-    */
+    /**
+     * Creates a SetVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @param string $value
+     * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
+     * @return Mailcode_Commands_Command_SetVariable
+     * @throws Mailcode_Factory_Exception
+     * 
+     * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
+     */
     public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
     {
         return self::$commandSets->set()->setVar($variableName, $value, $quoteValue);
     }
     
-   /**
-    * Like setVar(), but treats the value as a string literal
-    * and automatically adds quotes to it.
-    * 
-    * @param string $variableName
-    * @param string $value
-    * @return Mailcode_Commands_Command_SetVariable
-    */
+    /**
+     * Like setVar(), but treats the value as a string literal
+     * and automatically adds quotes to it.
+     * 
+     * @param string $variableName
+     * @param string $value
+     * @return Mailcode_Commands_Command_SetVariable
+     */
     public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
     {
         return self::$commandSets->set()->setVar($variableName, $value, true);
@@ -212,14 +212,14 @@ 
         return self::$commandSets->if()->ifContains($variable, array($search), $caseInsensitive);
     }
     
-   /**
-    * Creates if contains command, with several search terms.
-    * 
-    * @param string $variable
-    * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
-    * @param bool $caseInsensitive
-    * @return Mailcode_Commands_Command_If_Contains
-    */
+    /**
+     * Creates if contains command, with several search terms.
+     * 
+     * @param string $variable
+     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
+     * @param bool $caseInsensitive
+     * @return Mailcode_Commands_Command_If_Contains
+     */
     public static function ifContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
     {
         return self::$commandSets->if()->ifContains($variable, $searchTerms, $caseInsensitive);
@@ -230,14 +230,14 @@ 
         return self::$commandSets->elseIf()->elseIfContains($variable, array($search), $caseInsensitive);
     }
     
-   /**
-    * Creates else if contains command, with several search terms.
-    * 
-    * @param string $variable
-    * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
-    * @param bool $caseInsensitive
-    * @return Mailcode_Commands_Command_ElseIf_Contains
-    */
+    /**
+     * Creates else if contains command, with several search terms.
+     * 
+     * @param string $variable
+     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
+     * @param bool $caseInsensitive
+     * @return Mailcode_Commands_Command_ElseIf_Contains
+     */
     public static function elseIfContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
     {
         return self::$commandSets->elseIf()->elseIfContains($variable, $searchTerms, $caseInsensitive);
@@ -258,34 +258,34 @@ 
         return self::$commandSets->misc()->for($sourceVariable, $loopVariable);
     }
     
-   /**
-    * 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();

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();