Mailcode\RegionTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getRegionToken()	0	3	1
A	isRegionPresent()	0	3	1
A	validateSyntax_check_region()	0	21	4

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

declare(strict_types=1);

namespace Mailcode;

/**
 * @package Mailcode
 * @subpackage Validation
 * @author Olaf Böcker <olaf.boecker@ionos.com>
 *
 * @see RegionInterface
 */
trait RegionTrait
{
    private ?Mailcode_Parser_Statement_Tokenizer_Token $region = null;

    /**
     * @throws Mailcode_Exception
     */
    protected function validateSyntax_check_region(): 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(RegionInterface::REGION_PARAMETER_NAME);

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

        if (!$token instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable &&
            !$token instanceof Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral) {
            $this->validationResult->makeError(
                t('Invalid region token:') . ' ' . t('Expected a variable or a string.'),
                RegionInterface::VALIDATION_REGION_WRONG_TYPE
            );
            return;
        }

        $this->region = $token;
    }

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

    public function getRegionToken(): ?Mailcode_Parser_Statement_Tokenizer_Token
    {
        return $this->region;
    }
}