ilDateDurationInputGUI Class Reference

input GUI for a time span (start and end date) More...

Inheritance diagram for ilDateDurationInputGUI:

Collaboration diagram for ilDateDurationInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	enableToggleFullTime (string $a_title, bool $a_checked)
	enabledToggleFullTime ()
	setStart (?ilDateTime $a_date=null)
	Set start 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...
	setStartText (string $a_txt)
	getStartText ()
	setEndText (string $a_txt)
	getEndText ()
	getStart ()
	setEnd (?ilDateTime $a_date=null)
	Set end 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...
	getEnd ()
	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 ()
	Fixed to one minute increments, see https://mantis.ilias.de/view.php?id=42740. More...
	setValueByArray (array $a_values)
	checkInput ()
	getInput ()
	render ()
	insert (ilTemplate $a_tpl)
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getValue ()
	setValue ($value)
	Called from table gui with the stored session value Attention: If the user resets the table filter, a boolean false is passed by the table gui. More...
	hideSubForm ()
	openIntervalsAllowed ()
	setAllowOpenIntervals (bool $allowOpenInterval)
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...
	getFormLabelFor ()
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...

Protected Member Functions
	getDatePickerTimeFormat ()
	getDatetimeFormatForInput ()
	prepareInvalidInputAsValue (string $invalid_input)
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	$start = null
int	$startyear = null
string	$start_text = null
string	$end_text = null
int	$minute_step_size = 5
ilDateTime	$end = null
bool	$showtime = false
bool	$toggle_fulltime = false
string	$toggle_fulltime_txt = ''
bool	$toggle_fulltime_checked = false
bool	$allowOpenIntervals = false
string	$invalid_input_start = ''
string	$invalid_input_end = ''
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

input GUI for a time span (start and end date)

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Deprecated:

12 This component will be removed with ILIAS 12

Definition at line 27 of file class.ilDateDurationInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilDateDurationInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

Definition at line 45 of file class.ilDateDurationInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__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("dateduration");
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilDateDurationInputGUI::checkInput

(

)

Definition at line 207 of file class.ilDateDurationInputGUI.php.

References $end, ilFormPropertyGUI\$lng, $post, $start, $valid, ilDateTime\_after(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getDatePickerTimeFormat(), ilFormPropertyGUI\getDisabled(), getEnd(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getStart(), getStartYear(), IL_CAL_FKT_DATE, openIntervalsAllowed(), ilCalendarUtil\parseIncomingDate(), ilFormPropertyGUI\setAlert(), setEnd(), setStart(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        if ($this->getDisabled()) {
            return true;
        }

        $post = $this->strArray($this->getPostVar());

        $start = $post["start"] ?? '';
        $end = $post["end"] ?? '';

        // if full day is active, ignore time format
        $format = isset($post['tgl'])
            ? 0
            : $this->getDatePickerTimeFormat();

        // always done to make sure there are no obsolete values left
        $this->setStart();
        $this->setEnd();

        $valid_start = false;
        if (trim($start)) {
            $parsed = ilCalendarUtil::parseIncomingDate($start, (bool) $format);
            if ($parsed) {
                $this->setStart($parsed);
                $valid_start = true;
            }
        } elseif (!$this->getRequired() && !trim($end)) {
            $valid_start = true;
        } elseif ($this->openIntervalsAllowed() && !strlen(trim($start))) {
            $valid_start = true;
        }

        $valid_end = false;
        if (trim($end)) {
            $parsed = ilCalendarUtil::parseIncomingDate($end, (bool) $format);
            if ($parsed) {
                $this->setEnd($parsed);
                $valid_end = true;
            }
        } elseif (!$this->getRequired() && !trim($start)) {
            $valid_end = true;
        } elseif ($this->openIntervalsAllowed() && !strlen(trim($end))) {
            $valid_end = true;
        }

        if ($this->getStartYear()) {
            if ($valid_start &&
                $this->getStart()->get(IL_CAL_FKT_DATE, "Y") < $this->getStartYear()) {
                $valid_start = false;
            }
            if ($valid_end &&
                $this->getEnd()->get(IL_CAL_FKT_DATE, "Y") < $this->getStartYear()) {
                $valid_end = false;
            }
        }
        $valid = ($valid_start && $valid_end);

        if ($valid &&
            $this->getStart() &&
            $this->getEnd() &&
            ilDateTime::_after($this->getStart(), $this->getEnd())) {
            $valid = false;
        }

        if ($this->openIntervalsAllowed()) {
            $valid = true;
        } elseif (!$valid) {
            $this->invalid_input_start = $start;
            $this->invalid_input_end = $end;
            $this->setAlert($lng->txt("form_msg_wrong_date"));
        }

        if ($valid) {
            $valid = $this->checkSubItemsInput();
        }

        return $valid;
    }

Here is the call graph for this function:

enabledToggleFullTime()

ilDateDurationInputGUI::enabledToggleFullTime

(

)

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

References $toggle_fulltime.

Referenced by render().

                                           : bool
    {
        return $this->toggle_fulltime;
    }

Here is the caller graph for this function:

enableToggleFullTime()

ilDateDurationInputGUI::enableToggleFullTime	(	string	$a_title,
		bool	$a_checked
	)

Definition at line 58 of file class.ilDateDurationInputGUI.php.

     : void {
        $this->toggle_fulltime_txt = $a_title;
        $this->toggle_fulltime_checked = $a_checked;
        $this->toggle_fulltime = true;
    }

getDatePickerTimeFormat()

ilDateDurationInputGUI::getDatePickerTimeFormat ( )

protected

Definition at line 312 of file class.ilDateDurationInputGUI.php.

References getShowTime().

Referenced by checkInput(), and setValueByArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDatetimeFormatForInput()

ilDateDurationInputGUI::getDatetimeFormatForInput ( )

protected

Definition at line 317 of file class.ilDateDurationInputGUI.php.

References getShowTime().

Referenced by prepareInvalidInputAsValue(), and render().

                                                  : string
    {
        $format = 'Y-m-d';
        if ($this->getShowTime()) {
            $format .= '\TH:i';
        }
        return $format;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEnd()

ilDateDurationInputGUI::getEnd

(

)

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

References $end.

Referenced by checkInput(), ilCmiXapiDateDurationInputGUI\getEndXapiDateTime(), getInput(), ilCmiXapiDateDurationInputGUI\getValue(), getValue(), hideSubForm(), and render().

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

Here is the caller graph for this function:

getEndText()

ilDateDurationInputGUI::getEndText

(

)

Definition at line 101 of file class.ilDateDurationInputGUI.php.

References $end_text.

Referenced by render().

                                : ?string
    {
        return $this->end_text;
    }

Here is the caller graph for this function:

getFormLabelFor()

ilDateDurationInputGUI::getFormLabelFor

(

)

Definition at line 517 of file class.ilDateDurationInputGUI.php.

References ilFormPropertyGUI\getFieldId().

                                     : string
    {
        return $this->getFieldId() . "[start]";
    }

Here is the call graph for this function:

getInput()

ilDateDurationInputGUI::getInput

(

)

Definition at line 289 of file class.ilDateDurationInputGUI.php.

References getEnd(), ilFormPropertyGUI\getPostVar(), getStart(), null, openIntervalsAllowed(), and ilFormPropertyGUI\strArray().

                              : array
    {
        $ret = $this->strArray($this->getPostVar());

        if ($this->openIntervalsAllowed()) {
            if (!$this->getStart()) {
                $ret["start"] = null;
            }

            if (!$this->getEnd()) {
                $ret["end"] = null;
            }
        } elseif (
            !$this->getStart() ||
            !$this->getEnd()
        ) {
            $ret["start"] = null;
            $ret["end"] = null;
        }
        $ret["fullday"] = (bool) ($ret["tgl"] ?? false);
        return $ret;
    }

Here is the call graph for this function:

getMinuteStepSize()

ilDateDurationInputGUI::getMinuteStepSize

(

)

Fixed to one minute increments, see https://mantis.ilias.de/view.php?id=42740.

Definition at line 163 of file class.ilDateDurationInputGUI.php.

                                       : int
    {
        return 1;
    }

getShowTime()

ilDateDurationInputGUI::getShowTime

(

)

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

References $showtime.

Referenced by getDatePickerTimeFormat(), getDatetimeFormatForInput(), and render().

                                 : bool
    {
        return $this->showtime;
    }

Here is the caller graph for this function:

getStart()

ilDateDurationInputGUI::getStart

(

)

Definition at line 106 of file class.ilDateDurationInputGUI.php.

References $start.

Referenced by checkInput(), getInput(), ilCmiXapiDateDurationInputGUI\getStartXapiDateTime(), ilCmiXapiDateDurationInputGUI\getValue(), getValue(), hideSubForm(), and render().

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

Here is the caller graph for this function:

getStartText()

ilDateDurationInputGUI::getStartText

(

)

Definition at line 91 of file class.ilDateDurationInputGUI.php.

References $start_text.

Referenced by render().

                                  : ?string
    {
        return $this->start_text;
    }

Here is the caller graph for this function:

getStartYear()

ilDateDurationInputGUI::getStartYear

(

)

Definition at line 145 of file class.ilDateDurationInputGUI.php.

References $startyear.

Referenced by checkInput(), and render().

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

Here is the caller graph for this function:

getTableFilterHTML()

ilDateDurationInputGUI::getTableFilterHTML

(

)

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 464 of file class.ilDateDurationInputGUI.php.

References render().

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

Here is the call graph for this function:

getTableFilterLabelFor()

ilDateDurationInputGUI::getTableFilterLabelFor

(

)

Get label "for" attribute value.

Implements ilTableFilterItem.

Definition at line 512 of file class.ilDateDurationInputGUI.php.

References ilFormPropertyGUI\getFieldId().

                                            : string
    {
        return $this->getFieldId() . "[start]";
    }

Here is the call graph for this function:

getValue()

ilDateDurationInputGUI::getValue

(

)

Definition at line 469 of file class.ilDateDurationInputGUI.php.

References getEnd(), getStart(), IL_CAL_UNIX, and null.

                              : array
    {
        return array(
            'start' => $this->getStart() ? $this->getStart()->get(IL_CAL_UNIX) : null,
            'end' => $this->getEnd() ? $this->getEnd()->get(IL_CAL_UNIX) : null
        );
    }

Here is the call graph for this function:

hideSubForm()

ilDateDurationInputGUI::hideSubForm

(

)

Definition at line 491 of file class.ilDateDurationInputGUI.php.

References getEnd(), and getStart().

                                 : bool
    {
        if ($this->invalid_input_start ||
            $this->invalid_input_end) {
            return false;
        }

        return ((!$this->getStart() || $this->getStart()->isNull()) &&
            (!$this->getEnd() || $this->getEnd()->isNull()));
    }

Here is the call graph for this function:

insert()

ilDateDurationInputGUI::insert

(

ilTemplate

$a_tpl

)

Definition at line 455 of file class.ilDateDurationInputGUI.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:

openIntervalsAllowed()

ilDateDurationInputGUI::openIntervalsAllowed

(

)

Definition at line 502 of file class.ilDateDurationInputGUI.php.

References $allowOpenIntervals.

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

                                          : bool
    {
        return $this->allowOpenIntervals;
    }

Here is the caller graph for this function:

prepareInvalidInputAsValue()

ilDateDurationInputGUI::prepareInvalidInputAsValue ( string  $invalid_input )

protected

Definition at line 445 of file class.ilDateDurationInputGUI.php.

References $timestamp, and getDatetimeFormatForInput().

Referenced by render().

                                                                        : string
    {
        $timestamp = strtotime(htmlspecialchars($invalid_input));
        if ($timestamp === false) {
            return '';
        }
        return date($this->getDatetimeFormatForInput(), $timestamp);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilDateDurationInputGUI::render

(

)

Definition at line 326 of file class.ilDateDurationInputGUI.php.

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\$type, $user, enabledToggleFullTime(), getDatetimeFormatForInput(), ilFormPropertyGUI\getDisabled(), getEnd(), getEndText(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getShowTime(), getStart(), getStartText(), getStartYear(), IL_CAL_FKT_DATE, null, ilLegacyFormElementsUtil\prepareFormOutput(), prepareInvalidInputAsValue(), setShowTime(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

                            : string
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $toggle_id = null;

        $tpl = new ilTemplate("tpl.prop_datetime_duration.html", true, true, "components/ILIAS/Form");

        if ($this->enabledToggleFullTime()) {
            $this->setShowTime(true);

            $toggle_id = 't' . md5($this->getPostVar() . '_fulltime'); // :TODO: unique?

            $tpl->setCurrentBlock('toggle_fullday');
            $tpl->setVariable('DATE_TOGGLE_ID', $this->getPostVar() . '[tgl]');
            $tpl->setVariable('FULLDAY_TOGGLE_ID', $toggle_id);
            $tpl->setVariable('FULLDAY_TOGGLE_CHECKED', $this->toggle_fulltime_checked ? 'checked="checked"' : '');
            $tpl->setVariable('FULLDAY_TOGGLE_DISABLED', $this->getDisabled() ? 'disabled="disabled"' : '');
            $tpl->setVariable('TXT_TOGGLE_FULLDAY', $this->toggle_fulltime_txt);
            $tpl->parseCurrentBlock();
        }

        // config picker
        if (!$this->getDisabled()) {
            // :TODO: unique?
            $picker_start_id = 'p' . md5($this->getPostVar() . '_start');
            $picker_end_id = 'p' . md5($this->getPostVar() . '_end');

            $tpl->setVariable('DATEPICKER_START_ID', $picker_start_id);
            $tpl->setVariable('DATEPICKER_END_ID', $picker_end_id);

            $this->global_tpl->addOnLoadCode(
                'il.Form.initDateDurationPicker("' .
                $picker_start_id . '","' .
                $picker_end_id . '","' .
                $toggle_id .
                '");'
            );
        } else {
            $tpl->setVariable('DATEPICKER_START_DISABLED', 'disabled="disabled" ');
            $tpl->setVariable('DATEPICKER_END_DISABLED', 'disabled="disabled" ');
        }

        $type = 'date';
        if ($this->getShowTime()) {
            $type = 'datetime-local';
        }
        $tpl->setVariable('DATEPICKER_START_TYPE', $type);
        $tpl->setVariable('DATEPICKER_END_TYPE', $type);

        $start_txt = $this->getStartText();
        if ($start_txt === null) {
            $start_txt = $lng->txt("form_date_duration_start");
        }
        if (trim($start_txt)) {
            $tpl->setVariable('START_LABEL', $start_txt);
            $tpl->setVariable('START_ARIA_LABEL', ilLegacyFormElementsUtil::prepareFormOutput($start_txt));
            $tpl->touchBlock('start_width_bl');
        }

        $end_txt = $this->getEndText();
        if ($end_txt === null) {
            $end_txt = $lng->txt("form_date_duration_end");
        }
        if (trim($end_txt)) {
            $tpl->setVariable('END_LABEL', $end_txt);
            $tpl->setVariable('END_ARIA_LABEL', ilLegacyFormElementsUtil::prepareFormOutput($end_txt));
            $tpl->touchBlock('end_width_bl');
        }


        $tpl->setVariable('DATE_START_ID', $this->getPostVar() . '[start]');
        $tpl->setVariable('DATE_END_ID', $this->getPostVar() . '[end]');

        /*
         * For date input, step is in days, for datetime-local
         * it is in seconds.
         */
        $step_size = 60;
        if (!$this->getShowTime()) {
            $step_size = 1;
        }
        $tpl->setVariable('DATEPICKER_START_STEP', $step_size);
        $tpl->setVariable('DATEPICKER_END_STEP', $step_size);

        if ($this->getStartYear()) {
            $min = DateTimeImmutable::createFromFormat(
                'Y',
                (string) $this->getStartYear()
            )->format($this->getDatetimeFormatForInput());
            $tpl->setVariable('DATEPICKER_START_MIN', $min);
            $tpl->setVariable('DATEPICKER_END_MIN', $min);
        }

        // values

        $out_format = $this->getDatetimeFormatForInput();
        $date_value = $this->prepareInvalidInputAsValue($this->invalid_input_start);
        if (!$date_value &&
            $this->getStart()) {
            $date_value = $this->getStart()->get(IL_CAL_FKT_DATE, $out_format, $ilUser->getTimeZone());
        }
        $tpl->setVariable('DATEPICKER_START_VALUE', $date_value);

        $date_value = $this->prepareInvalidInputAsValue($this->invalid_input_end);
        if (!$date_value &&
            $this->getEnd()) {
            $date_value = $this->getEnd()->get(IL_CAL_FKT_DATE, $out_format, $ilUser->getTimeZone());
        }
        $tpl->setVariable('DATEPICKER_END_VALUE', $date_value);

        if ($this->getRequired()) {
            $tpl->setVariable("START_REQUIRED", "required=\"required\"");
            $tpl->setVariable("END_REQUIRED", "required=\"required\"");
        }

        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAllowOpenIntervals()

ilDateDurationInputGUI::setAllowOpenIntervals

(

bool

$allowOpenInterval

)

Definition at line 507 of file class.ilDateDurationInputGUI.php.

                                                                  : void
    {
        $this->allowOpenIntervals = $allowOpenInterval;
    }

setEnd()

ilDateDurationInputGUI::setEnd

(

?ilDateTime

$a_date = null

)

Set end 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 120 of file class.ilDateDurationInputGUI.php.

Referenced by checkInput(), setValue(), ILIAS\LegalDocuments\Legacy\ResettingDurationInputGUI\setValueByArray(), and setValueByArray().

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

Here is the caller graph for this function:

setEndText()

ilDateDurationInputGUI::setEndText

(

string

$a_txt

)

Definition at line 96 of file class.ilDateDurationInputGUI.php.

                                             : void
    {
        $this->end_text = $a_txt;
    }

setMinuteStepSize()

ilDateDurationInputGUI::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 155 of file class.ilDateDurationInputGUI.php.

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

setShowTime()

ilDateDurationInputGUI::setShowTime

(

bool

$a_showtime

)

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

Referenced by render().

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

Here is the caller graph for this function:

setStart()

ilDateDurationInputGUI::setStart

(

?ilDateTime

$a_date = null

)

Set start 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 81 of file class.ilDateDurationInputGUI.php.

Referenced by checkInput(), setValue(), ILIAS\LegalDocuments\Legacy\ResettingDurationInputGUI\setValueByArray(), and setValueByArray().

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

Here is the caller graph for this function:

setStartText()

ilDateDurationInputGUI::setStartText

(

string

$a_txt

)

Definition at line 86 of file class.ilDateDurationInputGUI.php.

                                               : void
    {
        $this->start_text = $a_txt;
    }

setStartYear()

ilDateDurationInputGUI::setStartYear

(

int

$a_year

)

Definition at line 140 of file class.ilDateDurationInputGUI.php.

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

setValue()

ilDateDurationInputGUI::setValue

(

$value

)

Called from table gui with the stored session value Attention: If the user resets the table filter, a boolean false is passed by the table gui.

Parameters

array | bool

$value

Exceptions

ilDateTimeException

Definition at line 483 of file class.ilDateDurationInputGUI.php.

References IL_CAL_UNIX, setEnd(), and setStart().

                                    : void
    {
        if (is_array($value)) {
            $this->setStart(new ilDateTime($value['start'], IL_CAL_UNIX));
            $this->setEnd(new ilDateTime($value['end'], IL_CAL_UNIX));
        }
    }

Here is the call graph for this function:

setValueByArray()

ilDateDurationInputGUI::setValueByArray

(

array

$a_values

)

Definition at line 168 of file class.ilDateDurationInputGUI.php.

References getDatePickerTimeFormat(), ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), IL_CAL_UNIX, null, openIntervalsAllowed(), ilCalendarUtil\parseIncomingDate(), setEnd(), and setStart().

                                                    : void
    {
        $incoming = $a_values[$this->getPostVar()] ?? [];
        if (is_array($incoming) && $incoming !== []) {
            $format = isset($incoming['tgl']) ? 0 : $this->getDatePickerTimeFormat();
            $this->toggle_fulltime_checked = (bool) ($incoming['tgl'] ?? false);

            if ($this->openIntervalsAllowed()) {
                if (isset($incoming['start']) && is_string($incoming['start']) && trim($incoming['start']) !== '') {
                    $this->setStart(ilCalendarUtil::parseIncomingDate($incoming["start"], (bool) $format));
                } else {
                    $this->setStart(new ilDate(null, IL_CAL_UNIX));
                }

                if (isset($incoming['end']) && is_string($incoming['end']) && trim($incoming['end']) !== '') {
                    $this->setEnd(ilCalendarUtil::parseIncomingDate($incoming["end"], (bool) $format));
                } else {
                    $this->setEnd(new ilDate(null, IL_CAL_UNIX));
                }
            } else {
                # 0033160
                if ($incoming['start'] instanceof ilDateTime) {
                    $this->setStart($incoming['start']);
                } else {
                    $this->setStart(ilCalendarUtil::parseIncomingDate((string) $incoming["start"], (bool) $format));
                }
                if ($incoming['end'] instanceof ilDateTime) {
                    $this->setEnd($incoming['end']);
                } else {
                    $this->setEnd(ilCalendarUtil::parseIncomingDate((string) $incoming["end"], (bool) $format));
                }
            }
        }

        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }

Here is the call graph for this function:

Field Documentation

$allowOpenIntervals

bool ilDateDurationInputGUI::$allowOpenIntervals = false

protected

Definition at line 41 of file class.ilDateDurationInputGUI.php.

Referenced by openIntervalsAllowed().

$end

ilDateTime ilDateDurationInputGUI::$end = null

protected

Definition at line 36 of file class.ilDateDurationInputGUI.php.

Referenced by checkInput(), and getEnd().

$end_text

string ilDateDurationInputGUI::$end_text = null

protected

Definition at line 34 of file class.ilDateDurationInputGUI.php.

Referenced by getEndText().

$invalid_input_end

string ilDateDurationInputGUI::$invalid_input_end = ''

protected

Definition at line 43 of file class.ilDateDurationInputGUI.php.

$invalid_input_start

string ilDateDurationInputGUI::$invalid_input_start = ''

protected

Definition at line 42 of file class.ilDateDurationInputGUI.php.

$minute_step_size

int ilDateDurationInputGUI::$minute_step_size = 5

protected

Definition at line 35 of file class.ilDateDurationInputGUI.php.

$showtime

bool ilDateDurationInputGUI::$showtime = false

protected

Definition at line 37 of file class.ilDateDurationInputGUI.php.

Referenced by getShowTime().

$start

ilDateTime ilDateDurationInputGUI::$start = null

protected

Definition at line 31 of file class.ilDateDurationInputGUI.php.

Referenced by checkInput(), and getStart().

$start_text

string ilDateDurationInputGUI::$start_text = null

protected

Definition at line 33 of file class.ilDateDurationInputGUI.php.

Referenced by getStartText().

$startyear

int ilDateDurationInputGUI::$startyear = null

protected

Definition at line 32 of file class.ilDateDurationInputGUI.php.

Referenced by getStartYear().

$toggle_fulltime

bool ilDateDurationInputGUI::$toggle_fulltime = false

protected

Definition at line 38 of file class.ilDateDurationInputGUI.php.

Referenced by enabledToggleFullTime().

$toggle_fulltime_checked

bool ilDateDurationInputGUI::$toggle_fulltime_checked = false

protected

Definition at line 40 of file class.ilDateDurationInputGUI.php.

$toggle_fulltime_txt

string ilDateDurationInputGUI::$toggle_fulltime_txt = ''

protected

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

$user

ilObjUser ilDateDurationInputGUI::$user

protected

Definition at line 29 of file class.ilDateDurationInputGUI.php.

Referenced by render().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Form/classes/class.ilDateDurationInputGUI.php