Mailcode\CurrencyNameTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setCurrencyNameEnabled()	0	7	1
A	getCurrencyNameToken()	0	6	1
A	isCurrencyNameEnabled()	0	5	1

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Command validation drop-in: checks for the presence
 * of the `currency-name:` keyword in the command statement,
 * and sets the currency name enabled flag accordingly.
 *
 * @package Mailcode
 * @subpackage Validation
 * @author Olaf Böcker <olaf.boecker@ionos.com>
 *
 * @see CurrencyNameInterface
 */
trait CurrencyNameTrait
{
    /**
     * @throws Mailcode_Exception
     */
    public function isCurrencyNameEnabled(): bool
    {
        return $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()
            ->hasKeyword(Mailcode_Commands_Keywords::TYPE_CURRENCY_NAME);
    }

    /**
     * @param bool $enabled
     * @return $this
     * @throws Mailcode_Exception
     */
    public function setCurrencyNameEnabled(bool $enabled): self
    {
        $this->requireParams()
            ->getInfo()
            ->setKeywordEnabled(Mailcode_Commands_Keywords::TYPE_CURRENCY_NAME, $enabled);

        return $this;
    }

    /**
     * @throws Mailcode_Exception
     */
    public function getCurrencyNameToken(): ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
    {
        return $this->requireParams()
            ->getInfo()
            ->getKeywordsCollection()
            ->getByName(Mailcode_Commands_Keywords::TYPE_CURRENCY_NAME);
    }
}