Mailcode\Mailcode_Commands_Command_ShowDate

Complexity

Total Complexity

11

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	parseFormatString()	0	12	2
A	validateSyntax_check_format()	0	14	2
A	getValidations()	0	6	1
A	getLabel()	0	3	1
A	setDefaultTimezone()	0	3	1
A	init()	0	6	1
A	getFormatString()	0	3	1
A	getName()	0	3	1
A	getDefaultTimezone()	0	3	1

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

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Interfaces\Commands\Validation\TimezoneInterface;
use Mailcode\Traits\Commands\Validation\TimezoneTrait;

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

    /**
     * @var Mailcode_Variables_Variable|string|NULL
     */
    private static $defaultTimeZone = null;

    /**
     * The date format string.
     * @var string
     */
    private string $formatString;

    /**
     * @var Mailcode_Date_FormatInfo
     */
    private Mailcode_Date_FormatInfo $formatInfo;

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

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

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

    protected function init(): void
    {
        $this->formatInfo = Mailcode_Factory::createDateInfo();
        $this->formatString = $this->formatInfo->getDefaultFormat();

        parent::init();
    }

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

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

        $format = $tokens[0]->getText();

        $this->parseFormatString($format);
    }

    private function parseFormatString(string $format): void
    {
        $result = $this->formatInfo->validateFormat($format);

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

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

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

    /**
     * @param string|Mailcode_Variables_Variable|NULL $zone A timezone identifier, e.g. <code>Europe/Paris</code> or a variable containing the zone identifier, or NULL to use the PHP default.
     * @return void
     */
    public static function setDefaultTimezone($zone) : void
    {
        self::$defaultTimeZone = $zone;
    }

    /**
     * Gets the default time zone used for dates. If not set via
     * {@see self::setDefaultTimezone()}, this defaults to PHP's
     * default time zone (typically <code>UTC</code> if not changed).
     *
     * @return string|Mailcode_Variables_Variable
     */
    public static function getDefaultTimezone()
    {
        return self::$defaultTimeZone ?? date_default_timezone_get();
    }
}