Mistralys / mailcode

src/Mailcode/Commands/Command/ShowVariable.php

Indentation +30 added lines, -30 removed lines

@@ -26,9 +26,9 @@ 
     
     const VALIDATION_VARIABLE_COUNT_MISMATCH = 48402;
     
-   /**
-    * @var Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Variables_Variable|NULL
+     */
     protected $variable;
     
     public function getName() : string
@@ -56,15 +56,15 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         $this->validate();
@@ -81,15 +81,15 @@ 
         );
     }
     
-   /**
-    * Retrieves the full name of the variable to show.
-    * 
-    * NOTE: Only available once the command has been
-    * validated. Always use isValid() first.
-    * 
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the full name of the variable to show.
+     * 
+     * NOTE: Only available once the command has been
+     * validated. Always use isValid() first.
+     * 
+     * @throws Mailcode_Exception
+     * @return string
+     */
     public function getVariableName() : string
     {
         return $this->getVariable()->getFullName();
@@ -97,19 +97,19 @@ 
 
     protected function validateSyntax_require_variable() : void
     {
-         $vars = $this->getVariables()->getGroupedByName();
-         $amount = count($vars);
+            $vars = $this->getVariables()->getGroupedByName();
+            $amount = count($vars);
          
-         if($amount === 1)
-         {
-             $this->variable = array_pop($vars);
-             return;
-         }
+            if($amount === 1)
+            {
+                $this->variable = array_pop($vars);
+                return;
+            }
          
-         $this->validationResult->makeError(
+            $this->validationResult->makeError(
             t('Command has %1$s variables, %2$s expected.', $amount, 1),
             self::VALIDATION_VARIABLE_COUNT_MISMATCH
-         );
+            );
     }
     
     protected function getValidations() : array

src/Mailcode/Commands/Command.php

Indentation +70 added lines, -70 removed lines

@@ -31,53 +31,53 @@ 
     const VALIDATION_UNKNOWN_COMMAND_NAME = 48304;
     const VALIDATION_INVALID_PARAMS_STATEMENT = 48305;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $paramsString = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash = '';
     
-   /**
-    * @var \AppUtils\OperationResult
-    */
+    /**
+     * @var \AppUtils\OperationResult
+     */
     protected $validationResult = null;
     
-   /**
-    * @var \Mailcode\Mailcode
-    */
+    /**
+     * @var \Mailcode\Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var \Mailcode\Mailcode_Parser_Statement
-    */
+    /**
+     * @var \Mailcode\Mailcode_Parser_Statement
+     */
     protected $params;
 
-   /**
-    * @var string[] 
-    */
+    /**
+     * @var string[] 
+     */
     protected $validations = array(
         'params',
         'type_supported',
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
@@ -95,9 +95,9 @@ 
         
     }
     
-   /**
-    * @return string The ID of the command = the name of the command class file.
-    */
+    /**
+     * @return string The ID of the command = the name of the command class file.
+     */
     public function getID() : string
     {
         // account for commands with types: If_Variable should still return If.
@@ -106,14 +106,14 @@ 
         return array_shift($tokens);
     }
     
-   /**
-    * Sets an optional comment that is not used anywhere, but
-    * can be used by the application to track why a command is
-    * used somewhere. 
-    * 
-    * @param string $comment
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Sets an optional comment that is not used anywhere, but
+     * can be used by the application to track why a command is
+     * used somewhere. 
+     * 
+     * @param string $comment
+     * @return Mailcode_Commands_Command
+     */
     public function setComment(string $comment) : Mailcode_Commands_Command
     {
         $this->comment = $comment;
@@ -121,34 +121,34 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the previously set comment, if any.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the previously set comment, if any.
+     * 
+     * @return string
+     */
     public function getComment() : string
     {
         return $this->comment;
     }
     
-   /**
-    * Checks whether this is a dummy command, which is only
-    * used to access information on the command type. It cannot
-    * be used as an actual live command.
-    * 
-    * @return bool
-    */
+    /**
+     * Checks whether this is a dummy command, which is only
+     * used to access information on the command type. It cannot
+     * be used as an actual live command.
+     * 
+     * @return bool
+     */
     public function isDummy() : bool
     {
         return $this->type === '__dummy';
     }
     
-   /**
-    * Retrieves a hash of the actual matched command string,
-    * which is used in collections to detect duplicate commands.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a hash of the actual matched command string,
+     * which is used in collections to detect duplicate commands.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         $this->requireNonDummy();
@@ -240,9 +240,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params() : void
@@ -429,22 +429,22 @@ 
         return implode('', $parts);
     }
     
-   /**
-    * Retrieves the names of all the command's supported types: the part
-    * between the command name and the colon. Example: {command type: params}.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all the command's supported types: the part
+     * between the command name and the colon. Example: {command type: params}.
+     * 
+     * @return string[]
+     */
     public function getSupportedTypes() : array
     {
         return array();
     }
     
-   /**
-    * Retrieves all variable names used in the command.
-    * 
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Retrieves all variable names used in the command.
+     * 
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function getVariables() : Mailcode_Variables_Collection_Regular
     {
         return Mailcode::create()->findVariables($this->paramsString);

src/Mailcode/Commands/Command/ShowSnippet.php

Indentation +17 added lines, -17 removed lines

@@ -24,9 +24,9 @@ 
     
     const VALIDATION_VARIABLE_MISSING = 52001;
     
-   /**
-    * @var Mailcode_Variables_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Variables_Variable|NULL
+     */
     protected $variable;
     
     public function getName() : string
@@ -54,13 +54,13 @@ 
         return true;
     }
     
-   /**
-    * Retrieves the variable to show, provided the command
-    * is valid.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable to show, provided the command
+     * is valid.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         $this->validate();
@@ -77,13 +77,13 @@ 
         );
     }
     
-   /**
-    * Retrieves the full name of the variable to show,
-    * provided the command is valid.
-    * 
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the full name of the variable to show,
+     * provided the command is valid.
+     * 
+     * @throws Mailcode_Exception
+     * @return string
+     */
     public function getVariableName() : string
     {
         return $this->getVariable()->getFullName();

src/Mailcode/Parser/Safeguard/Formatter.php

Indentation +26 added lines, -26 removed lines

@@ -24,9 +24,9 @@ 
  */
 abstract class Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var Mailcode_Parser_Safeguard
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard
+     */
     protected $safeguard;
     
     public function __construct(Mailcode_Parser_Safeguard $safeguard)
@@ -36,13 +36,13 @@ 
     
     abstract public function format(string $subject) : string;
     
-   /**
-    * Resolves a list of positions of needle in the haystack.
-    * 
-    * @param string $needle
-    * @param string $haystack
-    * @return int[]
-    */
+    /**
+     * Resolves a list of positions of needle in the haystack.
+     * 
+     * @param string $needle
+     * @param string $haystack
+     * @return int[]
+     */
     protected function resolvePositions(string $needle, string $haystack) : array
     {
         $lastPos = 0;
@@ -57,12 +57,12 @@ 
         return $positions;
     }
     
-   /**
-    * 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);
@@ -75,13 +75,13 @@ 
         return PHP_EOL;
     }
     
-   /**
-    * Resolves the list of placeholder strings that need
-    * to be formatted. This includes only commands that
-    * do not generate content.
-    *  
-    * @return string[]
-    */
+    /**
+     * Resolves the list of placeholder strings that need
+     * to be formatted. This includes only commands that
+     * do not generate content.
+     *  
+     * @return string[]
+     */
     protected function resolvePlaceholderStrings() : array
     {
         $placeholders = $this->filterPlaceholders();
@@ -96,9 +96,9 @@ 
         return $result;
     }
     
-   /**
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         return $this->safeguard->getPlaceholders();

src/Mailcode/Parser/Safeguard/Formatter/SingleLines/Placeholder.php

Indentation +26 added lines, -26 removed lines

@@ -21,39 +21,39 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines_Placeholder
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $subject;
     
-   /**
-    * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
-    */
+    /**
+     * @var Mailcode_Parser_Safeguard_Formatter_SingleLines
+     */
     protected $formatter;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $prepend = false;
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $append = false;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $placeholderLength;
     
     public function __construct(Mailcode_Parser_Safeguard_Formatter_SingleLines $formatter, string $subject, int $placeholderLength, int $position)
@@ -67,11 +67,11 @@ 
         $this->analyzeAppend($subject);
     }
     
-   /**
-    * Whether an EOL character needs to be appended or prepended.
-    *  
-    * @return bool
-    */
+    /**
+     * Whether an EOL character needs to be appended or prepended.
+     *  
+     * @return bool
+     */
     public function requiresAdjustment() : bool
     {
         return $this->requiresAppend() || $this->requiresPrepend();

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

Indentation +13 added lines, -13 removed lines

@@ -23,14 +23,14 @@ 
  */
 class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $eolLength;
     
     public function format(string $subject) : string
@@ -119,13 +119,13 @@ 
         return $prepend.$placeholder.$append;
     }
     
-   /**
-    * We only use placeholders that contain commands that do
-    * not generate contents, since these are the only ones
-    * that may need adjusting.
-    * 
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
-    */
+    /**
+     * We only use placeholders that contain commands that do
+     * not generate contents, since these are the only ones
+     * that may need adjusting.
+     * 
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
+     */
     protected function filterPlaceholders()
     {
         $placeholders = $this->safeguard->getPlaceholders();

src/Mailcode/Translator/Syntax/ApacheVelocity/ShowDate.php

Indentation +3 added lines, -3 removed lines

@@ -24,9 +24,9 @@
 {
     const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501;
     
-   /**
-    * @var string[]string
-    */
+    /**
+     * @var string[]string
+     */
     private $charTable = array(
         'd' => 'd',
         'm' => 'M',

src/Mailcode/Date/FormatInfo/Character.php

Indentation +34 added lines, -34 removed lines

@@ -23,19 +23,19 @@ 
 {
     const ERROR_UNHANDLED_CHARTYPE = 55601;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $description;
     
     public function __construct(string $type, string $char, string $description)
@@ -45,46 +45,46 @@ 
         $this->description = $description;
     }
     
-   /**
-    * Retrieves the format character (PHP date format).
-    * 
-    * @return string 
-    */
+    /**
+     * Retrieves the format character (PHP date format).
+     * 
+     * @return string 
+     */
     public function getChar() : string
     {
         return $this->char;
     }
     
-   /**
-    * Retrieves a human readable description of the character's role.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a human readable description of the character's role.
+     * 
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * Retrieves the character type ID.
-    * 
-    * @return string
-    * 
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME
-    * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION
-    */
+    /**
+     * Retrieves the character type ID.
+     * 
+     * @return string
+     * 
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_DATE
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_TIME
+     * @see Mailcode_Date_FormatInfo::CHARTYPE_PUNCTUATION
+     */
     public function getTypeID() : string
     {
         return $this->type;
     }
     
-   /**
-    * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation".
-    * 
-    * @throws Mailcode_Exception If the character type is unknown.
-    * @return string
-    */
+    /**
+     * Retrieves a human readable label for the character's type, e.g. "Date", "Time", "Punctuation".
+     * 
+     * @throws Mailcode_Exception If the character type is unknown.
+     * @return string
+     */
     public function getTypeLabel() : string
     {
         switch($this->type)

src/Mailcode/Date/FormatInfo.php

Indentation +39 added lines, -39 removed lines

@@ -31,24 +31,24 @@ 
     const CHARTYPE_TIME = 'time';
     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(
@@ -113,16 +113,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);
@@ -161,23 +161,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>
-    */
+    /**
+     * Retrieves the characters list, grouped by type label.
+     * 
+     * @return array<string, array>
+     */
     public function getCharactersGrouped() : array
     {
         $grouped = array();