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

Inheritance diagram for ilCheckboxGroupInputGUI:

Collaboration diagram for ilCheckboxGroupInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setUseValuesAsKeys (bool $a_val)
	Set use values as keys. More...

	getUseValuesAsKeys ()

	addOption ($a_option)

	setOptions (array $a_options)
	Set Options. More...

	getOptions ()

	setValue (?array $a_value)

	getValue ()

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	getItemByPostVar (string $a_post_var)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Member Functions
	render ($a_mode='')

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
array	$options = array()

array	$value = null

bool	$use_values_as_keys = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

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

Detailed Description

This class represents a property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Deprecated:: 12 This component will be removed with ILIAS 12

Definition at line 27 of file class.ilCheckboxGroupInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCheckboxGroupInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_postvar);
         $this->setType("checkboxgroup");
     }

Here is the call graph for this function:

Member Function Documentation

◆ addOption()

ilCheckboxGroupInputGUI::addOption ( $a_option )

Parameters

ilCheckboxOption | ilCheckboxInputGUI $a_option

Definition at line 60 of file class.ilCheckboxGroupInputGUI.php.

Referenced by ilForumThreadFormGUI\addFileUploadInput(), ilMemberExportSettingsGUI\initForm(), ilObjForumGUI\initReplyEditForm(), ilPRGMembersExportGUI\initSettingsForm(), ilMemberExportGUI\initSettingsForm(), and ilObjUserTrackingGUI\initSettingsForm().

                                         : void
     {
         $this->options[] = $a_option;
     }

Here is the caller graph for this function:

◆ checkInput()

ilCheckboxGroupInputGUI::checkInput ( )

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

References ilFormPropertyGUI\$lng, getOptions(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         $values = $this->strArray($this->getPostVar());
         if ($this->getRequired() && count($values) === 0) {
             $this->setAlert($lng->txt('msg_input_is_required'));
             return false;
         }
 
         $ok = true;
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 $item_ok = $item->checkInput();
                 if (!$item_ok && in_array($option->getValue(), $values)) {
                     $ok = false;
                 }
             }
         }
         return $ok;
     }

Here is the call graph for this function:

◆ getInput()

ilCheckboxGroupInputGUI::getInput ( )

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

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

                               : array
     {
         return $this->strArray($this->getPostVar());
     }

Here is the call graph for this function:

◆ getItemByPostVar()

ilCheckboxGroupInputGUI::getItemByPostVar ( string $a_post_var )

Definition at line 141 of file class.ilCheckboxGroupInputGUI.php.

References getOptions(), ilFormPropertyGUI\getPostVar(), and null.

                                                         : ?ilFormPropertyGUI
     {
         if ($this->getPostVar() == $a_post_var) {
             return $this;
         }
 
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 if ($item->getType() != "section_header") {
                     $ret = $item->getItemByPostVar($a_post_var);
                     if (is_object($ret)) {
                         return $ret;
                     }
                 }
             }
         }
 
         return null;
     }

Here is the call graph for this function:

◆ getOptions()

ilCheckboxGroupInputGUI::getOptions ( )

Definition at line 82 of file class.ilCheckboxGroupInputGUI.php.

References $options.

Referenced by checkInput(), getItemByPostVar(), render(), and setValueByArray().

                                 : array
     {
         return $this->options;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilCheckboxGroupInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 161 of file class.ilCheckboxGroupInputGUI.php.

References render().

                                         : string
     {
         return $this->render();
     }

Here is the call graph for this function:

◆ getToolbarHTML()

ilCheckboxGroupInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 166 of file class.ilCheckboxGroupInputGUI.php.

References render().

                                     : string
     {
         return $this->render('toolbar');
     }

Here is the call graph for this function:

◆ getUseValuesAsKeys()

ilCheckboxGroupInputGUI::getUseValuesAsKeys ( )

Definition at line 52 of file class.ilCheckboxGroupInputGUI.php.

References $use_values_as_keys.

Referenced by render().

                                         : bool
     {
         return $this->use_values_as_keys;
     }

Here is the caller graph for this function:

◆ getValue()

ilCheckboxGroupInputGUI::getValue ( )

Definition at line 92 of file class.ilCheckboxGroupInputGUI.php.

References $value.

Referenced by render().

                               : ?array
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilCheckboxGroupInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 134 of file class.ilCheckboxGroupInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

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

Here is the call graph for this function:

◆ render()

ilCheckboxGroupInputGUI::render ( $a_mode = '' )

protected

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

References ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getOptions(), ilFormPropertyGUI\getParentForm(), ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubInputItemsRecursive(), getUseValuesAsKeys(), and getValue().

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

                                            : string
     {
         $tpl = new ilTemplate("tpl.prop_checkbox_group.html", true, true, "components/ILIAS/Form");
 
         foreach ($this->getOptions() as $option) {
             // information text for option
             if ($option->getInfo() != "") {
                 $tpl->setCurrentBlock("checkbox_option_desc");
                 $tpl->setVariable("CHECKBOX_OPTION_DESC", $option->getInfo());
                 $tpl->parseCurrentBlock();
             }
 
 
             if (count($option->getSubItems()) > 0) {
                 $tpl->setCurrentBlock("checkbox_option_subform");
                 $pf = new ilPropertyFormGUI();
                 $pf->setMode("subform");
                 $pf->setItems($option->getSubItems());
                 $tpl->setVariable("SUB_FORM", $pf->getContent());
                 $tpl->setVariable("SOP_ID", $this->getFieldId() . "_" . $option->getValue());
                 if ($pf->getMultipart()) {
                     $this->getParentForm()->setMultipart(true);
                 }
                 $tpl->parseCurrentBlock();
                 if ($pf->getMultipart()) {
                     $this->getParentForm()->setMultipart(true);
                 }
             }
 
             $tpl->setCurrentBlock("prop_checkbox_option");
 
             if (!$this->getUseValuesAsKeys()) {
                 $tpl->setVariable("POST_VAR", $this->getPostVar() . '[]');
                 $tpl->setVariable("VAL_CHECKBOX_OPTION", $option->getValue());
             } else {
                 $tpl->setVariable("POST_VAR", $this->getPostVar() . '[' . $option->getValue() . ']');
                 $tpl->setVariable("VAL_CHECKBOX_OPTION", "1");
             }
 
             $tpl->setVariable("OP_ID", $this->getFieldId() . "_" . $option->getValue());
             $tpl->setVariable("FID", $this->getFieldId());
 
             if ($this->getDisabled() or $option->getDisabled()) {
                 $tpl->setVariable('DISABLED', 'disabled="disabled" ');
             }
 
             if (is_array($this->getValue())) {
                 if (!$this->getUseValuesAsKeys()) {
                     if (in_array($option->getValue(), $this->getValue())) {
                         $tpl->setVariable(
                             "CHK_CHECKBOX_OPTION",
                             'checked="checked"'
                         );
                     }
                 } else {
                     $cval = $this->getValue();
                     if (isset($cval[$option->getValue()]) && $cval[$option->getValue()] == 1) {
                         $tpl->setVariable(
                             "CHK_CHECKBOX_OPTION",
                             'checked="checked"'
                         );
                     }
                 }
             }
             $tpl->setVariable("TXT_CHECKBOX_OPTION", $option->getTitle());
 
 
             $tpl->parseCurrentBlock();
         }
         $tpl->setVariable("ID", $this->getFieldId());
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptions()

ilCheckboxGroupInputGUI::setOptions ( array $a_options )

Set Options.

Parameters

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

Definition at line 70 of file class.ilCheckboxGroupInputGUI.php.

                                                 : void
     {
         foreach ($a_options as $key => $label) {
             if (is_string($label)) {
                 $chb = new ilCheckboxInputGUI($label, $key);
                 $this->options[] = $chb;
             } elseif ($label instanceof ilCheckboxInputGUI) {
                 $this->options[] = $label;
             }
         }
     }

◆ setUseValuesAsKeys()

ilCheckboxGroupInputGUI::setUseValuesAsKeys ( bool $a_val )

Set use values as keys.

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

                                                    : void
     {
         $this->use_values_as_keys = $a_val;
     }

◆ setValue()

ilCheckboxGroupInputGUI::setValue ( ?array $a_value )

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

Referenced by ilCronOerHarvester\addCustomSettingsToForm(), ilECSObjectSettings\addSettingsToForm(), ilPageLayoutGUI\initForm(), ilECSParticipantSettingsGUI\initFormSettings(), ilObjPrivacySecurityGUI\initPrivacyForm(), and setValueByArray().

                                              : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilCheckboxGroupInputGUI::setValueByArray ( array $a_values )

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

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

                                                     : void
     {
         $this->setValue($a_values[$this->getPostVar()] ?? null);
         foreach ($this->getOptions() as $option) {
             foreach ($option->getSubItems() as $item) {
                 $item->setValueByArray($a_values);
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $options

array ilCheckboxGroupInputGUI::$options = array()

protected

Definition at line 29 of file class.ilCheckboxGroupInputGUI.php.

Referenced by getOptions().

◆ $use_values_as_keys

bool ilCheckboxGroupInputGUI::$use_values_as_keys = false

protected

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

Referenced by getUseValuesAsKeys().

◆ $value

array ilCheckboxGroupInputGUI::$value = null

protected

Definition at line 30 of file class.ilCheckboxGroupInputGUI.php.

Referenced by getValue().

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

components/ILIAS/Form/classes/class.ilCheckboxGroupInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOption()

◆ checkInput()

◆ getInput()

◆ getItemByPostVar()

◆ getOptions()

◆ getTableFilterHTML()

◆ getToolbarHTML()

◆ getUseValuesAsKeys()

◆ getValue()

◆ insert()

◆ render()

◆ setOptions()

◆ setUseValuesAsKeys()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $options

◆ $use_values_as_keys

◆ $value