class.ilDateTimeInputGUI.php

Go to the documentation of this file.

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

include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
class ilDateTimeInputGUI extends ilSubEnabledFormPropertyGUI implements ilTableFilterItem, ilToolbarItem
{
        protected $mode = null;
        protected $date_obj = null;
        protected $date;
        protected $time = "00:00:00";
        protected $showtime = false;
        protected $showseconds = false;
        protected $minute_step_size = 1;
        protected $show_empty = false;
        protected $startyear = '';
        
        protected $activation_title = '';
        protected $activation_post_var = '';

        const MODE_SELECT = 1;
        const MODE_INPUT = 2;
        
        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                $this->setType("datetime");
                $this->setMode(self::MODE_SELECT);
        }

        function setMode($mode)
        {
                if(in_array($mode, array(self::MODE_INPUT, self::MODE_SELECT)))
                {
                        $this->mode = $mode;
                }
        }

        function getMode()
        {
                return $this->mode;
        }
        
        public function enableDateActivation($a_title,$a_postvar,$a_checked = true)
        {
                $this->activation_title = $a_title;
                $this->activation_post_var = $a_postvar;
                $this->activation_checked = $a_checked;
        }
        
        public function getActivationPostVar()
        {
                return $this->activation_post_var;
        }

        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 setShowEmpty($a_empty)
        {
                $this->show_empty = $a_empty;
        }

        function getShowEmpty()
        {
                return $this->show_empty;
        }
        
        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)
        {
                global $ilUser;

                if($this->getMode() == self::MODE_INPUT &&
                                (!isset($a_values[$this->getPostVar()]["date"]) || $a_values[$this->getPostVar()]["date"] == ""))
                {
                        $this->date = NULL;
                }
                else if(isset($a_values[$this->getPostVar()]["time"]))
                {
                        $this->setDate(new ilDateTime($a_values[$this->getPostVar()]["date"].' '.$a_values[$this->getPostVar()]["time"],
                                IL_CAL_DATETIME,$ilUser->getTimeZone()));
                }
                else if (isset($a_values[$this->getPostVar()]["date"]))
                {
                        $this->setDate(new ilDate($a_values[$this->getPostVar()]["date"],
                                IL_CAL_DATE));
                }
                
                if($this->activation_post_var)
                {
                        $this->activation_checked = (bool)$a_values[$this->activation_post_var];
                }
        
                foreach($this->getSubItems() as $item)
                {
                        $item->setValueByArray($a_values);
                }
        }

        function checkInput()
        {
                global $ilUser, $lng;
                
                if ($this->getDisabled())
                {
                        return true;
                }

                $post = $_POST[$this->getPostVar()];

                // empty date valid with input field
                if(!$this->getRequired() && $this->getMode() == self::MODE_INPUT && $post["date"] == "")
                {
                        return true;
                }

                if($this->getMode() == self::MODE_SELECT)
                {
                        $post["date"]["y"] = ilUtil::stripSlashes($post["date"]["y"]);
                        $post["date"]["m"] = ilUtil::stripSlashes($post["date"]["m"]);
                        $post["date"]["d"] = ilUtil::stripSlashes($post["date"]["d"]);
                        $dt['year'] = (int) $post['date']['y'];
                        $dt['mon'] = (int) $post['date']['m'];
                        $dt['mday'] = (int) $post['date']['d'];

                        if($this->getShowTime())
                        {
                                $post["time"]["h"] = ilUtil::stripSlashes($post["time"]["h"]);
                                $post["time"]["m"] = ilUtil::stripSlashes($post["time"]["m"]);
                                $post["time"]["s"] = ilUtil::stripSlashes($post["time"]["s"]);
                                $dt['hours'] = (int) $post['time']['h'];
                                $dt['minutes'] = (int) $post['time']['m'];
                                $dt['seconds'] = (int) $post['time']['s'];
                        }
                }
                else
                {
                        $post["date"] = ilUtil::stripSlashes($post["date"]);
                        $post["time"] = ilUtil::stripSlashes($post["time"]);

                        if($post["date"])
                        {
                                switch($ilUser->getDateFormat())
                                {
                                        case ilCalendarSettings::DATE_FORMAT_DMY:
                                                $date = explode(".", $post["date"]);
                                                $dt['mday'] = (int)$date[0];
                                                $dt['mon'] = (int)$date[1];
                                                $dt['year'] = (int)$date[2];
                                                break;

                                        case ilCalendarSettings::DATE_FORMAT_YMD:
                                                $date = explode("-", $post["date"]);
                                                $dt['mday'] = (int)$date[2];
                                                $dt['mon'] = (int)$date[1];
                                                $dt['year'] = (int)$date[0];
                                                break;

                                        case ilCalendarSettings::DATE_FORMAT_MDY:
                                                $date = explode("/", $post["date"]);
                                                $dt['mday'] = (int)$date[1];
                                                $dt['mon'] = (int)$date[0];
                                                $dt['year'] = (int)$date[2];
                                                break;
                                }

                                if($this->getShowTime())
                                {
                                        if($ilUser->getTimeFormat() == ilCalendarSettings::TIME_FORMAT_12)
                                        {
                                                $seconds = "";
                                                if($this->getShowSeconds())
                                                {
                                                        $seconds = ":\s*([0-9]{1,2})\s*";
                                                }
                                                if(preg_match("/([0-9]{1,2})\s*:\s*([0-9]{1,2})\s*".$seconds."(am|pm)/", trim(strtolower($post["time"])), $matches))
                                                {
                                                        $dt['hours'] = (int)$matches[1];
                                                        $dt['minutes'] = (int)$matches[2];
                                                        if($seconds)
                                                        {
                                                                $dt['seconds'] = (int)$time[2];
                                                                $ampm = $matches[4];
                                                        }
                                                        else
                                                        {
                                                                $dt['seconds'] = 0;
                                                                $ampm = $matches[3];
                                                        }
                                                        if($dt['hours'] == 12)
                                                        {
                                                                if($ampm == "am")
                                                                {
                                                                        $dt['hours'] = 0;
                                                                }
                                                        }
                                                        else if($ampm == "pm")
                                                        {
                                                                $dt['hours'] += 12;
                                                        }
                                                }
                                        }
                                        else
                                        {
                                                $time = explode(":", $post["time"]);
                                                $dt['hours'] = (int)$time[0];
                                                $dt['minutes'] = (int)$time[1];
                                                $dt['seconds'] = (int)$time[2];
                                        }
                                }
                        }
                }

                // very basic validation
                if($dt['mday'] == 0 || $dt['mon'] == 0 || $dt['year'] == 0 || $dt['mday'] > 31 || $dt['mon'] > 12)
                {
                        $dt = false;
                }
                else if($this->getShowTime() && ($dt['hours'] > 23 || $dt['minutes'] > 59 || $dt['seconds'] > 59))
                {
                        $dt = false;
                }
                
                // #11847
                if(!checkdate($dt['mon'], $dt['mday'], $dt['year']))
                {
                        $this->invalid_input = $_POST[$this->getPostVar()]['date'];
                        $this->setAlert($lng->txt("exc_date_not_valid"));
                        $dt = false;
                }

                if($this->getShowTime())
                {
                        $date = new ilDateTime($dt, IL_CAL_FKT_GETDATE, $ilUser->getTimeZone());
                        $this->setDate($date);
                }
                else
                {
                        $date = new ilDate($dt, IL_CAL_FKT_GETDATE);
                        $this->setDate($date);
                }
                
                // post values used to be overwritten anyways - cannot change behaviour
                $_POST[$this->getPostVar()]['date'] = $date->get(IL_CAL_FKT_DATE, 'Y-m-d', $ilUser->getTimeZone());
                $_POST[$this->getPostVar()]['time'] = $date->get(IL_CAL_FKT_DATE, 'H:i:s', $ilUser->getTimeZone());
                
                return (bool)$dt;
        }

        function render()
        {
                global $lng,$ilUser;
                
                $tpl = new ilTemplate("tpl.prop_datetime.html", true, true, "Services/Form");

                $lng->loadLanguageModule("jscalendar");
                require_once("./Services/Calendar/classes/class.ilCalendarUtil.php");
                ilCalendarUtil::initJSCalendar();
                
                if(strlen($this->getActivationPostVar()))
                {
                        if(!$this->activation_checked)
                        {
                                $tpl->setCurrentBlock('sub_form_hide');
                                $tpl->setVariable('DSFID',$this->getFieldId());
                                $tpl->parseCurrentBlock();
                        }
                        
                        if($this->getInfo())
                        {
                                $tpl->setCurrentBlock('activation_description');
                                $tpl->setVariable('ACT_DESCRIPTION',$this->getInfo());
                                $tpl->parseCurrentBlock();
                                
                                // disable standard info block
                                $this->setInfo(null);
                        }
                        
                        $tpl->setCurrentBlock('prop_date_activation');
                        $tpl->setVariable('LAB_ID',$this->getFieldId());
                        $tpl->setVariable('SFID',$this->getFieldId());
                        $tpl->setVariable('CHECK_ENABLED_DATE',$this->getActivationPostVar());
                        $tpl->setVariable('TXT_DATE_ENABLED',$this->activation_title);
                        $tpl->setVariable('CHECKED_ENABLED',$this->activation_checked ? 'checked="checked"' : '');
                        $tpl->setVariable('CHECKED_DISABLED',$this->getDisabled() ? 'disabled="disabled" ' : '');
                        $tpl->parseCurrentBlock();
                        
                        $tpl->touchBlock('prop_date_activation_out');
                }

                if($this->getMode() == self::MODE_SELECT)
                {
                        if(is_a($this->getDate(),'ilDate'))
                        {
                                $date_info = $this->getDate()->get(IL_CAL_FKT_GETDATE,'','UTC');
                        }
                        elseif(is_a($this->getDate(),'ilDateTime'))
                        {
                                $date_info = $this->getDate()->get(IL_CAL_FKT_GETDATE,'',$ilUser->getTimeZone());
                        }
                        else
                        {
                                $this->setDate(new ilDateTime(time(), IL_CAL_UNIX));
                                $date_info = $this->getDate()->get(IL_CAL_FKT_GETDATE,'',$ilUser->getTimeZone());
                        }
                        
                        // display invalid input again
                        if(is_array($this->invalid_input))
                        {
                                $date_info['year'] = $this->invalid_input['y'];
                                $date_info['mon'] = $this->invalid_input['m'];
                                $date_info['mday'] = $this->invalid_input['d'];                                         
                        }
                }

                if($this->getMode() == self::MODE_SELECT)
                {
                        $tpl->setCurrentBlock("prop_date_input_select_setup");
                        $tpl->setVariable("INPUT_FIELDS_DATE", $this->getPostVar()."[date]");
                        $tpl->parseCurrentBlock();

                        $tpl->setCurrentBlock("prop_date");
                        $tpl->setVariable("DATE_SELECT",
                                ilUtil::makeDateSelect($this->getPostVar()."[date]", $date_info['year'], $date_info['mon'], $date_info['mday'],
                                        $this->startyear,true,array('disabled' => $this->getDisabled()), $this->getShowEmpty()));               
                }
                else
                {
                        $value = $this->getDate();
                        if($value)
                        {
                                $value = substr($this->getDate()->get(IL_CAL_DATETIME), 0, 10);
                                $day = substr($value, 8, 2);
                                $month = substr($value, 5, 2);
                                $year = substr($value, 0, 4);
                        }

                        switch($ilUser->getDateFormat())
                        {
                                case ilCalendarSettings::DATE_FORMAT_DMY:
                                        if($value)
                                        {
                                                $value = date("d.m.Y", mktime(0, 0, 0, $month, $day, $year));
                                        }
                                        $format = "%d.%m.%Y";
                                        $input_hint = $lng->txt("dd_mm_yyyy");
                                        break;

                                case ilCalendarSettings::DATE_FORMAT_YMD:
                                        if($value)
                                        {
                                                $value = date("Y-m-d", mktime(0, 0, 0, $month, $day, $year));
                                        }
                                        $format = "%Y-%m-%d";
                                        $input_hint = $lng->txt("yyyy_mm_dd");
                                        break;

                                case ilCalendarSettings::DATE_FORMAT_MDY:
                                        if($value)
                                        {
                                                $value = date("m/d/Y", mktime(0, 0, 0, $month, $day, $year));
                                        }
                                        $format = "%m/%d/%Y";
                                        $input_hint = $lng->txt("mm_dd_yyyy");
                                        break;
                        }
                        
                        // #17232
                        if($this->invalid_input)
                        {
                                $value = $this->invalid_input;
                        }

                        $tpl->setCurrentBlock("prop_date_input_field");
                        $tpl->setVariable("DATE_ID", $this->getPostVar());
                        $tpl->setVariable("DATE_VALUE", $value); 
                        $tpl->setVariable("DISABLED", $this->getDisabled() ? " disabled=\"disabled\"" : "");
                        $tpl->parseCurrentBlock();

                        $tpl->setCurrentBlock("prop_date_input_field_info");
                        $tpl->setVariable("TXT_INPUT_FORMAT", $input_hint);
                        $tpl->parseCurrentBlock();

                        $tpl->setCurrentBlock("prop_date_input_field_setup");
                        $tpl->setVariable("DATE_ID", $this->getPostVar());
                        $tpl->setVariable("DATE_FIELD_FORMAT", $format);
                        $tpl->parseCurrentBlock();
                }

                $tpl->setCurrentBlock("prop_date");
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $tpl->setVariable("IMG_DATE_CALENDAR", ilGlyphGUI::get(ilGlyphGUI::CALENDAR, $lng->txt("open_calendar")));
                $tpl->setVariable("DATE_ID", $this->getPostVar());

                include_once './Services/Calendar/classes/class.ilCalendarUserSettings.php';
                $tpl->setVariable('DATE_FIRST_DAY',ilCalendarUserSettings::_getInstance()->getWeekStart());

                $tpl->parseCurrentBlock();
                
                if($this->getShowTime())
                {
                        if($this->getMode() == self::MODE_INPUT)
                        {
                                $value = $this->getDate();
                                if($value)
                                {
                                        if(!$this->getShowSeconds())
                                        {
                                                $value = substr($value->get(IL_CAL_DATETIME), 11, 5);
                                                if($ilUser->getTimeFormat() == ilCalendarSettings::TIME_FORMAT_12)
                                                {
                                                        $value = date("g:ia", mktime(substr($value, 0, 2), substr($value, 3, 2)));
                                                }
                                        }
                                        else
                                        {
                                                $value = substr($value->get(IL_CAL_DATETIME), 11, 8);
                                                if($ilUser->getTimeFormat() == ilCalendarSettings::TIME_FORMAT_12)
                                                {
                                                        $value = date("g:i:sa", mktime(substr($value, 0, 2), substr($value, 3, 2), substr($value, 6, 2)));
                                                }
                                        }
                                }
                                
                                $tpl->setCurrentBlock("prop_time_input_field");
                $tpl->setVariable("DATE_ID", $this->getPostVar());
                                $tpl->setVariable("TIME_VALUE", $value); 
                                $tpl->setVariable("DISABLED", $this->getDisabled() ? " disabled=\"disabled\"" : "");
                                $tpl->parseCurrentBlock();
                        }
                        
                        $tpl->setCurrentBlock("prop_time");

                        if($this->getMode() == self::MODE_SELECT)
                        {
                                $tpl->setVariable("TIME_SELECT",
                                        ilUtil::makeTimeSelect($this->getPostVar()."[time]", !$this->getShowSeconds(),
                                        $date_info['hours'], $date_info['minutes'], $date_info['seconds'],
                                        true,array('minute_steps' => $this->getMinuteStepSize(),
                                                                'disabled' => $this->getDisabled())));
                        }
                        
                        $tpl->setVariable("TXT_TIME", $this->getShowSeconds()
                                ? "(".$lng->txt("hh_mm_ss").")"
                                : "(".$lng->txt("hh_mm").")");
                        
                        $tpl->parseCurrentBlock();
                }
                
                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()
        {
                return serialize($this->getDate());
        }
        
        function unserializeData($a_data)
        {
                $data = unserialize($a_data);

                if (is_object($data))
                {
                        $this->setDate($data);
                }
        }

        function getPostValueForComparison()
        {
                return trim($_POST[$this->getPostVar()]["date"]." ". $_POST[$this->getPostVar()]["time"]);
        }
        
        function getToolbarHTML()
        {
                $html = $this->render("toolbar");
                return $html;
        }       
}

?>