Mailcode\Mailcode_Commands_Command_ShowVariable

Complexity

Total Complexity

11

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	3	1
A	getName()	0	3	1
A	getValidations()	0	6	1
A	getDefaultDecryptionKey()	0	3	1
A	resolveActiveTokens()	0	19	4
A	validateSyntax_no_other_tokens()	0	10	2
A	setDefaultDecryptionKey()	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;

use Mailcode\Interfaces\Commands\Validation\DecryptInterface;
use Mailcode\Interfaces\Commands\Validation\IDNEncodingInterface;
use Mailcode\Traits\Commands\Validation\DecryptTrait;
use Mailcode\Traits\Commands\Validation\IDNDecodeTrait;
use Mailcode\Traits\Commands\Validation\IDNEncodeTrait;

/**
 * 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_ShowBase
    implements
    IDNEncodingInterface, DecryptInterface
{
    public const VALIDATION_TOO_MANY_PARAMETERS = 69701;

    use IDNEncodeTrait;
    use IDNDecodeTrait;
    use DecryptTrait;

    /**
     * @var string|NULL
     */
    private static ?string $defaultDecryptionKey = null;

    public function getName(): string
    {
        return 'showvar';
    }

    public function getLabel(): string
    {
        return t('Show variable');
    }

    protected function getValidations(): array
    {
        return array(
            Mailcode_Interfaces_Commands_Validation_Variable::VALIDATION_NAME_VARIABLE,
            'no_other_tokens',
            DecryptInterface::VALIDATION_DECRYPT_NAME
        );
    }

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

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

    /**
     * Gets all validated tokens that the command supports
     * (namely the variable, and keywords).
     *
     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
     * @throws Mailcode_Exception
     */
    protected function resolveActiveTokens(): array
    {
        $allowed = array($this->getVariableToken());

        $encodings = $this->getSupportedEncodings();

        foreach ($encodings as $keyword) {
            $token = $this->getEncodingToken($keyword);
            if ($token) {
                $allowed[] = $token;

                $parameter = $this->requireParams()->getInfo()->getTokenForKeyWord($token->getKeyword());
                if ($parameter) {
                    $allowed[] = $parameter;
                }
            }
        }

        return $allowed;
    }

    /**
     * @param string|NULL $decryptionKey A decryption key
     * @return void
     */
    public static function setDefaultDecryptionKey(?string $decryptionKey): void
    {
        self::$defaultDecryptionKey = $decryptionKey;
    }

    /**
     * Gets the default decryption key for decryption. If not set via
     * {@see self::setDefaultDecryptionKey()}, this defaults to "default".
     *
     * @return string
     */
    public static function getDefaultDecryptionKey(): string
    {
        return self::$defaultDecryptionKey ?? "default";
    }
}