Passed
Push — master ( 138b71...c5c69e )
by Sebastian
04:58
created

Mailcode_Factory_CommandSets_Set_Misc::comment()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 20
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 11
c 1
b 0
f 0
nc 2
nop 1
dl 0
loc 20
rs 9.9
1
<?php
2
/**
3
 * File containing the {@see Mailcode_Factory_CommandSets_Set_Misc} class.
4
 *
5
 * @package Mailcode
6
 * @subpackage Utilities
7
 * @see Mailcode_Factory_CommandSets_Set_Misc
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_CommandSets_Set_Misc extends Mailcode_Factory_CommandSets_Set
22
{
23
    public function comment(string $comments) : Mailcode_Commands_Command_Comment
24
    {
25
        $cmd = Mailcode::create()->getCommands()->createCommand(
26
            'Comment',
27
            '', // type
28
            $comments, // params
29
            sprintf(
30
                '{comment: %s}',
31
                $comments
32
            )
33
        );
34
    
35
        $this->instantiator->checkCommand($cmd);
36
        
37
        if($cmd instanceof Mailcode_Commands_Command_Comment)
38
        {
39
            return $cmd;
40
        }
41
        
42
        throw $this->instantiator->exceptionUnexpectedType('Comment', $cmd);
43
    }
44
}
45