ilHiddenInputGUI Class Reference

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

Inheritance diagram for ilHiddenInputGUI:

Collaboration diagram for ilHiddenInputGUI:

Public Member Functions
	__construct ($a_postvar)
	Constructor.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	checkInput ()
	Check input, strip slashes etc.
	setValueByArray ($a_values)
	Set value by array.
	insert (&$a_tpl)
	Insert property html.
	getToolbarHTML ()
	Get HTML for toolbar.
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor.
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	getSubForm ()
	Get sub form html.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	getItemByPostVar ($a_post_var)
	Get item by post var.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)
	setMulti ($a_multi)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.

Protected Attributes
	$value
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi
	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type.
	getMultiIconsHTML ($a_sortable=false)
	Get HTML for multiple value icons.

Detailed Description

This class represents a hidden form property in a property form.

Author

Roland Küstermann (rkues.nosp@m.term.nosp@m.ann@m.nosp@m.ps.d.nosp@m.e)

Version

$Id$

Definition at line 32 of file class.ilHiddenInputGUI.php.

Constructor & Destructor Documentation

ilHiddenInputGUI::__construct

(

$a_postvar

)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 41 of file class.ilHiddenInputGUI.php.

References ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

ilHiddenInputGUI::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 73 of file class.ilHiddenInputGUI.php.

        {
                return true;            // please overwrite
        }

ilHiddenInputGUI::getToolbarHTML

(

)

Get HTML for toolbar.

Implements ilToolbarItem.

Definition at line 106 of file class.ilHiddenInputGUI.php.

References getValue().

        {
                return "<input type=\"hidden\"".
                        " name=\"".$this->getPostVar()."\"".
                        " value=\"".ilUtil::prepareFormOutput($this->getValue())."\"".
                        " id=\"".$this->getFieldId()."\" />";
        }

Here is the call graph for this function:

ilHiddenInputGUI::getValue

(

)

Get Value.

Returns

string Value

Definition at line 62 of file class.ilHiddenInputGUI.php.

References $value.

Referenced by getToolbarHTML(), and insert().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilHiddenInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Returns

int Size

Definition at line 93 of file class.ilHiddenInputGUI.php.

References ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

        {
                $a_tpl->setCurrentBlock("hidden");              
                $a_tpl->setVariable('PROP_INPUT_TYPE','hidden');
                $a_tpl->setVariable("POST_VAR", $this->getPostVar());
                $a_tpl->setVariable("ID", $this->getFieldId());
                $a_tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilHiddenInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by ilPropertyFormGUI\insertItem(), and setValueByArray().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilHiddenInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Definition at line 83 of file class.ilHiddenInputGUI.php.

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

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

Here is the call graph for this function:

Field Documentation

ilHiddenInputGUI::$value

protected

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

Referenced by getValue().

---

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

• Services/Form/classes/class.ilHiddenInputGUI.php