ilSelectInputGUI Class Reference [Services/Form]

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

Inheritance diagram for ilSelectInputGUI:

Collaboration diagram for ilSelectInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor.
	setOptions ($a_options)
	Set Options.
	getOptions ()
	Get Options.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setValueByArray ($a_values)
	Set value by array.
	checkInput ()
	Check input, strip slashes etc.
	insert (&$a_tpl)
	Insert property html.
Protected Attributes
	$options
	$value

---

Detailed Description

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

Author:

Alex Killing <alex.killing@gmx.de>

Version:

$Id$

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

---

Constructor & Destructor Documentation

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

Constructor.

Parameters:

	string	$a_title Title
	string	$a_postvar Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 42 of file class.ilSelectInputGUI.php.

References ilFormPropertyGUI::setType().

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

Here is the call graph for this function:

---

Member Function Documentation

ilSelectInputGUI::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 103 of file class.ilSelectInputGUI.php.

References $lng, ilSubEnabledFormPropertyGUI::checkSubItemsInput(), ilFormPropertyGUI::getPostVar(), ilFormPropertyGUI::getRequired(), ilFormPropertyGUI::setAlert(), and ilUtil::stripSlashes().

        {
                global $lng;
                
                $_POST[$this->getPostVar()] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                return $this->checkSubItemsInput();
        }

Here is the call graph for this function:

ilSelectInputGUI::getOptions

(

)

Get Options.

Returns:

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

Definition at line 63 of file class.ilSelectInputGUI.php.

Referenced by insert().

        {
                return $this->options;
        }

Here is the caller graph for this function:

ilSelectInputGUI::getValue

(

)

Get Value.

Returns:

string Value

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

Referenced by insert().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilSelectInputGUI::insert

(

&$

a_tpl

)

Insert property html.

Returns:

int Size

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

References ilFormPropertyGUI::getDisabled(), getOptions(), ilFormPropertyGUI::getPostVar(), and getValue().

        {
                foreach($this->getOptions() as $option_value => $option_text)
                {
                        $a_tpl->setCurrentBlock("prop_select_option");
                        $a_tpl->setVariable("VAL_SELECT_OPTION", $option_value);
                        if ($option_value == $this->getValue())
                        {
                                $a_tpl->setVariable("CHK_SEL_OPTION",
                                        'selected="selected"');
                        }
                        $a_tpl->setVariable("TXT_SELECT_OPTION", $option_text);
                        $a_tpl->parseCurrentBlock();
                }
                $a_tpl->setCurrentBlock("prop_select");
                $a_tpl->setVariable("POST_VAR", $this->getPostVar());
                if ($this->getDisabled())
                {
                        $a_tpl->setVariable("DISABLED",
                                " disabled=\"disabled\"");
                }
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilSelectInputGUI::setOptions

(

$

a_options

)

Set Options.

Parameters:

array

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

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

Referenced by ilAdvancedSearchGUI::initAdvancedMetaDataForm().

        {
                $this->options = $a_options;
        }

Here is the caller graph for this function:

ilSelectInputGUI::setValue

(

$

a_value

)

Set Value.

Parameters:

string

$a_value Value

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

Referenced by setValueByArray().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilSelectInputGUI::setValueByArray

(

$

a_values

)

Set value by array.

Parameters:

array

$a_values value array

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

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

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

Here is the call graph for this function:

---

Field Documentation

ilSelectInputGUI::$options [protected]

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

ilSelectInputGUI::$value [protected]

Definition at line 34 of file class.ilSelectInputGUI.php.

---

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

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