Mailcode\Mailcode_Commands_Command_ShowVariable

Complexity

Total Complexity

10

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	requiresParameters()	0	3	1
A	getLabel()	0	3	1
A	getDefaultType()	0	3	1
A	supportsLogicKeywords()	0	3	1
A	getName()	0	3	1
A	getValidations()	0	5	1
A	validateSyntax_no_other_tokens()	0	10	2
A	supportsType()	0	3	1
A	generatesContent()	0	3	1

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: show a variable value.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_ShowVariable extends Mailcode_Commands_Command implements Mailcode_Commands_Command_Type_Standalone
{
    use Mailcode_Traits_Commands_Validation_Variable;

    const VALIDATION_TOO_MANY_PARAMETERS = 69701;

    public function getName() : string
    {
        return 'showvar';
    }
    
    public function getLabel() : string
    {
        return t('Show variable');
    }
    
    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',
            'no_other_tokens'
        );
    }
    
    public function generatesContent() : bool
    {
        return true;
    }

    protected function validateSyntax_no_other_tokens() : void
    {
        $tokens = $this->params->getInfo()->getTokens();

        if(count($tokens) > 1)
        {
            $this->validationResult->makeError(
                t('Unknown parameters found:').' '.
                t('Only the variable name should be specified.'),
                self::VALIDATION_TOO_MANY_PARAMETERS
            );
        }
    }
}