Mistralys / mailcode

src/Mailcode/Parser/Statement.php

Indentation +13 added lines, -13 removed lines

@@ -29,24 +29,24 @@ 
     
     const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $statement;
     
-   /**
-    * @var OperationResult
-    */
+    /**
+     * @var OperationResult
+     */
     protected $result;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Info|NULL
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Info|NULL
+     */
     protected $info;
     
     public function __construct(string $statement)
@@ -102,7 +102,7 @@ 
         if($unknown)
         {
             $this->result->makeError(
-               t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
+                t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
                 self::VALIDATION_UNQUOTED_STRING_LITERALS
             );
         }

src/Mailcode/Factory.php

Indentation +52 added lines, -52 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);
@@ -52,41 +52,41 @@ 
         return self::$commandSets->show()->showDate($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);
@@ -207,34 +207,34 @@ 
         return self::$commandSets->if()->ifNotEmpty($variable);
     }
     
-   /**
-    * 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/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;
     
     public function __construct(Mailcode $mailcode)
@@ -44,24 +44,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();
@@ -94,14 +94,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();
@@ -132,14 +132,14 @@ 
         $collection->addInvalidCommand($cmd);
     }
     
-   /**
-    * 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"
@@ -177,26 +177,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);

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

src/Mailcode.php

Indentation +51 added lines, -51 removed lines

@@ -26,51 +26,51 @@ 
  */
 class Mailcode
 {
-   /**
-    * @var Mailcode_Parser|NULL
-    */
+    /**
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
     }
     
-   /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+    /**
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()->parseString($string);
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -81,12 +81,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -102,12 +102,12 @@ 
         return $this->getParser()->createSafeguard($subject);
     }
     
-   /**
-    * Attempts to find all variables in the target string.
-    * 
-    * @param string $subject
-    * @return Mailcode_Variables_Collection_Regular
-    */
+    /**
+     * Attempts to find all variables in the target string.
+     * 
+     * @param string $subject
+     * @return Mailcode_Variables_Collection_Regular
+     */
     public function findVariables(string $subject) : Mailcode_Variables_Collection_Regular
     {
         return $this->createVariables()->parseString($subject);
@@ -123,12 +123,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))
@@ -139,12 +139,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();

src/Mailcode/Styler.php

Indentation +29 added lines, -29 removed lines

@@ -24,14 +24,14 @@ 
 {
     const ERROR_CSS_FILE_NOT_FOUND = 60901;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $fileName = 'highlight.css';
     
     public function __construct()
@@ -54,22 +54,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(
@@ -78,23 +78,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(