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

Inheritance diagram for ilCheckboxInputGUI:

Collaboration diagram for ilCheckboxInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setChecked ($a_checked)
	Set Checked.
	getChecked ()
	Get Checked.
	setOptionTitle ($a_optiontitle)
	Set Option Title (optional).
	getOptionTitle ()
	Get Option Title (optional).
	setValueByArray ($a_values)
	Set value by array.
	setAdditionalAttributes ($a_attrs)
	Set addiotional attributes.
	getAdditionalAttributes ()
	get addtional attributes
	checkInput ()
	Check input, strip slashes etc.
	hideSubForm ()
	Sub form hidden on init?
	render ()
	Render item.
	insert (&$a_tpl)
	Insert property html.
	getTableFilterHTML ()
	Get HTML for table filter.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
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.
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	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
	$value = "1"
	$checked
	$optiontitle = ""
	$additional_attributes = ''
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 checkbox 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 31 of file class.ilCheckboxInputGUI.php.

Constructor & Destructor Documentation

ilCheckboxInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 44 of file class.ilCheckboxInputGUI.php.

References ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

ilCheckboxInputGUI::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 148 of file class.ilCheckboxInputGUI.php.

References $_POST, $lng, $ok, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                $_POST[$this->getPostVar()] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                $ok = $this->checkSubItemsInput();
                return $ok;
        }

Here is the call graph for this function:

ilCheckboxInputGUI::getAdditionalAttributes ( )

get addtional attributes

Definition at line 138 of file class.ilCheckboxInputGUI.php.

References $additional_attributes.

Referenced by render().

        {
                return $this->additional_attributes;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::getChecked ( )

Get Checked.

Returns: boolean Checked

Definition at line 85 of file class.ilCheckboxInputGUI.php.

References $checked.

Referenced by hideSubForm(), render(), and serializeData().

        {
                return $this->checked;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::getOptionTitle ( )

Get Option Title (optional).

Returns: string Option Title (optional)

Definition at line 105 of file class.ilCheckboxInputGUI.php.

References $optiontitle.

Referenced by render().

        {
                return $this->optiontitle;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Definition at line 213 of file class.ilCheckboxInputGUI.php.

References render().

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

Here is the call graph for this function:

ilCheckboxInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 65 of file class.ilCheckboxInputGUI.php.

References $value.

Referenced by render().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::hideSubForm ( )

Sub form hidden on init?

Reimplemented from ilFormPropertyGUI.

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

References getChecked().

        {
                return !$this->getChecked();
        }

Here is the call graph for this function:

ilCheckboxInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 201 of file class.ilCheckboxInputGUI.php.

References render().

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

Here is the call graph for this function:

ilCheckboxInputGUI::render ( )

Render item.

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

References $tpl, getAdditionalAttributes(), getChecked(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getOptionTitle(), ilFormPropertyGUI\getPostVar(), and getValue().

Referenced by getTableFilterHTML(), and insert().

        {
                $tpl = new ilTemplate("tpl.prop_checkbox.html", true, true, "Services/Form");
                
                $tpl->setVariable("POST_VAR", $this->getPostVar());
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("PROPERTY_VALUE", $this->getValue());
                $tpl->setVariable("OPTION_TITLE", $this->getOptionTitle());
                if(strlen($this->getAdditionalAttributes()))
                {
                        $tpl->setVariable('PROP_CHECK_ATTRS',$this->getAdditionalAttributes());
                }
                if ($this->getChecked())
                {
                        $tpl->setVariable("PROPERTY_CHECKED",
                                'checked="checked"');
                }
                if ($this->getDisabled())
                {
                        $tpl->setVariable("DISABLED",
                                'disabled="disabled"');
                }
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCheckboxInputGUI::serializeData ( )

serialize data

Reimplemented from ilFormPropertyGUI.

Definition at line 222 of file class.ilCheckboxInputGUI.php.

References getChecked().

        {
                return serialize($this->getChecked());
        }

Here is the call graph for this function:

ilCheckboxInputGUI::setAdditionalAttributes ( $a_attrs )

Set addiotional attributes.

Parameters

string $a_attrs addition attribute string

Definition at line 129 of file class.ilCheckboxInputGUI.php.

        {
                $this->additional_attributes = $a_attrs;
        }

ilCheckboxInputGUI::setChecked ( $a_checked )

Set Checked.

Parameters

boolean $a_checked Checked

Definition at line 75 of file class.ilCheckboxInputGUI.php.

Referenced by ilObjAssessmentFolderGUI\defaultsObject(), ilObjExternalToolsSettingsGUI\editGoogleMapsObject(), ilObjExternalToolsSettingsGUI\editjsMathObject(), ilObjPaymentSettingsGUI\epaySettingsObject(), ilObjPaymentSettingsGUI\generalSettingsObject(), ilObjPaymentSettingsGUI\getERPform(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilAdvancedMDSettingsGUI\initFieldForm(), ilCalendarRecurrenceGUI\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilObjCourseGUI\initForm(), ilObjUserGUI\initForm(), ilObjSessionGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilObjSearchSettingsGUI\initFormSettings(), ilPersonalProfileGUI\initGeneralSettingsForm(), ilPersonalProfileGUI\initPublicProfileForm(), ilECSSettingsGUI\initSettingsForm(), ilObjMDSettingsGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilObjSurveyQuestionPoolGUI\propertiesObject(), ilObjQuestionPoolGUI\propertiesObject(), ilMailFormGUI\searchUsers(), ilRadiusSettingsGUI\settings(), ilObjSurveyAdministrationGUI\settingsObject(), setValueByArray(), ilPersonalProfileGUI\showjsMath(), ilMailSearchGUI\showResults(), ilObjPrivacySecurityGUI\showSecurity(), and unserializeData().

        {
                $this->checked = $a_checked;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::setOptionTitle ( $a_optiontitle )

Set Option Title (optional).

Parameters

string $a_optiontitle Option Title (optional)

Definition at line 95 of file class.ilCheckboxInputGUI.php.

Referenced by ilPersonalProfileGUI\getChatSettingsForm(), ilObjSessionGUI\initAttendanceForm(), ilObjChatServerGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjGroupGUI\initForm(), ilObjSearchSettingsGUI\initFormLuceneSettings(), ilObjExerciseGUI\initPropertiesForm(), ilPersonalProfileGUI\initPublicProfileForm(), ilObjTestGUI\propertiesObject(), ilMailFormGUI\showForm(), and ilObjPrivacySecurityGUI\showSecurity().

        {
                $this->optiontitle = $a_optiontitle;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by ilSocialBookmarks\_initForm(), ilObjFileAccessSettingsGUI\editDiskQuotaSettings(), ilObjFileAccessSettingsGUI\editDownloadingSettings(), ilObjGroupGUI\editMapSettingsObject(), ilObjCourseGUI\editMapSettingsObject(), ilObjForumGUI\editObject(), SurveyTextQuestionGUI\editQuestion(), SurveyMetricQuestionGUI\editQuestion(), SurveyMultipleChoiceQuestionGUI\editQuestion(), SurveySingleChoiceQuestionGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), assMultipleChoiceGUI\editQuestion(), assSingleChoiceGUI\editQuestion(), assClozeTestGUI\editQuestion(), ilObjNewsSettingsGUI\editSettings(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjFileAccessSettingsGUI\editWebDAVSettings(), ilObjSystemFolderGUI\initBasicSettingsForm(), ilLDAPSettingsGUI\initForm(), ilObjCourseGUI\initForm(), ilObjUserGUI\initForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilObjSearchSettingsGUI\initFormLuceneSettings(), ilObjRoleGUI\initFormRoleProperties(), ilLuceneSearchGUI\initFormSearch(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilObjForumGUI\initForumCreateForm(), ilObjUserFolderGUI\initLoginSettingsForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilAdvancedMDRecordGUI\parseSearch(), ilObjSurveyGUI\propertiesObject(), ilObjTestGUI\propertiesObject(), ilObjTestGUI\randomQuestionsObject(), ilPersonalProfileGUI\showLocation(), and unserializeData().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilCheckboxInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

object $a_item Item

Definition at line 115 of file class.ilCheckboxInputGUI.php.

References ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), and setChecked().

        {
                $this->setChecked($a_values[$this->getPostVar()]);
                foreach($this->getSubItems() as $item)
                {
                        $item->setValueByArray($a_values);
                }
        }

Here is the call graph for this function:

ilCheckboxInputGUI::unserializeData ( $a_data )

unserialize data

Reimplemented from ilFormPropertyGUI.

Definition at line 230 of file class.ilCheckboxInputGUI.php.

References $data, setChecked(), and setValue().

        {
                $data = unserialize($a_data);
                if ($data)
                {
                        $this->setValue($data);
                        $this->setChecked(true);
                }
        }