Mailcode\NamespaceTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isNamespacePresent()	0	3	1
A	validateSyntax_check_namespace()	0	20	3
A	requireNamespaceToken()	0	16	2
A	setNamespace()	0	8	1
A	getNamespaceToken()	0	3	1

<?php
/**
 * File containing the trait {@see \Mailcode\Traits\Commands\Validation\NamespaceTrait}.
 *
 * @package Mailcode
 * @subpackage Validation
 * @see \Mailcode\Traits\Commands\Validation\NamespaceTrait
 */

declare(strict_types=1);

namespace Mailcode;

use AppUtils\ConvertHelper;
use Mailcode\Commands\CommandException;

/**
 * @package Mailcode
 * @subpackage Validation
 * @author Olaf Böcker <olaf.boecker@ionos.com>
 *
 * @see NamespaceInterface
 */
trait NamespaceTrait
{
    private ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral $namespaceToken = null;

    protected function validateSyntax_check_namespace(): void
    {
        $token = $this
            ->requireParams()

It seems like requireParams() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            ->getInfo()
            ->getTokenByParamName(NamespaceInterface::PARAMETER_NAMESPACE_NAME);

        if ($token === null) {
            return;
        }

        if (!$token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) {
            $this->validationResult->makeError(
                t('Invalid namespace token:') . ' ' . t('Expected a string.'),
                NamespaceInterface::VALIDATION_NAMESPACE_WRONG_TYPE
            );
            return;
        }

        $this->namespaceToken = $token;
    }

    public function isNamespacePresent(): bool
    {
        return $this->getNamespaceToken() !== null;
    }

    public function getNamespaceToken(): ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
    {
        return $this->namespaceToken;
    }

    public function requireNamespaceToken() : Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
    {
        $token = $this->getNamespaceToken();

        if($token !== null) {
            return $token;
        }

        throw new CommandException(
            'The command does not have a namespace token.',
            sprintf(
                'A namespace token was required, but not present. '.PHP_EOL.
                'Use [%s] to check for its presence before calling this method.',
                ConvertHelper::callback2string(array($this, 'isNamespacePresent'))
            ),
            NamespaceInterface::ERROR_NO_NAMESPACE_TOKEN_PRESENT
        );
    }

    public function setNamespace(string $namespace = NamespaceInterface::DEFAULT_NAMESPACE): self
    {
        $this->namespaceToken = $this
            ->requireParams()
            ->getInfo()
            ->addParamString(NamespaceInterface::PARAMETER_NAMESPACE_NAME, $namespace);

        return $this;
    }
}