Mistralys / mailcode

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(

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
         $folder = sprintf(__DIR__.'/../../css/%s', $this->fileName);
         $path = realpath($folder);
         
-        if($path === false)
+        if ($path === false)
         {
             throw new Mailcode_Exception(
                 'Could not find the highlight CSS file',

src/Mailcode/Parser/Statement/Info.php

Indentation +69 added lines, -69 removed lines

@@ -21,14 +21,14 @@ 
  */
 class Mailcode_Parser_Statement_Info
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokens = array();
     
     public function __construct(Mailcode_Parser_Statement_Tokenizer $tokenizer)
@@ -37,11 +37,11 @@ 
         $this->tokens = $this->tokenizer->getTokens(); 
     }
     
-   /**
-    * Whether the whole statement is a variable being assigned a value.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being assigned a value.
+     * 
+     * @return bool
+     */
     public function isVariableAssignment() : bool
     {
         $variable = $this->getVariableByIndex(0);
@@ -56,11 +56,11 @@ 
         return false;
     }
     
-   /**
-    * Whether the whole statement is a variable being compared to something.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being compared to something.
+     * 
+     * @return bool
+     */
     public function isVariableComparison() : bool
     {
         $variable = $this->getVariableByIndex(0);
@@ -75,11 +75,11 @@ 
         return false;
     }
     
-   /**
-    * Retrieves all variables used in the statement.
-    * 
-    * @return \Mailcode\Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables used in the statement.
+     * 
+     * @return \Mailcode\Mailcode_Variables_Variable[]
+     */
     public function getVariables()
     {
         $result = array();
@@ -95,14 +95,14 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves a variable by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    * 
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * Retrieves a variable by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     * 
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable
     {
         $token = $this->getTokenByIndex($index);
@@ -115,14 +115,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a string literal by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
-    */
+    /**
+     * Retrieves a string literal by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
+     */
     public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
     {
         $token = $this->getTokenByIndex($index);
@@ -135,14 +135,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a keyword by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * Retrieves a keyword by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
     {
         $token = $this->getTokenByIndex($index);
@@ -155,14 +155,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves an operand by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
-    */
+    /**
+     * Retrieves an operand by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
+     */
     public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand
     {
         $token = $this->getTokenByIndex($index);
@@ -175,14 +175,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a parameter token by its position in the command's parameters,
-    * regardless of its type. Returns null if there is no parameter at the 
-    * specified index.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
-    */
+    /**
+     * Retrieves a parameter token by its position in the command's parameters,
+     * regardless of its type. Returns null if there is no parameter at the 
+     * specified index.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
+     */
     public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token
     {
         if(isset($this->tokens[$index]))
@@ -198,19 +198,19 @@ 
         return isset($this->tokens[$index]);
     }
     
-   /**
-    * Retrieves all tokens.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens() : array
     {
         return $this->tokens;
     }
     
-   /**
-    * Retrieves all string literals that were found in the command.
-    * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
-    */
+    /**
+     * Retrieves all string literals that were found in the command.
+     * @return \Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
+     */
     public function getStringLiterals()
     {
         $result = array();

src/Mailcode/Commands/LogicKeywords/Keyword.php

Indentation +51 added lines, -51 removed lines

@@ -29,39 +29,39 @@ 
     const VALIDATION_NO_COMMAND_CREATED = 61101;
     const VALIDATION_INVALID_COMMAND_CREATED = 61102;
     
-   /**
-    * @var Mailcode_Commands_LogicKeywords
-    */
+    /**
+     * @var Mailcode_Commands_LogicKeywords
+     */
     private $keywords;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $keywordType;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $matchedString;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $params = '';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $paramsSet = false;
     
-   /**
-    * @var Mailcode_Collection
-    */
+    /**
+     * @var Mailcode_Collection
+     */
     private $collection;
     
     public function __construct(Mailcode_Commands_LogicKeywords $keywords, string $name, string $matchedString, string $type)
@@ -72,10 +72,10 @@ 
         $this->matchedString = $matchedString;
     }
     
-   /**
-    * The keyword name, e.g. "and". Always lowercase.
-    * @return string
-    */
+    /**
+     * The keyword name, e.g. "and". Always lowercase.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
@@ -98,24 +98,24 @@ 
         return $string;
     }
     
-   /**
-    * The full string that was matched in the command's parameters
-    * string. Examples: "and:", "and variable:"...
-    * 
-    * @return string
-    */
+    /**
+     * The full string that was matched in the command's parameters
+     * string. Examples: "and:", "and variable:"...
+     * 
+     * @return string
+     */
     public function getMatchedString() : string
     {
         return $this->matchedString;
     }
     
-   /**
-    * Sets the parameters string matching this logic keyword,
-    * which is used to build the actual sub-command. Set by
-    * the LogicKeywords class instance.
-    * 
-    * @param string $params
-    */
+    /**
+     * Sets the parameters string matching this logic keyword,
+     * which is used to build the actual sub-command. Set by
+     * the LogicKeywords class instance.
+     * 
+     * @param string $params
+     */
     public function setParamsString(string $params) : void
     {
         if($this->paramsSet)
@@ -133,13 +133,13 @@ 
         $this->createCommand();
     }
     
-   /**
-    * Retrieves the full command string used to create 
-    * the actual command. For opening commands like IF,
-    * this includes the closing {end} command.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the full command string used to create 
+     * the actual command. For opening commands like IF,
+     * this includes the closing {end} command.
+     * 
+     * @return string
+     */
     public function getCommandString() : string
     {
         $string = sprintf(
@@ -182,12 +182,12 @@ 
         }
     }
     
-   /**
-    * Retrieves the command for the keyword.
-    * 
-    * @throws Mailcode_Exception
-    * @return Mailcode_Commands_Command
-    */
+    /**
+     * Retrieves the command for the keyword.
+     * 
+     * @throws Mailcode_Exception
+     * @return Mailcode_Commands_Command
+     */
     public function getCommand() : Mailcode_Commands_Command
     {
         $command = $this->collection->getFirstCommand();

Spacing +5 added lines, -5 removed lines

@@ -90,7 +90,7 @@ 
     {
         $string = $this->name;
         
-        if(!empty($this->keywordType))
+        if (!empty($this->keywordType))
         {
             $string .= ' '.$this->keywordType;
         }
@@ -118,7 +118,7 @@ 
     */
     public function setParamsString(string $params) : void
     {
-        if($this->paramsSet)
+        if ($this->paramsSet)
         {
             throw new Mailcode_Exception(
                 'Cannot set parameters twice',
@@ -160,7 +160,7 @@ 
         
         $command = $this->collection->getFirstCommand();
         
-        if($command === null)
+        if ($command === null)
         {
             $this->makeError(
                 t('No command could be created using the following string:').' '.
@@ -172,7 +172,7 @@ 
             return;
         }
         
-        if(!$command->isValid())
+        if (!$command->isValid())
         {
             $this->makeError(
                 t('Invalid command created:').' '.
@@ -192,7 +192,7 @@ 
     {
         $command = $this->collection->getFirstCommand();
         
-        if($command !== null && $command->isValid())
+        if ($command !== null && $command->isValid())
         {
             return $command;
         }

src/Mailcode/Commands/Highlighter.php

Indentation +12 added lines, -12 removed lines

@@ -20,19 +20,19 @@ 
  */
 class Mailcode_Commands_Highlighter
 {
-   /**
-    * @var Mailcode_Commands_Command
-    */
+    /**
+     * @var Mailcode_Commands_Command
+     */
     protected $command;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $parts = array();
     
     public function __construct(Mailcode_Commands_Command $command)
     {
-       $this->command = $command;
+        $this->command = $command;
     }
     
     public function highlight() : string
@@ -121,11 +121,11 @@ 
         $this->appendParams($keyword->getCommand());
     }
     
-   /**
-    * @param string[] $classes
-    * @param string $content
-    * @return string
-    */
+    /**
+     * @param string[] $classes
+     * @param string $content
+     * @return string
+     */
     protected function renderTag(array $classes, string $content) : string
     {
         $parts = array();

Spacing +8 added lines, -8 removed lines

@@ -52,12 +52,12 @@ 
     {
         $this->parts[] = $this->renderTag(array('command-name'), $this->command->getName());
         
-        if($this->command->hasType())
+        if ($this->command->hasType())
         {
             $this->parts[] = ' '.$this->renderTag(array('command-type'), $this->command->getType());
         }
         
-        if($this->command->requiresParameters())
+        if ($this->command->requiresParameters())
         {
             $this->parts[] = $this->renderTag(array('hyphen'), ':');
             $this->parts[] = '<wbr>';
@@ -68,7 +68,7 @@ 
     {
         $params = $command->getParams();
         
-        if($params === null)
+        if ($params === null)
         {
             return;
         }
@@ -77,7 +77,7 @@ 
         
         $this->parts[] = '<span class="mailcode-params">';
         
-        foreach($tokens as $token)
+        foreach ($tokens as $token)
         {
             $this->appendParamToken($token);
         }
@@ -92,14 +92,14 @@ 
     
     protected function appendLogicKeywords() : void
     {
-        if(!$this->command->supportsLogicKeywords())
+        if (!$this->command->supportsLogicKeywords())
         {
             return;
         }
         
         $keywords = $this->command->getLogicKeywords()->getKeywords();
         
-        foreach($keywords as $keyword)
+        foreach ($keywords as $keyword)
         {
             $this->appendLogicKeyword($keyword);
         }
@@ -111,7 +111,7 @@ 
         
         $type = $keyword->getType();
         
-        if(!empty($type))
+        if (!empty($type))
         {
             $this->parts[] = ' '.$this->renderTag(array('command-type'), $type);
         }
@@ -130,7 +130,7 @@ 
     {
         $parts = array();
         
-        foreach($classes as $class)
+        foreach ($classes as $class)
         {
             $parts[] = 'mailcode-'.$class;
         }

css/index.php

Indentation +7 added lines, -7 removed lines

@@ -48,13 +48,13 @@
     <body>
     	<p>
     		<?php 
-    		    pts('This showcases the command\'s syntax highlighting.');
-    		    pts(
-    		        'It is based on the %1$s color scheme%2$s:',
-    		        '<a href="https://ethanschoonover.com/solarized/">"Solarized"',
-    		        '</a>'
-		        );
-    		?>
+                pts('This showcases the command\'s syntax highlighting.');
+                pts(
+                    'It is based on the %1$s color scheme%2$s:',
+                    '<a href="https://ethanschoonover.com/solarized/">"Solarized"',
+                    '</a>'
+                );
+            ?>
 		</p>
 		<br>
     	<div class="commands">

Spacing +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
     $autoload = realpath($root.'/../vendor/autoload.php');
     
     // we need the autoloader to be present
-    if($autoload === false) 
+    if ($autoload === false) 
     {
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
     }
@@ -65,7 +65,7 @@ 
                     Mailcode_Factory::comment('Some comments here'),
                     Mailcode_Factory::showSnippet('snippet_name'),
                     Mailcode_Factory::showDate('DATE.VARIABLE'),
-                    Mailcode_Factory::if('1 + 1 == 2'),
+                    Mailcode_Factory::if ('1 + 1 == 2'),
                     Mailcode_Factory::ifContains('CUSTOMER.NAME', 'John'),
                     Mailcode_Factory::ifVarEquals('NUMBER', 124),
                 );
@@ -77,7 +77,7 @@ 
                 
                 $commands[] = Mailcode_Factory::end();
                 
-                foreach($commands as $command)
+                foreach ($commands as $command)
                 {
                     ?>
                     	<p>

Braces +3 added lines, -1 removed lines

@@ -65,10 +65,12 @@
                     Mailcode_Factory::comment('Some comments here'),
                     Mailcode_Factory::showSnippet('snippet_name'),
                     Mailcode_Factory::showDate('DATE.VARIABLE'),
-                    Mailcode_Factory::if('1 + 1 == 2'),
+                    Mailcode_Factory::if('1 + 1 == 2') {
+                        ,
                     Mailcode_Factory::ifContains('CUSTOMER.NAME', 'John'),
                     Mailcode_Factory::ifVarEquals('NUMBER', 124),
                 );
+                    }
                 
                 $and = Mailcode_Factory::elseIfVarEqualsString('STRINGVAR', 'John');
                 $and->getLogicKeywords()->appendOR('$STRINGVAR == "Steve"', "variable");