This class represents a date/time property in a property form. More...

Inheritance diagram for ilDateTimeInputGUI:

Collaboration diagram for ilDateTimeInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setDate (ilDateTime $a_date=NULL)
	set date E.g $dt_form->setDate(new ilDateTime(time(),IL_CAL_UTC)); or $dt_form->setDate(new ilDateTime('2008-06-12 08:00:00',IL_CAL_DATETIME)); More...

	getDate ()
	Get Date, yyyy-mm-dd. More...

	setShowTime ($a_showtime)
	Set Show Time Information. More...

	getShowTime ()
	Get Show Time Information. More...

	setStartYear ($a_year)
	Set start year. More...

	getStartYear ()
	Get start year. More...

	setMinuteStepSize ($a_step_size)
	Set minute step size E.g 5 => The selection will only show 00,05,10... minutes. More...

	getMinuteStepSize ()
	Get minute step size. More...

	setShowSeconds ($a_showseconds)
	Set Show Seconds. More...

	getShowSeconds ()
	Get Show Seconds. More...

	setValueByArray ($a_values)
	Set value by array. More...

	hasInvalidInput ()

	checkInput ()
	Check input, strip slashes etc. More...

	render ()
	Insert property html. More...

	insert ($a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	getPostValueForComparison ()
	parse post value to make it comparable More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	hideSubForm ()
	Sub form hidden on init? More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Protected Member Functions
	getDatePickerTimeFormat ()

	parseDatePickerConfig ()
	parse properties to datepicker config More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$date

	$time = "00:00:00"

	$showtime = false

	$showseconds = false

	$minute_step_size = 5

	$startyear = ''

	$invalid_input = ''

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This class represents a date/time property in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilDateTimeInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDateTimeInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 30 of file class.ilDateTimeInputGUI.php.

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

References ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilDateTimeInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 177 of file class.ilDateTimeInputGUI.php.

        {
                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;
        }

References $_POST, $lng, $valid, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getDate(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getShowTime(), getStartYear(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_DATE, ilCalendarUtil\parseIncomingDate(), ilFormPropertyGUI\setAlert(), and setDate().

Here is the call graph for this function:

◆ getDate()

ilDateTimeInputGUI::getDate ( )

Get Date, yyyy-mm-dd.

Returns: object Date, yyyy-mm-dd

Definition at line 57 of file class.ilDateTimeInputGUI.php.

        {
                return $this->date;
        }

References $date.

Referenced by checkInput(), hideSubForm(), render(), and serializeData().

Here is the caller graph for this function:

◆ getDatePickerTimeFormat()

ilDateTimeInputGUI::getDatePickerTimeFormat ( )

protected

Definition at line 162 of file class.ilDateTimeInputGUI.php.

        {
                return (int)$this->getShowTime() + (int)$this->getShowSeconds();
        }

References getShowSeconds(), and getShowTime().

Referenced by checkInput(), render(), and setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinuteStepSize()

ilDateTimeInputGUI::getMinuteStepSize ( )

Get minute step size.

@access public

Definition at line 121 of file class.ilDateTimeInputGUI.php.

        {
                return $this->minute_step_size;
        }

References $minute_step_size.

Referenced by parseDatePickerConfig().

Here is the caller graph for this function:

◆ getPostValueForComparison()

ilDateTimeInputGUI::getPostValueForComparison ( )

parse post value to make it comparable

used by combination input gui

Definition at line 385 of file class.ilDateTimeInputGUI.php.

        {
                // :TODO:
                return trim($_POST[$this->getPostVar()]);
        }

References $_POST, and ilFormPropertyGUI\getPostVar().

Here is the call graph for this function:

◆ getShowSeconds()

ilDateTimeInputGUI::getShowSeconds ( )

Get Show Seconds.

Returns: boolean Show Seconds

Definition at line 141 of file class.ilDateTimeInputGUI.php.

        {
                return $this->showseconds;
        }

References $showseconds.

Referenced by getDatePickerTimeFormat().

Here is the caller graph for this function:

◆ getShowTime()

ilDateTimeInputGUI::getShowTime ( )

Get Show Time Information.

Returns: boolean Show Time Information

Definition at line 77 of file class.ilDateTimeInputGUI.php.

        {
                return $this->showtime;
        }

References $showtime.

Referenced by checkInput(), getDatePickerTimeFormat(), and unserializeData().

Here is the caller graph for this function:

◆ getStartYear()

ilDateTimeInputGUI::getStartYear ( )

Get start year.

Returns: integer Start year

Reimplemented in ilBirthdayInputGUI.

Definition at line 97 of file class.ilDateTimeInputGUI.php.

        {
                return $this->startyear;
        }

References $startyear.

Referenced by checkInput(), and parseDatePickerConfig().

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilDateTimeInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 336 of file class.ilDateTimeInputGUI.php.

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

References $html, and render().

Here is the call graph for this function:

◆ getToolbarHTML()

ilDateTimeInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

Definition at line 394 of file class.ilDateTimeInputGUI.php.

        {
                $html = $this->render("toolbar");
                return $html;
        }       

References $html, and render().

Here is the call graph for this function:

◆ hasInvalidInput()

ilDateTimeInputGUI::hasInvalidInput ( )

Definition at line 167 of file class.ilDateTimeInputGUI.php.

        {
                return (bool)$this->invalid_input;
        }

References $invalid_input.

◆ hideSubForm()

ilDateTimeInputGUI::hideSubForm ( )

Sub form hidden on init?

Reimplemented from ilFormPropertyGUI.

Definition at line 400 of file class.ilDateTimeInputGUI.php.

        {
                return (!$this->getDate() || $this->getDate()->isNull());
        }

References getDate().

Here is the call graph for this function:

◆ insert()

ilDateTimeInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Definition at line 324 of file class.ilDateTimeInputGUI.php.

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

References $html, and render().

Here is the call graph for this function:

◆ parseDatePickerConfig()

ilDateTimeInputGUI::parseDatePickerConfig ( )

protected

parse properties to datepicker config

Returns: array

Reimplemented in ilBirthdayInputGUI.

Definition at line 250 of file class.ilDateTimeInputGUI.php.

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

References $config, getMinuteStepSize(), and getStartYear().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilDateTimeInputGUI::render ( )

Insert property html.

Definition at line 268 of file class.ilDateTimeInputGUI.php.

        {
                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();
        }

References $ilUser, $tpl, ilCalendarUtil\addDateTimePicker(), getDate(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilCalendarUtil\getUserDateFormat(), IL_CAL_FKT_DATE, and parseDatePickerConfig().

Referenced by getTableFilterHTML(), getToolbarHTML(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilDateTimeInputGUI::serializeData ( )

serialize data

Reimplemented from ilFormPropertyGUI.

Definition at line 345 of file class.ilDateTimeInputGUI.php.

        {
                if($this->getDate())
                {
                        return serialize($this->getDate()->get(IL_CAL_UNIX));
                }
        }

References getDate(), and IL_CAL_UNIX.

Here is the call graph for this function:

◆ setDate()

ilDateTimeInputGUI::setDate ( ilDateTime $a_date = NULL )

set date E.g $dt_form->setDate(new ilDateTime(time(),IL_CAL_UTC)); or $dt_form->setDate(new ilDateTime('2008-06-12 08:00:00',IL_CAL_DATETIME));

For fullday (no timezone conversion) events use:

            $dt_form->setDate(new ilDate('2008-08-01',IL_CAL_DATE));

Parameters

object $a_date ilDate or ilDateTime object

Definition at line 47 of file class.ilDateTimeInputGUI.php.

        {
                $this->date = $a_date;
        }

References date.

Referenced by checkInput(), setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setMinuteStepSize()

ilDateTimeInputGUI::setMinuteStepSize ( $a_step_size )

Set minute step size E.g 5 => The selection will only show 00,05,10... minutes.

@access public

Parameters

int	minute step_size 1,5,10,15,20...

Definition at line 110 of file class.ilDateTimeInputGUI.php.

        {
                $this->minute_step_size = $a_step_size;
        }

◆ setShowSeconds()

ilDateTimeInputGUI::setShowSeconds ( $a_showseconds )

Set Show Seconds.

Parameters

boolean $a_showseconds Show Seconds

Definition at line 131 of file class.ilDateTimeInputGUI.php.

        {
                $this->showseconds = $a_showseconds;
        }

◆ setShowTime()

ilDateTimeInputGUI::setShowTime ( $a_showtime )

Set Show Time Information.

Parameters

boolean $a_showtime Show Time Information

Definition at line 67 of file class.ilDateTimeInputGUI.php.

        {
                $this->showtime = $a_showtime;
        }

◆ setStartYear()

ilDateTimeInputGUI::setStartYear ( $a_year )

Set start year.

Parameters

integer Start year

Definition at line 87 of file class.ilDateTimeInputGUI.php.

        {
                $this->startyear = $a_year;
        }

◆ setValueByArray()

ilDateTimeInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 151 of file class.ilDateTimeInputGUI.php.

        {               
                $incoming = $a_values[$this->getPostVar()];             
                $this->setDate(ilCalendarUtil::parseIncomingDate($incoming, $this->getDatePickerTimeFormat()));
                                
                foreach($this->getSubItems() as $item)
                {
                        $item->setValueByArray($a_values);
                }
        }

References getDatePickerTimeFormat(), ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), ilCalendarUtil\parseIncomingDate(), and setDate().

Here is the call graph for this function:

◆ unserializeData()

ilDateTimeInputGUI::unserializeData ( $a_data )

unserialize data

Reimplemented from ilFormPropertyGUI.

Definition at line 356 of file class.ilDateTimeInputGUI.php.

        {
                $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);
                }
        }