Mailcode\Mailcode_Traits_Commands_IfContains

Complexity

Total Complexity

15

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getSearchTerm()	0	12	2
A	getVariable()	0	11	2
A	getValidations()	0	5	1
A	isCaseInsensitive()	0	3	1
A	validateSyntax_literal_after_keyword()	0	15	2
A	validateSyntax_variable()	0	15	2
A	validateSyntax_literal()	0	14	2
A	validateSyntax_keyword()	0	31	3

<?php
/**
 * File containing the {@see Mailcode_Commands_Command_If_Contains} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see Mailcode_Commands_Command_If_Contains
 */

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: opening IF statement.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 * 
 * @property Mailcode_Parser_Statement $params
 * @property \AppUtils\OperationResult $validationResult
 */
trait Mailcode_Traits_Commands_IfContains
{
    /**
     * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
     */
    protected $variable;

   /**
    * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
    */
    protected $literal;
    
   /**
    * @var boolean
    */
    protected $caseInsensitive = false;
    
    protected function getValidations() : array
    {
        return array(
            'variable',
            'literal',
        );
    }
    
    protected function validateSyntax_variable() : void
    {
        $info = $this->params->getInfo();
        
        $variable = $info->getVariableByIndex(0);
        
        if($variable)
        {
            $this->variable = $variable;
            return;
        }
        
        $this->validationResult->makeError(
            t('No variable specified in the command.'),
            Mailcode_Commands_IfBase::VALIDATION_VARIABLE_MISSING
        );
    }
    
    protected function validateSyntax_literal() : void
    {
        $info = $this->params->getInfo();
        
        // first variant: variable "Search term"
        $string = $info->getStringLiteralByIndex(1);
        
        if($string)
        {
            $this->literal = $string;
            return;
        }
        
        $this->validateSyntax_keyword();
    }
    
    protected function validateSyntax_keyword() : void
    {
        $info = $this->params->getInfo();
        
        // second variant: variable insensitive: "Search term"
        $keyword = $info->getKeywordByIndex(1);
        
        if(!$keyword)
        {
            $this->validationResult->makeError(
                t('Expected a search term or the %1$s keyword after the variable name.', 'insensitive:'),
                Mailcode_Commands_IfBase::VALIDATION_EXPECTED_KEYWORD
            );
            
            return;
        }
        
        if($keyword->getKeyword() !== 'insensitive:')
        {
            $this->validationResult->makeError(
                t('Invalid keyword %1$s.', $keyword->getKeyword()).' '.
                t('Only the keyword %1$s may be used here.', 'insensitive:'),
                Mailcode_Commands_IfBase::VALIDATION_INVALID_KEYWORD
            );
            
            return;
        }
        
        $this->caseInsensitive = true;
        
        $this->validateSyntax_literal_after_keyword();
    }
    
    protected function validateSyntax_literal_after_keyword() : void
    {
        $info = $this->params->getInfo();
        
        $string = $info->getStringLiteralByIndex(2);
        
        if($string)
        {
            $this->literal = $string;
            return;
        }
        
        $this->validationResult->makeError(
            t('Expected a search term after the %1$s keyword.', 'insensitive:'),
            Mailcode_Commands_IfBase::VALIDATION_CONTAINS_MISSING_SEARCH_TERM
        );
    }

   /**
    * Retrieves the variable being compared.
    *
    * @return Mailcode_Variables_Variable
    */
    public function getVariable() : Mailcode_Variables_Variable
    {
        if(isset($this->variable))
        {
            return $this->variable->getVariable();

The method getVariable() does not exist on null.

        }
        
        throw new Mailcode_Exception(
            'No variable available',
            null,
            Mailcode_Commands_IfBase::ERROR_NO_VARIABLE_AVAILABLE
        );
    }
    
    public function isCaseInsensitive() : bool
    {
        return $this->caseInsensitive;
    }
    
    public function getSearchTerm() : string
    {
        if(!isset($this->literal))
        {
            throw new Mailcode_Exception(
                'No string literal available',
                null,
                Mailcode_Commands_IfBase::ERROR_NO_STRING_LITERAL_AVAILABLE
            );
        }
        
        return $this->literal->getNormalized();

The method getNormalized() does not exist on null.

    }
}