Mailcode_Commands_Command_For::getInKeyword() - Code Metrics - Inspection of "Added changes." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Retried Inspection
Push — master ( 36c5b6...af11e6 )

by Sebastian
created 2022-02-24 11:12 UTC
Mailcode_Commands_Command_For::getInKeyword() A

↳ Parent: Mailcode_Commands_Command_For
Complexity

Conditions	2
Paths	2
Size

Total Lines	11
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	6
c	0
b	0
f	0
nc	2
nop	0
dl	0
loc	11
rs	10
<?php
/**
 * File containing the {@see Mailcode_Commands_Command_For} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see Mailcode_Commands_Command_For
 */

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: opening FOR statement.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <[email protected]>
 */
class Mailcode_Commands_Command_For extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Opening, Mailcode_Interfaces_Commands_ListVariables
{
    use Mailcode_Traits_Commands_ListVariables;
    use Mailcode_Traits_Commands_Type_Opening;

    public const ERROR_SOURCE_VARIABLE_NOT_AVAILABLE = 64101;
    public const ERROR_LOOP_VARIABLE_NOT_AVAILABLE = 64102;
    public const ERROR_KEYWORD_NOT_AVAILABLE = 64103;
    
    public const VALIDATION_INVALID_FOR_STATEMENT = 49701;
    public const VALIDATION_WRONG_KEYWORD = 49702;
    public const VALIDATION_VARIABLE_NAME_IS_THE_SAME = 49703;
    public const VALIDATION_VARIABLE_NAME_WITH_DOT = 49704;
    public const VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT = 49705;
    
   /**
    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
    */
    private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $loopVar = null;
    
   /**
    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
    */
    private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $sourceVar = null;
    
   /**
    * @var Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
    */
    private ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword $keyword = null;
    
    public function getName() : string
    {
        return 'for';
    }
    
    public function getLabel() : string
    {
        return t('FOR loop');
    }
    
    public function supportsType(): bool
    {
        return false;
    }

    public function supportsURLEncoding() : 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(
            'statement',
            'keyword',
            'variable_names',
            'list_var',
            'record_var'
        );
    }
    
    public function generatesContent() : bool
    {
        return false;
    }
    
    public function getSourceVariable() : Mailcode_Variables_Variable
    {
        if(isset($this->sourceVar))
        {
            return $this->sourceVar->getVariable();
            return $this->sourceVar->/** @scrutinizer ignore-call */ getVariable();
        }
        
        throw new Mailcode_Exception(
            'No source variable available',
            null,
            self::ERROR_SOURCE_VARIABLE_NOT_AVAILABLE
        );
    }
    
    public function getLoopVariable() : Mailcode_Variables_Variable
    {
        if(isset($this->loopVar))
        {
            return $this->loopVar->getVariable();
            return $this->loopVar->/** @scrutinizer ignore-call */ getVariable();
        }
        
        throw new Mailcode_Exception(
            'No loop variable available',
            null,
            self::ERROR_LOOP_VARIABLE_NOT_AVAILABLE
        );
    }
    
    protected function validateSyntax_statement() : void
    {
        $info = $this->requireParams()->getInfo();
        
        $this->loopVar = $info->getVariableByIndex(0);
        $this->keyword = $info->getKeywordByIndex(1);
        $this->sourceVar = $info->getVariableByIndex(2);
        
        if(!$this->loopVar || !$this->keyword || !$this->sourceVar)
        {
            $this->validationResult->makeError(
                t('Not a valid for loop.').' '.t('Is the %1$s keyword missing?', 'in:'),
                self::VALIDATION_INVALID_FOR_STATEMENT
            );
            
            return;
        }
    }
    
    protected function validateSyntax_keyword() : void
    {
        $keyword = $this->getInKeyword();

        if($keyword->isForIn())
        {
            return;
        }
         
        $this->validationResult->makeError(
            t('The %1$s keyword cannot be used in this command.', $keyword->getKeyword()),
            self::VALIDATION_WRONG_KEYWORD
        );
    }
    
    protected function validateSyntax_variable_names() : void
    {
        if($this->getSourceVariable()->getFullName() !== $this->getLoopVariable()->getFullName())
        {
            return;
        }
        
        $this->validationResult->makeError(
            t('The source and loop variables have the same name.'),
            self::VALIDATION_VARIABLE_NAME_IS_THE_SAME
        );
    }

    protected function validateSyntax_list_var() : void
    {
        $name = $this->getSourceVariable()->getFullName();

        $parts = explode('.', $name);

        if(count($parts) === 1) {
            return;
        }

        $this->validationResult->makeError(
            t('The source variable is not a list variable:').' '.
            t('Expected a variable without dot, like %1$s.', '<code>$'.t('LIST').'</code>'),
            self::VALIDATION_VARIABLE_NAME_WITH_DOT
        );
    }

    protected function validateSyntax_record_var() : void
    {
        $name = $this->getLoopVariable()->getFullName();

        $parts = explode('.', $name);

        if(count($parts) === 1) {
            return;
        }

        $this->validationResult->makeError(
            t('The loop record variable may not have a dot in its name.'),
            self::VALIDATION_LOOP_VARIABLE_NAME_WITH_DOT
        );
    }

    protected function _collectListVariables(Mailcode_Variables_Collection_Regular $collection): void
    {
        $collection->add($this->getSourceVariable());
    }

    public function getInKeyword() : Mailcode_Parser_Statement_Tokenizer_Token_Keyword
    {
        if(isset($this->keyword))
        {
            return $this->keyword;

        }

        throw new Mailcode_Exception(
            'No keyword available.',
            'The keyword variable has not been set.',
            self::ERROR_KEYWORD_NOT_AVAILABLE
        );
    }
}

Mistralys / mailcode

Push — master ( 36c5b6...af11e6 )

Mailcode_Commands_Command_For::getInKeyword() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
