DateFormat.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace ILIAS\Data\DateFormat;

class DateFormat
{
    public const DOT = '.';
    public const COMMA = ',';
    public const DASH = '-';
    public const SLASH = '/';
    public const SPACE = ' ';
    public const DAY = 'd';
    public const DAY_ORDINAL = 'jS';
    public const WEEKDAY = 'l';
    public const WEEKDAY_SHORT = 'D';
    public const WEEK = 'W';
    public const MONTH = 'm';
    public const MONTH_SPELLED = 'F';
    public const MONTH_SPELLED_SHORT = 'M';
    public const YEAR = 'Y';
    public const YEAR_TWO_DIG = 'y';
    public const HOURS12 = 'h';
    public const HOURS24 = 'H';
    public const MINUTES = 'i';
    public const SECONDS = 's';
    public const MERIDIEM = 'a';
    public const COLON = ':';

    public const TOKENS = [
        self::DOT,
        self::COMMA,
        self::DASH,
        self::SLASH,
        self::SPACE,
        self::DAY,
        self::DAY_ORDINAL,
        self::WEEKDAY,
        self::WEEKDAY_SHORT,
        self::WEEK,
        self::MONTH,
        self::MONTH_SPELLED,
        self::MONTH_SPELLED_SHORT,
        self::YEAR,
        self::YEAR_TWO_DIG,
        self::HOURS12,
        self::HOURS24,
        self::MINUTES,
        self::SECONDS,
        self::MERIDIEM,
        self::COLON
    ];

    protected array $format = [];

    public function __construct(array $format)
    {
        $this->validateFormatElelements($format);
        $this->format = $format;
    }

    public function validateFormatElelements(array $format): void
    {
        foreach ($format as $entry) {
            if (!in_array($entry, self::TOKENS, true)) {
                throw new \InvalidArgumentException("not a valid token for date-format", 1);
            }
        }
    }

    public function toArray(): array
    {
        return $this->format;
    }

    public function toString(): string
    {
        return implode('', $this->format);
    }

    public function __toString(): string
    {
        return $this->toString();
    }

    public function applyTo(\DateTimeImmutable $datetime): string
    {
        return $datetime->format($this->toString());
    }
}