Mailcode\Mailcode_Commands_Command_SetVariable

Complexity

Total Complexity

19

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	supportsType()	0	3	1
A	getLabel()	0	3	1
A	getName()	0	3	1
A	getVariable()	0	11	2
A	validateSyntax_variable()	0	13	2
A	getDefaultType()	0	3	1
A	validateSyntax_assignment()	0	9	2
A	requiresParameters()	0	3	1
A	getValidations()	0	6	1
A	validateSyntax_operand()	0	9	2
A	generatesContent()	0	3	1
A	getAssignmentString()	0	12	2
A	supportsLogicKeywords()	0	3	1
A	getAssignmentTokens()	0	8	1

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: set a variable value.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_SetVariable extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone
{
   /**
    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
    */
    private $variableToken;
    
    public function getName() : string
    {
        return 'setvar';
    }
    
    public function getLabel() : string
    {
        return t('Set variable value');
    }
    
    public function supportsType(): bool
    {
        return false;
    }
    
    public function getDefaultType() : string
    {
        return '';
    }
    
    public function requiresParameters(): bool
    {
        return true;
    }
    
    public function supportsLogicKeywords() : bool
    {
        return false;
    }
    
    protected function getValidations() : array
    {
        return array(
            'variable',
            'operand',
            'assignment'
        );
    }
    
    public function generatesContent() : bool
    {
        return false;
    }

    protected function validateSyntax_variable() : void
    {
        $val = $this->validator->createVariable()->setIndex(0);
        
        if($val->isValid())
        {
            $this->variableToken = $val->getToken();
        }
        else
        {
            $this->validationResult->makeError(
                'The first parameter must be a variable name.',
                Mailcode_Commands_CommonConstants::VALIDATION_VARIABLE_MISSING
            );
        }
    }
    
    protected function validateSyntax_operand() : void
    {
        $val = $this->validator->createOperand('=')->setIndex(1);
        
        if(!$val->isValid())
        {
            $this->validationResult->makeError(
                t('The second parameter must be an equals sign (%1$s).', '<code>=</code>'),
                Mailcode_Commands_CommonConstants::VALIDATION_INVALID_OPERAND
            );
        }
    }
    
    protected function validateSyntax_assignment() : void
    {
        $tokens = $this->getAssignmentTokens();
        
        if(empty($tokens))
        {
            $this->validationResult->makeError(
                t('No value assigned to the variable.'),
                Mailcode_Commands_CommonConstants::VALIDATION_VALUE_MISSING
            );
        }
    }
    
    public function getVariable() : Mailcode_Variables_Variable
    {
        if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)
        {
            return $this->variableToken->getVariable();
        }
        
        throw new Mailcode_Exception(
            'No variable found.',
            'Statement does not start with a variable: ['.$this->paramsString.']',
            Mailcode_Commands_CommonConstants::ERROR_NO_VARIABLE_AVAILABLE
        );
    }
    
   /**
    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
    */
    public function getAssignmentTokens() : array
    {
        $params = $this->params->getInfo()->getTokens();
        
        array_shift($params); // variable
        array_shift($params); // equals sign
        
        return $params;
    }
    
    public function getAssignmentString() : string
    {
        $tokens = $this->getAssignmentTokens();
        
        $items = array();
        
        foreach($tokens as $token)
        {
            $items[] = $token->getNormalized();
        }
        
        return implode(' ', $items);
    }
}