Mistralys / mailcode

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

Indentation +7 added lines, -7 removed lines

@@ -24,15 +24,15 @@
 {
     const ERROR_UNKNOWN_DATE_FORMAT_CHARACTER = 55501;
 
-   /**
-    * The date format used in the date variable. This is used to convert
-    * the native date to the format specified in the variable command.
-    */
+    /**
+     * The date format used in the date variable. This is used to convert
+     * the native date to the format specified in the variable command.
+     */
     const DEFAULT_INTERNAL_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
 
-   /**
-    * @var string[]string
-    */
+    /**
+     * @var string[]string
+     */
     private $charTable = array(
         'd' => 'd',
         'm' => 'M',

Spacing +3 added lines, -3 removed lines

@@ -52,7 +52,7 @@ 
     {
         $internalFormat = $command->getTranslationParam('internal_format');
 
-        if(empty($internalFormat))
+        if (empty($internalFormat))
         {
             $internalFormat = self::DEFAULT_INTERNAL_FORMAT;
         }
@@ -70,9 +70,9 @@ 
         $chars = ConvertHelper::string2array($formatString);
         $result = array();
         
-        foreach($chars as $char)
+        foreach ($chars as $char)
         {
-            if(!isset($this->charTable[$char]))
+            if (!isset($this->charTable[$char]))
             {
                 throw new Mailcode_Translator_Exception(
                     'Unknown date format string character',

src/Mailcode/Commands/Command.php

Indentation +106 added lines, -106 removed lines

@@ -32,44 +32,44 @@ 
     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_empty',
         'params_keywords',
@@ -78,24 +78,24 @@ 
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords|NULL
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords|NULL
+     */
     protected $logicKeywords;
     
-   /**
-    * @var Mailcode_Parser_Statement_Validator
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Validator
+     */
     protected $validator;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $validated = false;
 
     /**
@@ -125,13 +125,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;
@@ -147,9 +147,9 @@ 
         return $this->parent;
     }
     
-   /**
-    * @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.
@@ -158,14 +158,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;
@@ -173,34 +173,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();
@@ -294,9 +294,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params_empty() : void
@@ -455,12 +455,12 @@ 
     
     abstract public function supportsType() : bool;
     
-   /**
-    * Whether the command allows using logic keywords like "and:" or "or:"
-    * in the command parameters.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the command allows using logic keywords like "and:" or "or:"
+     * in the command parameters.
+     * 
+     * @return bool
+     */
     abstract public function supportsLogicKeywords() : bool;
     
     abstract public function generatesContent() : bool;
@@ -506,22 +506,22 @@ 
         return $normalizer->normalize();
     }
     
-   /**
-    * 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);
@@ -546,26 +546,26 @@ 
         );
     }
 
-   /**
-    * Sets a parameter for the translation backend. The backend can use
-    * these to allow command-specific configurations.
-    *
-    * @param string $name
-    * @param mixed $value
-    * @return $this
-    */
+    /**
+     * Sets a parameter for the translation backend. The backend can use
+     * these to allow command-specific configurations.
+     *
+     * @param string $name
+     * @param mixed $value
+     * @return $this
+     */
     public function setTranslationParam(string $name, $value)
     {
         $this->translationParams[$name] = $value;
         return $this;
     }
 
-   /**
-    * Retrieves a previously set translation parameter.
-    *
-    * @param string $name
-    * @return mixed
-    */
+    /**
+     * Retrieves a previously set translation parameter.
+     *
+     * @param string $name
+     * @return mixed
+     */
     public function getTranslationParam(string $name)
     {
         if(isset($this->translationParams[$name]))

Spacing +26 added lines, -26 removed lines

@@ -109,7 +109,7 @@ 
      */
     protected $parent = null;
 
-    public function __construct(string $type='', string $paramsString='', string $matchedText='')
+    public function __construct(string $type = '', string $paramsString = '', string $matchedText = '')
     {
         $this->type = $type;
         $this->paramsString = html_entity_decode($paramsString);
@@ -205,7 +205,7 @@ 
     {
         $this->requireNonDummy();
         
-        if($this->hash === '') {
+        if ($this->hash === '') {
             $this->hash = md5($this->matchedText);
         }
         
@@ -214,7 +214,7 @@ 
     
     protected function requireNonDummy() : void
     {
-        if(!$this->isDummy())
+        if (!$this->isDummy())
         {
             return;
         }
@@ -233,7 +233,7 @@ 
     
     protected function validate() : \AppUtils\OperationResult
     {
-        if(!$this->validated)
+        if (!$this->validated)
         {
             $this->requireNonDummy();
             $this->validateSyntax();
@@ -246,7 +246,7 @@ 
     
     public function getValidationResult() :  \AppUtils\OperationResult
     {
-        if(isset($this->validationResult)) 
+        if (isset($this->validationResult)) 
         {
             return $this->validationResult;
         }
@@ -262,10 +262,10 @@ 
     {
         $validations = array_merge($this->validations, $this->getValidations());
         
-        foreach($validations as $validation)
+        foreach ($validations as $validation)
         {
             // break off at the first validation issue
-            if(!$this->validateSyntaxMethod($validation))
+            if (!$this->validateSyntaxMethod($validation))
             {
                 return;
             }
@@ -276,7 +276,7 @@ 
     {
         $method = 'validateSyntax_'.$validation;
         
-        if(!method_exists($this, $method))
+        if (!method_exists($this, $method))
         {
             throw new Mailcode_Exception(
                 'Missing validation method ['.$validation.']',
@@ -301,12 +301,12 @@ 
     
     protected function validateSyntax_params_empty() : void
     {
-        if(!$this->requiresParameters())
+        if (!$this->requiresParameters())
         {
             return;
         }
         
-        if(empty($this->paramsString))
+        if (empty($this->paramsString))
         {
             $this->validationResult->makeError(
                 t('Parameters have to be specified.'),
@@ -318,14 +318,14 @@ 
     
     protected function validateSyntax_params_keywords() : void
     {
-        if(!$this->supportsLogicKeywords())
+        if (!$this->supportsLogicKeywords())
         {
             return;
         }
         
         $this->logicKeywords = new Mailcode_Commands_LogicKeywords($this, $this->paramsString);
         
-        if(!$this->logicKeywords->isValid())
+        if (!$this->logicKeywords->isValid())
         {
             $this->validationResult->makeError(
                 t('Invalid parameters:').' '.$this->logicKeywords->getErrorMessage(),
@@ -340,14 +340,14 @@ 
     
     protected function validateSyntax_params_parse() : void
     {
-        if(!$this->requiresParameters())
+        if (!$this->requiresParameters())
         {
             return;
         }
         
         $this->params = $this->mailcode->getParser()->createStatement($this->paramsString);
         
-        if(!$this->params->isValid())
+        if (!$this->params->isValid())
         {
             $error = $this->params->getValidationResult();
             
@@ -364,14 +364,14 @@ 
     
     protected function validateSyntax_type_supported() : void
     {
-        if(!$this->supportsType() || empty($this->type))
+        if (!$this->supportsType() || empty($this->type))
         {
             return;
         }
         
         $types = $this->getSupportedTypes();
 
-        if(!in_array($this->type, $types))
+        if (!in_array($this->type, $types))
         {
             $this->validationResult->makeError(
                 t('The command addon %1$s is not supported.', $this->type).' '.
@@ -385,7 +385,7 @@ 
     
     protected function validateSyntax_type_unsupported() : void
     {
-        if($this->supportsType() || empty($this->type))
+        if ($this->supportsType() || empty($this->type))
         {
             return;
         }
@@ -403,7 +403,7 @@ 
     
     public function getType() : string
     {
-        if($this->supportsType())
+        if ($this->supportsType())
         {
             return $this->type;
         }
@@ -423,7 +423,7 @@ 
     
     public function getHighlighted() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -434,7 +434,7 @@ 
     
     public function getParamsString() : string
     {
-        if($this->requiresParameters())
+        if ($this->requiresParameters())
         {
             return $this->paramsString;
         }
@@ -469,22 +469,22 @@ 
     
     public final function getCommandType() : string
     {
-        if($this instanceof Mailcode_Commands_Command_Type_Closing)
+        if ($this instanceof Mailcode_Commands_Command_Type_Closing)
         {
             return 'Closing';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Opening)
+        if ($this instanceof Mailcode_Commands_Command_Type_Opening)
         {
             return 'Opening';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Sibling)
+        if ($this instanceof Mailcode_Commands_Command_Type_Sibling)
         {
             return 'Sibling';
         }
         
-        if($this instanceof Mailcode_Commands_Command_Type_Standalone)
+        if ($this instanceof Mailcode_Commands_Command_Type_Standalone)
         {
             return 'Standalone';
         }
@@ -534,7 +534,7 @@ 
     
     public function getLogicKeywords() : Mailcode_Commands_LogicKeywords
     {
-        if($this->supportsLogicKeywords() && isset($this->logicKeywords))
+        if ($this->supportsLogicKeywords() && isset($this->logicKeywords))
         {
             return $this->logicKeywords;
         }
@@ -568,7 +568,7 @@ 
     */
     public function getTranslationParam(string $name)
     {
-        if(isset($this->translationParams[$name]))
+        if (isset($this->translationParams[$name]))
         {
             return $this->translationParams[$name];
         }

src/Mailcode/Parser.php

Indentation +50 added lines, -50 removed lines

@@ -28,14 +28,14 @@ 
         '{\s*([a-z]+)\s+([a-z-]+)\s*:([^}]*)}'
     );
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var Mailcode_Commands
-    */
+    /**
+     * @var Mailcode_Commands
+     */
     protected $commands;
 
     /**
@@ -49,24 +49,24 @@ 
         $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';
     }
     
-   /**
-    * Parses a string to detect all commands within. Returns a
-    * collection instance that contains information on all the 
-    * commands.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection A collection with all unique commands found.
-    */
+    /**
+     * Parses a string to detect all commands within. Returns a
+     * collection instance that contains information on all the 
+     * commands.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection A collection with all unique commands found.
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         $collection = new Mailcode_Collection();
@@ -99,14 +99,14 @@ 
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
     }
     
-   /**
-    * Processes a single match found in the string: creates the command,
-    * and adds it to the collection if it's a valid command, or to the list
-    * of invalid commands otherwise.
-    * 
-    * @param Mailcode_Parser_Match $match
-    * @param Mailcode_Collection $collection
-    */
+    /**
+     * Processes a single match found in the string: creates the command,
+     * and adds it to the collection if it's a valid command, or to the list
+     * of invalid commands otherwise.
+     * 
+     * @param Mailcode_Parser_Match $match
+     * @param Mailcode_Collection $collection
+     */
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
     {
         $name = $match->getName();
@@ -153,14 +153,14 @@ 
         }
     }
     
-   /**
-    * Parses a single regex match: determines which named group
-    * matches, and retrieves the according information.
-    * 
-    * @param array[] $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[] $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"
@@ -198,26 +198,26 @@ 
         );
     }
     
-   /**
-    * 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);
     }
     
-   /**
-    * Creates a statement parser, which is used to validate arbitrary
-    * command statements.
-    * 
-    * @param string $statement
-    * @return Mailcode_Parser_Statement
-    */
+    /**
+     * Creates a statement parser, which is used to validate arbitrary
+     * command statements.
+     * 
+     * @param string $statement
+     * @return Mailcode_Parser_Statement
+     */
     public function createStatement(string $statement) : Mailcode_Parser_Statement
     {
         return new Mailcode_Parser_Statement($statement);

Spacing +10 added lines, -10 removed lines

@@ -78,7 +78,7 @@ 
         
         $total = count($matches[0]);
         
-        for($i=0; $i < $total; $i++)
+        for ($i = 0; $i < $total; $i++)
         {
             $match = $this->parseMatch($matches, $i);
             
@@ -90,7 +90,7 @@ 
     
     protected function prepareString(string $subject) : string
     {
-        if(!ConvertHelper::isStringHTML($subject))
+        if (!ConvertHelper::isStringHTML($subject))
         {
             return $subject;
         }
@@ -111,7 +111,7 @@ 
     {
         $name = $match->getName();
         
-        if(!$this->commands->nameExists($name))
+        if (!$this->commands->nameExists($name))
         {
             $collection->addErrorMessage(
                 $match->getMatchedString(),
@@ -128,7 +128,7 @@ 
             $match->getMatchedString()
         );
         
-        if(!$cmd->isValid())
+        if (!$cmd->isValid())
         {
             $collection->addInvalidCommand($cmd);
             return;
@@ -137,17 +137,17 @@ 
         $collection->addCommand($cmd);
 
         // Set the command's parent from the stack, if any is present.
-        if(!empty($this->stack))
+        if (!empty($this->stack))
         {
             $cmd->setParent($this->stack[array_key_last($this->stack)]);
         }
 
         // Handle opening and closing commands, adding and removing from the stack.
-        if($cmd instanceof Mailcode_Commands_Command_Type_Opening)
+        if ($cmd instanceof Mailcode_Commands_Command_Type_Opening)
         {
             $this->stack[] = $cmd;
         }
-        else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
+        else if ($cmd instanceof Mailcode_Commands_Command_Type_Closing)
         {
             array_pop($this->stack);
         }
@@ -174,16 +174,16 @@ 
         // 5 = parameter type command, type
         // 6 = parameter type command, params
         
-        if(!empty($matches[1][$index]))
+        if (!empty($matches[1][$index]))
         {
             $name = $matches[1][$index];
         }
-        else if(!empty($matches[2][$index]))
+        else if (!empty($matches[2][$index]))
         {
             $name = $matches[2][$index];
             $params = $matches[3][$index];
         }
-        else if(!empty($matches[4][$index]))
+        else if (!empty($matches[4][$index]))
         {
             $name = $matches[4][$index];
             $type = $matches[5][$index];

Braces +3 added lines, -6 removed lines

@@ -146,8 +146,7 @@ 
         if($cmd instanceof Mailcode_Commands_Command_Type_Opening)
         {
             $this->stack[] = $cmd;
-        }
-        else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
+        } else if($cmd instanceof Mailcode_Commands_Command_Type_Closing)
         {
             array_pop($this->stack);
         }
@@ -177,13 +176,11 @@ 
         if(!empty($matches[1][$index]))
         {
             $name = $matches[1][$index];
-        }
-        else if(!empty($matches[2][$index]))
+        } else if(!empty($matches[2][$index]))
         {
             $name = $matches[2][$index];
             $params = $matches[3][$index];
-        }
-        else if(!empty($matches[4][$index]))
+        } else if(!empty($matches[4][$index]))
         {
             $name = $matches[4][$index];
             $type = $matches[5][$index];