Mistralys / mailcode

src/Mailcode/Translator/Syntax/ApacheVelocity.php

Indentation +7 added lines, -7 removed lines

@@ -20,13 +20,13 @@
  */
 abstract class Mailcode_Translator_Syntax_ApacheVelocity extends Mailcode_Translator_Command
 {
-   /**
-    * Filters the string for use in an Apache Velocity (Java)
-    * regex string: escapes all special characters.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Filters the string for use in an Apache Velocity (Java)
+     * regex string: escapes all special characters.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function filterRegexString(string $string) : string
     {
         $escape = array(

src/Mailcode/Translator/Syntax.php

Indentation +21 added lines, -21 removed lines

@@ -23,9 +23,9 @@ 
 {
     const ERROR_UNKNOWN_COMMAND_TYPE = 50401;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $typeID;
     
     public function __construct(string $typeID)
@@ -33,22 +33,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
     {
         $translator = $this->createTranslator($command);
@@ -81,13 +81,13 @@ 
         return $translator;
     }
     
-   /**
-    * Translates all safeguarded commands in the subject string to the 
-    * target syntax in one go.
-    * 
-    * @param Mailcode_Parser_Safeguard $safeguard
-    * @return string
-    */
+    /**
+     * Translates all safeguarded commands in the subject string to the 
+     * target syntax in one go.
+     * 
+     * @param Mailcode_Parser_Safeguard $safeguard
+     * @return string
+     */
     public function translateSafeguard(Mailcode_Parser_Safeguard $safeguard) : string
     {
         $subject = $safeguard->makeSafe();

src/Mailcode/Collection/NestingValidator.php

Indentation +9 added lines, -9 removed lines

@@ -29,19 +29,19 @@
     const VALIDATION_COMMANDS_ALREADY_CLOSED = 49103;
     const VALIDATION_UNCLOSED_COMMAND = 49104;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     protected $collection;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $validationResult;
     
-   /**
-    * @var Mailcode_Commands_Command_Type[]
-    */
+    /**
+     * @var Mailcode_Commands_Command_Type[]
+     */
     protected $stack = array();
     
     public function __construct(Mailcode_Collection $collection)

src/Mailcode/Commands/Command/SetVariable.php

Indentation +3 added lines, -3 removed lines

@@ -25,9 +25,9 @@
     
     const VALIDATION_NOT_ASSIGNMENT_STATEMENT = 48501;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Type_Value
+     */
     protected $value;
     
     public function getName() : string

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