ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Attributes
ilMultiSelectInputGUI Class Reference
Services/Form

This class represents a multi selection list property in a property form. More...

+ Inheritance diagram for ilMultiSelectInputGUI:
+ Collaboration diagram for ilMultiSelectInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor.
 setOptions ($a_options)
 Set Options.
 getOptions ()
 Get Options.
 setValue ($a_array)
 Set Value.
 getValue ()
 Get Value.
 setValueByArray ($a_values)
 Set value by array.
 checkInput ()
 Check input, strip slashes etc.
 render ()
 Render item.
 insert (&$a_tpl)
 Insert property html.
 getTableFilterHTML ()
 Get HTML for table filter.
- Public Member Functions inherited from ilFormPropertyGUI
& 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)

Protected Attributes

 $options
 $value
- Protected Attributes inherited from ilFormPropertyGUI
 $type
 $title
 $postvar
 $info
 $alert
 $required = false
 $parentgui
 $parentform

Additional Inherited Members

- Protected Member Functions inherited from ilFormPropertyGUI
 setType ($a_type)
 Set Type.

Detailed Description

This class represents a multi selection list 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 34 of file class.ilMultiSelectInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 45 of file class.ilMultiSelectInputGUI.php.

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

{
parent::__construct($a_title, $a_postvar);
$this->setType("multi_select");
$this->setValue(array());
}

+ Here is the call graph for this function:

Member Function Documentation

ilMultiSelectInputGUI::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 107 of file class.ilMultiSelectInputGUI.php.

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

{
global $lng;
if (is_array($_POST[$this->getPostVar()]))
{
foreach ($_POST[$this->getPostVar()] as $k => $v)
{
$_POST[$this->getPostVar()][$k] =
ilUtil::stripSlashes($v);
}
}
else
{
$_POST[$this->getPostVar()] = array();
}
if ($this->getRequired() && count($_POST[$this->getPostVar()]) == 0)
{
$this->setAlert($lng->txt("msg_input_is_required"));
return false;
}
return true;
}

+ Here is the call graph for this function:

ilMultiSelectInputGUI::getOptions ( )

Get Options.

Returns
array Options. Array ("value" => "option_text")

Definition at line 67 of file class.ilMultiSelectInputGUI.php.

References $options.

Referenced by render().

{
return $this->options;
}

+ Here is the caller graph for this function:

ilMultiSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 181 of file class.ilMultiSelectInputGUI.php.

References render().

{
$html = $this->render();
return $html;
}

+ Here is the call graph for this function:

ilMultiSelectInputGUI::getValue ( )

Get Value.

Returns
array array with all activated selections

Definition at line 87 of file class.ilMultiSelectInputGUI.php.

Referenced by render().

{
return is_array($this->value) ? $this->value : array();
}

+ Here is the caller graph for this function:

ilMultiSelectInputGUI::insert ( &  $a_tpl)

Insert property html.

Returns
int Size

Definition at line 171 of file class.ilMultiSelectInputGUI.php.

References render().

{
$a_tpl->setCurrentBlock("prop_generic");
$a_tpl->setVariable("PROP_GENERIC", $this->render());
$a_tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

ilMultiSelectInputGUI::render ( )

Render item.

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

References $tpl, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

{
$tpl = new ilTemplate("tpl.prop_multi_select.html", true, true, "Services/Form");
$values = $this->getValue();
foreach($this->getOptions() as $option_value => $option_text)
{
$tpl->setCurrentBlock("item");
if ($this->getDisabled())
{
$tpl->setVariable("DISABLED",
" disabled=\"disabled\"");
}
if (in_array($option_value, $values))
{
$tpl->setVariable("CHECKED",
" checked=\"checked\"");
}
$tpl->setVariable("VAL", ilUtil::prepareFormOutput($option_value));
$tpl->setVariable("ID_VAL", ilUtil::prepareFormOutput($option_value));
$tpl->setVariable("IID", $this->getFieldId());
$tpl->setVariable("TXT_OPTION", $option_text);
$tpl->setVariable("POST_VAR", $this->getPostVar());
$tpl->parseCurrentBlock();
}
$tpl->setVariable("ID", $this->getFieldId());
return $tpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilMultiSelectInputGUI::setOptions (   $a_options)

Set Options.

Parameters
array$a_optionsOptions. Array ("value" => "option_text")

Definition at line 57 of file class.ilMultiSelectInputGUI.php.

{
$this->options = $a_options;
}
ilMultiSelectInputGUI::setValue (   $a_array)

Set Value.

Parameters
arrayarray with all activated selections

Definition at line 77 of file class.ilMultiSelectInputGUI.php.

Referenced by __construct(), ilLPProgressTableGUI\initFilter(), ilLPObjectsTableGUI\initFilter(), and setValueByArray().

{
$this->value = $a_array;
}

+ Here is the caller graph for this function:

ilMultiSelectInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Definition at line 97 of file class.ilMultiSelectInputGUI.php.

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

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

+ Here is the call graph for this function:

Field Documentation

ilMultiSelectInputGUI::$options
protected

Definition at line 36 of file class.ilMultiSelectInputGUI.php.

Referenced by getOptions().

ilMultiSelectInputGUI::$value
protected

Definition at line 37 of file class.ilMultiSelectInputGUI.php.

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