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.
	setWidth ($a_width)
	Sets the width of this field.
	getWidth ()
	Returns the width currently set for this field.
	setHeight ($a_height)
	Sets the height of this field.
	getHeight ()
	Returns the height currently set for this field.
	setOptions ($a_options)
	Set Options.
	getOptions ()
	Get Options.
	setValue ($a_array)
	Set Value.
	getValue ()
	Get Value.
	setValueByArray ($a_values)
	Set value by array.
	enableSelectAll ($a_value)
	enableSelectedFirst ($a_value)
	checkInput ()
	Check input, strip slashes etc.
	render ()
	Render item.
	insert (&$a_tpl)
	Insert property html.
	getTableFilterHTML ()
	Get HTML for table filter.
	getCustomAttributes ()
	setCustomAttributes ($custom_attributes)
	addCustomAttribute ($custom_attribute)
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)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

Protected Attributes
	$options
	$value
	$select_all
	$selected_first
	$custom_attributes = array()
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

Private Attributes
	$width = 160
	$height = 100

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

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_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 67 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::addCustomAttribute ( $custom_attribute )

Parameters

array $custom_attribute

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

                                                              {
                $this->custom_attributes[] = $custom_attribute;
        }

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 185 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::enableSelectAll ( $a_value )

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

        {
                $this->select_all = (bool)$a_value;
        }

ilMultiSelectInputGUI::enableSelectedFirst ( $a_value )

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

        {
                $this->selected_first = (bool)$a_value;
        }

ilMultiSelectInputGUI::getCustomAttributes ( )

Returns: array

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

References $custom_attributes.

Referenced by render().

                                              {
                return $this->custom_attributes;
        }

Here is the caller graph for this function:

ilMultiSelectInputGUI::getHeight ( )

Returns the height currently set for this field.

public

Returns: integer height

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

References $height.

Referenced by render().

        {
                return $this->height;
        }

Here is the caller graph for this function:

ilMultiSelectInputGUI::getOptions ( )

Get Options.

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

Definition at line 133 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 312 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 153 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::getWidth ( )

Returns the width currently set for this field.

public

Returns: integer width

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

References $width.

Referenced by render().

        {
                return $this->width;
        }

Here is the caller graph for this function:

ilMultiSelectInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 302 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 213 of file class.ilMultiSelectInputGUI.php.

References $lng, $options, $tpl, getCustomAttributes(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getHeight(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), getWidth(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

        {
                global $lng;
                
                $tpl = new ilTemplate("tpl.prop_multi_select.html", true, true, "Services/Form");
                $values = $this->getValue();
                $options = $this->getOptions();
                if($options)
                {
                        if($this->select_all)
                        {
                                // enable select all toggle
                                $tpl->setCurrentBlock("item");                  
                                $tpl->setVariable("VAL", "");
                                $tpl->setVariable("ID_VAL", ilUtil::prepareFormOutput("all__toggle"));
                                $tpl->setVariable("IID", $this->getFieldId());
                                $tpl->setVariable("TXT_OPTION" ,"<em>".$lng->txt("select_all")."</em>");
                                $tpl->setVariable("POST_VAR", $this->getPostVar());
                                $tpl->parseCurrentBlock();                      
                                
                                $tpl->setVariable("TOGGLE_FIELD_ID", $this->getFieldId());
                                $tpl->setVariable("TOGGLE_ALL_ID", $this->getFieldId()."_all__toggle");
                                $tpl->setVariable("TOGGLE_ALL_CBOX_ID", $this->getFieldId()."_");
                        }
                        
                        if($this->selected_first)
                        {
                                // move selected values to top
                                $tmp_checked = $tmp_unchecked = array();
                                foreach($options as $option_value => $option_text)
                                {
                                        if (in_array($option_value, $values))
                                        {
                                                $tmp_checked[$option_value] = $option_text;
                                        }
                                        else
                                        {
                                                $tmp_unchecked[$option_value] = $option_text;
                                        }
                                }
                                $options = $tmp_checked + $tmp_unchecked;
                                unset($tmp_checked);
                                unset($tmp_unchecked);
                        }
                        
                        foreach($options 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());
                $tpl->setVariable("CUSTOM_ATTRIBUTES", implode(' ', $this->getCustomAttributes()));
                if($this->getWidth())
                {
                        $tpl->setVariable("WIDTH", $this->getWidth());
                }
                if($this->getHeight())
                {
                        $tpl->setVariable("HEIGHT", $this->getHeight());
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMultiSelectInputGUI::setCustomAttributes ( $custom_attributes )

Parameters

array $custom_attributes

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

References $custom_attributes.

                                                                {
                $this->custom_attributes = $custom_attributes;
        }

ilMultiSelectInputGUI::setHeight ( $a_height )

Sets the height of this field.

public

Parameters

integer $a_height

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

Referenced by ilObjAdvancedEditingGUI\initTagsForm().

        {
                $this->height = (int)$a_height;
        }

Here is the caller graph for this function:

ilMultiSelectInputGUI::setOptions ( $a_options )

Set Options.

Parameters

array $a_options Options. Array ("value" => "option_text")

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

        {
                $this->options = $a_options;
        }

ilMultiSelectInputGUI::setValue ( $a_array )

Set Value.

Parameters

array array with all activated selections

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

Referenced by __construct(), 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_values value array

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

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

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

Here is the call graph for this function:

ilMultiSelectInputGUI::setWidth ( $a_width )

Sets the width of this field.

public

Parameters

integer $a_width

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

        {
                $this->width = (int)$a_width;
        }

Field Documentation

ilMultiSelectInputGUI::$custom_attributes = array()

protected

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

Referenced by getCustomAttributes(), and setCustomAttributes().

ilMultiSelectInputGUI::$height = 100

private

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

Referenced by getHeight().

ilMultiSelectInputGUI::$options

protected

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

Referenced by getOptions(), and render().

ilMultiSelectInputGUI::$select_all

protected

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

ilMultiSelectInputGUI::$selected_first

protected

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

ilMultiSelectInputGUI::$value

protected

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

ilMultiSelectInputGUI::$width = 160

private

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

Referenced by getWidth().

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

Services/Form/classes/class.ilMultiSelectInputGUI.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation