Mistralys / mailcode

src/Mailcode.php

Spacing +8 added lines, -8 removed lines

@@ -77,7 +77,7 @@ 
     */
     public function getParser() : Mailcode_Parser
     {
-        if(!isset($this->parser)) 
+        if (!isset($this->parser)) 
         {
             $this->parser = new Mailcode_Parser($this);
         }
@@ -93,7 +93,7 @@ 
     */
     public function getCommands() : Mailcode_Commands
     {
-        if(!isset($this->commands)) 
+        if (!isset($this->commands)) 
         {
             $this->commands = new Mailcode_Commands();
         }
@@ -118,14 +118,14 @@ 
      * @param Mailcode_Commands_Command|null $sourceCommand
      * @return Mailcode_Variables_Collection_Regular
      */
-    public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Variables_Collection_Regular
+    public function findVariables(string $subject, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject, $sourceCommand);
     }
     
     public function createVariables() : Mailcode_Variables
     {
-        if(!isset($this->variables))
+        if (!isset($this->variables))
         {
             $this->variables = new Mailcode_Variables();
         }
@@ -141,7 +141,7 @@ 
     */
     public function createTranslator() : Mailcode_Translator
     {
-        if(!isset($this->translator))
+        if (!isset($this->translator))
         {
             $this->translator = new Mailcode_Translator(); 
         }
@@ -189,7 +189,7 @@ 
         return self::$logger;
     }
 
-    public static function setDebugging(bool $enabled=true) : void
+    public static function setDebugging(bool $enabled = true) : void
     {
         self::$debug = $enabled;
     }
@@ -204,9 +204,9 @@ 
      * @param array<string|int,mixed> $context
      * @return void
      */
-    public static function debug(string $message, array $context=array()) : void
+    public static function debug(string $message, array $context = array()) : void
     {
-        if(self::$debug && isset(self::$logger))
+        if (self::$debug && isset(self::$logger))
         {
             self::$logger->debug($message, $context);
         }

src/Mailcode/Commands/Command/ShowURL/AutoTrackingID.php

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
     {
         $instanceID = $command->getInstanceID();
 
-        if(isset(self::$generated[$instanceID]))
+        if (isset(self::$generated[$instanceID]))
         {
             return self::$generated[$instanceID];
         }
@@ -85,11 +85,11 @@ 
 
     private static function generateIDString(TrackingIDInterface $command) : string
     {
-        if(isset(self::$customGenerator))
+        if (isset(self::$customGenerator))
         {
             $result = call_user_func(self::$customGenerator, $command);
 
-            if(is_string($result))
+            if (is_string($result))
             {
                 return $result;
             }

src/Mailcode/Commands/Command.php

Spacing +22 added lines, -22 removed lines

@@ -131,7 +131,7 @@ 
 
     private int $instanceID;
 
-    public function __construct(string $type='', string $paramsString='', string $matchedText='')
+    public function __construct(string $type = '', string $paramsString = '', string $matchedText = '')
     {
         self::$instanceCounter++;
 
@@ -222,7 +222,7 @@ 
     {
         $this->requireNonDummy();
         
-        if($this->hash === '') {
+        if ($this->hash === '') {
             $this->hash = md5($this->matchedText);
         }
         
@@ -231,7 +231,7 @@ 
     
     protected function requireNonDummy() : void
     {
-        if(!$this->isDummy())
+        if (!$this->isDummy())
         {
             return;
         }
@@ -250,7 +250,7 @@ 
     
     protected function validate() : OperationResult
     {
-        if(!$this->validated)
+        if (!$this->validated)
         {
             $this->requireNonDummy();
             $this->validateSyntax();
@@ -270,10 +270,10 @@ 
     {
         $validations = $this->resolveValidations();
 
-        foreach($validations as $validation)
+        foreach ($validations as $validation)
         {
             // break off at the first validation issue
-            if(!$this->validateSyntaxMethod($validation))
+            if (!$this->validateSyntaxMethod($validation))
             {
                 return;
             }
@@ -292,7 +292,7 @@ 
     {
         $method = 'validateSyntax_'.$validation;
         
-        if(!method_exists($this, $method))
+        if (!method_exists($this, $method))
         {
             throw new Mailcode_Exception(
                 'Missing validation method ['.$validation.']',
@@ -322,7 +322,7 @@ 
 
     public function validateNesting() : OperationResult
     {
-        if($this->nestingValidated)
+        if ($this->nestingValidated)
         {
             return $this->validationResult;
         }
@@ -346,7 +346,7 @@ 
     
     public function getType() : string
     {
-        if($this->supportsType())
+        if ($this->supportsType())
         {
             return $this->type;
         }
@@ -366,7 +366,7 @@ 
     
     public function getHighlighted() : string
     {
-        if(!$this->isValid())
+        if (!$this->isValid())
         {
             return '';
         }
@@ -377,7 +377,7 @@ 
     
     public function getParamsString() : string
     {
-        if($this->requiresParameters())
+        if ($this->requiresParameters())
         {
             return $this->paramsString;
         }
@@ -392,7 +392,7 @@ 
 
     public function requireParams() : Mailcode_Parser_Statement
     {
-        if(isset($this->params))
+        if (isset($this->params))
         {
             return $this->params;
         }
@@ -422,22 +422,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';
         }
@@ -474,7 +474,7 @@ 
     
     public function getLogicKeywords() : Mailcode_Commands_LogicKeywords
     {
-        if(isset($this->logicKeywords) && $this->supportsLogicKeywords())
+        if (isset($this->logicKeywords) && $this->supportsLogicKeywords())
         {
             return $this->logicKeywords;
         }
@@ -494,7 +494,7 @@ 
 
     public function getTranslationParam(string $name)
     {
-        if(isset($this->translationParams[$name]))
+        if (isset($this->translationParams[$name]))
         {
             return $this->translationParams[$name];
         }
@@ -502,7 +502,7 @@ 
         return null;
     }
 
-    public function setURLEncoding(bool $encoding=true)
+    public function setURLEncoding(bool $encoding = true)
     {
         $this->requireURLEncoding();
 
@@ -513,7 +513,7 @@ 
         return $this;
     }
 
-    public function setURLDecoding(bool $decode=true)
+    public function setURLDecoding(bool $decode = true)
     {
         $this->requireURLEncoding();
 
@@ -526,7 +526,7 @@ 
 
     protected function requireURLEncoding() : void
     {
-        if($this->supportsURLEncoding()) {
+        if ($this->supportsURLEncoding()) {
             return;
         }
 
@@ -552,7 +552,7 @@ 
 
     protected function getValidator() : Mailcode_Parser_Statement_Validator
     {
-        if(isset($this->validator))
+        if (isset($this->validator))
         {
             return $this->validator;
         }

src/Mailcode/Factory/CommandSets/Set/Show.php

Spacing +18 added lines, -18 removed lines

@@ -35,7 +35,7 @@ 
         
         $this->instantiator->checkCommand($cmd);
         
-        if($cmd instanceof Mailcode_Commands_Command_ShowVariable)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowVariable)
         {
             return $cmd;
         }
@@ -43,12 +43,12 @@ 
         throw $this->instantiator->exceptionUnexpectedType('ShowVariable', $cmd);
     }
     
-    public function date(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowDate
+    public function date(string $variableName, string $formatString = "") : Mailcode_Commands_Command_ShowDate
     {
         $variableName = $this->instantiator->filterVariableName($variableName);
         
         $format = '';
-        if(!empty($formatString))
+        if (!empty($formatString))
         {
             $format = sprintf(
                 ' "%s"',
@@ -69,7 +69,7 @@ 
         
         $this->instantiator->checkCommand($cmd);
         
-        if($cmd instanceof Mailcode_Commands_Command_ShowDate)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowDate)
         {
             return $cmd;
         }
@@ -77,7 +77,7 @@ 
         throw $this->instantiator->exceptionUnexpectedType('ShowDate', $cmd);
     }
 
-    public function number(string $variableName, string $formatString="", bool $absolute=false) : Mailcode_Commands_Command_ShowNumber
+    public function number(string $variableName, string $formatString = "", bool $absolute = false) : Mailcode_Commands_Command_ShowNumber
     {
         $variableName = $this->instantiator->filterVariableName($variableName);
         $paramsString = $this->compileNumberParams($formatString, $absolute);
@@ -95,7 +95,7 @@ 
 
         $this->instantiator->checkCommand($cmd);
 
-        if($cmd instanceof Mailcode_Commands_Command_ShowNumber)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowNumber)
         {
             return $cmd;
         }
@@ -103,11 +103,11 @@ 
         throw $this->instantiator->exceptionUnexpectedType('ShowNumber', $cmd);
     }
 
-    private function compileNumberParams(string $formatString="", bool $absolute=false) : string
+    private function compileNumberParams(string $formatString = "", bool $absolute = false) : string
     {
         $params = array();
 
-        if(!empty($formatString))
+        if (!empty($formatString))
         {
             $params[] = sprintf(
                 ' "%s"',
@@ -115,12 +115,12 @@ 
             );
         }
 
-        if($absolute)
+        if ($absolute)
         {
             $params[] = ' absolute:';
         }
 
-        if(!empty($params))
+        if (!empty($params))
         {
             return ' '.implode(' ', $params);
         }
@@ -138,7 +138,7 @@ 
      * @throws Mailcode_Exception
      * @throws Mailcode_Factory_Exception
      */
-    public function phone(string $variableName, string $sourceFormat, string $urlEncoding=Mailcode_Factory::URL_ENCODING_NONE) : Mailcode_Commands_Command_ShowPhone
+    public function phone(string $variableName, string $sourceFormat, string $urlEncoding = Mailcode_Factory::URL_ENCODING_NONE) : Mailcode_Commands_Command_ShowPhone
     {
         $variableName = $this->instantiator->filterVariableName($variableName);
 
@@ -161,7 +161,7 @@ 
         $this->instantiator->checkCommand($cmd);
         $this->instantiator->setEncoding($cmd, $urlEncoding);
 
-        if($cmd instanceof Mailcode_Commands_Command_ShowPhone)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowPhone)
         {
             return $cmd;
         }
@@ -182,7 +182,7 @@ 
         
         $this->instantiator->checkCommand($cmd);
         
-        if($cmd instanceof Mailcode_Commands_Command_ShowSnippet)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowSnippet)
         {
             return $cmd;
         }
@@ -198,21 +198,21 @@ 
      * @throws Mailcode_Exception
      * @throws Mailcode_Factory_Exception
      */
-    public function url(string $url, ?string $trackingID=null, array $queryParams=array()) : Mailcode_Commands_Command_ShowURL
+    public function url(string $url, ?string $trackingID = null, array $queryParams = array()) : Mailcode_Commands_Command_ShowURL
     {
         $contentID = PreParser::storeContent($url);
 
         $params = array();
         $params[] = (string)$contentID;
 
-        if($trackingID !== null)
+        if ($trackingID !== null)
         {
             $params[] = sprintf('"%s"', $trackingID);
         }
 
-        if(!empty($queryParams))
+        if (!empty($queryParams))
         {
-            foreach($queryParams as $name => $value)
+            foreach ($queryParams as $name => $value)
             {
                 $params[] = sprintf(
                     '"%s=%s"',
@@ -233,7 +233,7 @@ 
 
         $this->instantiator->checkCommand($cmd);
 
-        if($cmd instanceof Mailcode_Commands_Command_ShowURL)
+        if ($cmd instanceof Mailcode_Commands_Command_ShowURL)
         {
             return $cmd;
         }

src/Mailcode/Parser.php

Spacing +10 added lines, -10 removed lines

@@ -72,7 +72,7 @@ 
 
         $result = new ParseResult($collection, $preParser);
 
-        if(!$collection->isValid())
+        if (!$collection->isValid())
         {
             return $result;
         }
@@ -84,7 +84,7 @@ 
         
         $total = count($matches[0]);
 
-        for($i=0; $i < $total; $i++)
+        for ($i = 0; $i < $total; $i++)
         {
             $match = $this->parseMatch($matches, $i);
             
@@ -154,17 +154,17 @@ 
     private function handleNesting(Mailcode_Commands_Command $cmd) : void
     {
         // Set the command's parent from the stack, if any is present.
-        if(!empty($this->stack))
+        if (!empty($this->stack))
         {
             $cmd->setParent($this->getStackLast());
         }
 
         // 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);
         }
@@ -178,7 +178,7 @@ 
     {
         $cmd = $this->stack[array_key_last($this->stack)];
 
-        if($cmd instanceof Mailcode_Commands_Command)
+        if ($cmd instanceof Mailcode_Commands_Command)
         {
             return $cmd;
         }
@@ -207,16 +207,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];
@@ -253,7 +253,7 @@ 
      * @param Mailcode_Commands_Command|null $sourceCommand
      * @return Mailcode_Parser_Statement
      */
-    public function createStatement(string $statement, bool $freeform=false, ?Mailcode_Commands_Command $sourceCommand=null) : Mailcode_Parser_Statement
+    public function createStatement(string $statement, bool $freeform = false, ?Mailcode_Commands_Command $sourceCommand = null) : Mailcode_Parser_Statement
     {
         return new Mailcode_Parser_Statement($statement, $freeform, $sourceCommand);
     }

src/Mailcode/Parser/PreParser.php

Spacing +17 added lines, -17 removed lines

@@ -116,7 +116,7 @@ 
      */
     public static function getContent(int $id) : string
     {
-        if(isset(self::$contents[$id]))
+        if (isset(self::$contents[$id]))
         {
             return self::$contents[$id];
         }
@@ -139,7 +139,7 @@ 
      */
     public static function clearContent(int $id) : void
     {
-        if(isset(self::$contents[$id]))
+        if (isset(self::$contents[$id]))
         {
             unset(self::$contents[$id]);
         }
@@ -156,7 +156,7 @@ 
      */
     public function parse() : self
     {
-        if($this->parsed)
+        if ($this->parsed)
         {
             return $this;
         }
@@ -166,7 +166,7 @@ 
 
         $this->detectCommands();
 
-        foreach($this->commands as $commandDef)
+        foreach ($this->commands as $commandDef)
         {
             $this->processCommand($commandDef);
         }
@@ -187,7 +187,7 @@ 
         $commands = Mailcode::create()->getCommands()->getContentCommands();
         $result = array();
 
-        foreach($commands as $command)
+        foreach ($commands as $command)
         {
             $result[] = $command->getName();
         }
@@ -260,9 +260,9 @@ 
 
     private function validateCommandContents() : void
     {
-        foreach($this->commands as $command)
+        foreach ($this->commands as $command)
         {
-            if(!$command->validateContent($this, $this->collection))
+            if (!$command->validateContent($this, $this->collection))
             {
                 return;
             }
@@ -274,12 +274,12 @@ 
         $openingCommands = $this->detectOpeningCommands();
         $closingCommands = $this->detectClosingCommands();
 
-        if(!$this->validateCommandsList($openingCommands, $closingCommands))
+        if (!$this->validateCommandsList($openingCommands, $closingCommands))
         {
             return;
         }
 
-        foreach($openingCommands as $idx => $def)
+        foreach ($openingCommands as $idx => $def)
         {
             $this->commands[] = new CommandDef(
                 $def['name'],
@@ -300,20 +300,20 @@ 
         $opening = count($openingCommands);
         $closing = count($closingCommands);
         $max = $opening;
-        if($closing > $max) {
+        if ($closing > $max) {
             $max = $closing;
         }
 
-        for($i=0; $i < $max; $i++)
+        for ($i = 0; $i < $max; $i++)
         {
             // command closed that was never opened
-            if(!isset($openingCommands[$i]))
+            if (!isset($openingCommands[$i]))
             {
                 return $this->addErrorClosedNeverOpened($closingCommands[$i]['matchedText']);
             }
 
             // command opened that was never closed
-            if(!isset($closingCommands[$i]))
+            if (!isset($closingCommands[$i]))
             {
                 return $this->addErrorNeverClosed(
                     $openingCommands[$i]['matchedText'],
@@ -322,7 +322,7 @@ 
             }
 
             // command closed does not match opening
-            if($openingCommands[$i]['name'] !== $closingCommands[$i]['name'])
+            if ($openingCommands[$i]['name'] !== $closingCommands[$i]['name'])
             {
                 return $this->addErrorClosingMismatch(
                     $openingCommands[$i]['name'],
@@ -377,7 +377,7 @@ 
 
         $result = array();
 
-        foreach($matches[0] as $idx => $matchedText)
+        foreach ($matches[0] as $idx => $matchedText)
         {
             $result[] = array(
                 'name' => strtolower(trim((string)$matches[1][$idx])),
@@ -461,7 +461,7 @@ 
             $matchedText,
             t(
                 'The command is never closed with a matching %1$s command.',
-                sb()->code('{' . $name . '}')
+                sb()->code('{'.$name.'}')
             ),
             Mailcode_Commands_CommonConstants::VALIDATION_MISSING_CONTENT_CLOSING_TAG
         );
@@ -485,7 +485,7 @@ 
                 )
                 ->t(
                     'It must be closed with a matching %1$s command.',
-                    sb()->code('{' . $name . '}')
+                    sb()->code('{'.$name.'}')
                 ),
             Mailcode_Commands_CommonConstants::VALIDATION_CONTENT_CLOSING_MISMATCHED_TAG
         );

src/Mailcode/Parser/PreParser/Debugger.php

Spacing +10 added lines, -10 removed lines

@@ -30,22 +30,22 @@ 
      */
     public function debugOpeningCommands(array $matches) : void
     {
-        if(!Mailcode::isDebugEnabled())
+        if (!Mailcode::isDebugEnabled())
         {
             return;
         }
 
         Mailcode::debug('Opening command matches:');
 
-        if(empty($matches))
+        if (empty($matches))
         {
             Mailcode::debug('...None found.');
             return;
         }
 
-        foreach($matches[0] as $idx => $matchedText)
+        foreach ($matches[0] as $idx => $matchedText)
         {
-            $number = $idx+1;
+            $number = $idx + 1;
 
             Mailcode::debug(sprintf('...#%02d matched: [%s]', $number, $matchedText));
             Mailcode::debug(sprintf('...#%02d name...: [%s]', $number, $matches[1][$idx]));
@@ -59,22 +59,22 @@ 
      */
     public function debugClosingCommands(array $commands) : void
     {
-        if(!Mailcode::isDebugEnabled())
+        if (!Mailcode::isDebugEnabled())
         {
             return;
         }
 
         Mailcode::debug('Closing command matches:', $commands);
 
-        if(empty($commands))
+        if (empty($commands))
         {
             Mailcode::debug('...None found.');
             return;
         }
 
-        foreach($commands as $idx => $command)
+        foreach ($commands as $idx => $command)
         {
-            $number = $idx+1;
+            $number = $idx + 1;
 
             Mailcode::debug(sprintf('...#%02d matched: [%s]', $number, $command['matchedText']));
             Mailcode::debug(sprintf('...#%02d name...: [%s]', $number, $command['name']));
@@ -83,14 +83,14 @@ 
 
     public function debugCommandDef(CommandDef $commandDef) : void
     {
-        if(!Mailcode::isDebugEnabled())
+        if (!Mailcode::isDebugEnabled())
         {
             return;
         }
 
         Mailcode::debug('Command definition:', $commandDef->toArray());
 
-        if(defined('TESTS_ROOT'))
+        if (defined('TESTS_ROOT'))
         {
             print_r($commandDef->toArray());
         }

src/Mailcode/Styler.php

Indentation +29 added lines, -29 removed lines

@@ -25,14 +25,14 @@ 
 {
     public const ERROR_CSS_FILE_NOT_FOUND = 60901;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private string $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private string $fileName = 'highlight.css';
     
     public function __construct()
@@ -55,22 +55,22 @@ 
         $this->path = $path;
     }
    
-   /**
-    * Retrieves the raw CSS source for the highlighting.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the raw CSS source for the highlighting.
+     * 
+     * @return string
+     */
     public function getCSS() : string
     {
         return FileHelper::readContents($this->path);
     }
     
-   /**
-    * Retrieves a fully formed `code` tag with the CSS,
-    * to inject inline into an HTML document.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a fully formed `code` tag with the CSS,
+     * to inject inline into an HTML document.
+     * 
+     * @return string
+     */
     public function getStyleTag() : string
     {
         return sprintf(
@@ -79,23 +79,23 @@ 
         );
     }
     
-   /**
-    * Retrieves the path to the stylesheet file.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path to the stylesheet file.
+     * 
+     * @return string
+     */
     public function getStylesheetPath() : string
     {
         return $this->path;
     }
     
-   /**
-    * Retrieves the URL to the stylesheet file, given the
-    * local URL to the application's vendor folder.
-    *  
-    * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
-    * @return string
-    */
+    /**
+     * Retrieves the URL to the stylesheet file, given the
+     * local URL to the application's vendor folder.
+     *  
+     * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
+     * @return string
+     */
     public function getStylesheetURL(string $vendorURL) : string
     {
         return sprintf(

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected bool $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::show()->var($variableName));