User interface class for a checkbox list overlay. More...

Collaboration diagram for ilCheckboxListOverlayGUI:

Public Member Functions
	__construct ($a_id="")
	Constructor. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setLinkTitle ($a_val)
	Set link title. More...

	getLinkTitle ()
	Get link title. More...

	setItems ($a_val)
	Set items. More...

	getItems ()
	Get items. More...

	setSelectionHeaderClass ($a_selectionheaderclass)
	Set Selection Header Class. More...

	getSelectionHeaderClass ()
	Get Selection Header Class. More...

	setFormCmd ($a_val)
	Set form command. More...

	getFormCmd ()
	Get form command. More...

	setFieldVar ($a_val)
	Set field var. More...

	getFieldVar ()
	Get field var. More...

	setHiddenVar ($a_val)
	Set hidden var (used to indicated that checkbox array has been sent in a form) More...

	getHiddenVar ()
	Get hidden var. More...

	getHTML ()
	Get selection list HTML. More...

Protected Attributes
	$lng

Private Attributes
	$items = array()

Detailed Description

User interface class for a checkbox list overlay.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id:$

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

Constructor & Destructor Documentation

◆ __construct()

ilCheckboxListOverlayGUI::__construct ( $a_id = "" )

Constructor.

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

References $DIC, and setId().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->setId($a_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getFieldVar()

ilCheckboxListOverlayGUI::getFieldVar ( )

Get field var.

Returns: string field var

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

Referenced by getHTML().

     {
         return $this->field_var;
     }

Here is the caller graph for this function:

◆ getFormCmd()

ilCheckboxListOverlayGUI::getFormCmd ( )

Get form command.

Returns: string form command

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

Referenced by getHTML().

     {
         return $this->form_cmd;
     }

Here is the caller graph for this function:

◆ getHiddenVar()

ilCheckboxListOverlayGUI::getHiddenVar ( )

Get hidden var.

Returns: string hidden var

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

Referenced by getHTML().

     {
         return $this->hidden_var;
     }

Here is the caller graph for this function:

◆ getHTML()

ilCheckboxListOverlayGUI::getHTML ( )

Get selection list HTML.

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

References $items, $lng, $tpl, getFieldVar(), getFormCmd(), getHiddenVar(), getId(), getItems(), and getLinkTitle().

     {
         $lng = $this->lng;
         
         $items = $this->getItems();
 
         $tpl = new ilTemplate(
             "tpl.checkbox_list_overlay.html",
             true,
             true,
             "Services/UIComponent/CheckboxListOverlay",
             "DEFAULT",
             false,
             true
         );
                 
         $tpl->setCurrentBlock("top_img");
         
         // do not repeat title (accessibility) -> empty alt
         $tpl->setVariable("TXT_SEL_TOP", $this->getLinkTitle());
         $tpl->setVariable("ALT_SEL_TOP", "");
         
         $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();
         }
         
         $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 ( )

Get id.

Returns: string id

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

References $id.

Referenced by getHTML().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getItems()

ilCheckboxListOverlayGUI::getItems ( )

Get items.

Returns: array items

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

References $items.

Referenced by getHTML().

     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ getLinkTitle()

ilCheckboxListOverlayGUI::getLinkTitle ( )

Get link title.

Returns: string link title

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

Referenced by getHTML().

     {
         return $this->link_title;
     }

Here is the caller graph for this function:

◆ getSelectionHeaderClass()

ilCheckboxListOverlayGUI::getSelectionHeaderClass ( )

Get Selection Header Class.

Returns: string Selection Header Class

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

     {
         return $this->selectionheaderclass;
     }

◆ setFieldVar()

ilCheckboxListOverlayGUI::setFieldVar ( $a_val )

Set field var.

Parameters

string field var

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

     {
         $this->field_var = $a_val;
     }

◆ setFormCmd()

ilCheckboxListOverlayGUI::setFormCmd ( $a_val )

Set form command.

Parameters

string form command

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

     {
         $this->form_cmd = $a_val;
     }

◆ setHiddenVar()

ilCheckboxListOverlayGUI::setHiddenVar ( $a_val )

Set hidden var (used to indicated that checkbox array has been sent in a form)

Parameters

string hidden var

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

     {
         $this->hidden_var = $a_val;
     }

◆ setId()

ilCheckboxListOverlayGUI::setId ( $a_val )

Set id.

Parameters

string id

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

Referenced by __construct().

     {
         $this->id = $a_val;
     }

Here is the caller graph for this function:

◆ setItems()

ilCheckboxListOverlayGUI::setItems ( $a_val )

Set items.

Parameters

array items

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

     {
         $this->items = $a_val;
     }

◆ setLinkTitle()

ilCheckboxListOverlayGUI::setLinkTitle ( $a_val )

Set link title.

Parameters

string link title

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

     {
         $this->link_title = $a_val;
     }

◆ setSelectionHeaderClass()

ilCheckboxListOverlayGUI::setSelectionHeaderClass ( $a_selectionheaderclass )

Set Selection Header Class.

Parameters

string $a_selectionheaderclass Selection Header Class

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

     {
         $this->selectionheaderclass = $a_selectionheaderclass;
     }

Field Documentation

◆ $items

ilCheckboxListOverlayGUI::$items = array()

private

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

Referenced by getHTML(), and getItems().

◆ $lng

ilCheckboxListOverlayGUI::$lng

protected

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

Referenced by getHTML().

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

Services/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFieldVar()

◆ getFormCmd()

◆ getHiddenVar()

◆ getHTML()

◆ getId()

◆ getItems()

◆ getLinkTitle()

◆ getSelectionHeaderClass()

◆ setFieldVar()

◆ setFormCmd()

◆ setHiddenVar()

◆ setId()

◆ setItems()

◆ setLinkTitle()

◆ setSelectionHeaderClass()

Field Documentation

◆ $items

◆ $lng