class.ilDateTimeInputGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDateTimeInputGUI extends ilSubEnabledFormPropertyGUI implements ilTableFilterItem, ilToolbarItem
{
    protected ilObjUser $user;
    protected ?ilDateTime $date = null;
    protected string $time = "00:00:00";
    protected bool $showtime = false;
    protected int $minute_step_size = 5;
    protected ?int $startyear = null;
    protected string $invalid_input = '';
    protected bool $side_by_side = true;
    protected bool $valid = false;

    public function __construct(
        string $a_title = "",
        string $a_postvar = ""
    ) {
        global $DIC;

        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        parent::__construct($a_title, $a_postvar);
        $this->setType("datetime");
    }

    public function setDate(ilDateTime $a_date = null): void
    {
        $this->date = $a_date;
    }

    public function getDate(): ?ilDateTime
    {
        return $this->date;
    }

    public function setShowTime(bool $a_showtime): void
    {
        $this->showtime = $a_showtime;
    }

    public function getShowTime(): bool
    {
        return $this->showtime;
    }

    public function setStartYear(int $a_year): void
    {
        $this->startyear = $a_year;
    }

    public function getStartYear(): ?int
    {
        return $this->startyear;
    }

    public function setMinuteStepSize(int $a_step_size): void
    {
        $this->minute_step_size = $a_step_size;
    }

    public function getMinuteStepSize(): int
    {
        return 1;
    }

    public function setValueByArray(array $a_values): void
    {
        $incoming = $a_values[$this->getPostVar()] ?? "";
        $this->setDate(ilCalendarUtil::parseIncomingDate($incoming, (bool) $this->getDatePickerTimeFormat()));

        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }

    protected function getDatePickerTimeFormat(): int
    {
        return (int) $this->getShowTime();
    }

    public function hasInvalidInput(): bool
    {
        return (bool) $this->invalid_input;
    }

    public function checkInput(): bool
    {
        $lng = $this->lng;

        if ($this->getDisabled()) {
            return true;
        }

        $post = $this->str($this->getPostVar());

        // always done to make sure there are no obsolete values left
        $this->setDate(null);

        $valid = false;
        if (trim($post)) {
            $parsed = ilCalendarUtil::parseIncomingDate($post, (bool) $this->getDatePickerTimeFormat());
            if ($parsed) {
                $this->setDate($parsed);
                $valid = true;
            }
        } elseif (!$this->getRequired()) {
            $valid = true;
        }

        if ($valid &&
            $this->getDate() &&
            $this->getStartYear() &&
            $this->getDate()->get(IL_CAL_FKT_DATE, "Y") < $this->getStartYear()) {
            $valid = false;
        }

        $this->valid = $valid;

        if (!$valid) {
            $this->invalid_input = $post;
            $this->setAlert($lng->txt("form_msg_wrong_date"));
        }

        if ($valid) {
            $valid = $this->checkSubItemsInput();
        }

        return $valid;
    }

    public function getInput(): ?string
    {
        if ($this->valid && $this->getDate() !== null) {
            // getInput() should return a generic format
            $post_format = $this->getShowTime()
                ? IL_CAL_DATETIME
                : IL_CAL_DATE;
            return $this->getDate()->get($post_format);
        }
        return null;
    }

    public function setSideBySide(bool $a_val): void
    {
        // not relevant for native html date(time) pickers
    }

    protected function getDatetimeFormatForInput(): string
    {
        $format = 'Y-m-d';
        if ($this->getShowTime()) {
            $format .= '\TH:i';
        }
        return $format;
    }

    public function render(): string
    {
        $ilUser = $this->user;
        $lng = $this->lng;

        $tpl = new ilTemplate("tpl.prop_datetime.html", true, true, "components/ILIAS/Form");

        // config picker
        if (!$this->getDisabled()) {
            $picker_id = 'p' . md5($this->getPostVar()); // :TODO: unique?
            $tpl->setVariable('DATEPICKER_ID', $picker_id);
        } else {
            $tpl->setVariable('DATEPICKER_DISABLED', 'disabled="disabled" ');
        }

        $type = 'date';
        if ($this->getShowTime()) {
            $type = 'datetime-local';
        }
        $tpl->setVariable('DATEPICKER_TYPE', $type);

        // current value
        $out_format = $this->getDatetimeFormatForInput();
        $date_value = htmlspecialchars($this->invalid_input);
        if (!$date_value &&
            $this->getDate()) {
            $date_value = $this->getDate()->get(IL_CAL_FKT_DATE, $out_format, $ilUser->getTimeZone());
        }
        $tpl->setVariable('DATEPICKER_START_VALUE', $date_value);

        /*
         * For date input, step is in days, for datetime-local
         * it is in seconds.
         */
        $step_size = 60;
        if (!$this->getShowTime()) {
            $step_size = 1;
        }
        $tpl->setVariable('DATEPICKER_STEP', $step_size);

        if ($this->getStartYear()) {
            $min = DateTimeImmutable::createFromFormat(
                'Y',
                (string) $this->getStartYear()
            )->format($this->getDatetimeFormatForInput());
            $tpl->setVariable('DATEPICKER_MIN', $min);
        }

        $tpl->setVariable('DATEPICKER_VALUE', $date_value);
        $tpl->setVariable('DATE_ID', $this->getPostVar());

        if ($this->getRequired()) {
            $tpl->setVariable("REQUIRED", "required=\"required\"");
        }

        return $tpl->get();
    }

    public function getOnloadCode(): array
    {
        // no js necessary anymore
        return [];
    }

    public function insert(ilTemplate $a_tpl): void
    {
        $html = $this->render();

        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $html);
        $a_tpl->parseCurrentBlock();
    }

    public function getTableFilterHTML(): string
    {
        $html = $this->render();
        return $html;
    }

    public function serializeData(): string
    {
        if ($this->getDate()) {
            return serialize($this->getDate()->get(IL_CAL_UNIX));
        }
        return "";
    }

    public function unserializeData(string $a_data): void
    {
        $tmp = unserialize($a_data);
        if ($tmp) {
            // we used to serialize the complete instance
            if (is_object($tmp)) {
                $date = $tmp;
            } else {
                $date = $this->getShowTime()
                    ? new ilDateTime($tmp, IL_CAL_UNIX)
                    : new ilDate($tmp, IL_CAL_UNIX);
            }
            $this->setDate($date);
        } else {
            $this->setDate();
        }
    }

    public function getPostValueForComparison(): string
    {
        return $this->serializeData();
    }

    public function getToolbarHTML(): string
    {
        $html = $this->render();
        return $html;
    }

    public function hideSubForm(): bool
    {
        return (!$this->getDate() || $this->getDate()->isNull());
    }
}