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 ($a_title="", $a_postvar="")
	Constructor. More...

	setDays ($a_days)
	Set Days. More...

	getDays ()
	Get Days. More...

	setHours ($a_hours)
	Set Hours. More...

	getHours ()
	Get Hours. More...

	setMinutes ($a_minutes)
	Set Minutes. More...

	getMinutes ()
	Get Minutes. More...

	setSeconds ($a_seconds)
	Set Seconds. More...

	setMonths ($a_months)
	set months More...

	getMonths ()
	get months More...

	getSeconds ()
	Get Seconds. More...

	setShowMonths ($a_show_months)
	Set show months. More...

	getShowMonths ()
	Get show months. More...

	setShowDays ($a_showdays)
	Set Show Days. More...

	getShowDays ()
	Get Show Days. More...

	setShowHours ($a_showhours)
	Set Show Hours. More...

	getShowHours ()
	Get Show Hours. More...

	setShowMinutes ($a_showminutes)
	Set Show Minutes. More...

	getShowMinutes ()
	Get Show Minutes. More...

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

	getShowSeconds ()
	Get Show Seconds. More...

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

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

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

	render ()
	Insert property html. More...

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

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	getValueInSeconds ()
	Get combined value in seconds. 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...

	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

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

Protected Attributes
	$months = 0

	$days = 0

	$hours = 0

	$minutes = 0

	$seconds = 0

	$showmonths = false

	$showdays = false

	$showhours = true

	$showminutes = true

	$showseconds = false

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
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

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

Detailed Description

This class represents a duration (typical hh:mm:ss) 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 31 of file class.ilDurationInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

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

References ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilDurationInputGUI::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 279 of file class.ilDurationInputGUI.php.

        {
                global $lng;
                
                $_POST[$this->getPostVar()]["MM"] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]["MM"]);
                $_POST[$this->getPostVar()]["dd"] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]["dd"]);
                $_POST[$this->getPostVar()]["hh"] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]["hh"]);
                $_POST[$this->getPostVar()]["mm"] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]["mm"]);
                $_POST[$this->getPostVar()]["ss"] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]["ss"]);
 
                return true;
        }

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getDays()

ilDurationInputGUI::getDays ( )

Get Days.

Returns: int Days

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

        {
                return $this->days;
        }

References $days.

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

Here is the caller graph for this function:

◆ getHours()

ilDurationInputGUI::getHours ( )

Get Hours.

Returns: int Hours

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

        {
                return $this->hours;
        }

References $hours.

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

Here is the caller graph for this function:

◆ getMinutes()

ilDurationInputGUI::getMinutes ( )

Get Minutes.

Returns: int Minutes

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

        {
                return $this->minutes;
        }

References $minutes.

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

Here is the caller graph for this function:

◆ getMonths()

ilDurationInputGUI::getMonths ( )

get months

@access public

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

        {
                return $this->months;
        }

References $months.

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

Here is the caller graph for this function:

◆ getSeconds()

ilDurationInputGUI::getSeconds ( )

Get Seconds.

Returns: int Seconds

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

        {
                return $this->seconds;
        }

References $seconds.

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

Here is the caller graph for this function:

◆ getShowDays()

ilDurationInputGUI::getShowDays ( )

Get Show Days.

Returns: boolean Show Days

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

        {
                return $this->showdays;
        }

References $showdays.

Referenced by getValueInSeconds(), and render().

Here is the caller graph for this function:

◆ getShowHours()

ilDurationInputGUI::getShowHours ( )

Get Show Hours.

Returns: boolean Show Hours

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

        {
                return $this->showhours;
        }

References $showhours.

Referenced by getValueInSeconds(), and render().

Here is the caller graph for this function:

◆ getShowMinutes()

ilDurationInputGUI::getShowMinutes ( )

Get Show Minutes.

Returns: boolean Show Minutes

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

        {
                return $this->showminutes;
        }

References $showminutes.

Referenced by getValueInSeconds(), and render().

Here is the caller graph for this function:

◆ getShowMonths()

ilDurationInputGUI::getShowMonths ( )

Get show months.

@access public

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

        {
                return $this->showmonths;
        }

References $showmonths.

Referenced by getValueInSeconds(), and render().

Here is the caller graph for this function:

◆ getShowSeconds()

ilDurationInputGUI::getShowSeconds ( )

Get Show Seconds.

Returns: boolean Show Seconds

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

        {
                return $this->showseconds;
        }

References $showseconds.

Referenced by getValueInSeconds(), and render().

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilDurationInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

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

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

References $html, and render().

Here is the call graph for this function:

◆ getValueInSeconds()

ilDurationInputGUI::getValueInSeconds ( )

Get combined value in seconds.

Returns: int

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

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

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

Here is the call graph for this function:

◆ insert()

ilDurationInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

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

◆ render()

ilDurationInputGUI::render ( )

Insert property html.

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

        {
                global $lng;
 
                $tpl = new ilTemplate("tpl.prop_duration.html", true, true, "Services/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",
                                ilUtil::formSelect($this->getMonths(), $this->getPostVar()."[MM]",
                                $val, false, true));
                        $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",
                                ilUtil::formSelect($this->getDays(), $this->getPostVar()."[dd]",
                                $val, false, true));
                        $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",
                                ilUtil::formSelect($this->getHours(), $this->getPostVar()."[hh]",
                                $val, false, true));
                        $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",
                                ilUtil::formSelect($this->getMinutes(), $this->getPostVar()."[mm]",
                                $val, false, true));
                        $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",
                                ilUtil::formSelect($this->getSeconds(), $this->getPostVar()."[ss]",
                                $val, false, true));
                        $tpl->parseCurrentBlock();
                }
                
                return $tpl->get();
        }

References $lng, $tpl, ilUtil\formSelect(), getDays(), getHours(), getMinutes(), getMonths(), ilFormPropertyGUI\getPostVar(), getSeconds(), getShowDays(), getShowHours(), getShowMinutes(), getShowMonths(), and getShowSeconds().

Referenced by getTableFilterHTML(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilDurationInputGUI::serializeData ( )

serialize data

Reimplemented from ilFormPropertyGUI.

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

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

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

Here is the call graph for this function:

◆ setDays()

ilDurationInputGUI::setDays ( $a_days )

Set Days.

Parameters

int $a_days Days

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

        {
                $this->days = $a_days;
        }

Referenced by setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setHours()

ilDurationInputGUI::setHours ( $a_hours )

Set Hours.

Parameters

int $a_hours Hours

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

        {
                $this->hours = $a_hours;
        }

Referenced by setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setMinutes()

ilDurationInputGUI::setMinutes ( $a_minutes )

Set Minutes.

Parameters

int $a_minutes Minutes

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

        {
                $this->minutes = $a_minutes;
        }

Referenced by setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setMonths()

ilDurationInputGUI::setMonths ( $a_months )

set months

@access public

Parameters

int months

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

        {
                $this->months = $a_months;
        }

Referenced by setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setSeconds()

ilDurationInputGUI::setSeconds ( $a_seconds )

Set Seconds.

Parameters

int $a_seconds Seconds

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

        {
                $this->seconds = $a_seconds;
        }

Referenced by setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setShowDays()

ilDurationInputGUI::setShowDays ( $a_showdays )

Set Show Days.

Parameters

boolean $a_showdays Show Days

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

        {
                $this->showdays = $a_showdays;
        }

◆ setShowHours()

ilDurationInputGUI::setShowHours ( $a_showhours )

Set Show Hours.

Parameters

boolean $a_showhours Show Hours

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

        {
                $this->showhours = $a_showhours;
        }

◆ setShowMinutes()

ilDurationInputGUI::setShowMinutes ( $a_showminutes )

Set Show Minutes.

Parameters

boolean $a_showminutes Show Minutes

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

        {
                $this->showminutes = $a_showminutes;
        }

◆ setShowMonths()

ilDurationInputGUI::setShowMonths ( $a_show_months )

Set show months.

@access public

Parameters

boolean $a_show_month

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

        {
                $this->showmonths = $a_show_months;
        }

◆ setShowSeconds()

ilDurationInputGUI::setShowSeconds ( $a_showseconds )

Set Show Seconds.

Parameters

boolean $a_showseconds Show Seconds

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

        {
                $this->showseconds = $a_showseconds;
        }

◆ setValueByArray()

ilDurationInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

        {
                $this->setMonths($a_values[$this->getPostVar()]["MM"]);
                $this->setDays($a_values[$this->getPostVar()]["dd"]);
                $this->setHours($a_values[$this->getPostVar()]["hh"]);
                $this->setMinutes($a_values[$this->getPostVar()]["mm"]);
                $this->setSeconds($a_values[$this->getPostVar()]["ss"]);
        }

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

Here is the call graph for this function:

◆ unserializeData()

ilDurationInputGUI::unserializeData ( $a_data )

unserialize data

Reimplemented from ilFormPropertyGUI.

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

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