This class represents a duration (typical hh:mm:ss) property in a property form. More...

Inheritance diagram for ilDurationInputGUI:

Collaboration diagram for ilDurationInputGUI:

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

	setDays (int $a_days)

	getDays ()

	setHours (int $a_hours)

	getHours ()

	setMinutes (int $a_minutes)

	getMinutes ()

	setSeconds (int $a_seconds)

	setMonths (int $a_months)

	getMonths ()

	getSeconds ()

	setShowMonths (bool $a_show_months)

	getShowMonths ()

	setShowDays (bool $a_showdays)

	getShowDays ()

	setShowHours (bool $a_showhours)

	getShowHours ()

	setShowMinutes (bool $a_showminutes)

	getShowMinutes ()

	setShowSeconds (bool $a_showseconds)

	getShowSeconds ()

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	render ()

	getTableFilterHTML ()

	serializeData ()

	unserializeData (string $a_data)

	getValueInSeconds ()

	getPostValueForComparison ()

	getValueAsArray ()

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 Attributes
int	$months = 0

int	$days = 0

int	$hours = 0

int	$minutes = 0

int	$seconds = 0

bool	$showmonths = false

bool	$showdays = false

bool	$showhours = true

bool	$showminutes = true

bool	$showseconds = false

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...

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)

Detailed Description

This class represents a duration (typical hh:mm:ss) property in a property form.

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

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilDurationInputGUI::checkInput ( )

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

                                 : bool
     {
         return true;
     }

◆ getDays()

ilDurationInputGUI::getDays ( )

Definition at line 56 of file class.ilDurationInputGUI.php.

References $days.

Referenced by getValueAsArray(), getValueInSeconds(), render(), and serializeData().

                              : int
     {
         return $this->days;
     }

Here is the caller graph for this function:

◆ getHours()

ilDurationInputGUI::getHours ( )

Definition at line 66 of file class.ilDurationInputGUI.php.

References $hours.

Referenced by getValueAsArray(), getValueInSeconds(), render(), and serializeData().

                               : int
     {
         return $this->hours;
     }

Here is the caller graph for this function:

◆ getInput()

ilDurationInputGUI::getInput ( )

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

References ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\strArray().

Referenced by getPostValueForComparison().

                               : array
     {
         return $this->strArray($this->getPostVar());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinutes()

ilDurationInputGUI::getMinutes ( )

Definition at line 76 of file class.ilDurationInputGUI.php.

References $minutes.

Referenced by getValueAsArray(), getValueInSeconds(), render(), and serializeData().

                                 : int
     {
         return $this->minutes;
     }

Here is the caller graph for this function:

◆ getMonths()

ilDurationInputGUI::getMonths ( )

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

References $months.

Referenced by getValueAsArray(), getValueInSeconds(), render(), and serializeData().

                                : int
     {
         return $this->months;
     }

Here is the caller graph for this function:

◆ getPostValueForComparison()

ilDurationInputGUI::getPostValueForComparison ( )

Definition at line 355 of file class.ilDurationInputGUI.php.

References getInput(), getShowDays(), getShowHours(), getShowMinutes(), getShowMonths(), getShowSeconds(), and ilFormPropertyGUI\int().

                                                : int
     {
         $values = $this->getInput();
         $value_or_zero = fn($part) => array_key_exists($part, $values ?? []) ? (int) $values[$part] : 0;
         $value = 0;
         if ($this->getShowMonths()) {
             $value += $value_or_zero("MM") * 30 * 24 * 60 * 60;
         }
         if ($this->getShowDays()) {
             $value += $value_or_zero("dd") * 24 * 60 * 60;
         }
         if ($this->getShowHours()) {
             $value += $value_or_zero("hh") * 60 * 60;
         }
         if ($this->getShowMinutes()) {
             $value += $value_or_zero("mm") * 60;
         }
         if ($this->getShowSeconds()) {
             $value += $value_or_zero("ss");
         }
         return $value;
     }

Here is the call graph for this function:

◆ getSeconds()

ilDurationInputGUI::getSeconds ( )

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

References $seconds.

Referenced by getValueAsArray(), getValueInSeconds(), render(), and serializeData().

                                 : int
     {
         return $this->seconds;
     }

Here is the caller graph for this function:

◆ getShowDays()

ilDurationInputGUI::getShowDays ( )

Definition at line 116 of file class.ilDurationInputGUI.php.

References $showdays.

Referenced by getPostValueForComparison(), getValueInSeconds(), and render().

                                  : bool
     {
         return $this->showdays;
     }

Here is the caller graph for this function:

◆ getShowHours()

ilDurationInputGUI::getShowHours ( )

Definition at line 126 of file class.ilDurationInputGUI.php.

References $showhours.

Referenced by getPostValueForComparison(), getValueInSeconds(), and render().

                                   : bool
     {
         return $this->showhours;
     }

Here is the caller graph for this function:

◆ getShowMinutes()

ilDurationInputGUI::getShowMinutes ( )

Definition at line 136 of file class.ilDurationInputGUI.php.

References $showminutes.

Referenced by getPostValueForComparison(), getValueInSeconds(), and render().

                                     : bool
     {
         return $this->showminutes;
     }

Here is the caller graph for this function:

◆ getShowMonths()

ilDurationInputGUI::getShowMonths ( )

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

References $showmonths.

Referenced by getPostValueForComparison(), getValueInSeconds(), and render().

                                    : bool
     {
         return $this->showmonths;
     }

Here is the caller graph for this function:

◆ getShowSeconds()

ilDurationInputGUI::getShowSeconds ( )

Definition at line 146 of file class.ilDurationInputGUI.php.

References $showseconds.

Referenced by getPostValueForComparison(), getValueInSeconds(), and render().

                                     : bool
     {
         return $this->showseconds;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilDurationInputGUI::getTableFilterHTML ( )

Definition at line 306 of file class.ilDurationInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getValueAsArray()

ilDurationInputGUI::getValueAsArray ( )

Returns: array{MM: int, dd: int, hh: int, mm: int, ss: int}

Definition at line 381 of file class.ilDurationInputGUI.php.

References getDays(), getHours(), getMinutes(), getMonths(), and getSeconds().

                                      : array
     {
         return [
             'MM' => $this->getMonths(),
             'dd' => $this->getDays(),
             'hh' => $this->getHours(),
             'mm' => $this->getMinutes(),
             'ss' => $this->getSeconds()
         ];
     }

Here is the call graph for this function:

◆ getValueInSeconds()

ilDurationInputGUI::getValueInSeconds ( )

Definition at line 334 of file class.ilDurationInputGUI.php.

References getDays(), getHours(), getMinutes(), getMonths(), getSeconds(), getShowDays(), getShowHours(), getShowMinutes(), getShowMonths(), and getShowSeconds().

                                        : int
     {
         $value = 0;
         if ($this->getShowMonths()) {
             $value += $this->getMonths() * 30 * 24 * 60 * 60;
         }
         if ($this->getShowDays()) {
             $value += $this->getDays() * 24 * 60 * 60;
         }
         if ($this->getShowHours()) {
             $value += $this->getHours() * 60 * 60;
         }
         if ($this->getShowMinutes()) {
             $value += $this->getMinutes() * 60;
         }
         if ($this->getShowSeconds()) {
             $value += $this->getSeconds();
         }
         return $value;
     }

Here is the call graph for this function:

◆ insert()

ilDurationInputGUI::insert ( ilTemplate $a_tpl )

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

◆ render()

ilDurationInputGUI::render ( )

Definition at line 181 of file class.ilDurationInputGUI.php.

References ilFormPropertyGUI\$lng, ilLegacyFormElementsUtil\formSelect(), getDays(), ilFormPropertyGUI\getDisabled(), getHours(), getMinutes(), getMonths(), ilFormPropertyGUI\getPostVar(), getSeconds(), getShowDays(), getShowHours(), getShowMinutes(), getShowMonths(), getShowSeconds(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

                             : string
     {
         $lng = $this->lng;
 
         $tpl = new ilTemplate("tpl.prop_duration.html", true, true, "components/ILIAS/Form");
 
         if ($this->getShowMonths()) {
             $tpl->setCurrentBlock("dur_months");
             $tpl->setVariable("TXT_MONTHS", $lng->txt("form_months"));
             $val = array();
             for ($i = 0; $i <= 36; $i++) {
                 $val[$i] = $i;
             }
             $tpl->setVariable(
                 "SELECT_MONTHS",
                 ilLegacyFormElementsUtil::formSelect(
                     $this->getMonths(),
                     $this->getPostVar() . "[MM]",
                     $val,
                     false,
                     true,
                     0,
                     '',
                     [],
                     $this->getDisabled()
                 )
             );
             $tpl->parseCurrentBlock();
         }
         if ($this->getShowDays()) {
             $tpl->setCurrentBlock("dur_days");
             $tpl->setVariable("TXT_DAYS", $lng->txt("form_days"));
             $val = array();
             for ($i = 0; $i <= 366; $i++) {
                 $val[$i] = $i;
             }
             $tpl->setVariable(
                 "SELECT_DAYS",
                 ilLegacyFormElementsUtil::formSelect(
                     $this->getDays(),
                     $this->getPostVar() . "[dd]",
                     $val,
                     false,
                     true,
                     0,
                     '',
                     [],
                     $this->getDisabled()
                 )
             );
             $tpl->parseCurrentBlock();
         }
         if ($this->getShowHours()) {
             $tpl->setCurrentBlock("dur_hours");
             $tpl->setVariable("TXT_HOURS", $lng->txt("form_hours"));
             $val = array();
             for ($i = 0; $i <= 23; $i++) {
                 $val[$i] = $i;
             }
             $tpl->setVariable(
                 "SELECT_HOURS",
                 ilLegacyFormElementsUtil::formSelect(
                     $this->getHours(),
                     $this->getPostVar() . "[hh]",
                     $val,
                     false,
                     true,
                     0,
                     '',
                     [],
                     $this->getDisabled()
                 )
             );
             $tpl->parseCurrentBlock();
         }
         if ($this->getShowMinutes()) {
             $tpl->setCurrentBlock("dur_minutes");
             $tpl->setVariable("TXT_MINUTES", $lng->txt("form_minutes"));
             $val = array();
             for ($i = 0; $i <= 59; $i++) {
                 $val[$i] = $i;
             }
             $tpl->setVariable(
                 "SELECT_MINUTES",
                 ilLegacyFormElementsUtil::formSelect(
                     $this->getMinutes(),
                     $this->getPostVar() . "[mm]",
                     $val,
                     false,
                     true,
                     0,
                     '',
                     [],
                     $this->getDisabled()
                 )
             );
             $tpl->parseCurrentBlock();
         }
         if ($this->getShowSeconds()) {
             $tpl->setCurrentBlock("dur_seconds");
             $tpl->setVariable("TXT_SECONDS", $lng->txt("form_seconds"));
             $val = array();
             for ($i = 0; $i <= 59; $i++) {
                 $val[$i] = $i;
             }
             $tpl->setVariable(
                 "SELECT_SECONDS",
                 ilLegacyFormElementsUtil::formSelect(
                     $this->getSeconds(),
                     $this->getPostVar() . "[ss]",
                     $val,
                     false,
                     true,
                     0,
                     '',
                     [],
                     $this->getDisabled()
                 )
             );
             $tpl->parseCurrentBlock();
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilDurationInputGUI::serializeData ( )

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

References $data, getDays(), getHours(), getMinutes(), getMonths(), and getSeconds().

                                    : string
     {
         $data = array("months" => $this->getMonths(),
             "days" => $this->getDays(),
             "hours" => $this->getHours(),
             "minutes" => $this->getMinutes(),
             "seconds" => $this->getSeconds());
 
         return serialize($data);
     }

Here is the call graph for this function:

◆ setDays()

ilDurationInputGUI::setDays ( int $a_days )

Definition at line 51 of file class.ilDurationInputGUI.php.

Referenced by setValueByArray(), and unserializeData().

                                         : void
     {
         $this->days = $a_days;
     }

Here is the caller graph for this function:

◆ setHours()

ilDurationInputGUI::setHours ( int $a_hours )

Definition at line 61 of file class.ilDurationInputGUI.php.

Referenced by setValueByArray(), and unserializeData().

                                           : void
     {
         $this->hours = $a_hours;
     }

Here is the caller graph for this function:

◆ setMinutes()

ilDurationInputGUI::setMinutes ( int $a_minutes )

Definition at line 71 of file class.ilDurationInputGUI.php.

Referenced by setValueByArray(), and unserializeData().

                                               : void
     {
         $this->minutes = $a_minutes;
     }

Here is the caller graph for this function:

◆ setMonths()

ilDurationInputGUI::setMonths ( int $a_months )

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

Referenced by setValueByArray(), and unserializeData().

                                             : void
     {
         $this->months = $a_months;
     }

Here is the caller graph for this function:

◆ setSeconds()

ilDurationInputGUI::setSeconds ( int $a_seconds )

Definition at line 81 of file class.ilDurationInputGUI.php.

Referenced by setValueByArray(), and unserializeData().

                                               : void
     {
         $this->seconds = $a_seconds;
     }

Here is the caller graph for this function:

◆ setShowDays()

ilDurationInputGUI::setShowDays ( bool $a_showdays )

Definition at line 111 of file class.ilDurationInputGUI.php.

                                                  : void
     {
         $this->showdays = $a_showdays;
     }

◆ setShowHours()

ilDurationInputGUI::setShowHours ( bool $a_showhours )

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

                                                    : void
     {
         $this->showhours = $a_showhours;
     }

◆ setShowMinutes()

ilDurationInputGUI::setShowMinutes ( bool $a_showminutes )

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

Referenced by ilConsultationHoursGUI\initFormSequence().

                                                        : void
     {
         $this->showminutes = $a_showminutes;
     }

Here is the caller graph for this function:

◆ setShowMonths()

ilDurationInputGUI::setShowMonths ( bool $a_show_months )

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

                                                       : void
     {
         $this->showmonths = $a_show_months;
     }

◆ setShowSeconds()

ilDurationInputGUI::setShowSeconds ( bool $a_showseconds )

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

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

◆ setValueByArray()

ilDurationInputGUI::setValueByArray ( array $a_values )

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

References ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\int(), setDays(), setHours(), setMinutes(), setMonths(), and setSeconds().

                                                     : void
     {
         $values = ($a_values[$this->getPostVar()] ?? []);
         $value_or_zero = fn($part) => array_key_exists($part, $values ?? []) ? (int) $values[$part] : 0;
         $this->setMonths($value_or_zero("MM"));
         $this->setDays($value_or_zero("dd"));
         $this->setHours($value_or_zero("hh"));
         $this->setMinutes($value_or_zero("mm"));
         $this->setSeconds($value_or_zero("ss"));
     }

Here is the call graph for this function:

◆ unserializeData()

ilDurationInputGUI::unserializeData ( string $a_data )

Definition at line 323 of file class.ilDurationInputGUI.php.

References $data, setDays(), setHours(), setMinutes(), setMonths(), and setSeconds().

                                                    : void
     {
         $data = unserialize($a_data);
 
         $this->setMonths($data["months"]);
         $this->setDays($data["days"]);
         $this->setHours($data["hours"]);
         $this->setMinutes($data["minutes"]);
         $this->setSeconds($data["seconds"]);
     }

Here is the call graph for this function:

Field Documentation

◆ $days

int ilDurationInputGUI::$days = 0

protected

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

Referenced by getDays().

◆ $hours

int ilDurationInputGUI::$hours = 0

protected

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

Referenced by getHours().

◆ $minutes

int ilDurationInputGUI::$minutes = 0

protected

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

Referenced by getMinutes().

◆ $months

int ilDurationInputGUI::$months = 0

protected

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

Referenced by getMonths().

◆ $seconds

int ilDurationInputGUI::$seconds = 0

protected

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

Referenced by getSeconds().

◆ $showdays

bool ilDurationInputGUI::$showdays = false

protected

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

Referenced by getShowDays().

◆ $showhours

bool ilDurationInputGUI::$showhours = true

protected

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

Referenced by getShowHours().

◆ $showminutes

bool ilDurationInputGUI::$showminutes = true

protected

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

Referenced by getShowMinutes().

◆ $showmonths

bool ilDurationInputGUI::$showmonths = false

protected

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

Referenced by getShowMonths().

◆ $showseconds

bool ilDurationInputGUI::$showseconds = false

protected

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

Referenced by getShowSeconds().

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

components/ILIAS/Form/classes/class.ilDurationInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getDays()

◆ getHours()

◆ getInput()

◆ getMinutes()

◆ getMonths()

◆ getPostValueForComparison()

◆ getSeconds()

◆ getShowDays()

◆ getShowHours()

◆ getShowMinutes()

◆ getShowMonths()

◆ getShowSeconds()

◆ getTableFilterHTML()

◆ getValueAsArray()

◆ getValueInSeconds()

◆ insert()

◆ render()

◆ serializeData()

◆ setDays()

◆ setHours()

◆ setMinutes()

◆ setMonths()

◆ setSeconds()

◆ setShowDays()

◆ setShowHours()

◆ setShowMinutes()

◆ setShowMonths()

◆ setShowSeconds()

◆ setValueByArray()

◆ unserializeData()

Field Documentation

◆ $days

◆ $hours

◆ $minutes

◆ $months

◆ $seconds

◆ $showdays

◆ $showhours

◆ $showminutes

◆ $showmonths

◆ $showseconds