This class represents a typical learning time property in a property form. More...

Inheritance diagram for ilTypicalLearningTimeInputGUI:

Collaboration diagram for ilTypicalLearningTimeInputGUI:

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

	setValue ($a_value)
	Set Value. More...

	setValueByLOMDuration ($a_value)
	Set by LOM duration. More...

	getValue ()
	Get Value. More...

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

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

	__buildMonthsSelect ($sel_month)

	__buildDaysSelect ($sel_day)

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

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

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

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

	getTitle ()
	Get Title. More...

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

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

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

	getInfo ()
	Get Information Text. More...

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

	getAlert ()
	Get Alert Text. More...

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

	getRequired ()
	Get Required. More...

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

	getDisabled ()
	Get Disabled. More...

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

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

	getParentForm ()
	Get Parent Form. More...

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

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

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

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

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

	getHiddenTitle ()
	Get hidden title. More...

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

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

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

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

	getMulti ()
	Get Multi. More...

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

	getMultiValues ()
	Get multi values. More...

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

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

Protected Attributes
	$value

	$valid = true

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

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

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 typical learning time property in a property form.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 25 of file class.ilTypicalLearningTimeInputGUI.php.

References $lng, array, ilFormPropertyGUI\setType(), and setValue().

         {
                 global $lng;
                 
                 $this->lng = $lng;
                 $this->lng->loadLanguageModule("meta");
                 
                 parent::__construct($a_title, $a_postvar);
                 $this->setType("typical_learntime");
                 $this->setValue(array(0,0,0,0,0));
         }

Here is the call graph for this function:

Member Function Documentation

◆ __buildDaysSelect()

ilTypicalLearningTimeInputGUI::__buildDaysSelect ( $sel_day )

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

References $options, ilUtil\formSelect(), and ilFormPropertyGUI\getPostVar().

Referenced by insert().

         {
                 for($i = 0;$i <= 31;$i++)
                 {
                         $options[$i] = sprintf('%02d',$i);
                 }
                 return ilUtil::formSelect($sel_day, $this->getPostVar().'[d]',$options,false,true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMonthsSelect()

ilTypicalLearningTimeInputGUI::__buildMonthsSelect ( $sel_month )

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

References $options, ilUtil\formSelect(), and ilFormPropertyGUI\getPostVar().

Referenced by insert().

         {
                 for($i = 0;$i <= 24;$i++)
                 {
                         $options[$i] = sprintf('%02d',$i);
                 }
                 return ilUtil::formSelect($sel_month,$this->getPostVar().'[mo]',$options,false,true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilTypicalLearningTimeInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

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

         {
                 global $lng;
                 
                 $_POST[$this->getPostVar()][0] = (int) ilUtil::stripSlashes($_POST[$this->getPostVar()][0]);
                 $_POST[$this->getPostVar()][1] = (int) ilUtil::stripSlashes($_POST[$this->getPostVar()][1]);
                 $_POST[$this->getPostVar()][2] = (int) ilUtil::stripSlashes($_POST[$this->getPostVar()][2]);
                 $_POST[$this->getPostVar()][3] = (int) ilUtil::stripSlashes($_POST[$this->getPostVar()][3]);
                 if (isset($_POST[$this->getPostVar()][4]))
                 {
                         $_POST[$this->getPostVar()][4] = (int) ilUtil::stripSlashes($_POST[$this->getPostVar()][4]);
                 }
                 
                 // check required
                 $v = $_POST[$this->getPostVar()];
                 if ($this->getRequired() && $v[0] == 0 && $v[1] == 0 &&
                         $v[2] == 0 && $v[3] == 0 && (int) $v[4] == 0)
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
                         return false;
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ getValue()

ilTypicalLearningTimeInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by insert().

         {
                 return $this->value;
         }

Here is the caller graph for this function:

◆ insert()

ilTypicalLearningTimeInputGUI::insert ( & $a_tpl )

Insert property html.

Definition at line 147 of file class.ilTypicalLearningTimeInputGUI.php.

References __buildDaysSelect(), __buildMonthsSelect(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\makeTimeSelect().

         {
                 $ttpl = new ilTemplate("tpl.prop_typical_learning_time.html", true, true, "Services/MetaData");
                 $val = $this->getValue();
                 
                 $ttpl->setVariable("TXT_MONTH",$this->lng->txt('md_months'));           
                 $ttpl->setVariable("SEL_MONTHS",$this->__buildMonthsSelect($val[0]));
                 $ttpl->setVariable("SEL_DAYS",$this->__buildDaysSelect($val[1]));
                 
                 $ttpl->setVariable("TXT_DAYS",$this->lng->txt('md_days'));
                 $ttpl->setVariable("TXT_TIME",$this->lng->txt('md_time'));
 
                 $ttpl->setVariable("SEL_TLT",ilUtil::makeTimeSelect($this->getPostVar(),$val[4] ? false : true,
                                                                                                                                  $val[2],$val[3],$val[4],
                                                                                                                                  false));
                 $ttpl->setVariable("TLT_HINT",$tlt[4] ? '(hh:mm:ss)' : '(hh:mm)');
 
                 if(!$this->valid)
                 {
                         $ttpl->setCurrentBlock("tlt_not_valid");
                         $ttpl->setVariable("TXT_CURRENT_VAL",$this->lng->txt('meta_current_value'));
                         $ttpl->setVariable("TLT", $this->lom_duration);
                         $ttpl->setVariable("INFO_TLT_NOT_VALID",$this->lng->txt('meta_info_tlt_not_valid'));
                         $ttpl->parseCurrentBlock();
                 }
                 
                 $a_tpl->setCurrentBlock("prop_generic");
                 $a_tpl->setVariable("PROP_GENERIC", $ttpl->get());
                 $a_tpl->parseCurrentBlock();
         }

Here is the call graph for this function:

◆ setValue()

ilTypicalLearningTimeInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by __construct(), setValueByArray(), and setValueByLOMDuration().

         {
                 $this->value = $a_value;
         }

Here is the caller graph for this function:

◆ setValueByArray()

ilTypicalLearningTimeInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 90 of file class.ilTypicalLearningTimeInputGUI.php.

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

         {
                 $this->setValue($a_values[$this->getPostVar()]);
         }

Here is the call graph for this function:

◆ setValueByLOMDuration()

ilTypicalLearningTimeInputGUI::setValueByLOMDuration ( $a_value )

Set by LOM duration.

Parameters

string $a_value Value

Definition at line 52 of file class.ilTypicalLearningTimeInputGUI.php.

References ilMDUtils\_LOMDurationToArray(), array, and setValue().

Referenced by ilMDEditorGUI\initQuickEditForm().

         {
                 $this->lom_duration = $a_value;
                 $this->valid = true;
                 
                 include_once 'Services/MetaData/classes/class.ilMDUtils.php';
                 $tlt = ilMDUtils::_LOMDurationToArray($a_value);
                 
                 if(!$tlt)
                 {
                         $this->setValue(array(0,0,0,0,0));
                         if ($a_value != "")
                         {
                                 $this->valid = false;
                         }
                 }
                 else
                 {
                         $this->setValue($tlt);
                 }
                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $valid

ilTypicalLearningTimeInputGUI::$valid = true

protected

Definition at line 17 of file class.ilTypicalLearningTimeInputGUI.php.

◆ $value

ilTypicalLearningTimeInputGUI::$value

protected

Definition at line 16 of file class.ilTypicalLearningTimeInputGUI.php.

Referenced by getValue().

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

Services/MetaData/classes/class.ilTypicalLearningTimeInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __buildDaysSelect()

◆ __buildMonthsSelect()

◆ checkInput()

◆ getValue()

◆ insert()

◆ setValue()

◆ setValueByArray()

◆ setValueByLOMDuration()

Field Documentation

◆ $valid

◆ $value