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

Inheritance diagram for ilCheckboxInputGUI:

Collaboration diagram for ilCheckboxInputGUI:

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

	setValue (string $a_value)

	getValue ()

	setChecked (bool $a_checked)

	getChecked ()

	setOptionTitle (string $a_optiontitle)

	getOptionTitle ()

	setValueByArray (array $a_values)

	setAdditionalAttributes (string $a_attrs)

	getAdditionalAttributes ()

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

	getInput ()

	hideSubForm ()

	render ($a_mode='')

	insert (ilTemplate $a_tpl)

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

	serializeData ()

	unserializeData (string $a_data)

	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)
	Get item by post var. More...

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

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

Public Member Functions inherited from ilTableFilterItem
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

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

Protected Attributes
string	$value = "1"

bool	$checked = false

string	$optiontitle = ""

string	$additional_attributes = ''

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

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)

Detailed Description

This class represents a checkbox property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

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

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

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

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: bool Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilDclCheckboxInputGUI.

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

                                : bool
    {
        $ok = $this->checkSubItemsInput();
 
        // only not ok, if checkbox not checked
        if ($this->getInput() == "") {
            $ok = true;
        }
 
        return $ok;
    }

References ilSubEnabledFormPropertyGUI\checkSubItemsInput(), and getInput().

Here is the call graph for this function:

◆ getAdditionalAttributes()

ilCheckboxInputGUI::getAdditionalAttributes ( )

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

                                             : string
    {
        return $this->additional_attributes;
    }

References $additional_attributes.

Referenced by render().

Here is the caller graph for this function:

◆ getChecked()

ilCheckboxInputGUI::getChecked ( )

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

                                : bool
    {
        return $this->checked;
    }

References $checked.

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

Here is the caller graph for this function:

◆ getInput()

ilCheckboxInputGUI::getInput ( )

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

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

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

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionTitle()

ilCheckboxInputGUI::getOptionTitle ( )

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

                                    : string
    {
        return $this->optiontitle;
    }

References $optiontitle.

Referenced by render().

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilCheckboxInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

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

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

References render().

Here is the call graph for this function:

◆ getToolbarHTML()

ilCheckboxInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

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

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

References render().

Here is the call graph for this function:

◆ getValue()

ilCheckboxInputGUI::getValue ( )

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

                              : string
    {
        return $this->value;
    }

References $value.

Referenced by render().

Here is the caller graph for this function:

◆ hideSubForm()

ilCheckboxInputGUI::hideSubForm ( )

Reimplemented from ilFormPropertyGUI.

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

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

References getChecked().

Here is the call graph for this function:

◆ insert()

ilCheckboxInputGUI::insert ( ilTemplate $a_tpl )

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

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

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

Here is the call graph for this function:

◆ render()

ilCheckboxInputGUI::render ( $a_mode = '' )

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

                                        : string
    {
        $tpl = new ilTemplate("tpl.prop_checkbox.html", true, true, "components/ILIAS/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;');
        }
 
        $tpl->setVariable("ARIA_LABEL", ilLegacyFormElementsUtil::prepareFormOutput($this->getTitle()));
        if ($this->getInfo() !== '') {
            $tpl->setVariable('DESCRIBED_BY_FIELD_ID', $this->getFieldId());
        }
 
        return $tpl->get();
    }

References getAdditionalAttributes(), getChecked(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getInfo(), getOptionTitle(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getTitle(), getValue(), and ilLegacyFormElementsUtil\prepareFormOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeData()

ilCheckboxInputGUI::serializeData ( )

Reimplemented from ilFormPropertyGUI.

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

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

References getChecked().

Here is the call graph for this function:

◆ setAdditionalAttributes()

ilCheckboxInputGUI::setAdditionalAttributes ( string $a_attrs )

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

                                                            : void
    {
        $this->additional_attributes = $a_attrs;
    }

◆ setChecked()

ilCheckboxInputGUI::setChecked ( bool $a_checked )

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

                                               : void
    {
        $this->checked = $a_checked;
    }

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Referenced by setValueByArray(), and unserializeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptionTitle()

ilCheckboxInputGUI::setOptionTitle ( string $a_optiontitle )

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

                                                         : void
    {
        $this->optiontitle = $a_optiontitle;
    }

◆ setValue()

ilCheckboxInputGUI::setValue ( string $a_value )

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

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

Referenced by unserializeData().

Here is the caller graph for this function:

◆ setValueByArray()

ilCheckboxInputGUI::setValueByArray ( array $a_values )

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

                                                    : void
    {
        $checked = $a_values[$this->getPostVar()] ?? false;
        $this->setChecked((bool) $checked);
        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }

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

Here is the call graph for this function:

◆ unserializeData()

ilCheckboxInputGUI::unserializeData ( string $a_data )

Reimplemented from ilFormPropertyGUI.

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

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