Mistralys / mailcode

src/Mailcode/Parser.php

Indentation +21 added lines, -21 removed lines

@@ -42,11 +42,11 @@ 
         $this->commands = $this->mailcode->getCommands();
     }
     
-   /**
-    * Gets the regex format string used to detect commands.
-    * 
-    * @return string
-    */
+    /**
+     * Gets the regex format string used to detect commands.
+     * 
+     * @return string
+     */
     protected static function getRegex() : string
     {
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
@@ -183,14 +183,14 @@ 
         throw new Mailcode_Exception('Not a command', '', self::ERROR_NOT_A_COMMAND);
     }
     
-   /**
-    * Parses a single regex match: determines which named group
-    * matches, and retrieves the according information.
-    * 
-    * @param array<int,array<int,string>>$matches The regex results array.
-    * @param int $index The matched index.
-    * @return Mailcode_Parser_Match
-    */
+    /**
+     * Parses a single regex match: determines which named group
+     * matches, and retrieves the according information.
+     * 
+     * @param array<int,array<int,string>>$matches The regex results array.
+     * @param int $index The matched index.
+     * @return Mailcode_Parser_Match
+     */
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
     {
         $name = ''; // the command name, e.g. "showvar"
@@ -228,14 +228,14 @@ 
         );
     }
     
-   /**
-    * Creates an instance of the safeguard tool, which
-    * is used to safeguard commands in a string with placeholders.
-    * 
-    * @param string $subject The string to use to safeguard commands in.
-    * @return Mailcode_Parser_Safeguard
-    * @see Mailcode_Parser_Safeguard
-    */
+    /**
+     * Creates an instance of the safeguard tool, which
+     * is used to safeguard commands in a string with placeholders.
+     * 
+     * @param string $subject The string to use to safeguard commands in.
+     * @return Mailcode_Parser_Safeguard
+     * @see Mailcode_Parser_Safeguard
+     */
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
     {
         return new Mailcode_Parser_Safeguard($this, $subject);

src/Mailcode/Factory.php

Indentation +19 added lines, -19 removed lines

@@ -28,8 +28,8 @@ 
     public const URL_ENCODING_DECODE = 'decode';
 
     /**
-    * @var Mailcode_Factory_CommandSets|NULL
-    */
+     * @var Mailcode_Factory_CommandSets|NULL
+     */
     private static ?Mailcode_Factory_CommandSets $commandSets = null;
 
     /**
@@ -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();

src/Mailcode/Commands/Command.php

Indentation +46 added lines, -46 removed lines

@@ -45,44 +45,44 @@ 
 
     public const META_URL_ENCODING = 'url_encoding';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $type = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $paramsString = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $hash = '';
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected OperationResult $validationResult;
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected Mailcode $mailcode;
     
-   /**
-    * @var Mailcode_Parser_Statement|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement|NULL
+     */
     protected ?Mailcode_Parser_Statement $params = null;
 
-   /**
-    * @var string[] 
-    */
+    /**
+     * @var string[] 
+     */
     protected array $validations = array(
         Mailcode_Interfaces_Commands_Validation_EmptyParams::VALIDATION_NAME_EMPTY_PARAMS,
         Mailcode_Interfaces_Commands_Validation_ParamKeywords::VALIDATION_NAME_KEYWORDS,
@@ -91,24 +91,24 @@ 
         Mailcode_Interfaces_Commands_Validation_TypeUnsupported::VALIDATION_NAME_TYPE_UNSUPPORTED
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $comment = '';
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords|NULL
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords|NULL
+     */
     protected ?Mailcode_Commands_LogicKeywords $logicKeywords = null;
     
-   /**
-    * @var Mailcode_Parser_Statement_Validator|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Validator|NULL
+     */
     protected ?Mailcode_Parser_Statement_Validator $validator = null;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private bool $validated = false;
 
     /**
@@ -143,13 +143,13 @@ 
         
     }
 
-   /**
-    * Sets the command's parent opening command, if any.
-    * NOTE: This is set automatically by the parser, and
-    * should not be called manually.
-    *
-    * @param Mailcode_Commands_Command $command
-    */
+    /**
+     * Sets the command's parent opening command, if any.
+     * NOTE: This is set automatically by the parser, and
+     * should not be called manually.
+     *
+     * @param Mailcode_Commands_Command $command
+     */
     public function setParent(Mailcode_Commands_Command $command) : void
     {
         $this->parent = $command;
@@ -295,9 +295,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
 
     protected function _validateNesting() : void

src/Mailcode/Collection.php

Indentation +28 added lines, -28 removed lines

@@ -26,9 +26,9 @@ 
     public const ERROR_CANNOT_MODIFY_FINALIZED = 52302;
     public const ERROR_NO_VALIDATION_RESULT_AVAILABLE = 52303;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected array $commands = array();
     
     /**
@@ -63,21 +63,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);
@@ -98,12 +98,12 @@ 
         $this->commands = $keep;
     }
     
-   /**
-    * 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() : array
     {
         $this->validate();
@@ -357,10 +357,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 Mailcode_Collection_TypeFilter::getShowVariableCommands($this->commands);
@@ -374,11 +374,11 @@ 
         return Mailcode_Collection_TypeFilter::getForCommands($this->commands);
     }
 
-   /**
-    * 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 Mailcode_Collection_TypeFilter::getShowDateCommands($this->commands);

src/Mailcode/Styler.php

Indentation +29 added lines, -29 removed lines

@@ -25,14 +25,14 @@ 
 {
     public const ERROR_CSS_FILE_NOT_FOUND = 60901;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private string $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private string $fileName = 'highlight.css';
     
     public function __construct()
@@ -55,22 +55,22 @@ 
         $this->path = $path;
     }
    
-   /**
-    * Retrieves the raw CSS source for the highlighting.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the raw CSS source for the highlighting.
+     * 
+     * @return string
+     */
     public function getCSS() : string
     {
         return FileHelper::readContents($this->path);
     }
     
-   /**
-    * Retrieves a fully formed `code` tag with the CSS,
-    * to inject inline into an HTML document.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a fully formed `code` tag with the CSS,
+     * to inject inline into an HTML document.
+     * 
+     * @return string
+     */
     public function getStyleTag() : string
     {
         return sprintf(
@@ -79,23 +79,23 @@ 
         );
     }
     
-   /**
-    * Retrieves the path to the stylesheet file.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path to the stylesheet file.
+     * 
+     * @return string
+     */
     public function getStylesheetPath() : string
     {
         return $this->path;
     }
     
-   /**
-    * Retrieves the URL to the stylesheet file, given the
-    * local URL to the application's vendor folder.
-    *  
-    * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
-    * @return string
-    */
+    /**
+     * Retrieves the URL to the stylesheet file, given the
+     * local URL to the application's vendor folder.
+     *  
+     * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
+     * @return string
+     */
     public function getStylesheetURL(string $vendorURL) : string
     {
         return sprintf(

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected bool $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::show()->var($variableName));

src/Mailcode/Variables.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 {
     public const REGEX_VARIABLE_NAME = '/\$\s*([A-Z0-9_]+)\s*\.\s*([A-Z0-9_]+)|\$\s*([A-Z0-9_]+)/six';
     
-   /**
-    * @var Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * @var Mailcode_Variables_Collection_Regular
+     */
     protected Mailcode_Variables_Collection_Regular $collection;
 
     /**

src/Mailcode/Parser/Match.php

Indentation +12 added lines, -12 removed lines

@@ -23,24 +23,24 @@
  */
 class Mailcode_Parser_Match
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $params;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $matchedString;
     
     public function __construct(string $name, string $type, string $params, string $matchedString)

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

Indentation +11 added lines, -11 removed lines

@@ -24,9 +24,9 @@ 
     protected string $matchedText;
     private ?Mailcode_Commands_Command $sourceCommand;
 
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $subject;
 
     /**
@@ -58,20 +58,20 @@ 
         return $this->sourceCommand;
     }
     
-   /**
-    * The ID of the type. i.e. the class name ("Keyword", "StringLiteral").
-    * @return string
-    */
+    /**
+     * The ID of the type. i.e. the class name ("Keyword", "StringLiteral").
+     * @return string
+     */
     public function getTypeID() : string
     {
         $parts = explode('_', get_class($this));
         return array_pop($parts);
     }
     
-   /**
-    * Retrieves a unique ID of the token.
-    * @return string  
-    */
+    /**
+     * Retrieves a unique ID of the token.
+     * @return string  
+     */
     public function getID() : string
     {
         return $this->tokenID;