Mailcode\Traits\Commands\Validation\TrackingIDTrait

Complexity

Total Complexity

18

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	clearTrackingIDToken()	0	10	2
A	detectToken()	0	21	3
A	getTrackingID()	0	13	2
A	initTrackingToken()	0	22	4
A	filterTrackingID()	0	8	2
A	validateSyntax_tracking_id()	0	13	1
A	handleKeywordsChanged()	0	3	1
A	getTrackingIDToken()	0	5	1
A	setTrackingID()	0	10	2

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

declare(strict_types=1);

namespace Mailcode\Traits\Commands\Validation;

use AppUtils\NamedClosure;
use Closure;
use Mailcode\Commands\Command\ShowURL\AutoTrackingID;
use Mailcode\Interfaces\Commands\Validation\TrackingIDInterface;
use Mailcode\Mailcode_Parser_Statement_Tokenizer;
use Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral;

/**
 * Command validation drop-in: checks for the presence
 * of a tracking ID, which must be the first string
 * literal in the command's parameters list. If not
 * present or not a match for a tracking ID name, an
 * empty string is used as default.
 *
 * When the `no-tracking:` keyword is enabled, the
 * tracking ID will always be empty.
 *
 * @package Mailcode
 * @subpackage Validation
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see TrackingIDInterface
 */
trait TrackingIDTrait
{
    private ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral $trackingIDToken = null;

    /**
     * @return string
     */
    public function getTrackingID() : string
    {
        $token = $this->getTrackingIDToken();

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

        // In case of an empty tracking ID
        $token->setText($this->filterTrackingID($token->getText()));

        return $token->getText();
    }

    private function filterTrackingID(string $trackingID) : string
    {
        if(empty($trackingID))
        {
            return AutoTrackingID::generate($this);

$this of type Mailcode\Traits\Commands\Validation\TrackingIDTrait is incompatible with the type Mailcode\Interfaces\Commands\Validation\TrackingIDInterface expected by parameter $command of Mailcode\Commands\Command\ShowURL\AutoTrackingID::generate().

        }

        return $trackingID;
    }

    public function getTrackingIDToken() : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
    {
        $this->initTrackingToken();

        return $this->trackingIDToken;
    }

    private function initTrackingToken() : void
    {
        if(!$this->isTrackingEnabled())

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

        {
            $this->clearTrackingIDToken();
            return;
        }

        if(isset($this->trackingIDToken))
        {
            return;
        }

        $token = $this->detectToken();
        if($token === null)
        {
            $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()
                ->addStringLiteral(AutoTrackingID::generate($this));

$this of type Mailcode\Traits\Commands\Validation\TrackingIDTrait is incompatible with the type Mailcode\Interfaces\Commands\Validation\TrackingIDInterface expected by parameter $command of Mailcode\Commands\Command\ShowURL\AutoTrackingID::generate().

        }

        $this->trackingIDToken = $token;
    }

    private function clearTrackingIDToken() : void
    {
        $this->trackingIDToken = null;

        $token = $this->detectToken();
        if($token !== null)
        {
            $this->requireParams()
                ->getInfo()
                ->removeToken($token);
        }
    }

    public function setTrackingID(string $trackingID) : self
    {
        $token = $this->getTrackingIDToken();

        if($token !== null)
        {
            $token->setText($this->filterTrackingID($trackingID));
        }

        return $this;
    }

    private function detectToken() : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
    {
        $literals = $this->requireParams()
            ->getInfo()
            ->getStringLiterals();

        if(empty($literals))
        {
            return null;
        }

        $trackingID = array_shift($literals);

        $id = $trackingID->getText();

        if(strpos($id, '=') === false)
        {
            return $trackingID;
        }

        return null;
    }

    /**
     * Checks if any of the parameters contain a trackingID.
     * This must be the first string literal in the parameters,
     * allowing any keywords to be placed before it, but not
     * after the optional query parameters.
     */
    protected function validateSyntax_tracking_id() : void
    {
        // Add a listener to automatically update the
        // tracking ID if the tracking is disabled
        // programmatically via `setTrackingEnabled()`.
        $this->requireParams()->getEventHandler()->onKeywordsChanged(
            NamedClosure::fromClosure(
                Closure::fromCallable(array($this, 'handleKeywordsChanged')),
                array($this, 'handleKeywordsChanged')
            )
        );

        $this->initTrackingToken();
    }

    private function handleKeywordsChanged(Mailcode_Parser_Statement_Tokenizer $tokenizer) : void

The parameter $tokenizer is not used and could be removed.

    {
        $this->initTrackingToken();
    }
}