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/Translator/Syntax.php

Indentation +14 added lines, -14 removed lines

@@ -24,9 +24,9 @@ 
     public const ERROR_UNKNOWN_COMMAND_TYPE = 50401;
     public const ERROR_INVALID_COMMAND_INSTANCE = 50402;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $typeID;
     
     public function __construct(string $typeID)
@@ -34,22 +34,22 @@ 
         $this->typeID = $typeID;
     }
     
-   /**
-    * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
-    * @return string
-    */
+    /**
+     * Retrieves the syntax' type ID, e.g. "ApacheVelocity".
+     * @return string
+     */
     public function getTypeID() : string
     {
         return $this->typeID;
     }
     
-   /**
-    * Translates a single command to the target syntax.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @throws Mailcode_Translator_Exception
-    * @return string
-    */
+    /**
+     * Translates a single command to the target syntax.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @throws Mailcode_Translator_Exception
+     * @return string
+     */
     public function translateCommand(Mailcode_Commands_Command $command) : string
     {
         return $this->createTranslator($command)->translate($command);

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.php

Indentation +40 added lines, -40 removed lines

@@ -28,21 +28,21 @@ 
     public const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903;
     public const ERROR_INVALID_COMMAND_CLASS = 45904;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     private $commands = array();
     
-   /**
-    * @var array<string,Mailcode_Commands_Command>
-    */
+    /**
+     * @var array<string,Mailcode_Commands_Command>
+     */
     private static $dummyCommands = array();
     
-   /**
-    * Retrieves a list of all available command IDs.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all available command IDs.
+     * 
+     * @return string[]
+     */
     public function getIDs() : array
     {
         static $ids = array();
@@ -88,12 +88,12 @@ 
         return $result;
     }
     
-   /**
-    * Gets an available command by its ID.
-    * 
-    * @param string $id
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Gets an available command by its ID.
+     * 
+     * @param string $id
+     * @return Mailcode_Commands_Command
+     */
     public function getByID(string $id) : Mailcode_Commands_Command
     {
         static $instances = array();
@@ -106,15 +106,15 @@ 
         return $instances[$id];
     }
     
-   /**
-    * Retrieves the ID of a command by its name.
-    * 
-    * @param string $name
-    * @throws Mailcode_Exception
-    * @return string
-    * 
-    * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
-    */
+    /**
+     * Retrieves the ID of a command by its name.
+     * 
+     * @param string $name
+     * @throws Mailcode_Exception
+     * @return string
+     * 
+     * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
+     */
     public function getIDByName(string $name) : string
     {
         $items = $this->getAll();
@@ -143,12 +143,12 @@ 
         return in_array($id, $ids);
     }
     
-   /**
-    * Checks wether the specified name exists.
-    * 
-    * @param string $name For example: "showvar".
-    * @return bool
-    */
+    /**
+     * Checks wether the specified name exists.
+     * 
+     * @param string $name For example: "showvar".
+     * @return bool
+     */
     public function nameExists(string $name) : bool
     {
         $items = $this->getAll();
@@ -216,14 +216,14 @@ 
         return $class;
     }
     
-   /**
-    * Translates the command type to the expected class naming scheme.
-    * 
-    * Example: not-empty => NotEmpty
-    * 
-    * @param string $type
-    * @return string
-    */
+    /**
+     * Translates the command type to the expected class naming scheme.
+     * 
+     * Example: not-empty => NotEmpty
+     * 
+     * @param string $type
+     * @return string
+     */
     private function adjustTypeName(string $type) : string
     {
         $type = str_replace('-', ' ', $type);

src/Mailcode/Date/FormatInfo.php

Indentation +39 added lines, -39 removed lines

@@ -31,24 +31,24 @@ 
     public const CHARTYPE_TIME = 'time';
     public const CHARTYPE_PUNCTUATION = 'punctuation';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $defaultFormat = "Y/m/d";
     
-   /**
-    * @var Mailcode_Date_FormatInfo_Character[]
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo_Character[]
+     */
     private $formatChars = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     private $allowedChars = array();
     
-   /**
-    * @var Mailcode_Date_FormatInfo|NULL
-    */
+    /**
+     * @var Mailcode_Date_FormatInfo|NULL
+     */
     private static $instance;
     
     private function __construct()
@@ -66,11 +66,11 @@ 
         return self::$instance;
     }
 
-   /**
-    * Initialized the list of allowed date formatting
-    * characters. This is done only once per request
-    * by storing them statically for performance reasons.
-    */
+    /**
+     * Initialized the list of allowed date formatting
+     * characters. This is done only once per request
+     * by storing them statically for performance reasons.
+     */
     private function initCharacters() : void
     {
         $chars = array(
@@ -115,16 +115,16 @@ 
         $this->defaultFormat = $formatString;
     }
     
-   /**
-    * Validates the date format string, by ensuring that
-    * all the characters it is composed of are known.
-    *
-    * @param string $formatString
-    * @return OperationResult
-    * 
-    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
-    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
-    */
+    /**
+     * Validates the date format string, by ensuring that
+     * all the characters it is composed of are known.
+     *
+     * @param string $formatString
+     * @return OperationResult
+     * 
+     * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
+     * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
+     */
     public function validateFormat(string $formatString) : OperationResult
     {
         $result = new OperationResult($this);
@@ -163,23 +163,23 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all characters that are allowed to
-    * be used in a date format string, with information
-    * on each.
-    *
-    * @return Mailcode_Date_FormatInfo_Character[]
-    */
+    /**
+     * Retrieves all characters that are allowed to
+     * be used in a date format string, with information
+     * on each.
+     *
+     * @return Mailcode_Date_FormatInfo_Character[]
+     */
     public function getCharactersList() : array
     {
         return $this->formatChars;
     }
     
-   /**
-    * Retrieves the characters list, grouped by type label.
-    * 
-    * @return array<string,array<int,Mailcode_Date_FormatInfo_Character>>
-    */
+    /**
+     * Retrieves the characters list, grouped by type label.
+     * 
+     * @return array<string,array<int,Mailcode_Date_FormatInfo_Character>>
+     */
     public function getCharactersGrouped() : array
     {
         $grouped = array();

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/Commands/Command/SetVariable.php

Indentation +6 added lines, -6 removed lines

@@ -20,9 +20,9 @@ 
  */
 class Mailcode_Commands_Command_SetVariable extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private $variableToken;
     
     public function getName() : string
@@ -153,9 +153,9 @@ 
         );
     }
     
-   /**
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getAssignmentTokens() : array
     {
         $params = $this->requireParams()->getInfo()->getTokens();

src/Mailcode/Commands/Command/For.php

Indentation +9 added lines, -9 removed lines

@@ -33,19 +33,19 @@
     public const VALIDATION_VARIABLE_NAME_WITH_DOT = 49704;
     public const VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT = 49705;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $loopVar = null;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $sourceVar = null;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     private ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword $keyword = null;
     
     public function getName() : string

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