class.ilDateTimeInputGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilDateTimeInputGUI extends ilSubEnabledFormPropertyGUI implements ilTableFilterItem, ilToolbarItem
{
    protected $lng;

    protected $user;

    protected $date;
    protected $time = "00:00:00";
    protected $showtime = false;
    protected $showseconds = false;
    protected $minute_step_size = 5;
    protected $startyear = '';
    protected $invalid_input = '';

    protected $side_by_side = true;
    protected $valid_incoming_datetime = null;

    public function __construct($a_title = "", $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)
    {
        $this->date = $a_date;
    }

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

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

    public function getShowTime()
    {
        return $this->showtime;
    }
    
    public function setStartYear($a_year)
    {
        $this->startyear = $a_year;
    }
    
    public function getStartYear()
    {
        return $this->startyear;
    }
    
    public function setMinuteStepSize($a_step_size)
    {
        $this->minute_step_size = $a_step_size;
    }
    
    public function getMinuteStepSize()
    {
        return $this->minute_step_size;
    }

    public function setShowSeconds($a_showseconds)
    {
        $this->showseconds = $a_showseconds;
    }

    public function getShowSeconds()
    {
        return $this->showseconds;
    }

    public function setValueByArray($a_values)
    {
        if ($this->valid_incoming_datetime !== null) {
            $this->setDate($this->valid_incoming_datetime);
        } else {
            $incoming = $a_values[$this->getPostVar()];
            $this->setDate(ilCalendarUtil::parseIncomingDate($incoming, $this->getDatePickerTimeFormat()));
        }

        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }
    
    protected function getDatePickerTimeFormat()
    {
        return (int) $this->getShowTime() + (int) $this->getShowSeconds();
    }
    
    public function hasInvalidInput()
    {
        return (bool) $this->invalid_input;
    }

    public function checkInput()
    {
        $lng = $this->lng;
        
        if ($this->getDisabled()) {
            return true;
        }

        $post = $_POST[$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, $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;
        }
        
        if (!$valid) {
            $this->invalid_input = $post;
            $_POST[$this->getPostVar()] = null;
            
            $this->setAlert($lng->txt("form_msg_wrong_date"));
        } else {
            if ($this->getDate() !== null) {
                // getInput() should return a generic format
                $post_format = $this->getShowTime()
                    ? IL_CAL_DATETIME
                    : IL_CAL_DATE;
                $this->valid_incoming_datetime = $this->getDate();
                $_POST[$this->getPostVar()] = $this->getDate()->get($post_format);
            } else {
                $_POST[$this->getPostVar()] = null;
            }
        }
        
        if ($valid) {
            $valid = $this->checkSubItemsInput();
        }
        
        return $valid;
    }

    public function setSideBySide(bool $a_val)
    {
        $this->side_by_side = $a_val;
    }

    public function getSideBySide() : bool
    {
        return $this->side_by_side;
    }


    protected function parseDatePickerConfig()
    {
        $config = null;
        if ($this->getMinuteStepSize()) {
            $config['stepping'] = (int) $this->getMinuteStepSize();
        }
        if ($this->getStartYear()) {
            $config['minDate'] = $this->getStartYear() . '-01-01';
        }
        $config['sideBySide'] = $this->getSideBySide();
        return $config;
    }

    public function render()
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        
        $tpl = new ilTemplate("tpl.prop_datetime.html", true, true, "Services/Form");

        // config picker
        if (!$this->getDisabled()) {
            $picker_id = md5($this->getPostVar()); // :TODO: unique?
            $tpl->setVariable('DATEPICKER_ID', $picker_id);
            
            ilCalendarUtil::addDateTimePicker(
                $picker_id,
                $this->getDatePickerTimeFormat(),
                $this->parseDatePickerConfig(),
                null,
                null,
                null,
                "subform_" . $this->getPostVar()
            );
        } else {
            $tpl->setVariable('DATEPICKER_DISABLED', 'disabled="disabled" ');
        }
        
        // :TODO: i18n?
        $pl_format = ilCalendarUtil::getUserDateFormat($this->getDatePickerTimeFormat());
        $tpl->setVariable('PLACEHOLDER', $pl_format);

        // accessibility description
        $tpl->setVariable(
            'DESCRIPTION',
            ilUtil::prepareFormOutput($lng->txt("form_date_aria_desc") . " " . $pl_format)
        );
        
        // current value
        $date_value = htmlspecialchars($this->invalid_input);
        if (!$date_value &&
            $this->getDate()) {
            $out_format = ilCalendarUtil::getUserDateFormat($this->getDatePickerTimeFormat(), true);
            $date_value = $this->getDate()->get(IL_CAL_FKT_DATE, $out_format, $ilUser->getTimeZone());
        }

        $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
    {
        $code = [];
        if (!$this->getDisabled()) {
            $picker_id = md5($this->getPostVar());

            $code = ilCalendarUtil::getCodeForPicker(
                $picker_id,
                $this->getDatePickerTimeFormat(),
                $this->parseDatePickerConfig(),
                null,
                null,
                null,
                "subform_" . $this->getPostVar()
            );
        }
        return $code;
    }

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

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

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

    public function serializeData()
    {
        if ($this->getDate()) {
            return serialize($this->getDate()->get(IL_CAL_UNIX));
        }
    }
    
    public function unserializeData($a_data)
    {
        $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(null);
        }
    }

    public function getPostValueForComparison()
    {
        // :TODO:
        return trim($_POST[$this->getPostVar()]);
    }
    
    public function getToolbarHTML()
    {
        $html = $this->render("toolbar");
        return $html;
    }
    
    public function hideSubForm()
    {
        return (!$this->getDate() || $this->getDate()->isNull());
    }
}