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

Inheritance diagram for ilDateTimeInputGUI:

Collaboration diagram for ilDateTimeInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	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 ()

	setShowTime (bool $a_showtime)

	getShowTime ()

	setStartYear (int $a_year)

	getStartYear ()

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

	getMinuteStepSize ()

	setShowSeconds (bool $a_showseconds)

	getShowSeconds ()

	setValueByArray (array $a_values)

	hasInvalidInput ()

	checkInput ()

	getInput ()

	setSideBySide (bool $a_val)

	getSideBySide ()

	render ()

	getOnloadCode ()

	insert (ilTemplate $a_tpl)

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

	serializeData ()

	unserializeData (string $a_data)

	getPostValueForComparison ()

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

	hideSubForm ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Member Functions
	getDatePickerTimeFormat ()

	parseDatePickerConfig ()

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
ilObjUser	$user

ilDateTime	$date = null

string	$time = "00:00:00"

bool	$showtime = false

bool	$showseconds = false

int	$minute_step_size = 5

int	$startyear = null

string	$invalid_input = ''

bool	$side_by_side = true

bool	$valid = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

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

Detailed Description

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\lng(), ilFormPropertyGUI\setType(), and ILIAS\Repository\user().

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilDateTimeInputGUI::checkInput ( )

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

References ilFormPropertyGUI\$lng, $post, $valid, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getDate(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getStartYear(), IL_CAL_FKT_DATE, ilCalendarUtil\parseIncomingDate(), ilFormPropertyGUI\setAlert(), setDate(), ilFormPropertyGUI\str(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ getDate()

ilDateTimeInputGUI::getDate ( )

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

References $date.

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

                              : ?ilDateTime
     {
         return $this->date;
     }

Here is the caller graph for this function:

◆ getDatePickerTimeFormat()

ilDateTimeInputGUI::getDatePickerTimeFormat ( )

protected

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

References getShowSeconds(), getShowTime(), and ilFormPropertyGUI\int().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInput()

ilDateTimeInputGUI::getInput ( )

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

References getDate(), getShowTime(), IL_CAL_DATE, and IL_CAL_DATETIME.

                               : ?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;
     }

Here is the call graph for this function:

◆ getMinuteStepSize()

ilDateTimeInputGUI::getMinuteStepSize ( )

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

References $minute_step_size.

Referenced by parseDatePickerConfig().

                                        : int
     {
         return $this->minute_step_size;
     }

Here is the caller graph for this function:

◆ getOnloadCode()

ilDateTimeInputGUI::getOnloadCode ( )

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

References ilCalendarUtil\getCodeForPicker(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), and parseDatePickerConfig().

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

Here is the call graph for this function:

◆ getPostValueForComparison()

ilDateTimeInputGUI::getPostValueForComparison ( )

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

References serializeData().

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

Here is the call graph for this function:

◆ getShowSeconds()

ilDateTimeInputGUI::getShowSeconds ( )

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

References $showseconds.

Referenced by getDatePickerTimeFormat().

                                     : bool
     {
         return $this->showseconds;
     }

Here is the caller graph for this function:

◆ getShowTime()

ilDateTimeInputGUI::getShowTime ( )

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

References $showtime.

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

                                  : bool
     {
         return $this->showtime;
     }

Here is the caller graph for this function:

◆ getSideBySide()

ilDateTimeInputGUI::getSideBySide ( )

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

References $side_by_side.

Referenced by parseDatePickerConfig().

                                    : bool
     {
         return $this->side_by_side;
     }

Here is the caller graph for this function:

◆ getStartYear()

ilDateTimeInputGUI::getStartYear ( )

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

References $startyear.

Referenced by checkInput(), and parseDatePickerConfig().

                                   : ?int
     {
         return $this->startyear;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilDateTimeInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

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

References render().

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilDateTimeInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

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

References render().

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

Here is the call graph for this function:

◆ hasInvalidInput()

ilDateTimeInputGUI::hasInvalidInput ( )

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

References $invalid_input.

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

◆ hideSubForm()

ilDateTimeInputGUI::hideSubForm ( )

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

References getDate().

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

Here is the call graph for this function:

◆ insert()

ilDateTimeInputGUI::insert ( ilTemplate $a_tpl )

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

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

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

Here is the call graph for this function:

◆ parseDatePickerConfig()

ilDateTimeInputGUI::parseDatePickerConfig ( )

protected

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

References getMinuteStepSize(), getSideBySide(), and getStartYear().

Referenced by getOnloadCode(), and render().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilDateTimeInputGUI::render ( )

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

References ilFormPropertyGUI\$lng, $user, ilCalendarUtil\addDateTimePicker(), getDate(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilCalendarUtil\getUserDateFormat(), IL_CAL_FKT_DATE, parseDatePickerConfig(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

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

                             : string
     {
         $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',
             ilLegacyFormElementsUtil::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();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilDateTimeInputGUI::serializeData ( )

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

References getDate(), and IL_CAL_UNIX.

Referenced by getPostValueForComparison().

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

Here is the call graph for this function:

Here is the caller 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));

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

Referenced by ilObjRemoteCourseGUI\addCustomEditForm(), ilObjRemoteGroupGUI\addCustomEditForm(), ilObjRemoteTestGUI\addCustomEditForm(), ilPersonalSkillsFilterGUI\addToToolbar(), checkInput(), ilUserTableGUI\initFilter(), ilPCSectionGUI\initForm(), ilSessionStatisticsGUI\long(), ilSessionStatisticsGUI\periodic(), setValueByArray(), ilSessionStatisticsGUI\short(), and unserializeData().

                                                       : void
     {
         $this->date = $a_date;
     }

Here is the caller graph for this function:

◆ setMinuteStepSize()

ilDateTimeInputGUI::setMinuteStepSize ( int $a_step_size )

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

minutes

Parameters

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

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

                                                        : void
     {
         $this->minute_step_size = $a_step_size;
     }

◆ setShowSeconds()

ilDateTimeInputGUI::setShowSeconds ( bool $a_showseconds )

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

                                                        : void
     {
         $this->showseconds = $a_showseconds;
     }

◆ setShowTime()

ilDateTimeInputGUI::setShowTime ( bool $a_showtime )

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

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilObjAssessmentFolderGUI\getLogDataOutputForm(), ilObjUserFolderGUI\initAccessRestrictionForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilBookingScheduleGUI\initForm(), ilDclTableEditGUI\initForm(), and ilConsultationHoursGUI\initFormSequence().

                                                  : void
     {
         $this->showtime = $a_showtime;
     }

Here is the caller graph for this function:

◆ setSideBySide()

ilDateTimeInputGUI::setSideBySide ( bool $a_val )

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

                                               : void
     {
         $this->side_by_side = $a_val;
     }

◆ setStartYear()

ilDateTimeInputGUI::setStartYear ( int $a_year )

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

                                              : void
     {
         $this->startyear = $a_year;
     }

◆ setValueByArray()

ilDateTimeInputGUI::setValueByArray ( array $a_values )

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

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

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

Here is the call graph for this function:

◆ unserializeData()

ilDateTimeInputGUI::unserializeData ( string $a_data )

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

References getShowTime(), IL_CAL_UNIX, and setDate().

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