ilCheckboxListOverlayGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCheckboxListOverlayGUI:

Public Member Functions
	__construct (string $a_id="")
	setId (string $a_val)
	getId ()
	setLinkTitle (string $a_val)
	getLinkTitle ()
	setItems (array $a_val)
	getItems ()
	setSelectionHeaderClass (string $a_selectionheaderclass)
	getSelectionHeaderClass ()
	setFormCmd (string $a_val)
	getFormCmd ()
	setFieldVar (string $a_val)
	getFieldVar ()
	setHiddenVar (string $a_val)
	getHiddenVar ()
	getHTML (bool $pull_right=true)

Protected Attributes
ilLanguage	$lng
string	$id
string	$link_title
string	$selectionheaderclass
string	$form_cmd
string	$field_var
string	$hidden_var
ilGlobalTemplateInterface	$main_tpl

Private Attributes
array	$items = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning User interface class for a checkbox list overlay

Author

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

Deprecated:

9 Only used in legacy tables, do not introduce this anywhere else

Definition at line 25 of file class.ilCheckboxListOverlayGUI.php.

Constructor & Destructor Documentation

__construct()

ilCheckboxListOverlayGUI::__construct

(

string

$a_id = ""

)

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

References $DIC, ILIAS\Repository\lng(), and setId().

      {
        global $DIC;

        $this->lng = $DIC->language();
        $this->setId($a_id);
        $this->main_tpl = $DIC->ui()->mainTemplate();
    }

Here is the call graph for this function:

Member Function Documentation

getFieldVar()

ilCheckboxListOverlayGUI::getFieldVar

(

)

Definition at line 103 of file class.ilCheckboxListOverlayGUI.php.

References $field_var.

Referenced by getHTML().

                                 : string
    {
        return $this->field_var;
    }

Here is the caller graph for this function:

getFormCmd()

ilCheckboxListOverlayGUI::getFormCmd

(

)

Definition at line 93 of file class.ilCheckboxListOverlayGUI.php.

References $form_cmd.

Referenced by getHTML().

                                : string
    {
        return $this->form_cmd;
    }

Here is the caller graph for this function:

getHiddenVar()

ilCheckboxListOverlayGUI::getHiddenVar

(

)

Definition at line 113 of file class.ilCheckboxListOverlayGUI.php.

References $hidden_var.

Referenced by getHTML().

                                  : string
    {
        return $this->hidden_var;
    }

Here is the caller graph for this function:

getHTML()

ilCheckboxListOverlayGUI::getHTML

(

bool

$pull_right = true

)

Definition at line 118 of file class.ilCheckboxListOverlayGUI.php.

References $lng, getFieldVar(), getFormCmd(), getHiddenVar(), getId(), getItems(), getLinkTitle(), and ilLanguage\txt().

                                                    : string
    {
        $lng = $this->lng;

        $items = $this->getItems();

        $tpl = new ilTemplate(
            "tpl.checkbox_list_overlay.html",
            true,
            true,
            "components/ILIAS/UIComponent/CheckboxListOverlay",
            "DEFAULT",
            false,
            true
        );

        $this->main_tpl->addOnLoadCode("
            const o = document.getElementById('chkbxlstovl_{$this->getId()}');
            o.addEventListener('click', (e) => {
                e.stopPropagation();
            });
            let b;
            const close = () => {
                b.parentNode.classList.remove('open');
                b.area_expanded = 'false';
                document.removeEventListener('click', close);
            }
            const closeOnEscape = (e) => {
                if (e.key === 'Escape') {
                    close();
                    document.removeEventListener('keydown', closeOnEscape);
                }
            }
            o.previousElementSibling.addEventListener('click', (e) => {
                e.stopPropagation();
                b = e.target.closest('button');
                if (b.parentNode.classList.contains('open')) {
                    close();
                    return;
                }
                b.parentNode.classList.add('open');
                b.area_expanded = 'true';
                document.body.click();
                document.addEventListener('click', close);
                document.addEventListener('keydown', closeOnEscape);
            });
        ");

        $tpl->touchBlock("top_img");

        // do not repeat title (accessibility) -> empty alt
        $tpl->setVariable("TXT_SEL_TOP", $this->getLinkTitle());

        $tpl->parseCurrentBlock();

        reset($items);
        $cnt = 0;
        foreach ($items as $k => $v) {
            $tpl->setCurrentBlock("list_entry");
            $tpl->setVariable("VAR", $this->getFieldVar());
            $tpl->setVariable("VAL_ENTRY", $k);
            $tpl->setVariable("TXT_ENTRY", $v["txt"]);
            $tpl->setVariable("IDX_ENTRY", ++$cnt);
            if ($v["selected"]) {
                $tpl->setVariable("CHECKED", "checked='checked'");
            }
            $tpl->parseCurrentBlock();
        }

        if ($pull_right) {
            $tpl->touchBlock("pr");
        }

        $tpl->setVariable("ID", $this->getId());
        $tpl->setVariable("HIDDEN_VAR", $this->getHiddenVar());
        $tpl->setVariable("CMD_SUBMIT", $this->getFormCmd());
        $tpl->setVariable("VAL_SUBMIT", $lng->txt("refresh"));
        return $tpl->get();
    }

Here is the call graph for this function:

getId()

ilCheckboxListOverlayGUI::getId

(

)

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

References $id.

Referenced by getHTML().

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getItems()

ilCheckboxListOverlayGUI::getItems

(

)

Definition at line 72 of file class.ilCheckboxListOverlayGUI.php.

References $items.

Referenced by getHTML().

                              : array
    {
        return $this->items;
    }

Here is the caller graph for this function:

getLinkTitle()

ilCheckboxListOverlayGUI::getLinkTitle

(

)

Definition at line 62 of file class.ilCheckboxListOverlayGUI.php.

References $link_title.

Referenced by getHTML().

                                  : string
    {
        return $this->link_title;
    }

Here is the caller graph for this function:

getSelectionHeaderClass()

ilCheckboxListOverlayGUI::getSelectionHeaderClass

(

)

Definition at line 83 of file class.ilCheckboxListOverlayGUI.php.

References $selectionheaderclass.

                                             : string
    {
        return $this->selectionheaderclass;
    }

setFieldVar()

ilCheckboxListOverlayGUI::setFieldVar

(

string

$a_val

)

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

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

setFormCmd()

ilCheckboxListOverlayGUI::setFormCmd

(

string

$a_val

)

Definition at line 88 of file class.ilCheckboxListOverlayGUI.php.

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

setHiddenVar()

ilCheckboxListOverlayGUI::setHiddenVar

(

string

$a_val

)

Definition at line 108 of file class.ilCheckboxListOverlayGUI.php.

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

setId()

ilCheckboxListOverlayGUI::setId

(

string

$a_val

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

setItems()

ilCheckboxListOverlayGUI::setItems

(

array

$a_val

)

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

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

setLinkTitle()

ilCheckboxListOverlayGUI::setLinkTitle

(

string

$a_val

)

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

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

setSelectionHeaderClass()

ilCheckboxListOverlayGUI::setSelectionHeaderClass

(

string

$a_selectionheaderclass

)

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

     : void {
        $this->selectionheaderclass = $a_selectionheaderclass;
    }

Field Documentation

$field_var

string ilCheckboxListOverlayGUI::$field_var

protected

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

Referenced by getFieldVar().

$form_cmd

string ilCheckboxListOverlayGUI::$form_cmd

protected

Definition at line 32 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getFormCmd().

$hidden_var

string ilCheckboxListOverlayGUI::$hidden_var

protected

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

Referenced by getHiddenVar().

$id

string ilCheckboxListOverlayGUI::$id

protected

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

Referenced by getId().

$items

array ilCheckboxListOverlayGUI::$items = array()

private

Definition at line 28 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getItems().

$link_title

string ilCheckboxListOverlayGUI::$link_title

protected

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

Referenced by getLinkTitle().

$lng

ilLanguage ilCheckboxListOverlayGUI::$lng

protected

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

Referenced by getHTML().

$main_tpl

ilGlobalTemplateInterface ilCheckboxListOverlayGUI::$main_tpl

protected

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

$selectionheaderclass

string ilCheckboxListOverlayGUI::$selectionheaderclass

protected

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

Referenced by getSelectionHeaderClass().

---

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

• components/ILIAS/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php