Mailcode_Factory::_checkCommand() - Code Metrics - Inspection of "Removed unneeded parameter." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 138b71...c5c69e )

by Sebastian

created 2020-06-26 10:09 UTC

Mailcode_Factory::_checkCommand() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	13
rs	10

<?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 <[email protected]>
 */
class Mailcode_Factory
{
    const ERROR_INVALID_COMMAND_CREATED = 50001;
    const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;

   /**
    * @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
    */
    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
     */
    public static function showDate(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowDate
    {
        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
    */
    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
    */
    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
    */
    public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
    {
        return self::$commandSets->set()->setVar($variableName, $value, true);
    }
    
    public static function comment(string $comments) : Mailcode_Commands_Command_Comment
    {
        return self::$commandSets->misc()->comment($comments);
    }
    
    public static function else() : Mailcode_Commands_Command_Else
    {
        return self::$commandSets->if()->else();
    }
    
    public static function end() : Mailcode_Commands_Command_End
    {
        return self::$commandSets->if()->end();
    }
    
    public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If
    {
        return self::$commandSets->if()->if($condition, $type);
    }
    
    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 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);
    }
    
    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 ifContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
    {
        return self::$commandSets->if()->ifContains($variable, $search, $caseInsensitive);
    }
    
    public static function elseIfContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
    {
        return self::$commandSets->elseIf()->elseIfContains($variable, $search, $caseInsensitive);
    }
    
    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();


1			<?php
2			/**
3			* File containing the {@see Mailcode_Factory} class.
4			*
5			* @package Mailcode
6			* @subpackage Utilities
7			* @see Mailcode_Factory
8			*/
9
10			declare(strict_types=1);
11
12			namespace Mailcode;
13
14			/**
15			* Factory utility used to create commands.
16			*
17			* @package Mailcode
18			* @subpackage Utilities
19			* @author Sebastian Mordziol <[email protected]>
20			*/
21			class Mailcode_Factory
22			{
23			const ERROR_INVALID_COMMAND_CREATED = 50001;
24			const ERROR_UNEXPECTED_COMMAND_TYPE = 50002;
25
26			/**
27			* @var Mailcode_Factory_CommandSets
28			*/
29			private static $commandSets;
30
31			/**
32			* Creates a ShowVariable command.
33			*
34			* @param string $variableName A variable name, with or without the $ sign prepended.
35			* @return Mailcode_Commands_Command_ShowVariable
36			*/
37			public static function showVar(string $variableName) : Mailcode_Commands_Command_ShowVariable
38			{
39			return self::$commandSets->show()->showVar($variableName);
40			}
41
42			/**
43			* Creates a ShowDate command, used to display date variables and
44			* format the date using date format strings.
45			*
46			* @param string $variableName A variable name, with or without the $ sign prepended.
47			* @param string $formatString A date format string, or empty string for default.
48			* @return Mailcode_Commands_Command_ShowDate
49			*/
50			public static function showDate(string $variableName, string $formatString="") : Mailcode_Commands_Command_ShowDate
51			{
52			return self::$commandSets->show()->showDate($variableName, $formatString);
53			}
54
55			/**
56			* Creates a ShowSnippet command.
57			*
58			* @param string $snippetName A snippet name, with or without the $ sign prepended.
59			* @return Mailcode_Commands_Command_ShowSnippet
60			*/
61			public static function showSnippet(string $snippetName) : Mailcode_Commands_Command_ShowSnippet
62			{
63			return self::$commandSets->show()->showSnippet($snippetName);
64			}
65
66			/**
67			* Creates a SetVariable command.
68			*
69			* @param string $variableName A variable name, with or without the $ sign prepended.
70			* @param string $value
71			* @param bool $quoteValue Whether to treat the value as a string literal, and add quotes to it.
72			* @return Mailcode_Commands_Command_SetVariable
73			* @throws Mailcode_Factory_Exception
74			*
75			* @see Mailcode_Factory::ERROR_INVALID_COMMAND_CREATED
76			*/
77			public static function setVar(string $variableName, string $value, bool $quoteValue=true) : Mailcode_Commands_Command_SetVariable
78			{
79			return self::$commandSets->set()->setVar($variableName, $value, $quoteValue);
80			}
81
82			/**
83			* Like setVar(), but treats the value as a string literal
84			* and automatically adds quotes to it.
85			*
86			* @param string $variableName
87			* @param string $value
88			* @return Mailcode_Commands_Command_SetVariable
89			*/
90			public static function setVarString(string $variableName, string $value) : Mailcode_Commands_Command_SetVariable
91			{
92			return self::$commandSets->set()->setVar($variableName, $value, true);
93			}
94
95			public static function comment(string $comments) : Mailcode_Commands_Command_Comment
96			{
97			return self::$commandSets->misc()->comment($comments);
98			}
99
100			public static function else() : Mailcode_Commands_Command_Else
101			{
102			return self::$commandSets->if()->else();
103			}
104
105			public static function end() : Mailcode_Commands_Command_End
106			{
107			return self::$commandSets->if()->end();
108			}
109
110			public static function if(string $condition, string $type='') : Mailcode_Commands_Command_If
111			{
112			return self::$commandSets->if()->if($condition, $type);
113			}
114
115			public static function ifVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
116			{
117			return self::$commandSets->if()->ifVar($variable, $operand, $value, $quoteValue);
118			}
119
120			public static function ifVarString(string $variable, string $operand, string $value) : Mailcode_Commands_Command_If_Variable
121			{
122			return self::$commandSets->if()->ifVarString($variable, $operand, $value);
123			}
124
125			public static function ifVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
126			{
127			return self::$commandSets->if()->ifVarEquals($variable, $value, $quoteValue);
128			}
129
130			public static function ifVarEqualsString(string $variable, string $value) : Mailcode_Commands_Command_If
131			{
132			return self::$commandSets->if()->ifVarEqualsString($variable, $value);
133			}
134
135			public static function ifVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_If_Variable
136			{
137			return self::$commandSets->if()->ifVarNotEquals($variable, $value, $quoteValue);
138			}
139
140			public static function ifVarNotEqualsString(string $variable, string $value) : Mailcode_Commands_Command_If_Variable
141			{
142			return self::$commandSets->if()->ifVarNotEqualsString($variable, $value);
143			}
144
145			public static function elseIf(string $condition, string $type='') : Mailcode_Commands_Command_ElseIf
146			{
147			return self::$commandSets->elseIf()->elseIf($condition, $type);
148			}
149
150			public static function elseIfEmpty(string $variable) : Mailcode_Commands_Command_ElseIf_Empty
151			{
152			return self::$commandSets->elseIf()->elseIfEmpty($variable);
153			}
154
155			public static function elseIfNotEmpty(string $variable) : Mailcode_Commands_Command_ElseIf_NotEmpty
156			{
157			return self::$commandSets->elseIf()->elseIfNotEmpty($variable);
158			}
159
160			public static function elseIfVar(string $variable, string $operand, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
161			{
162			return self::$commandSets->elseIf()->elseIfVar($variable, $operand, $value, $quoteValue);
163			}
164
165			public static function elseIfVarString(string $variable, string $operand, string $value) : Mailcode_Commands_Command_ElseIf_Variable
166			{
167			return self::$commandSets->elseIf()->elseIfVarString($variable, $operand, $value);
168			}
169
170			public static function elseIfVarEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
171			{
172			return self::$commandSets->elseIf()->elseIfVarEquals($variable, $value, $quoteValue);
173			}
174
175			public static function elseIfVarEqualsString(string $variable, string $value) : Mailcode_Commands_Command_ElseIf_Variable
176			{
177			return self::$commandSets->elseIf()->elseIfVarEqualsString($variable, $value);
178			}
179
180			public static function elseIfVarNotEquals(string $variable, string $value, bool $quoteValue=false) : Mailcode_Commands_Command_ElseIf_Variable
181			{
182			return self::$commandSets->elseIf()->elseIfVarNotEquals($variable, $value, $quoteValue);
183			}
184
185			public static function elseIfVarNotEqualsString(string $variable, string $value) : Mailcode_Commands_Command_ElseIf_Variable
186			{
187			return self::$commandSets->elseIf()->elseIfVarNotEqualsString($variable, $value);
188			}
189
190			public static function ifContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_If_Contains
191			{
192			return self::$commandSets->if()->ifContains($variable, $search, $caseInsensitive);
193			}
194
195			public static function elseIfContains(string $variable, string $search, bool $caseInsensitive=false) : Mailcode_Commands_Command_ElseIf_Contains
196			{
197			return self::$commandSets->elseIf()->elseIfContains($variable, $search, $caseInsensitive);
198			}
199
200			public static function ifEmpty(string $variable) : Mailcode_Commands_Command_If_Empty
201			{
202			return self::$commandSets->if()->ifEmpty($variable);
203			}
204
205			public static function ifNotEmpty(string $variable) : Mailcode_Commands_Command_If_NotEmpty
206			{
207			return self::$commandSets->if()->ifNotEmpty($variable);
208			}
209
210			/**
211			* Creates a renderer instance, which can be used to easily
212			* create and convert commands to strings.
213			*
214			* @return Mailcode_Renderer
215			*/
216			public static function createRenderer() : Mailcode_Renderer
217			{
218			return new Mailcode_Renderer();
219			}
220
221			/**
222			* Creates a printer instance, which works like the renderer,
223			* but outputs the generated strings to standard output.
224			*
225			* @return Mailcode_Printer
226			*/
227			public static function createPrinter() : Mailcode_Printer
228			{
229			return new Mailcode_Printer();
230			}
231
232			/**
233			* Gets/creates the global instance of the date format info
234			* class, used to handle date formatting aspects.
235			*
236			* @return Mailcode_Date_FormatInfo
237			*/
238			public static function createDateInfo() : Mailcode_Date_FormatInfo
239			{
240			return Mailcode_Date_FormatInfo::getInstance();
241			}
242
243			public static function init() : void
244			{
245			if(!isset(self::$commandSets))
246			{
247			self::$commandSets = new Mailcode_Factory_CommandSets();
248			}
249			}
250			}
251
252			Mailcode_Factory::init();
253

Mistralys / mailcode

Push — master ( 138b71...c5c69e )

Mailcode_Factory::_checkCommand() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like