Duration.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2018 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\Refinery\Transformation\Factory as TransformationFactory;
use ILIAS\Refinery\Validation\Factory as ValidationFactory;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\JavaScriptBindable as JSBindabale;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\Input\Field\DateTime as DTField;

class Duration extends Group implements C\Input\Field\Duration, JSBindabale
{
    use ComponentHelper;
    use JavaScriptBindable;

    protected $format;

    protected $min_date;

    protected $max_date;

    protected $with_time = false;

    protected $with_time_only = false;

    protected $timezone;

    protected $transformation_factory;

    public function __construct(
        DataFactory $data_factory,
        \ILIAS\Refinery\Factory $refinery,
        \ilLanguage $lng,
        Factory $field_factory,
        $label,
        $byline
    ) {
        $inputs = [
            $field_factory->dateTime('start'),
            $field_factory->dateTime('end')
        ];

        parent::__construct($data_factory, $refinery, $lng, $inputs, $label, $byline);

        $this->addTransformation();
        $this->addValidation();
    }

    protected function addTransformation()
    {
        $duration = $this->refinery->custom()->transformation(function ($v) {
            list($from, $until) = $v;
            if ($from && $until) {
                return ['start' => $from, 'end' => $until, 'interval' => $from->diff($until)];
            }
            return null;
        });
        $this->setAdditionalTransformation($duration);
    }

    protected function addValidation()
    {
        $txt_id = 'duration_end_must_not_be_earlier_than_start';
        $error = function (callable $txt, $value) use ($txt_id) {
            return $txt($txt_id, $value);
        };
        $is_ok = function ($v) {
            if (is_null($v)) {
                return true;
            }
            return $v['start'] < $v['end'];
        };

        $from_before_until = $this->refinery->custom()->constraint($is_ok, $error);
        $this->setAdditionalTransformation($from_before_until);
    }

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

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

    protected function applyFormat()
    {
        $this->inputs = array_map(
            function ($inpt) {
                return $inpt->withFormat($this->getFormat());
            },
            $this->inputs
        );
    }

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

    protected function applyMinValue()
    {
        $this->inputs = array_map(
            function ($inpt) {
                return $inpt->withMinValue($this->getMinValue());
            },
            $this->inputs
        );
    }

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

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

    protected function applyMaxValue()
    {
        $this->inputs = array_map(
            function ($inpt) {
                return $inpt->withMaxValue($this->getMaxValue());
            },
            $this->inputs
        );
    }

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

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

    protected function applyWithTimeOnly()
    {
        $this->inputs = array_map(
            function ($inpt) {
                return $inpt->withTimeOnly($this->getTimeOnly());
            },
            $this->inputs
        );
    }

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

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

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

    protected function applyWithUseTime()
    {
        $this->inputs = array_map(
            function ($inpt) {
                return $inpt->withUseTime($this->getUseTime());
            },
            $this->inputs
        );
    }

    public function withTimezone(string $tz) : C\Input\Field\Duration
    {
        $trafo = $this->refinery->dateTime()->changeTimezone($tz);
        $clone = clone $this;
        $clone->timezone = $tz;

        $clone->inputs = array_map(
            function ($inpt) use ($trafo) {
                return $inpt->withAdditionalTransformation($trafo);
            },
            $clone->inputs
        );
        return $clone;
    }

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

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

    protected function getConstraintForRequirement()
    {
        return null;
    }

    public function getUpdateOnLoadCode() : \Closure
    {
        return function ($id) {
            $code = "var combinedDuration = function() {
                                var options = [];
                                $('#$id').find('input').each(function() {
                                        options.push($(this).val());
                                });
                                return options.join(' - ');
                        }
                        $('#$id').on('input dp.change', function(event) {
                                il.UI.input.onFieldUpdate(event, '$id', combinedDuration());
                        });
                        il.UI.input.onFieldUpdate(event, '$id', combinedDuration());";
            return $code;
        };
    }
}