ilScheduleInputGUI Class Reference

This class represents a text property in a property form. More...

Inheritance diagram for ilScheduleInputGUI:

Collaboration diagram for ilScheduleInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...
	getValidationFailureMessage ()
	setValueByArray ($a_values)
	Set value by array. More...
	checkInput ()
	Check input, strip slashes etc. More...
	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...
	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...

Static Public Member Functions
static	getPostData ($a_post_var, $a_remove_invalid=true)

Protected Member Functions
	render ($a_mode="")
	Render item. More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

Protected Attributes
	$value
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

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

        {
                parent::__construct($a_title, $a_postvar);
        }

Member Function Documentation

checkInput()

ilScheduleInputGUI::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 78 of file class.ilScheduleInputGUI.php.

        {
                global $lng;
                
                $data = self::getPostData($this->getPostVar(), false);
                if(sizeof($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]);
                                
                                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;
        }

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

Here is the call graph for this function:

getPostData()

static ilScheduleInputGUI::getPostData (   $a_post_var,   $a_remove_invalid = true  )

static

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

        {
                $res = array();         
                for($loop = 0; $loop < 24; $loop++)
                {
                        $days = $_POST[$a_post_var."_days~".$loop];             
                        $from = self::parseTime($_POST[$a_post_var."_from_hh~".$loop],
                                $_POST[$a_post_var."_from_mm~".$loop]);
                        $to = self::parseTime($_POST[$a_post_var."_to_hh~".$loop],
                                $_POST[$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;            
        }

References $_POST, $res, and parseTime().

Referenced by checkInput(), and ilBookingScheduleGUI\formToObject().

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.

        {
                return $this->validationFailureMessage;
        }

getValue()

ilScheduleInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

        {
                return $this->value;
        }

References $value.

Referenced by render().

Here is the caller graph for this function:

insert()

ilScheduleInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Returns

int Size

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

        {
                global $tpl;            
                
                $tpl->addJavascript("Modules/BookingManager/js/ScheduleInput.js");
                
                $html = $this->render();
 
                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }

References $html, $tpl, and render().

Here is the call graph for this function:

parseTime()

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

staticprotected

Parse/normalize incoming time values.

Parameters

string	$a_hours
string	$a_minutes

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

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

Referenced by getPostData().

Here is the caller graph for this function:

render()

ilScheduleInputGUI::render (   $a_mode = "" )

protected

Render item.

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

        {
                global $lng;
                
                $tpl = new ilTemplate("tpl.schedule_input.html", true, true, "Modules/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))
                                {
                                        $tpl->setVariable("DAY_STATUS", " checked=\"checked\"");
                                }                               
                                
                                $tpl->parseCurrentBlock();
                        }
 
                        $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"));
                        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                        $tpl->setVariable("IMG_MULTI_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
                        $tpl->setVariable("IMG_MULTI_REMOVE", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                        $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();
        }

References $lng, $row, $tpl, ilGlyphGUI\ADD, ilGlyphGUI\get(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), and ilGlyphGUI\REMOVE.

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

setValidationFailureMessage()

ilScheduleInputGUI::setValidationFailureMessage

(

$a_msg

)

Set message string for validation failure.

Returns

Parameters

string

$a_msg

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

        {
                $this->validationFailureMessage = $a_msg;
        }

setValue()

ilScheduleInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

        {
                $this->value = $a_value;
        }

Referenced by setValueByArray().

Here is the caller graph for this function:

setValueByArray()

ilScheduleInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

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

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

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

Here is the call graph for this function:

Field Documentation

$value

ilScheduleInputGUI::$value

protected

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

Referenced by getValue().

---

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

• Modules/BookingManager/classes/class.ilScheduleInputGUI.php