Mailcode\Mailcode_Traits_Commands_ProtectedContent

Complexity

Total Complexity

18

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	validateSyntax_content_id()	0	16	2
A	getNormalized()	0	3	1
A	getContent()	0	3	1
A	getNestedMailcode()	0	19	3
A	getContentIDToken()	0	3	1
A	getContentTrimmed()	0	3	1
A	loadContent()	0	7	1
A	getContentID()	0	11	2
A	getVariables()	0	17	3
A	validateSyntax_nested_mailcode()	0	16	3

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

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Parser\PreParser;

/**
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see Mailcode_Interfaces_Commands_ProtectedContent
 */
trait Mailcode_Traits_Commands_ProtectedContent
{
    protected string $content = '';
    private ?Mailcode_Collection $nestedMailcode = null;
    protected ?Mailcode_Parser_Statement_Tokenizer_Token_Number $contentIDToken = null;

    public function getContent() : string
    {
        return $this->content;
    }

    public function getContentTrimmed() : string
    {
        return trim($this->content);
    }

    public function getContentIDToken() : ?Mailcode_Parser_Statement_Tokenizer_Token_Number
    {
        return $this->contentIDToken;
    }

    protected function validateSyntax_content_id() : void
    {
        $contentIDToken = $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()
            ->getTokenByIndex(0);

        if($contentIDToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Number)
        {
            $this->contentIDToken = $contentIDToken;
            $this->loadContent();
            return;
        }

        $this->validationResult->makeError(
            t('The content ID parameter is missing.'),
            Mailcode_Interfaces_Commands_ProtectedContent::VALIDATION_ERROR_CONTENT_ID_MISSING
        );
    }

    public function getNestedMailcode() : Mailcode_Collection
    {
         if(isset($this->nestedMailcode))
         {
             return $this->nestedMailcode;

The expression return $this->nestedMailcode could return the type null which is incompatible with the type-hinted return Mailcode\Mailcode_Collection. Consider adding an additional type-check to rule them out.

         }

         if($this->isMailcodeEnabled())

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

         {
             $collection = Mailcode::create()->parseString($this->getContent());
         }
         else
         {
             $collection = new Mailcode_Collection();
         }

         $this->nestedMailcode = $collection;

         return $collection;
    }

    protected function validateSyntax_nested_mailcode() : void
    {
        $collection = $this->getNestedMailcode();

        if($collection->isValid())
        {
            return;
        }

        $errors = $collection->getErrors();

        foreach($errors as $error)
        {
            $this->getValidationResult()->makeError(

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

                $error->getMessage(),
                $error->getCode()
            );
        }
    }

    public function getContentID() : int
    {
        if(isset($this->contentIDToken))
        {
            return (int)$this->contentIDToken->getValue();

The method getValue() does not exist on null.

        }

        throw new Mailcode_Exception(
            'No content ID set',
            '',
            Mailcode_Interfaces_Commands_ProtectedContent::ERROR_NO_CONTENT_ID_TOKEN
        );
    }

    private function loadContent() : void
    {
        $contentID = $this->getContentID();

        $this->content = PreParser::getContent($contentID);

        PreParser::clearContent($contentID);
    }

    public function getNormalized() : string
    {
        return (new Mailcode_Commands_Normalizer_ProtectedContent($this))->normalize();

$this of type Mailcode\Mailcode_Traits_Commands_ProtectedContent is incompatible with the type Mailcode\Mailcode_Commands_Command expected by parameter $command of Mailcode\Mailcode_Commands_Normalizer_ProtectedContent::__construct().

    }

    public function getVariables() : Mailcode_Variables_Collection_Regular
    {
        $variables = parent::getVariables();

        if($this->isMailcodeEnabled())
        {
            $nested = $this->getNestedMailcode()
                ->getVariables()
                ->getAll();

            foreach($nested as $variable)
            {
                $variables->add($variable);
            }
        }

        return $variables;
    }
}