This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTypicalLearningTimeInputGUI:

Collaboration diagram for ilTypicalLearningTimeInputGUI:

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

	setValue (array $a_value)

	setValueByLOMDuration (string $a_value)

	setShowSeconds (bool $status)

	getShowSeconds ()

	getValue ()

	setValueByArray (array $a_values)

	checkInput ()

	__buildMonthsSelect (string $sel_month)

	__buildDaysSelect (string $sel_day)

	insert (ilTemplate $a_tpl)

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

Data Fields
const	POST_NAME_MONTH = 'mo'

const	POST_NAME_DAY = 'd'

const	POST_NAME_HOUR = 'h'

const	POST_NAME_MINUTE = 'm'

const	POST_NAME_SECOND = 's'

Protected Member Functions
	getInputFromPost (string $post_name)

Protected Member Functions inherited from ilFormPropertyGUI
	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
array	$value

bool	$valid = true

string	$lom_duration = ''

bool	$show_seconds = 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...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 27 of file class.ilTypicalLearningTimeInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

     {
         parent::__construct($a_title, $a_postvar);
 
         $this->lng->loadLanguageModule("meta");
         $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 ( string $sel_day )

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

References $i, ilLegacyFormElementsUtil\formSelect(), and ilFormPropertyGUI\getPostVar().

Referenced by insert().

                                                       : string
     {
         $options = [];
         for ($i = 0; $i <= 31; $i++) {
             $options[$i] = sprintf('%02d', $i);
         }
         return ilLegacyFormElementsUtil::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 ( string $sel_month )

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

References $i, ilLegacyFormElementsUtil\formSelect(), and ilFormPropertyGUI\getPostVar().

Referenced by insert().

                                                           : string
     {
         $options = [];
         for ($i = 0; $i <= 24; $i++) {
             $options[$i] = sprintf('%02d', $i);
         }
         return ilLegacyFormElementsUtil::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 ( )

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

References getInputFromPost(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setAlert().

                                 : bool
     {
         $counter = 0;
         $required_fullfilled = false;
         foreach ([self::POST_NAME_MONTH, self::POST_NAME_DAY, self::POST_NAME_HOUR, self::POST_NAME_MINUTE, self::POST_NAME_SECOND] as $post_name) {
             $value = $this->getInputFromPost($post_name);
             if ($value > 0) {
                 $required_fullfilled = true;
             }
             $this->value[$counter++] = $this->getInputFromPost($post_name);
         }
         if ($this->getRequired() && !$required_fullfilled) {
             $this->setAlert($this->lng->txt("msg_input_is_required"));
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ getInputFromPost()

ilTypicalLearningTimeInputGUI::getInputFromPost ( string $post_name )

protected

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

References ilFormPropertyGUI\getPostVar(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by checkInput().

                                                           : int
     {
         if ($this->http->wrapper()->post()->has($this->getPostVar() . '[' . $post_name . ']')) {
             return $this->http->wrapper()->post()->retrieve(
                 $this->getPostVar() . '[' . $post_name . ']',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShowSeconds()

ilTypicalLearningTimeInputGUI::getShowSeconds ( )

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

References $show_seconds.

                                     : bool
     {
         return $this->show_seconds;
     }

◆ getValue()

ilTypicalLearningTimeInputGUI::getValue ( )

Returns: int[]

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

References $value.

Referenced by insert().

                               : array
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilTypicalLearningTimeInputGUI::insert ( ilTemplate $a_tpl )

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

References __buildDaysSelect(), __buildMonthsSelect(), ilFormPropertyGUI\getPostVar(), getValue(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\makeTimeSelect(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $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((string) ($val[0] ?? "")));
         $ttpl->setVariable("SEL_DAYS", $this->__buildDaysSelect((string) ($val[1] ?? "")));
 
         $ttpl->setVariable("TXT_DAYS", $this->lng->txt('md_days'));
         $ttpl->setVariable("TXT_TIME", $this->lng->txt('md_time'));
 
         $ttpl->setVariable(
             "SEL_TLT",
             ilLegacyFormElementsUtil::makeTimeSelect(
                 $this->getPostVar(),
                 !($val[4] ?? 0),
                 (int) ($val[2] ?? 0),
                 (int) ($val[3] ?? 0),
                 (int) ($val[4] ?? 0),
                 false
             )
         );
         $ttpl->setVariable("TLT_HINT", ($val[4] ?? false) ? '(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:

◆ setShowSeconds()

ilTypicalLearningTimeInputGUI::setShowSeconds ( bool $status )

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

                                                 : void
     {
         $this->show_seconds = $status;
     }

◆ setValue()

ilTypicalLearningTimeInputGUI::setValue ( array $a_value )

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

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

                                             : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilTypicalLearningTimeInputGUI::setValueByArray ( array $a_values )

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

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

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

Here is the call graph for this function:

◆ setValueByLOMDuration()

ilTypicalLearningTimeInputGUI::setValueByLOMDuration ( string $a_value )

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

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

Referenced by ilMDEditorGUI\initQuickEditForm().

                                                           : void
     {
         $this->lom_duration = $a_value;
         $this->valid = true;
 
         $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);
         }
     }