Mistralys / mailcode

src/Mailcode/Traits/Commands/IfNotEmpty.php

Indentation +8 added lines, -8 removed lines

@@ -23,9 +23,9 @@ 
  */
 trait Mailcode_Traits_Commands_IfNotEmpty
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     protected $variableToken;
 
     protected function getValidations() : array
@@ -53,11 +53,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the variable being compared.
-    *
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable being compared.
+     *
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)

src/Mailcode/Traits/Commands/IfEmpty.php

Indentation +8 added lines, -8 removed lines

@@ -23,9 +23,9 @@ 
  */
 trait Mailcode_Traits_Commands_IfEmpty
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     protected $variableToken;
 
     protected function getValidations() : array
@@ -53,11 +53,11 @@ 
         );
     }
     
-   /**
-    * Retrieves the variable being compared.
-    *
-    * @return Mailcode_Variables_Variable
-    */
+    /**
+     * Retrieves the variable being compared.
+     *
+     * @return Mailcode_Variables_Variable
+     */
     public function getVariable() : Mailcode_Variables_Variable
     {
         if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)

src/Mailcode/Commands.php

Indentation +54 added lines, -54 removed lines

@@ -27,21 +27,21 @@ 
     
     const ERROR_INVALID_DUMMY_COMMAND_TYPE = 45903;
     
-   /**
-    * @var Mailcode_Commands_Command[]
-    */
+    /**
+     * @var Mailcode_Commands_Command[]
+     */
     private $commands = array();
     
-   /**
-    * @var string[]Mailcode_Commands_Command
-    */
+    /**
+     * @var string[]Mailcode_Commands_Command
+     */
     private static $dummyCommands = array();
     
-   /**
-    * Retrieves a list of all available command IDs.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all available command IDs.
+     * 
+     * @return string[]
+     */
     public function getIDs() : array
     {
         static $ids = array();
@@ -54,13 +54,13 @@ 
         return $ids;
     }
     
-   /**
-    * Retrieves a list of all available commands, sorted by label.
-    * 
-    * NOTE: These instances are only used for information purposes.
-    * 
-    * @return Mailcode_Commands_Command[]
-    */
+    /**
+     * Retrieves a list of all available commands, sorted by label.
+     * 
+     * NOTE: These instances are only used for information purposes.
+     * 
+     * @return Mailcode_Commands_Command[]
+     */
     public function getAll()
     {
         if(!empty($this->commands)) {
@@ -86,12 +86,12 @@ 
         return $result;
     }
     
-   /**
-    * Gets an available command by its ID.
-    * 
-    * @param string $id
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Gets an available command by its ID.
+     * 
+     * @param string $id
+     * @return Mailcode_Commands_Command
+     */
     public function getByID(string $id) : Mailcode_Commands_Command
     {
         static $instances = array();
@@ -104,15 +104,15 @@ 
         return $instances[$id];
     }
     
-   /**
-    * Retrieves the ID of a command by its name.
-    * 
-    * @param string $name
-    * @throws Mailcode_Exception
-    * @return string
-    * 
-    * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
-    */
+    /**
+     * Retrieves the ID of a command by its name.
+     * 
+     * @param string $name
+     * @throws Mailcode_Exception
+     * @return string
+     * 
+     * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST
+     */
     public function getIDByName(string $name) : string
     {
         $items = $this->getAll();
@@ -141,12 +141,12 @@ 
         return in_array($id, $ids);
     }
     
-   /**
-    * Checks wether the specified name exists.
-    * 
-    * @param string $name For example: "showvar".
-    * @return bool
-    */
+    /**
+     * Checks wether the specified name exists.
+     * 
+     * @param string $name For example: "showvar".
+     * @return bool
+     */
     public function nameExists(string $name) : bool
     {
         $items = $this->getAll();
@@ -200,14 +200,14 @@ 
         return $class;
     }
     
-   /**
-    * Translates the command type to the expected class naming scheme.
-    * 
-    * Example: not-empty => NotEmpty
-    * 
-    * @param string $type
-    * @return string
-    */
+    /**
+     * Translates the command type to the expected class naming scheme.
+     * 
+     * Example: not-empty => NotEmpty
+     * 
+     * @param string $type
+     * @return string
+     */
     private function adjustTypeName(string $type) : string
     {
         $type = str_replace('-', ' ', $type);
@@ -217,13 +217,13 @@ 
         return $type;
     }
     
-   /**
-    * Retrieves the dummy command of the specified type, which
-    * is used to retrieve information on the command's capabilities.
-    *  
-    * @param string $id
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Retrieves the dummy command of the specified type, which
+     * is used to retrieve information on the command's capabilities.
+     *  
+     * @param string $id
+     * @return Mailcode_Commands_Command
+     */
     private function getDummyCommand(string $id) : Mailcode_Commands_Command
     {
         if(!isset(self::$dummyCommands[$id]))

src/Mailcode/Factory/CommandSets/Set.php

Indentation +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  */
 abstract class Mailcode_Factory_CommandSets_Set
 {
-   /**
-    * @var Mailcode_Factory_Instantiator
-    */
+    /**
+     * @var Mailcode_Factory_Instantiator
+     */
     protected $instantiator;
     
     public function __construct()

src/Mailcode/Factory/CommandSets.php

Indentation +6 added lines, -6 removed lines

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

src/Mailcode/Commands/Command.php

Indentation +79 added lines, -79 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,14 +78,14 @@ 
         'type_unsupported'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $comment = '';
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords|NULL
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords|NULL
+     */
     protected $logicKeywords;
     
     public function __construct(string $type='', string $paramsString='', string $matchedText='')
@@ -103,9 +103,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.
@@ -114,14 +114,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;
@@ -129,34 +129,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();
@@ -253,9 +253,9 @@ 
         return $this->validationResult->isValid();
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     abstract protected function getValidations() : array;
     
     protected function validateSyntax_params_empty() : void
@@ -410,12 +410,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;
@@ -461,22 +461,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);

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
@@ -61,15 +61,15 @@ 
         return false;
     }
     
-   /**
-    * 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();
@@ -86,15 +86,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();
@@ -102,19 +102,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/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
@@ -59,13 +59,13 @@ 
         return false;
     }
     
-   /**
-    * 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();
@@ -82,13 +82,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/Commands/LogicKeywords.php

Indentation +45 added lines, -45 removed lines

@@ -31,27 +31,27 @@ 
     const VALIDATION_CANNOT_MIX_LOGIC_KEYWORDS = 60701;
     const VALIDATION_INVALID_SUB_COMMAND = 60702;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $paramsString;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     private $names = array(
         'and', 
         'or'
     );
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     private $keywords = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $mainParams = '';
     
     public function __construct(Mailcode_Commands_Command $command, string $paramsString)
@@ -136,9 +136,9 @@ 
         }
     }
     
-   /**
-    * @return string[]
-    */
+    /**
+     * @return string[]
+     */
     private function detectParameters() : array
     {
         $params = $this->paramsString;
@@ -156,13 +156,13 @@ 
         return $stack;
     }
 
-   /**
-    * @param string $params
-    * @param Mailcode_Commands_LogicKeywords_Keyword $keyword
-    * @param string[] $stack
-    * @throws Mailcode_Exception
-    * @return string
-    */
+    /**
+     * @param string $params
+     * @param Mailcode_Commands_LogicKeywords_Keyword $keyword
+     * @param string[] $stack
+     * @throws Mailcode_Exception
+     * @return string
+     */
     private function detectParamsKeyword(string $params, Mailcode_Commands_LogicKeywords_Keyword $keyword, array &$stack) : string
     {
         $search = $keyword->getMatchedString();
@@ -187,22 +187,22 @@ 
         return $params;
     }
     
-   /**
-    * Extracts the parameters string to use for the 
-    * original command itself, omitting all the logic
-    * keywords for the sub-commands.
-    * 
-    * @return string
-    */
+    /**
+     * Extracts the parameters string to use for the 
+     * original command itself, omitting all the logic
+     * keywords for the sub-commands.
+     * 
+     * @return string
+     */
     public function getMainParamsString() : string
     {
         return $this->mainParams;
     }
     
-   /**
-    * Retrieves the detected keyword names.
-    * @return string[]
-    */
+    /**
+     * Retrieves the detected keyword names.
+     * @return string[]
+     */
     public function getDetectedNames() : array
     {
         $names = array();
@@ -220,23 +220,23 @@ 
         return $names;
     }
     
-   /**
-    * Retrieves all keywords that were detected in the
-    * command's parameters string, if any.
-    * 
-    * @return Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * Retrieves all keywords that were detected in the
+     * command's parameters string, if any.
+     * 
+     * @return Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     public function getKeywords() : array
     {
         return $this->keywords;
     }
     
-   /**
-    * Detects any keyword statements in the parameters by keyword name.
-    * 
-    * @param string $name
-    * @return Mailcode_Commands_LogicKeywords_Keyword[]
-    */
+    /**
+     * Detects any keyword statements in the parameters by keyword name.
+     * 
+     * @param string $name
+     * @return Mailcode_Commands_LogicKeywords_Keyword[]
+     */
     private function detectKeywords(string $name) : array
     {
         $regex = sprintf('/%1$s\s+([a-z\-0-9]+):|%1$s:/x', $name);