Mailcode\Mailcode_Factory_CommandSets_Set_Misc

Complexity

Total Complexity

14

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	for()	0	37	4
A	mono()	0	32	4
A	code()	0	26	2
A	break()	0	16	2
A	comment()	0	19	2

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

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Interfaces\Commands\Validation\BreakAtInterface;
use Mailcode\Parser\PreParser;

/**
 * Factory utility used to create commands.
 *
 * @package Mailcode
 * @subpackage Factory
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Factory_CommandSets_Set_Misc extends Mailcode_Factory_CommandSets_Set
{
    /**
     * @param string $comments Quoted or unquoted string.
     * @return Mailcode_Commands_Command_Comment
     * @throws Mailcode_Exception
     * @throws Mailcode_Factory_Exception
     */
    public function comment(string $comments): Mailcode_Commands_Command_Comment
    {
        $cmd = $this->commands->createCommand(
            'Comment',
            '', // type
            $this->instantiator->quoteString($comments),
            sprintf(
                '{comment: "%s"}',
                $this->instantiator->quoteString($comments)
            )
        );

        $this->instantiator->checkCommand($cmd);

        if ($cmd instanceof Mailcode_Commands_Command_Comment) {
            return $cmd;
        }

        throw $this->instantiator->exceptionUnexpectedType('Comment', $cmd);
    }

    /**
     * Creates a for loop command.
     *
     * @param string $sourceVariable
     * @param string $loopVariable
     * @param Mailcode_Variables_Variable|string|int|NULL $breakAtValue
     * @return Mailcode_Commands_Command_For
     * @throws Mailcode_Exception
     * @throws Mailcode_Factory_Exception
     */
    public function for(string $sourceVariable, string $loopVariable, $breakAtValue = ''): Mailcode_Commands_Command_For
    {
        $sourceVariable = dollarize($sourceVariable);
        $loopVariable = dollarize($loopVariable);

        if($breakAtValue instanceof Mailcode_Variables_Variable) {
            $breakAtValue = $breakAtValue->getFullName();
        }

        if (!empty($breakAtValue)) {
            $breakAtValue = sprintf(' %s=%s', BreakAtInterface::PARAMETER_NAME, $breakAtValue);

It seems like $breakAtValue can also be of type Mailcode\Mailcode_Variables_Variable; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

        }

        $cmd = $this->commands->createCommand(
            'For',
            '',
            sprintf(
                '%s in: %s%s',
                $loopVariable,
                $sourceVariable,
                $breakAtValue
            ),
            sprintf(
                '{for: %s in: %s%s}',
                $loopVariable,
                $sourceVariable,
                $breakAtValue
            )
        );

        $this->instantiator->checkCommand($cmd);

        if ($cmd instanceof Mailcode_Commands_Command_For) {
            return $cmd;
        }

        throw $this->instantiator->exceptionUnexpectedType('For', $cmd);
    }

    /**
     * Creates a break command, which can be used to break out of
     * a loop command. Using this outside of a loop will trigger
     * a validation error.
     *
     * @return Mailcode_Commands_Command_Break
     * @throws Mailcode_Exception
     * @throws Mailcode_Factory_Exception
     */
    public function break(): Mailcode_Commands_Command_Break
    {
        $cmd = $this->commands->createCommand(
            'Break',
            '',
            '',
            '{break}'
        );

        $this->instantiator->checkCommand($cmd);

        if ($cmd instanceof Mailcode_Commands_Command_Break) {
            return $cmd;
        }

        throw $this->instantiator->exceptionUnexpectedType('Break', $cmd);
    }

    /**
     * Creates a preprocessor command to format text as preformatted.
     *
     * NOTE: Requires the Mailcode text to be preprocessed using the
     * preprocessor. See the documentation on how to use it.
     *
     * @param bool $multiline
     * @param string[] $classes
     * @return Mailcode_Commands_Command_Mono
     * @throws Mailcode_Exception
     * @throws Mailcode_Factory_Exception
     */
    public function mono(bool $multiline = false, array $classes = array()): Mailcode_Commands_Command_Mono
    {
        $params = '';
        $source = '{code';

        if ($multiline) {
            $params = 'multiline:';
            $source = '{code: multiline:';
        }

        if (!empty($classes)) {
            $classString = sprintf('"%s"', implode(' ', $classes));
            $params .= $classString;
            $source .= $classString;
        }

        $source .= '}';

        $cmd = $this->commands->createCommand(
            'Mono',
            '',
            $params,
            $source
        );

        $this->instantiator->checkCommand($cmd);

        if ($cmd instanceof Mailcode_Commands_Command_Mono) {
            return $cmd;
        }

        throw $this->instantiator->exceptionUnexpectedType('Mono', $cmd);
    }

    public function code(string $language, string $content): Mailcode_Commands_Command_Code
    {
        $contentID = PreParser::storeContent($content);

        $cmd = $this->commands->createCommand(
            'Code',
            '',
            sprintf(
                '%s "%s"',
                $contentID,
                $language
            ),
            sprintf(
                '{code: %s "%s"}',
                $contentID,
                $language
            )
        );

        $this->instantiator->checkCommand($cmd);

        if ($cmd instanceof Mailcode_Commands_Command_Code) {
            return $cmd;
        }

        throw $this->instantiator->exceptionUnexpectedType('Code', $cmd);
    }
}