DateTime.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2019 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

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

use ILIAS\UI\Component as C;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\DateFormat as DateFormat;


use ILIAS\UI\Component\JavaScriptBindable as JSBindabale;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;

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

    public const TIME_FORMAT = 'HH:mm';

    protected $format;

    protected $min_date;

    protected $max_date;

    protected $with_time = false;

    protected $with_time_only = false;

    protected $additional_picker_config = [];

    protected $timezone;

    public function __construct(
        DataFactory $data_factory,
        \ILIAS\Refinery\Factory $refinery,
        $label,
        $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($or_trafo)
    {
        return $this->refinery->custom()->transformation(
            function ($v) use ($or_trafo) {
                if (!$v) {
                    return null;
                }
                return $or_trafo->transform($v);
            }
        );
    }

    public function withFormat(DateFormat\DateFormat $format) : C\Input\Field\DateTime
    {
        $clone = clone $this;
        $clone->format = $format;
        return $clone;
    }

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


    public function withTimezone(string $tz) : C\Input\Field\DateTime
    {
        $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()
    {
        return $this->timezone;
    }

    public function withMinValue(\DateTimeImmutable $date) : C\Input\Field\DateTime
    {
        $clone = clone $this;
        $clone->min_date = $date;
        return $clone;
    }

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

    public function withMaxValue(\DateTimeImmutable $date) : C\Input\Field\DateTime
    {
        $clone = clone $this;
        $clone->max_date = $date;
        return $clone;
    }

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

    public function withUseTime(bool $with_time) : C\Input\Field\DateTime
    {
        $clone = clone $this;
        $clone->with_time = $with_time;
        return $clone;
    }

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

    public function withTimeOnly(bool $with_time_only) : C\Input\Field\DateTime
    {
        $clone = clone $this;
        $clone->with_time_only = $with_time_only;
        return $clone;
    }

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

    protected function isClientSideValueOk($value) : bool
    {
        return is_string($value);
    }

    protected function getConstraintForRequirement()
    {
        return $this->refinery->string()->hasMinLength(1)
            ->withProblemBuilder(function ($txt, $value) {
                return $txt("datetime_required");
            });
    }

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

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

    public function getUpdateOnLoadCode() : \Closure
    {
        return function ($id) {
            $code = "$('#$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());";
            return $code;
        };
    }
}