Mailcode\Mailcode_Factory

Complexity

Total Complexity

53

Size/Duplication

Total Lines	429
Duplicated Lines	0 %

Importance

Changes	10
Bugs	0	Features	1

52 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	2
A	elseIfContainsAny()	0	3	1
A	elseIfVarEqualsString()	0	3	1
A	ifVarEqualsString()	0	3	1
A	ifBiggerThan()	0	3	1
A	elseIfEndsWith()	0	3	1
A	ifVarNotEquals()	0	3	1
A	elseIfVar()	0	3	1
A	elseIfEmpty()	0	3	1
A	elseIfVarNotEqualsString()	0	3	1
A	elseIfBiggerThan()	0	3	1
A	code()	0	3	1
A	elseIfNotEmpty()	0	3	1
A	elseIf()	0	3	1
A	elseIfNotContainsAny()	0	3	1
A	ifNotEmpty()	0	3	1
A	ifSmallerThan()	0	3	1
A	ifVarString()	0	3	1
A	ifVarEquals()	0	3	1
A	createPrinter()	0	3	1
A	comment()	0	3	1
A	showVar()	0	3	1
A	ifVarEqualsNumber()	0	3	1
A	setVarString()	0	3	1
A	showNumber()	0	3	1
A	ifVarNotEqualsString()	0	3	1
A	createRenderer()	0	3	1
A	break()	0	3	1
A	elseIfContains()	0	3	1
A	if()	0	3	1
A	elseIfBeginsWith()	0	3	1
A	else()	0	3	1
A	setVar()	0	3	1
A	createDateInfo()	0	3	1
A	elseIfVarString()	0	3	1
A	elseIfVarEquals()	0	3	1
A	ifNotContains()	0	3	1
A	ifEndsWith()	0	3	1
A	elseIfNotContains()	0	3	1
A	ifNotContainsAny()	0	3	1
A	showSnippet()	0	3	1
A	ifContainsAny()	0	3	1
A	ifEmpty()	0	3	1
A	ifContains()	0	3	1
A	elseIfVarEqualsNumber()	0	3	1
A	for()	0	3	1
A	elseIfSmallerThan()	0	3	1
A	ifBeginsWith()	0	3	1
A	ifVar()	0	3	1
A	showDate()	0	3	1
A	elseIfVarNotEquals()	0	3	1
A	end()	0	3	1

<?php
/**
 * File containing the {@see Mailcode_Factory} class.
 *
 * @package Mailcode
 * @subpackage Utilities
 * @see Mailcode_Factory
 */

declare(strict_types=1);

namespace Mailcode;

/**
 * Factory utility used to create commands.
 *
 * @package Mailcode
 * @subpackage Utilities
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Factory
{
    const ERROR_INVALID_COMMAND_CREATED = 50001;
    const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;

   /**
    * @var Mailcode_Factory_CommandSets
    */
    private static $commandSets;

    // region Show commands

    /**
     * Creates a ShowVariable command.
     *
     * @param string $variableName A variable name, with or without the $ sign prepended.
     * @return Mailcode_Commands_Command_ShowVariable
     * @throws Mailcode_Factory_Exception
     */
    public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
    {
        return self::$commandSets->show()->showVar($variableName);
    }

    /**
     * Creates a ShowDate command, used to display date variables and
     * format the date using date format strings.
     *
     * @param string $variableName A variable name, with or without the $ sign prepended.
     * @param string $formatString A date format string, or empty string for default.
     * @return Mailcode_Commands_Command_ShowDate
     * @throws Mailcode_Factory_Exception
     */
    public static function showDate(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowDate
    {
        return self::$commandSets->show()->showDate($variableName, $formatString);
    }

    /**
     * Creates a ShowNumber command, used to display numeric variables
     * and format the numbers to a specific format.
     *
     * @param string $variableName A variable name, with or without the $ sign prepended.
     * @param string $formatString A number format string, or empty string for default.
     * @return Mailcode_Commands_Command_ShowNumber
     * @throws Mailcode_Factory_Exception
     */
    public static function showNumber(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowNumber
    {
        return self::$commandSets->show()->showNumber($variableName, $formatString);
    }

    /**
     * Creates a ShowSnippet command.
     *
     * @param string $snippetName A snippet name, with or without the $ sign prepended.
     * @return Mailcode_Commands_Command_ShowSnippet
     * @throws Mailcode_Factory_Exception
     */
    public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
    {
        return self::$commandSets->show()->showSnippet($snippetName);
    }

    // endregion

    // region Miscellaneous

    /**
     * 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
     * @throws Mailcode_Factory_Exception
     */
    public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
    {
        return self::$commandSets->set()->setVar($variableName, $value, true);
    }

    /**
     * Creates a comment command for documenting things.
     *
     * @param string $comments
     * @return Mailcode_Commands_Command_Comment
     * @throws Mailcode_Factory_Exception
     */
    public static function comment(string $comments) : Mailcode_Commands_Command_Comment
    {
        return self::$commandSets->misc()->comment($comments);
    }

    /**
     * Creates a code command for inserting code blocks meant for
     * the backend system that will parse the templates.
     *
     * @param string $language
     * @return Mailcode_Commands_Command_Code
     * @throws Mailcode_Factory_Exception
     */
    public static function code(string $language) : Mailcode_Commands_Command_Code
    {
        return self::$commandSets->misc()->code($language);
    }

    /**
     * Ends commands like IF and FOR.
     *
     * @return Mailcode_Commands_Command_End
     * @throws Mailcode_Factory_Exception
     */
    public static function end() : Mailcode_Commands_Command_End
    {
        return self::$commandSets->if()->end();
    }

    /**
     * Creates a FOR loop command to iterate over collections.
     *
     * @param string $sourceVariable
     * @param string $loopVariable
     * @return Mailcode_Commands_Command_For
     * @throws Mailcode_Factory_Exception
     */
    public static function for(string $sourceVariable, string $loopVariable) : Mailcode_Commands_Command_For
    {
        return self::$commandSets->misc()->for($sourceVariable, $loopVariable);
    }

    /**
     * Used to break out of a FOR loop command.
     *
     * @return Mailcode_Commands_Command_Break
     * @throws Mailcode_Factory_Exception
     */
    public static function break() : Mailcode_Commands_Command_Break
    {
        return self::$commandSets->misc()->break();
    }

    // endregion
    
    public static function else() : Mailcode_Commands_Command_Else
    {
        return self::$commandSets->if()->else();
    }
    
    public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If
    {
        return self::$commandSets->if()->if($condition, $type);
    }
    

    public static function elseIf(string $condition, string $type='') : Mailcode_Commands_Command_ElseIf
    {
        return self::$commandSets->elseIf()->elseIf($condition, $type);
    }
    
    public static function elseIfEmpty(string $variable) : Mailcode_Commands_Command_ElseIf_Empty
    {
        return self::$commandSets->elseIf()->elseIfEmpty($variable);
    }
    
    public static function elseIfNotEmpty(string $variable) : Mailcode_Commands_Command_ElseIf_NotEmpty
    {
        return self::$commandSets->elseIf()->elseIfNotEmpty($variable);
    }

    // region IF variable

    public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
    {
        return self::$commandSets->if()->ifVar($variable, $operand, $value, $quoteValue);
    }

    public static function ifVarString(string $variable, string $operand, string $value) : Mailcode_Commands_Command_If_Variable
    {
        return self::$commandSets->if()->ifVarString($variable, $operand, $value);
    }

    public static function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
    {
        return self::$commandSets->if()->ifVarEquals($variable, $value, $quoteValue);
    }

    public static function ifVarEqualsString(string $variable, string $value) : Mailcode_Commands_Command_If
    {
        return self::$commandSets->if()->ifVarEqualsString($variable, $value);
    }

    public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
    {
        return self::$commandSets->if()->ifVarNotEquals($variable, $value, $quoteValue);
    }

    public static function ifVarNotEqualsString(string $variable, string $value) : Mailcode_Commands_Command_If_Variable
    {
        return self::$commandSets->if()->ifVarNotEqualsString($variable, $value);
    }

    public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVar($variable, $operand, $value, $quoteValue);
    }

    public static function elseIfVarString(string $variable, string $operand, string $value) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVarString($variable, $operand, $value);
    }
    
    public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVarEquals($variable, $value, $quoteValue);
    }

    public static function elseIfVarEqualsString(string $variable, string $value) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVarEqualsString($variable, $value);
    }
    
    public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVarNotEquals($variable, $value, $quoteValue);
    }

    public static function elseIfVarNotEqualsString(string $variable, string $value) : Mailcode_Commands_Command_ElseIf_Variable
    {
        return self::$commandSets->elseIf()->elseIfVarNotEqualsString($variable, $value);
    }

    public static function ifVarEqualsNumber(string $variable, string $number) : Mailcode_Commands_Command_If_EqualsNumber
    {
        return self::$commandSets->if()->ifVarEqualsNumber($variable, $number);
    }

    public static function elseIfVarEqualsNumber(string $variable, string $number) : Mailcode_Commands_Command_ElseIf_EqualsNumber
    {
        return self::$commandSets->elseIf()->elseIfVarEqualsNumber($variable, $number);
    }

    // endregion

    public static function ifBeginsWith(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_BeginsWith
    {
        return self::$commandSets->if()->ifBeginsWith($variable, $search, $caseInsensitive);
    }

    public static function ifBiggerThan(string $variable, string $number) : Mailcode_Commands_Command_If_BiggerThan
    {
        return self::$commandSets->if()->ifBiggerThan($variable, $number);
    }

    public static function ifSmallerThan(string $variable, string $number) : Mailcode_Commands_Command_If_SmallerThan
    {
        return self::$commandSets->if()->ifSmallerThan($variable, $number);
    }

    public static function ifEndsWith(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_EndsWith
    {
        return self::$commandSets->if()->ifEndsWith($variable, $search, $caseInsensitive);
    }

    public static function elseIfBeginsWith(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_BeginsWith
    {
        return self::$commandSets->elseIf()->elseIfBeginsWith($variable, $search, $caseInsensitive);
    }
    
    public static function elseIfEndsWith(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_EndsWith
    {
        return self::$commandSets->elseIf()->elseIfEndsWith($variable, $search, $caseInsensitive);
    }
    
    public static function elseIfBiggerThan(string $variable, string $number) : Mailcode_Commands_Command_ElseIf_BiggerThan
    {
        return self::$commandSets->elseIf()->elseIfBiggerThan($variable, $number);
    }

    public static function elseIfSmallerThan(string $variable, string $number) : Mailcode_Commands_Command_ElseIf_SmallerThan
    {
        return self::$commandSets->elseIf()->elseIfSmallerThan($variable, $number);
    }

    // region Contains

    public static function ifContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
    {
        return self::$commandSets->if()->ifContains($variable, array($search), $caseInsensitive);
    }

    /**
     * Creates if contains command, with several search terms.
     *
     * @param string $variable
     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
     * @param bool $caseInsensitive
     * @return Mailcode_Commands_Command_If_Contains
     * @throws Mailcode_Factory_Exception
     */
    public static function ifContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
    {
        return self::$commandSets->if()->ifContains($variable, $searchTerms, $caseInsensitive);
    }
    
    public static function elseIfContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
    {
        return self::$commandSets->elseIf()->elseIfContains($variable, array($search), $caseInsensitive);
    }

    /**
     * Creates else if contains command, with several search terms.
     *
     * @param string $variable
     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
     * @param bool $caseInsensitive
     * @return Mailcode_Commands_Command_ElseIf_Contains
     * @throws Mailcode_Factory_Exception
     */
    public static function elseIfContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
    {
        return self::$commandSets->elseIf()->elseIfContains($variable, $searchTerms, $caseInsensitive);
    }

    public static function ifNotContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_NotContains
    {
        return self::$commandSets->if()->ifNotContains($variable, array($search), $caseInsensitive);
    }

    /**
     * Creates if not contains command, with several search terms.
     *
     * @param string $variable
     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
     * @param bool $caseInsensitive
     * @return Mailcode_Commands_Command_If_NotContains
     * @throws Mailcode_Factory_Exception
     */
    public static function ifNotContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_NotContains
    {
        return self::$commandSets->if()->ifNotContains($variable, $searchTerms, $caseInsensitive);
    }

    public static function elseIfNotContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_NotContains
    {
        return self::$commandSets->elseIf()->elseIfNotContains($variable, array($search), $caseInsensitive);
    }

    /**
     * Creates else if not contains command, with several search terms.
     *
     * @param string $variable
     * @param string[] $searchTerms List of search terms. Do not add surrounding quotes.
     * @param bool $caseInsensitive
     * @return Mailcode_Commands_Command_ElseIf_NotContains
     * @throws Mailcode_Factory_Exception
     */
    public static function elseIfNotContainsAny(string $variable, array $searchTerms, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_NotContains
    {
        return self::$commandSets->elseIf()->elseIfNotContains($variable, $searchTerms, $caseInsensitive);
    }

    //endregion


    public static function ifEmpty(string $variable) : Mailcode_Commands_Command_If_Empty
    {
        return self::$commandSets->if()->ifEmpty($variable);
    }
    
    public static function ifNotEmpty(string $variable) : Mailcode_Commands_Command_If_NotEmpty
    {
        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
    */
    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
    */
    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
    */
    public static function createDateInfo() : Mailcode_Date_FormatInfo
    {
        return Mailcode_Date_FormatInfo::getInstance();
    }

    public static function init() : void
    {
        if(!isset(self::$commandSets))
        {
            self::$commandSets = new Mailcode_Factory_CommandSets();
        }
    }
}

Mailcode_Factory::init();