Mailcode\Mailcode_Commands_Command_ShowNumber

Complexity

Total Complexity

9

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getValidations()	0	6	1
A	validateSyntax_check_format()	0	13	2
A	getLabel()	0	3	1
A	getFormatString()	0	3	1
A	getFormatInfo()	0	3	1
A	parseFormatString()	0	12	2

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

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Interfaces\Commands\Validation\AbsoluteKeywordInterface;
use Mailcode\Traits\Commands\Validation\AbsoluteKeywordTrait;

/**
 * Mailcode command: show a date variable value.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_ShowNumber
    extends Mailcode_Commands_ShowBase
    implements AbsoluteKeywordInterface
{
    use AbsoluteKeywordTrait;

    public const VALIDATION_PADDING_SEPARATOR_OVERFLOW = 72202;
    public const VALIDATION_INVALID_FORMAT_NUMBER = 72203;
    public const VALIDATION_INVALID_THOUSANDS_SEPARATOR = 72204;
    public const VALIDATION_INVALID_DECIMALS_NO_DECIMALS = 72205;
    public const VALIDATION_INVALID_CHARACTERS = 72206;
    public const VALIDATION_PADDING_INVALID_CHARS = 72207;
    public const VALIDATION_INVALID_DECIMALS_CHARS = 72208;
    public const VALIDATION_INVALID_DECIMAL_SEPARATOR = 72209;
    public const VALIDATION_SEPARATORS_SAME_CHARACTER = 72210;

    /**
     * The default number format string.
     * @var string
     */
    private string $formatString = Mailcode_Number_Info::DEFAULT_FORMAT;

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

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

    protected function getValidations(): array
    {
        return array(
            Mailcode_Interfaces_Commands_Validation_Variable::VALIDATION_NAME_VARIABLE,
            'check_format',
            AbsoluteKeywordInterface::VALIDATION_NAME
        );
    }

    protected function validateSyntax_check_format(): void
    {
        $tokens = $this->requireParams()
            ->getInfo()
            ->getStringLiterals();

        // no format specified? Use the default one.
        if (empty($tokens)) {
            return;
        }

        $token = array_pop($tokens);
        $this->parseFormatString($token->getText());
    }

    private function parseFormatString(string $format): void
    {
        $result = new Mailcode_Number_Info($format);

        if ($result->isValid()) {
            $this->formatString = $format;
            return;
        }

        $this->validationResult->makeError(
            $result->getErrorMessage(),
            $result->getCode()
        );
    }

    /**
     * Retrieves the format string used to format the number.
     *
     * @return string
     */
    public function getFormatString(): string
    {
        return $this->formatString;
    }

    /**
     * Retrieves information on how the number should be formatted.
     *
     * @return Mailcode_Number_Info
     */
    public function getFormatInfo(): Mailcode_Number_Info
    {
        return new Mailcode_Number_Info($this->getFormatString());
    }
}