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

Inheritance diagram for ilScheduleInputGUI:

Collaboration diagram for ilScheduleInputGUI:

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

	setValue (array $a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

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

	checkInput ()

	getInput ()

	getPostData (string $a_post_var, $a_remove_invalid=true)

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

Protected Member Functions
	render (string $a_mode="")

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)

Static Protected Member Functions
static	parseTime (string $a_hours, string $a_minutes)
	Parse/normalize incoming time values. More...

Protected Attributes
ILIAS DI UIServices	$ui

ilGlobalTemplateInterface	$tpl

array	$value = []

string	$validationFailureMessage

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 text property in a property form.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilScheduleInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
         parent::__construct($a_title, $a_postvar);
         $this->ui = $DIC->ui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilScheduleInputGUI::checkInput ( )

Definition at line 73 of file class.ilScheduleInputGUI.php.

References $data, ilFormPropertyGUI\$lng, $parts, getPostData(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
         $data = $this->getPostData($this->getPostVar(), false);
         if (count($data)) {
             // slots may not overlap
             foreach ($data as $slot => $days) {
                 if (!$days) {
                     $this->setAlert($lng->txt("msg_input_does_not_match_regexp"));
                     return false;
                 }
 
                 $parts = explode("-", $slot);
                 $from = str_replace(":", "", $parts[0]);
                 $to = str_replace(":", "", $parts[1]);
                 if ($from >= $to) {
                     $this->setAlert($lng->txt("msg_input_does_not_match_regexp"));
                     return false;
                 }
 
                 foreach ($data as $rslot => $rdays) {
                     if ($slot != $rslot && $rdays && array_intersect($days, $rdays)) {
                         $rparts = explode("-", $rslot);
                         $rfrom = str_replace(":", "", $rparts[0]);
                         $rto = str_replace(":", "", $rparts[1]);
 
                         if (($rfrom > $from && $rfrom < $to) ||
                             ($rto > $from && $rto < $to) ||
                             ($rfrom < $from && $rto > $to)) {
                             $this->setAlert($lng->txt("msg_input_does_not_match_regexp"));
                             return false;
                         }
                     }
                 }
             }
 
             return true;
         }
 
         if ($this->getRequired()) {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getInput()

ilScheduleInputGUI::getInput ( )

Definition at line 120 of file class.ilScheduleInputGUI.php.

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

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

Here is the call graph for this function:

◆ getPostData()

ilScheduleInputGUI::getPostData	(	string	$a_post_var,
			$a_remove_invalid = `true`
	)

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

References $res, ilFormPropertyGUI\str(), and ilFormPropertyGUI\strArray().

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

      : array {
         $res = array();
         for ($loop = 0; $loop < 240; $loop++) {
             $days = $this->strArray($a_post_var . "_days~" . $loop);
             $from = self::parseTime(
                 $this->str($a_post_var . "_from_hh~" . $loop),
                 $this->str($a_post_var . "_from_mm~" . $loop)
             );
             $to = self::parseTime(
                 $this->str($a_post_var . "_to_hh~" . $loop),
                 $this->str($a_post_var . "_to_mm~" . $loop)
             );
 
             // only if any part was edited (js based gui)
             if ($days || $from !== "00:00" || $to !== "00:00") {
                 $slot = $from . "-" . $to;
                 if ($days) {
                     if (isset($res[$slot])) {
                         $res[$slot] = array_unique(array_merge($res[$slot], $days));
                     } else {
                         $res[$slot] = $days;
                     }
                 } else {
                     $res[$slot] = array();
                 }
 
                 if ($a_remove_invalid && !($days && $from && $to && $from !== $to)) {
                     unset($res[$slot]);
                 }
             }
         }
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidationFailureMessage()

ilScheduleInputGUI::getValidationFailureMessage ( )

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

References $validationFailureMessage.

                                                  : string
     {
         return $this->validationFailureMessage;
     }

◆ getValue()

ilScheduleInputGUI::getValue ( )

Definition at line 48 of file class.ilScheduleInputGUI.php.

References $value.

Referenced by render().

                               : array
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilScheduleInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 240 of file class.ilScheduleInputGUI.php.

References $tpl, ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $tpl = $this->tpl;
 
         $tpl->addJavascript("assets/js/ScheduleInput.js");
 
         $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:

◆ parseTime()

static ilScheduleInputGUI::parseTime	(	string	$a_hours,
		string	$a_minutes
	)

staticprotected

Parse/normalize incoming time values.

Definition at line 256 of file class.ilScheduleInputGUI.php.

References ilFormPropertyGUI\int().

      : string {
         $hours = (int) $a_hours;
         $min = (int) $a_minutes;
         if ($hours > 23) {
             $hours = 23;
             $min = 59;
         }
         if ($min > 59) {
             $min = 59;
         }
         return str_pad($hours, 2, "0", STR_PAD_LEFT) . ":" .
             str_pad($min, 2, "0", STR_PAD_LEFT);
     }

Here is the call graph for this function:

◆ render()

ilScheduleInputGUI::render ( string $a_mode = "" )

protected

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

References ilFormPropertyGUI\$lng, $parts, $r, ILIAS\UICore\GlobalTemplate\get(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), ilLanguage\loadLanguageModule(), null, ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), ilLanguage\txt(), and ILIAS\Repository\ui().

Referenced by insert().

      : string {
         $lng = $this->lng;
 
         $tpl = new ilTemplate("tpl.schedule_input.html", true, true, "components/ILIAS/BookingManager");
 
         $lng->loadLanguageModule("dateplaner");
 
         $def = $this->getValue();
         if (!$def) {
             $def = array(null => null);
         }
 
         $days = array("Mo", "Tu", "We", "Th", "Fr", "Sa", "Su");
         $row = 0;
         foreach ($def as $slot => $days_select) {
             $tpl->setCurrentBlock("days");
             foreach ($days as $day) {
                 $day_value = strtolower($day);
 
                 $tpl->setVariable("ROW", $row);
                 $tpl->setVariable("ID", $this->getFieldId());
                 $tpl->setVariable("POST_VAR", $this->getPostVar());
                 $tpl->setVariable("DAY", $day_value);
                 $tpl->setVariable("TXT_DAY", $lng->txt($day . "_short"));
 
                 if ($days_select && in_array($day_value, $days_select, true)) {
                     $tpl->setVariable("DAY_STATUS", " checked=\"checked\"");
                 }
 
                 $tpl->parseCurrentBlock();
             }
 
             $add_gl = $this->ui->factory()->symbol()->glyph()->add();
             $rem_gl = $this->ui->factory()->symbol()->glyph()->remove();
             $r = $this->ui->renderer();
             $tpl->setCurrentBlock("row");
             $tpl->setVariable("ROW", $row);
             $tpl->setVariable("ID", $this->getFieldId());
             $tpl->setVariable("POST_VAR", $this->getPostVar());
             $tpl->setVariable("TXT_FROM", $lng->txt("cal_from"));
             $tpl->setVariable("TXT_TO", $lng->txt("cal_until"));
             $tpl->setVariable("IMG_MULTI_ADD", $r->render($add_gl));
             $tpl->setVariable("IMG_MULTI_REMOVE", $r->render($rem_gl));
             $tpl->setVariable("TXT_MULTI_ADD", $lng->txt("add"));
             $tpl->setVariable("TXT_MULTI_REMOVE", $lng->txt("remove"));
 
             if ($slot) {
                 $parts = explode("-", $slot);
                 $from = explode(":", $parts[0]);
                 $to = explode(":", $parts[1]);
 
                 $tpl->setVariable("FROM_HH_VALUE", $from[0]);
                 $tpl->setVariable("FROM_MM_VALUE", $from[1]);
                 $tpl->setVariable("TO_HH_VALUE", $to[0]);
                 $tpl->setVariable("TO_MM_VALUE", $to[1]);
             }
 
             // manage hidden buttons
             if ($row > 0) {
                 // inline needed because of JS
                 $tpl->setVariable("ADD_STYLE", " style=\"display:none\"");
                 // $tpl->setVariable("ADD_CLASS", "ilNoDisplay");
             } else {
                 // inline needed because of JS
                 $tpl->setVariable("RMV_STYLE", " style=\"display:none\"");
                 // $tpl->setVariable("RMV_CLASS", "ilNoDisplay");
             }
 
             $tpl->parseCurrentBlock();
 
             $row++;
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValidationFailureMessage()

ilScheduleInputGUI::setValidationFailureMessage ( string $a_msg )

Definition at line 53 of file class.ilScheduleInputGUI.php.

                                                               : void
     {
         $this->validationFailureMessage = $a_msg;
     }

◆ setValue()

ilScheduleInputGUI::setValue ( array $a_value )

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

Referenced by setValueByArray().

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

Here is the caller graph for this function:

◆ setValueByArray()

ilScheduleInputGUI::setValueByArray ( array $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 68 of file class.ilScheduleInputGUI.php.

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

                                                     : void
     {
         $this->setValue($this->getPostData($this->getPostVar(), false));
     }

Here is the call graph for this function:

Field Documentation

◆ $tpl

ilGlobalTemplateInterface ilScheduleInputGUI::$tpl

protected

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

Referenced by insert().

◆ $ui

ILIAS DI UIServices ilScheduleInputGUI::$ui

protected

Definition at line 26 of file class.ilScheduleInputGUI.php.

◆ $validationFailureMessage

string ilScheduleInputGUI::$validationFailureMessage

protected

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

Referenced by getValidationFailureMessage().

◆ $value

array ilScheduleInputGUI::$value = []

protected

Definition at line 28 of file class.ilScheduleInputGUI.php.

Referenced by getValue().

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

components/ILIAS/BookingManager/classes/class.ilScheduleInputGUI.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInput()

◆ getPostData()

◆ getValidationFailureMessage()

◆ getValue()

◆ insert()

◆ parseTime()

◆ render()

◆ setValidationFailureMessage()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $tpl

◆ $ui

◆ $validationFailureMessage

◆ $value