DateTime.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Input\Field;

use ILIAS\UI\Component as C;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\DateFormat\DateFormat;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use DateTimeImmutable;
use ILIAS\Refinery\Custom\Transformation;
use ILIAS\Refinery\Constraint;
use Closure;

class DateTime extends FormInput implements C\Input\Field\DateTime
{
    use ComponentHelper;
    use JavaScriptBindable;

    public const TIME_FORMAT = 'HH:mm';

    protected DateFormat $format;
    protected ?DateTimeImmutable $min_date = null;
    protected ?DateTimeImmutable $max_date = null;
    protected bool $with_time = false;
    protected bool $with_time_only = false;
    protected ?string $timezone = null;

    protected array $additional_picker_config = [];

    public function __construct(
        DataFactory $data_factory,
        \ILIAS\Refinery\Factory $refinery,
        string $label,
        ?string $byline
    ) {
        parent::__construct($data_factory, $refinery, $label, $byline);

        $this->format = $data_factory->dateFormat()->standard();

        $datetime_trafo = $refinery->to()->dateTime();
        $trafo = $this->getOptionalNullTransformation($datetime_trafo);
        $this->setAdditionalTransformation($trafo);
    }

    protected function getOptionalNullTransformation(\ILIAS\Refinery\Transformation $or_trafo): Transformation
    {
        return $this->refinery->custom()->transformation(
            function ($v) use ($or_trafo) {
                if (!$v) {
                    return null;
                }
                return $or_trafo->transform($v);
            }
        );
    }

    public function withValue($value): self
    {
        // This is necessary, otherwise DateTimeImmutable will replace
        // the empty string with the current date during rendering.
        // The empty string is the default value posted by the input, if
        // it is left empty.
        if ($value === '') {
            $value = null;
        }
        // TODO: It would be a lot nicer if the value would be held as DateTimeImmutable
        // internally, but currently this is just to much. Added to the roadmap.
        if ($value instanceof \DateTimeImmutable) {
            $value = $value->format(Renderer::HTML5_NATIVE_DATETIME_FORMAT);
        }
        return parent::withValue($value);
    }

    public function withFormat(DateFormat $format): self
    {
        $clone = clone $this;
        $clone->format = $format;
        return $clone;
    }

    public function getFormat(): DateFormat
    {
        return $this->format;
    }


    public function withTimezone(string $tz): self
    {
        $timezone_trafo = $this->refinery->dateTime()->changeTimezone($tz);
        $clone = clone $this;
        $clone->timezone = $tz;

        $trafo = $this->getOptionalNullTransformation($timezone_trafo);
        $clone = $clone->withAdditionalTransformation($trafo);
        return $clone;
    }

    public function getTimezone(): ?string
    {
        return $this->timezone;
    }

    public function withMinValue(DateTimeImmutable $datetime): self
    {
        $clone = clone $this;
        $clone->min_date = $datetime;
        return $clone;
    }

    public function getMinValue(): ?DateTimeImmutable
    {
        return $this->min_date;
    }

    public function withMaxValue(DateTimeImmutable $datetime): self
    {
        $clone = clone $this;
        $clone->max_date = $datetime;
        return $clone;
    }

    public function getMaxValue(): ?DateTimeImmutable
    {
        return $this->max_date;
    }

    public function withUseTime(bool $with_time): self
    {
        $clone = clone $this;
        $clone->with_time = $with_time;
        return $clone;
    }

    public function getUseTime(): bool
    {
        return $this->with_time;
    }

    public function withTimeOnly(bool $time_only): self
    {
        $clone = clone $this;
        $clone->with_time_only = $time_only;
        return $clone;
    }

    public function getTimeOnly(): bool
    {
        return $this->with_time_only;
    }

    protected function isClientSideValueOk($value): bool
    {
        if ($value instanceof \DateTimeImmutable || is_null($value)) {
            return true;
        }

        if (!is_string($value)) {
            return false;
        }

        try {
            new \DateTimeImmutable($value);
            return true;
        }
        // We should mostly not catch generic Throwables because we will be masking
        // a lot of error conditions in this way... But, unfortunately, I cannot
        // currently see a better way to check if \DateTimeImmutable would accept
        // the supplied $value, so here we go...
        catch (\Throwable $e) {
            return false;
        }
    }

    protected function getConstraintForRequirement(): ?Constraint
    {
        if ($this->requirement_constraint !== null) {
            return $this->requirement_constraint;
        }

        return $this->refinery->logical()->sequential([
            $this->refinery->logical()->not($this->refinery->null()),
            $this->refinery->string()->hasMinLength(1)
        ])
        ->withProblemBuilder(fn($txt, $value) => $txt("datetime_required"));

    }

    public function getAdditionalPickerconfig(): array
    {
        return $this->additional_picker_config;
    }

    public function withAdditionalPickerconfig(array $config): self
    {
        $clone = clone $this;
        $clone->additional_picker_config = array_merge($clone->additional_picker_config, $config);
        return $clone;
    }

    public function getUpdateOnLoadCode(): Closure
    {
        return fn($id) => "$('#$id').on('input dp.change', function(event) {
                                il.UI.input.onFieldUpdate(event, '$id', $('#$id').find('input').val());
                        });
                        il.UI.input.onFieldUpdate(event, '$id', $('#$id').find('input').val());";
    }
}