class.ilDateTimeInputGUI.php

Go to the documentation of this file.

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

require_once("./Services/Calendar/classes/class.ilCalendarUtil.php");
include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");

class ilDateTimeInputGUI extends ilSubEnabledFormPropertyGUI implements ilTableFilterItem, ilToolbarItem
{
        protected $date;
        protected $time = "00:00:00";
        protected $showtime = false;
        protected $showseconds = false;
        protected $minute_step_size = 5;
        protected $startyear = '';
        protected $invalid_input = '';

        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                $this->setType("datetime");
        }

        function setDate(ilDateTime $a_date = NULL)
        {
                $this->date = $a_date;
        }

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

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

        function getShowTime()
        {
                return $this->showtime;
        }
        
        function setStartYear($a_year)
        {
                $this->startyear = $a_year;
        }
        
        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;
        }

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

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

        function setValueByArray($a_values)
        {               
                $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;
        }

        function checkInput()
        {
                global $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;
                        }                                       
                }
                else if(!$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;
                                $_POST[$this->getPostVar()] = $this->getDate()->get($post_format);
                        }
                        else
                        {
                                $_POST[$this->getPostVar()] = null;
                        }
                }
                
                if($valid)
                {
                        $valid = $this->checkSubItemsInput();
                }
                
                return $valid;
        }
        
        protected function parseDatePickerConfig()
        {
                $config = null;
                if($this->getMinuteStepSize())
                {
                        $config['stepping'] = (int)$this->getMinuteStepSize();
                }
                if($this->getStartYear())
                {
                        $config['minDate'] = $this->getStartYear().'-01-01';
                }
                return $config;
        }

        function render()
        {
                global $ilUser;
                
                $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);           
                
                // 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();
        }

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

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

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

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

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

?>