Mailcode\Mailcode_Traits_Commands_Validation_URLEncode

Complexity

Total Complexity

3

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getURLEncodeToken()	0	3	1
A	setURLEncoding()	0	3	1
A	isURLEncoded()	0	3	1

<?php
/**
 * File containing the {@see Mailcode_Traits_Commands_Validation_URLEncode} trait.
 *
 * @package Mailcode
 * @subpackage Validation
 * @see Mailcode_Traits_Commands_Validation_URLEncode
 */

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Commands\ParamsException;

/**
 * Command validation drop-in: checks for the presence
 * of a "urlencode:" keyword, to automatically set the
 * command's URL encoding flag.
 *
 * @package Mailcode
 * @subpackage Validation
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see Mailcode_Interfaces_Commands_Validation_URLEncode
 */
trait Mailcode_Traits_Commands_Validation_URLEncode
{
    public function getURLEncodeToken() : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
    {
        return $this->getEncodingToken(Mailcode_Commands_Keywords::TYPE_URLENCODE);

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

    }

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

    /**
     * @param bool $encoding
     * @return $this
     * @throws Mailcode_Exception
     */
    public function setURLEncoding(bool $encoding=true) : self
    {
        return $this->setEncodingEnabled(Mailcode_Commands_Keywords::TYPE_URLENCODE, $encoding);

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

    }
}