Mistralys / mailcode

src/Mailcode/Factory.php

Indentation +67 added lines, -67 removed lines

@@ -23,17 +23,17 @@ 
     const ERROR_INVALID_COMMAND_CREATED = 50001;
     const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
 
-   /**
-    * @var Mailcode_Factory_CommandSets
-    */
+    /**
+     * @var Mailcode_Factory_CommandSets
+     */
     private static $commandSets;
     
-   /**
-    * Creates a ShowVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowVariable
-    */
+    /**
+     * Creates a ShowVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowVariable
+     */
     public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
     {
         return self::$commandSets->show()->showVar($variableName);
@@ -65,41 +65,41 @@ 
         return self::$commandSets->show()->showNumber($variableName, $formatString);
     }
 
-   /**
-    * Creates a ShowSnippet command.
-    *
-    * @param string $snippetName A snippet name, with or without the $ sign prepended.
-    * @return Mailcode_Commands_Command_ShowSnippet
-    */
+    /**
+     * Creates a ShowSnippet command.
+     *
+     * @param string $snippetName A snippet name, with or without the $ sign prepended.
+     * @return Mailcode_Commands_Command_ShowSnippet
+     */
     public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
     {
         return self::$commandSets->show()->showSnippet($snippetName);
     }
     
-   /**
-    * Creates a SetVariable command.
-    * 
-    * @param string $variableName A variable name, with or without the $ sign prepended.
-    * @param string $value
-    * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
-    * @return Mailcode_Commands_Command_SetVariable
-    * @throws Mailcode_Factory_Exception
-    * 
-    * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
-    */
+    /**
+     * Creates a SetVariable command.
+     * 
+     * @param string $variableName A variable name, with or without the $ sign prepended.
+     * @param string $value
+     * @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
+     * @return Mailcode_Commands_Command_SetVariable
+     * @throws Mailcode_Factory_Exception
+     * 
+     * @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
+     */
     public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
     {
         return self::$commandSets->set()->setVar($variableName, $value, $quoteValue);
     }
     
-   /**
-    * Like setVar(), but treats the value as a string literal
-    * and automatically adds quotes to it.
-    * 
-    * @param string $variableName
-    * @param string $value
-    * @return Mailcode_Commands_Command_SetVariable
-    */
+    /**
+     * Like setVar(), but treats the value as a string literal
+     * and automatically adds quotes to it.
+     * 
+     * @param string $variableName
+     * @param string $value
+     * @return Mailcode_Commands_Command_SetVariable
+     */
     public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
     {
         return self::$commandSets->set()->setVar($variableName, $value, true);
@@ -256,13 +256,13 @@ 
     }
 
     /**
-    * Creates if contains command, with several search terms.
-    * 
-    * @param string $variable
-    * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
-    * @param bool $caseInsensitive
-    * @return Mailcode_Commands_Command_If_Contains
-    */
+     * Creates if contains command, with several search terms.
+     * 
+     * @param string $variable
+     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
+     * @param bool $caseInsensitive
+     * @return Mailcode_Commands_Command_If_Contains
+     */
     public static function ifContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
     {
         return self::$commandSets->if()->ifContains($variable, $searchTerms, $caseInsensitive);
@@ -273,14 +273,14 @@ 
         return self::$commandSets->elseIf()->elseIfContains($variable, array($search), $caseInsensitive);
     }
     
-   /**
-    * Creates else if contains command, with several search terms.
-    * 
-    * @param string $variable
-    * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
-    * @param bool $caseInsensitive
-    * @return Mailcode_Commands_Command_ElseIf_Contains
-    */
+    /**
+     * Creates else if contains command, with several search terms.
+     * 
+     * @param string $variable
+     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
+     * @param bool $caseInsensitive
+     * @return Mailcode_Commands_Command_ElseIf_Contains
+     */
     public static function elseIfContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
     {
         return self::$commandSets->elseIf()->elseIfContains($variable, $searchTerms, $caseInsensitive);
@@ -306,34 +306,34 @@ 
         return self::$commandSets->misc()->break();
     }
     
-   /**
-    * 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/Collection.php

Indentation +54 added lines, -54 removed lines

@@ -25,9 +25,9 @@ 
     const ERROR_CANNOT_RETRIEVE_FIRST_ERROR = 52301;
     const ERROR_CANNOT_MODIFY_FINALIZED = 52302;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     protected $commands = array();
     
     /**
@@ -35,9 +35,9 @@ 
      */
     protected $errors = array();
     
-   /**
-    * @var OperationResult|NULL
-    */
+    /**
+     * @var OperationResult|NULL
+     */
     protected $validationResult;
 
     /**
@@ -46,11 +46,11 @@ 
     private $finalized = false;
 
     /**
-    * Adds a command to the collection.
-    * 
-    * @param Mailcode_Commands_Command $command
-    * @return Mailcode_Collection
-    */
+     * Adds a command to the collection.
+     * 
+     * @param Mailcode_Commands_Command $command
+     * @return Mailcode_Collection
+     */
     public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection
     {
         if($this->finalized)
@@ -71,21 +71,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);
@@ -123,9 +123,9 @@ 
         $this->commands = $keep;
     }
     
-   /**
-    * @return Mailcode_Collection_Error[]
-    */
+    /**
+     * @return Mailcode_Collection_Error[]
+     */
     public function getErrors()
     {
         $result = $this->getValidationResult();
@@ -167,25 +167,25 @@ 
         return empty($errors);
     }
     
-   /**
-    * Retrieves all commands that were detected, in the exact order
-    * they were found.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all commands that were detected, in the exact order
+     * they were found.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getCommands()
     {
-       return $this->commands;
+        return $this->commands;
     }
     
-   /**
-    * Retrieves all unique commands by their matched
-    * string hash: this ensures only commands that were
-    * written the exact same way (including spacing)
-    * are returned.
-    * 
-    * @return \Mailcode\Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves all unique commands by their matched
+     * string hash: this ensures only commands that were
+     * written the exact same way (including spacing)
+     * are returned.
+     * 
+     * @return \Mailcode\Mailcode_Commands_Command[]
+     */
     public function getGroupedByHash()
     {
         $hashes = array();
@@ -203,12 +203,12 @@ 
         return array_values($hashes);
     }
 
-   /**
-    * Adds several commands at once.
-    * 
-    * @param Mailcode_Commands_Command[] $commands
-    * @return Mailcode_Collection
-    */
+    /**
+     * Adds several commands at once.
+     * 
+     * @param Mailcode_Commands_Command[] $commands
+     * @return Mailcode_Collection
+     */
     public function addCommands(array $commands) : Mailcode_Collection
     {
         foreach($commands as $command)
@@ -281,10 +281,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()
     {
         return $this->getCommandsByClass(Mailcode_Commands_Command_ShowVariable::class);
@@ -298,11 +298,11 @@ 
         return $this->getCommandsByClass(Mailcode_Commands_Command_For::class);
     }
 
-   /**
-    * 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 $this->getCommandsByClass(Mailcode_Commands_Command_ShowDate::class);

src/Mailcode/Commands/Command.php

Indentation +106 added lines, -106 removed lines

@@ -43,44 +43,44 @@ 
 
     const META_URL_ENCODING = 'url_encoding';
 
-   /**
-    * @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 OperationResult
-    */
+    /**
+     * @var 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',
@@ -89,24 +89,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;
 
     /**
@@ -146,13 +146,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;
@@ -168,9 +168,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.
@@ -179,14 +179,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;
@@ -194,34 +194,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();
@@ -323,9 +323,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
 
     protected function _validateNesting() : void
@@ -413,12 +413,12 @@ 
 
     abstract public function supportsURLEncoding() : 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;
@@ -464,22 +464,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);
@@ -504,26 +504,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]))