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. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setChecked ($a_checked)
	Set Checked. More...

	getChecked ()
	Get Checked. More...

	setOptionTitle ($a_optiontitle)
	Set Option Title (optional). More...

	getOptionTitle ()
	Get Option Title (optional). More...

	setValueByArray ($a_values)
	Set value by array. More...

	setAdditionalAttributes ($a_attrs)
	Set addiotional attributes. More...

	getAdditionalAttributes ()
	get addtional attributes More...

	checkInput ()
	Check input, strip slashes etc. More...

	hideSubForm ()
	Sub form hidden on init? More...

	render ($a_mode='')
	Render item. More...

	insert ($a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

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

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

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

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 46 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

◆ checkInput()

ilCheckboxInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 150 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()]);
                 
                 // getRequired() is NOT processed here!
 
                 $ok = $this->checkSubItemsInput();
 
                 // only not ok, if checkbox not checked
                 if (!$ok && $_POST[$this->getPostVar()] == "")
                 {
                         $ok = true;
                 }
 
                 return $ok;
         }

Here is the call graph for this function:

◆ getAdditionalAttributes()

ilCheckboxInputGUI::getAdditionalAttributes ( )

get addtional attributes

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

References $additional_attributes.

Referenced by render().

         {
                 return $this->additional_attributes;
         }

Here is the caller graph for this function:

◆ getChecked()

ilCheckboxInputGUI::getChecked ( )

Get Checked.

Returns: boolean Checked

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

References $checked.

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

         {
                 return $this->checked;
         }

Here is the caller graph for this function:

◆ getOptionTitle()

ilCheckboxInputGUI::getOptionTitle ( )

Get Option Title (optional).

Returns: string Option Title (optional)

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

References $optiontitle.

Referenced by render().

         {
                 return $this->optiontitle;
         }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilCheckboxInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

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

References $html, and render().

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilCheckboxInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

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

References $html, and render().

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

Here is the call graph for this function:

◆ getValue()

ilCheckboxInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by render().

         {
                 return $this->value;
         }

Here is the caller graph for this function:

◆ hideSubForm()

ilCheckboxInputGUI::hideSubForm ( )

Sub form hidden on init?

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

References getChecked().

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

Here is the call graph for this function:

◆ insert()

ilCheckboxInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

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

References $html, and 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:

◆ render()

ilCheckboxInputGUI::render ( $a_mode = '' )

Render item.

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

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

Referenced by getTableFilterHTML(), getToolbarHTML(), 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"');
                 }
                 
                 if ($a_mode == "toolbar")
                 {
                         // block-inline hack, see: http://blog.mozilla.com/webdev/2009/02/20/cross-browser-inline-block/
                         // -moz-inline-stack for FF2
                         // zoom 1; *display:inline for IE6 & 7
                         $tpl->setVariable("STYLE_PAR", 'display: -moz-inline-stack; display:inline-block; zoom: 1; *display:inline;');
                 }
                 
                 return $tpl->get();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilCheckboxInputGUI::serializeData ( )

serialize data

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

References getChecked().

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

Here is the call graph for this function:

◆ setAdditionalAttributes()

ilCheckboxInputGUI::setAdditionalAttributes ( $a_attrs )

Set addiotional attributes.

Parameters

string $a_attrs addition attribute string

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

         {
                 $this->additional_attributes = $a_attrs;
         }

◆ setChecked()

ilCheckboxInputGUI::setChecked ( $a_checked )

Set Checked.

Parameters

boolean $a_checked Checked

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

Referenced by ilCourseContentGUI\__showUserAcceptanceTable(), ilObjTestSettingsGeneralGUI\addAvailabilityProperties(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilObjTestSettingsGeneralGUI\addTestAccessProperties(), ilObjTestSettingsGeneralGUI\addTestFinishProperties(), ilObjTestSettingsGeneralGUI\addTestIntroProperties(), ilAdvancedMDFieldDefinition\addToFieldDefinitionForm(), ilObjSystemFolderGUI\benchmarkObject(), ilObjQuestionPoolSettingsGeneralGUI\buildForm(), ilTestScoringGUI\buildManScoringParticipantForm(), ilCertificateGUI\certificateEditor(), ilSetupGUI\displayDatabase(), ilObjExternalToolsSettingsGUI\editMapsObject(), ilObjExternalToolsSettingsGUI\editMathJaxObject(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjUserGUI\getValues(), ilSetupGUI\initDbSlaveForm(), ilObjRootFolderGUI\initEditForm(), ilObjPortfolioGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilLearningProgressBaseGUI\initEditUserForm(), ilCalendarRecurrenceGUI\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilObjGroupGUI\initForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilECSMappingSettingsGUI\initFormDSettings(), ilObjLinkResourceGUI\initFormLink(), ilObjRoleTemplateGUI\initFormRoleTemplate(), ilCASSettingsGUI\initFormSettings(), ilObjSearchSettingsGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilObjSystemFolderGUI\initHTTPSForm(), ilObjContentObjectGUI\initMenuForm(), ilPDNewsBlockGUI\initPrivateSettingsForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjSurveyAdministrationGUI\initSettingsForm(), ilObjUserTrackingGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilObjMDSettingsGUI\initSettingsForm(), ilObjTaxonomyGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilWikiPageTemplateGUI\listTemplates(), ilScoringAdjustmentGUI\outputAdjustQuestionForm(), assKprimChoiceGUI\populateQuestionSpecificFormPart(), ilRadiusSettingsGUI\settings(), ilObjCertificateSettingsGUI\settings(), ilObjAssessmentFolderGUI\settingsObject(), ilObjAdvancedEditingGUI\settingsObject(), ilObjLanguageExtGUI\settingsObject(), setValueByArray(), ilConditionHandlerGUI\showObligatoryForm(), ilPersonalProfileGUI\showPublicProfileFields(), and unserializeData().

         {
                 $this->checked = $a_checked;
         }

Here is the caller graph for this function:

◆ setOptionTitle()

ilCheckboxInputGUI::setOptionTitle ( $a_optiontitle )

Set Option Title (optional).

Parameters

string $a_optiontitle Option Title (optional)

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

Referenced by ilMailFormGUI\getTemplateDataById(), ilSetupGUI\initBasicSettingsForm(), ilMailFolderTableGUI\initFilter(), ilLDAPSettingsGUI\initForm(), ilObjSearchSettingsGUI\initFormLuceneSettings(), ilObjCalendarSettingsGUI\initFormSettings(), and ilObjFileBasedLMGUI\initSettingsForm().

         {
                 $this->optiontitle = $a_optiontitle;
         }

Here is the caller graph for this function:

◆ setValue()

ilCheckboxInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by ilDAVCronDiskQuota\addCustomSettingsToForm(), SurveyMultipleChoiceQuestionGUI\addFieldsToEditForm(), SurveyMatrixQuestionGUI\addFieldsToEditForm(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilObjTestSettingsScoringResultsGUI\addResultDetailsSettingsFormSection(), ilECSObjectSettings\addSettingsToForm(), ilObjTestSettingsGeneralGUI\addTestAccessProperties(), ilObjTestSettingsGeneralGUI\addTestFinishProperties(), ilObjTestSettingsGeneralGUI\addTestIntroProperties(), ilObjTestSettingsGeneralGUI\addTestRunProperties(), ilObjTestSettingsGeneralGUI\addTestSequenceProperties(), ilObjTestDynamicQuestionSetConfigGUI\buildForm(), ilObjGroupGUI\editMapSettingsObject(), ilObjCourseGUI\editMapSettingsObject(), ilObjNewsSettingsGUI\editSettings(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilObjSkillManagementGUI\editSettings(), ilObjFileAccessSettingsGUI\editWebDAVSettings(), ilObjPersonalDesktopSettingsGUI\editWsp(), ilObjContactAdministrationGUI\getConfigurationForm(), ilSearchBaseGUI\getCreationDateForm(), ilObjUserGUI\getValues(), ilObjUserGUI\handleIgnoredRequiredFields(), ilObjFileAccessSettingsGUI\initDownloadingSettingsForm(), SurveyQuestionGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilObjMailGUI\initForm(), ilObjBibliographicAdminLibrariesFormGUI\initForm(), ilContainerNewsSettingsGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjGroupGUI\initForm(), ilObjUserFolderGUI\initFormGeneralSettings(), ilObjLinkResourceGUI\initFormLink(), ilObjSearchSettingsGUI\initFormLuceneSettings(), ilObjRoleGUI\initFormRoleProperties(), ilObjPortfolioAdministrationGUI\initFormSettings(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjSearchSettingsGUI\initFormSettings(), ilObjLoggingSettingsGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilObjForumGUI\initForumCreateForm(), ilObjUserFolderGUI\initLoginSettingsForm(), ilObjForumGUI\initNotificationSettingsForm(), ilObjFileAccessSettingsGUI\initPreviewSettingsForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilMemberExportGUI\initSettingsForm(), ilLOEditorGUI\initSettingsForm(), ilObjGlossaryGUI\initSettingsForm(), ilSearchBaseGUI\initStandardSearchForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilObjFileAccessSettingsGUI\initUploadSettingsForm(), assFormulaQuestionGUI\isSaveCommand(), ilObjForumGUI\isTopLevelReplyCommand(), ilObjLinkResourceGUI\linkChecker(), ilObjContentObjectGUI\linkChecker(), assClozeTestGUI\populateQuestionSpecificFormPart(), assSingleChoiceGUI\populateQuestionSpecificFormPart(), assMultipleChoiceGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateSelectGapFormPart(), ilObjSCORMLearningModuleGUI\properties(), ilNotificationGUI\showSettingsObject(), and unserializeData().

         {
                 $this->value = $a_value;
         }

Here is the caller graph for this function:

◆ setValueByArray()

ilCheckboxInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

object $a_item Item

Definition at line 117 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:

◆ unserializeData()

ilCheckboxInputGUI::unserializeData ( $a_data )

unserialize data

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $additional_attributes

ilCheckboxInputGUI::$additional_attributes = ''

protected

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

Referenced by getAdditionalAttributes().

◆ $checked

ilCheckboxInputGUI::$checked

protected

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

Referenced by getChecked().

◆ $optiontitle

ilCheckboxInputGUI::$optiontitle = ""

protected

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

Referenced by getOptionTitle().

◆ $value

ilCheckboxInputGUI::$value = "1"

protected

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

Referenced by getValue().

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

Services/Form/classes/class.ilCheckboxInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAdditionalAttributes()

◆ getChecked()

◆ getOptionTitle()

◆ getTableFilterHTML()

◆ getToolbarHTML()

◆ getValue()

◆ hideSubForm()

◆ insert()

◆ render()

◆ serializeData()

◆ setAdditionalAttributes()

◆ setChecked()

◆ setOptionTitle()

◆ setValue()

◆ setValueByArray()

◆ unserializeData()

Field Documentation

◆ $additional_attributes

◆ $checked

◆ $optiontitle

◆ $value