Mistralys / mailcode

src/Mailcode/Parser/Statement.php

Indentation +13 added lines, -13 removed lines

@@ -26,24 +26,24 @@ 
     public const VALIDATION_EMPTY = 48801;
     public const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected OperationResult $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected Mailcode_Parser_Statement_Tokenizer $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected ?Mailcode_Parser_Statement_Info $info = null;
 
     /**
@@ -138,7 +138,7 @@ 
         if($unknown)
         {
             $this->result->makeError(
-               t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
+                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
             );
         }

src/Mailcode/Parser/Safeguard.php

Indentation +146 added lines, -146 removed lines

@@ -54,40 +54,40 @@ 
     public const ERROR_NO_PLACEHOLDER_FOR_COMMAND = 47805;
     public const ERROR_NO_FIRST_PLACEHOLDER = 47806;
 
-   /**
-    * @var Mailcode_Parser
-    */
+    /**
+     * @var Mailcode_Parser
+     */
     protected Mailcode_Parser $parser;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $commands;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $originalString;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected Mailcode_Collection $collection;
     
-   /**
-    * Counter for the placeholders, global for all placeholders.
-    * @var integer
-    */
+    /**
+     * Counter for the placeholders, global for all placeholders.
+     * @var integer
+     */
     private static int $counter = 0;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_PlaceholderCollection|NULL
+     */
     protected ?Mailcode_Parser_Safeguard_PlaceholderCollection $placeholders = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $delimiter = '999';
     
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -106,28 +106,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);
@@ -143,15 +143,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();
@@ -159,16 +159,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->getPlaceholdersCollection()->getAll();
@@ -218,13 +218,13 @@ 
         $analyzer->analyze();
     }
     
-   /**
-    * Creates a formatting handler, which can be used to specify
-    * which formatting 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 formatting 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))
@@ -249,11 +249,11 @@ 
     }
 
     /**
-    * Retrieves all placeholders that have to be added to
-    * the subject text.
-    * 
-    * @return Mailcode_Parser_Safeguard_PlaceholderCollection
-    */
+     * Retrieves all placeholders that have to be added to
+     * the subject text.
+     * 
+     * @return Mailcode_Parser_Safeguard_PlaceholderCollection
+     */
     public function getPlaceholdersCollection() : Mailcode_Parser_Safeguard_PlaceholderCollection
     {
         if(isset($this->placeholders))
@@ -313,16 +313,16 @@ 
         return $formatting->toString();
     }
 
-   /**
-    * 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(
@@ -332,15 +332,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(
@@ -350,19 +350,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(
@@ -372,15 +372,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(
@@ -390,11 +390,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the command collection contained in the string.
-    * 
-    * @return Mailcode_Collection
-    */
+    /**
+     * Retrieves the command collection contained in the string.
+     * 
+     * @return Mailcode_Collection
+     */
     public function getCollection() : Mailcode_Collection
     {
         if(isset($this->collection))
@@ -418,11 +418,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())
@@ -445,13 +445,13 @@ 
         throw $exception;
     }
     
-   /**
-    * Retrieves a list of all placeholder IDs used in the text.
-    * 
-    * @return string[]
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a list of all placeholder IDs used in the text.
+     * 
+     * @return string[]
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderStrings() : array
     {
         return $this->getPlaceholdersCollection()->getStrings();
@@ -462,29 +462,29 @@ 
         return $this->getPlaceholdersCollection()->isStringPlaceholder($subject);
     }
     
-   /**
-    * Retrieves a placeholder instance by its ID.
-    * 
-    * @param int $id
-    * @throws Mailcode_Exception If the placeholder was not found.
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its ID.
+     * 
+     * @param int $id
+     * @throws Mailcode_Exception If the placeholder was not found.
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByID($id);
     }
     
-   /**
-    * Retrieves a placeholder instance by its replacement text.
-    * 
-    * @param string $string
-    * @throws Mailcode_Exception
-    * @return Mailcode_Parser_Safeguard_Placeholder
-    *
-    * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
-    */
+    /**
+     * Retrieves a placeholder instance by its replacement text.
+     * 
+     * @param string $string
+     * @throws Mailcode_Exception
+     * @return Mailcode_Parser_Safeguard_Placeholder
+     *
+     * @deprecated Use the placeholder collection instead {@see Mailcode_Parser_Safeguard::getPlaceholdersCollection()}.
+     */
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
     {
         return $this->getPlaceholdersCollection()->getByString($string);

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

Indentation +44 added lines, -44 removed lines

@@ -24,34 +24,34 @@ 
 {
     public const ERROR_PLACEHOLDER_NOT_FOUND = 66001;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter
+     */
     protected $formatter;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $append = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $prepend = '';
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Placeholder
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Placeholder
+     */
     protected $placeholder;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder $placeholder)
@@ -67,22 +67,22 @@ 
     
     abstract public function requiresAdjustment() : bool;
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getStartPosition()
     {
         return $this->subject->getSubstrPosition($this->placeholder->getReplacementText());
     }
     
-   /**
-    * Checks whether the specified position within the string
-    * is within another command's placeholder (excluding this
-    * location's placeholder).
-    * 
-    * @param int $position
-    * @return bool
-    */
+    /**
+     * Checks whether the specified position within the string
+     * is within another command's placeholder (excluding this
+     * location's placeholder).
+     * 
+     * @param int $position
+     * @return bool
+     */
     public function isWithinCommand(int $position) : bool
     {
         $placeholders = $this->formatter->getSafeguard()->getPlaceholdersCollection()->getAll();
@@ -114,9 +114,9 @@ 
         return false;
     }
     
-   /**
-    * @return int|boolean
-    */
+    /**
+     * @return int|boolean
+     */
     public function getEndPosition()
     {
         $start = $this->getStartPosition();
@@ -139,14 +139,14 @@ 
         return $this->placeholder;
     }
     
-   /**
-    * Replaces the placeholder with the specified replacement text.
-    * 
-    * @param string $replacementText
-    * @throws Mailcode_Exception
-    * 
-    * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
-    */
+    /**
+     * Replaces the placeholder with the specified replacement text.
+     * 
+     * @param string $replacementText
+     * @throws Mailcode_Exception
+     * 
+     * @see Mailcode_Parser_Safeguard_Formatter_Location::ERROR_PLACEHOLDER_NOT_FOUND
+     */
     public function replaceWith(string $replacementText) : void
     {
         $needle = $this->placeholder->getReplacementText();
@@ -196,10 +196,10 @@ 
         );
     }
     
-   /**
-    * Retrieves the location's log messages, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the location's log messages, if any.
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +24 added lines, -24 removed lines

@@ -27,19 +27,19 @@ 
 {
     public const ERROR_INVALID_LOCATION_INSTANCE = 65601;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatting
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatting
+     */
     protected $formatting;
     
-   /**
-    * @var Mailcode_StringContainer
-    */
+    /**
+     * @var Mailcode_StringContainer
+     */
     protected $subject;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $log = array();
     
     public function __construct(Mailcode_Parser_Safeguard_Formatting $formatting)
@@ -98,12 +98,12 @@ 
         );
     }
     
-   /**
-    * Retrieves all formatter-specific placeholder locations 
-    * in the subject string.
-    * 
-    * @return Mailcode_Parser_Safeguard_Formatter_Location[]
-    */
+    /**
+     * Retrieves all formatter-specific placeholder locations 
+     * in the subject string.
+     * 
+     * @return Mailcode_Parser_Safeguard_Formatter_Location[]
+     */
     protected function resolveLocations() : array
     {
         $placeholders = $this->formatting->getSafeguard()->getPlaceholdersCollection()->getAll();
@@ -118,12 +118,12 @@ 
         return $result;
     }
     
-   /**
-    * 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);
@@ -155,9 +155,9 @@ 
         );
     }
  
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     public function getLog() : array
     {
         return $this->log;

src/Mailcode/Factory/CommandSets.php

Indentation +6 added lines, -6 removed lines

@@ -35,14 +35,14 @@
      */
     private ?Mailcode_Factory_CommandSets_Set_Misc $misc = null;
     
-   /**
-    * @var Mailcode_Factory_CommandSets_Set_Set|NULL
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets_Set_Set|NULL
+     */
     private ?Mailcode_Factory_CommandSets_Set_Set $set = null;
     
-   /**
-    * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets_Set_ElseIf|NULL
+     */
     private ?Mailcode_Factory_CommandSets_Set_ElseIf $elseIf = null;
     
     public function if() : Mailcode_Factory_CommandSets_Set_If

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