ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Attributes
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.
 render ($a_mode="")
 Render item.
 insert (&$a_tpl)
 Insert property html.
 getTableFilterHTML ()
 Get HTML for table filter.
 getToolbarHTML ()
 Get HTML for toolbar.
- Public Member Functions inherited from ilSubEnabledFormPropertyGUI
 addSubItem ($a_item)
 Add Subitem.
 getSubItems ()
 Get Subitems.
 checkSubItemsInput ()
 Check SubItems.
 getSubForm ()
 Get sub form html.
 getItemByPostVar ($a_post_var)
 Get item by post var.
- 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.
 hideSubForm ()
 Sub form hidden on init?
 setHiddenTitle ($a_val)
 Set hidden title (for screenreaders)
 getHiddenTitle ()
 Get hidden title.
 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 = array()
 $value
- Protected Attributes inherited from ilSubEnabledFormPropertyGUI
 $sub_items = array()
- 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 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.ilSelectInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 45 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 106 of file class.ilSelectInputGUI.php.

References $_POST, $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 66 of file class.ilSelectInputGUI.php.

Referenced by render().

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

+ Here is the caller graph for this function:

ilSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

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

References render().

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

+ Here is the call graph for this function:

ilSelectInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

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

References render().

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

+ Here is the call graph for this function:

ilSelectInputGUI::getValue ( )

Get Value.

Returns
string Value

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

References $value.

Referenced by render().

{
return $this->value;
}

+ Here is the caller graph for this function:

ilSelectInputGUI::insert ( &  $a_tpl)

Insert property html.

Returns
int Size

Definition at line 181 of file class.ilSelectInputGUI.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:

ilSelectInputGUI::render (   $a_mode = "")

Render item.

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

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

Referenced by getTableFilterHTML(), getToolbarHTML(), and insert().

{
$tpl = new ilTemplate("tpl.prop_select.html", true, true, "Services/Form");
// determin value to select. Due to accessibility reasons we
// should always select a value (per default the first one)
$first = true;
foreach($this->getOptions() as $option_value => $option_text)
{
if ($first)
{
$sel_value = $option_value;
}
$first = false;
if ((string) $option_value == (string) $this->getValue())
{
$sel_value = $option_value;
}
}
foreach($this->getOptions() as $option_value => $option_text)
{
$tpl->setCurrentBlock("prop_select_option");
$tpl->setVariable("VAL_SELECT_OPTION", $option_value);
if((string) $sel_value == (string) $option_value)
{
$tpl->setVariable("CHK_SEL_OPTION",
'selected="selected"');
}
$tpl->setVariable("TXT_SELECT_OPTION", $option_text);
$tpl->parseCurrentBlock();
}
$tpl->setVariable("ID", $this->getFieldId());
if ($this->getDisabled())
{
$tpl->setVariable("DISABLED",
" disabled=\"disabled\"");
}
if ($this->getDisabled())
{
$tpl->setVariable("DISABLED",
" disabled=\"disabled\"");
$tpl->setVariable("HIDDEN_INPUT",
$this->getHiddenTag($this->getPostVar(), $this->getValue()));
}
else
{
$tpl->setVariable("POST_VAR", $this->getPostVar());
}
return $tpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSelectInputGUI::setOptions (   $a_options)

Set Options.

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

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

Referenced by ilPaymentObjectGUI\editDetails(), assClozeTestGUI\editQuestion(), assMatchingQuestionGUI\editQuestion(), ilObjNewsSettingsGUI\editSettings(), ilPDNewsBlockGUI\editSettings(), ilSetupGUI\initBasicSettingsForm(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilObjStyleSheetGUI\initCharacteristicForm(), ilSetupGUI\initClientDbForm(), ilObjSystemFolderGUI\initCronJobsForm(), ilSetupGUI\initDBSelectionForm(), ilRoleAssignmentTableGUI\initFilter(), ilLPObjectsTableGUI\initFilter(), ilLPProgressTableGUI\initFilter(), ilPDNewsTableGUI\initFilter(), ilTestQuestionBrowserTableGUI\initFilter(), ilSurveyQuestionbrowserTableGUI\initFilter(), ilSurveyQuestionsTableGUI\initFilter(), ilUserTableGUI\initFilter(), ilQuestionBrowserTableGUI\initFilter(), ilMediaPoolTableGUI\initFilter(), ilObjMailGUI\initForm(), ilPCTabsGUI\initForm(), ilObjChatServerGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilPCMapGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilObjSearchSettingsGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalProfileGUI\initGeneralSettingsForm(), ilObjSystemFolderGUI\initJavaServerIniForm(), ilPCListGUI\initListForm(), ilMailOptionsGUI\initMailOptionsForm(), ilPersonalProfileGUI\initMailOptionsForm(), ilNoteGUI\initNoteForm(), ilPCTableGUI\initPropertiesForm(), ilObjContentObjectGUI\initPropertiesForm(), ilECSSettingsGUI\initSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilObjContentObjectGUI\initStylePropertiesForm(), ilObjWikiGUI\initStylePropertiesForm(), ilContainerGUI\initStylePropertiesForm(), ilObjStyleSheetGUI\initTagStyleForm(), ilObjStyleSheetGUI\initTemplateGenerationForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilPCQuestionGUI\insert(), ilMailAddressbookGUI\inviteToChat(), ilFileSystemGUI\listFiles(), ilRadiusSettingsGUI\settings(), ilObjCertificateSettingsGUI\settings(), ilMailingListsGUI\showAssignmentForm(), and ilPaymentObjectGUI\showSelectedObject().

{
$this->options = $a_options;
}

+ Here is the caller graph for this function:

ilSelectInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

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

Referenced by ilCertificateGUI\certificateEditor(), ilObjPaymentSettingsGUI\generalSettingsObject(), ilECSSettingsGUI\initCategoryMappingForm(), ilCalendarAppointmentGUI\initForm(), ilObjSearchSettingsGUI\initFormSettings(), ilObjAuthSettingsGUI\initLoginForm(), ilAdvancedMDRecordGUI\parseSearch(), and setValueByArray().

{
$this->value = $a_value;
}

+ Here is the caller graph for this function:

ilSelectInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Definition at line 96 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 = array()
protected

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

ilSelectInputGUI::$value
protected

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

Referenced by getValue().

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