Mailcode\Traits\Commands\Validation\NoTrackingTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	isTrackingEnabled()	0	5	1
A	setTrackingEnabled()	0	7	1
A	getNoTrackingToken()	0	6	1

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

declare(strict_types=1);

namespace Mailcode\Traits\Commands\Validation;

use Mailcode\Interfaces\Commands\Validation\NoTrackingInterface;
use Mailcode\Mailcode_Commands_Keywords;
use Mailcode\Mailcode_Exception;
use Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_Keyword;
use Mailcode\Mailcode_Parser_Statement_Validator;
use phpDocumentor\Descriptor\Interfaces\FunctionInterface;

The type phpDocumentor\Descriptor\Interfaces\FunctionInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpDocumentor\Reflection\Utils;

/**
 * Command validation drop-in: checks for the presence
 * of the `no-tracking:` keyword in the command statement,
 * and sets the tracking enabled flag accordingly.
 *
 * @package Mailcode
 * @subpackage Validation
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see NoTrackingInterface
 */
trait NoTrackingTrait
{
    public function isTrackingEnabled() : 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_NO_TRACKING);
    }

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

        return $this;
    }

    public function getNoTrackingToken() : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
    {
        return $this->requireParams()
            ->getInfo()
            ->getKeywordsCollection()
            ->getByName(Mailcode_Commands_Keywords::TYPE_NO_TRACKING);
    }
}