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

Inheritance diagram for ilAdvancedSelectionListGUI:

Collaboration diagram for ilAdvancedSelectionListGUI:

Public Member Functions
	setLinksMode (string $a_link_class="")
	Set links mode (for no js fallback) More...

	setFormSelectMode (string $a_select_name, string $a_select_class="", bool $a_include_form_tag=false, string $a_form_action="", string $a_form_id="", string $a_form_class="", string $a_form_target="_top", string $a_button_text="", string $a_button_class="", string $a_button_cmd="")
	Set form mode (for no js fallback) Outputs form selection including surrounding form. More...

	addItem (string $a_title, string $a_value="", string $a_link="", string $a_img="", string $a_alt="", string $a_frame="", string $a_html="", bool $a_prevent_background_click=false, string $a_onclick="", string $a_ttip="", string $a_tt_my="right center", string $a_tt_at="left center", bool $a_tt_use_htmlspecialchars=true, array $a_data=array())

	addComponent (\ILIAS\UI\Component\Component $component)

	setGroupedList (ilGroupedListGUI $a_val)

	getGroupedList ()

	flush ()

	getItems ()

	setListTitle (string $a_listtitle)

	getListTitle ()

	setAriaListTitle (string $a_listtitle)

	getAriaListTitle ()

	setSelectionHeaderClass (string $a_selectionheaderclass)
	DEPRECATED use set style instead. More...

	getSelectionHeaderClass ()

	setStyle (int $a_val)

	getStyle ()

	setSelectionHeaderSpanClass (string $a_val)

	getSelectionHeaderSpanClass ()

	setHeaderIcon (string $a_headericon)

	getHeaderIcon ()

	setNoJSLinkClass (string $a_nojslinkclass)

	getNoJSLinkClass ()

	setItemLinkClass (string $a_itemlinkclass)

	getItemLinkClass ()

	setId (string $a_id)

	getId ()

	setUseImages (bool $a_useimages)

	getUseImages ()

	setTriggerEvent (string $a_val)

	getTriggerEvent ()

	setAutoHide (bool $a_val)

	getAutoHide ()

	setOnClickMode (string $a_val, string $a_onclick_form_id="")
	Set "onClick"- Mode. More...

	getOnClickMode ()

	setSelectedValue (string $a_val)

	getSelectedValue ()

	setAdditionalToggleElement (string $a_el, string $a_on)
	Set additional toggle element. More...

	getAdditionalToggleElement ()
	Get additional toggle element. More...

	setAsynch (bool $a_val)

	getAsynch ()

	setAsynchUrl (string $a_val)

	getAsynchUrl ()

	setSelectCallback (string $a_val)

	getSelectCallback ()

	setPullRight (bool $a_val)

	getPullRight ()

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

	getHTML (bool $a_only_cmd_list_asynch=false)

	getOnloadCode ()

Data Fields
const	DOWN_ARROW_DARK = "down_arrow_dark"

const	ICON_ARROW = "caret"

const	ICON_CONFIG = "glyphicon glyphicon-cog"

const	NO_ICON = ""

const	MODE_LINKS = "links"

const	MODE_FORM_SELECT = "select"

const	ON_ITEM_CLICK_HREF = "href"

const	ON_ITEM_CLICK_FORM_SUBMIT = "submit"

const	ON_ITEM_CLICK_FORM_SELECT = "select"

const	ON_ITEM_CLICK_NOP = "nop"

const	STYLE_DEFAULT = 0

const	STYLE_LINK = 1

const	STYLE_EMPH = 2

const	STYLE_LINK_BUTTON = 3

array	select_class

Protected Member Functions
	getJSTemplate ()

Protected Attributes
string	$css_row = ""

bool	$access_key = false

array	$toggle = null

string	$asynch_url = ''

string	$selected_value = ""

string	$trigger_event = "click"

bool	$auto_hide = false

ilGroupedListGUI	$grouped_list = null

int	$style = 0

string	$listtitle = ""

string	$aria_listtitle = ""

bool	$useimages = false

string	$itemlinkclass = ''

string	$mode = ""

array	$links_mode = []

string	$selectionheaderclass = ""

string	$headericon = ""

string	$nojslinkclass = ""

string	$on_click = ""

array	$form_mode

string	$select_callback = ''

string	$sel_head_span_class = ''

ilLanguage	$lng

string	$on_click_form_id

ilGlobalTemplateInterface	$global_tpl

Private Attributes
array	$items = array()

string	$id = "asl"

bool	$asynch = false

bool	$dd_pullright = true

ILIAS UI Renderer	$renderer

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 advanced drop-down selection lists

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

Deprecated:: use KS Dropdowns instead

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

Member Function Documentation

◆ addComponent()

ilAdvancedSelectionListGUI::addComponent ( \ILIAS\UI\Component\Component $component )

Definition at line 190 of file class.ilAdvancedSelectionListGUI.php.

                                                                           : void
     {
         $this->items[] = [
             'component' => $component,
         ];
     }

◆ addItem()

ilAdvancedSelectionListGUI::addItem	(	string	$a_title,
		string	$a_value = `""`,
		string	$a_link = `""`,
		string	$a_img = `""`,
		string	$a_alt = `""`,
		string	$a_frame = `""`,
		string	$a_html = `""`,
		bool	$a_prevent_background_click = `false`,
		string	$a_onclick = `""`,
		string	$a_ttip = `""`,
		string	$a_tt_my = `"right center"`,
		string	$a_tt_at = `"left center"`,
		bool	$a_tt_use_htmlspecialchars = `true`,
		array	$a_data = `array()`
	)

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

Referenced by ilOrgUnitRecursiveUserAssignmentTableGUI\addActions(), ilSystemStylesTableGUI\addManagementActionsToList(), ilFileNewsRendererGUI\addTimelineActions(), and ilMyStaffGUI\executeCommand().

      : void {
         $this->items[] = array("title" => $a_title, "value" => $a_value,
             "link" => $a_link, "img" => $a_img, "alt" => $a_alt, "frame" => $a_frame,
             "html" => $a_html, "prevent_background_click" => $a_prevent_background_click,
             "onclick" => $a_onclick, "ttip" => $a_ttip, "tt_my" => $a_tt_my, "tt_at" => $a_tt_at,
             "tt_use_htmlspecialchars" => $a_tt_use_htmlspecialchars, "data" => $a_data);
     }

Here is the caller graph for this function:

◆ flush()

ilAdvancedSelectionListGUI::flush ( )

Definition at line 207 of file class.ilAdvancedSelectionListGUI.php.

                            : void
     {
         $this->items = array();
     }

◆ getAdditionalToggleElement()

ilAdvancedSelectionListGUI::getAdditionalToggleElement ( )

Get additional toggle element.

Definition at line 391 of file class.ilAdvancedSelectionListGUI.php.

References $toggle.

Referenced by getHTML().

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

Here is the caller graph for this function:

◆ getAriaListTitle()

ilAdvancedSelectionListGUI::getAriaListTitle ( )

Definition at line 232 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML().

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

Here is the caller graph for this function:

◆ getAsynch()

ilAdvancedSelectionListGUI::getAsynch ( )

Definition at line 404 of file class.ilAdvancedSelectionListGUI.php.

References $asynch.

Referenced by getHTML(), and getOnloadCode().

                                : bool
     {
         return $this->asynch;
     }

Here is the caller graph for this function:

◆ getAsynchUrl()

ilAdvancedSelectionListGUI::getAsynchUrl ( )

Definition at line 414 of file class.ilAdvancedSelectionListGUI.php.

References $asynch_url.

Referenced by getHTML().

                                   : string
     {
         return $this->asynch_url;
     }

Here is the caller graph for this function:

◆ getAutoHide()

ilAdvancedSelectionListGUI::getAutoHide ( )

Definition at line 342 of file class.ilAdvancedSelectionListGUI.php.

References $auto_hide.

Referenced by getHTML().

                                  : bool
     {
         return $this->auto_hide;
     }

Here is the caller graph for this function:

◆ getGroupedList()

ilAdvancedSelectionListGUI::getGroupedList ( )

Definition at line 202 of file class.ilAdvancedSelectionListGUI.php.

References $grouped_list.

Referenced by getHTML(), and getOnloadCode().

                                     : ?ilGroupedListGUI
     {
         return $this->grouped_list;
     }

Here is the caller graph for this function:

◆ getHeaderIcon()

ilAdvancedSelectionListGUI::getHeaderIcon ( )

Definition at line 282 of file class.ilAdvancedSelectionListGUI.php.

References $headericon.

Referenced by getHTML().

                                    : string
     {
         return $this->headericon;
     }

Here is the caller graph for this function:

◆ getHTML()

ilAdvancedSelectionListGUI::getHTML ( bool $a_only_cmd_list_asynch = false )

Definition at line 444 of file class.ilAdvancedSelectionListGUI.php.

References $tpl, ilTooltipGUI\addTooltip(), getAdditionalToggleElement(), getAriaListTitle(), getAsynch(), getAsynchUrl(), getAutoHide(), getGroupedList(), getHeaderIcon(), getId(), ilUtil\getImagePath(), getItemLinkClass(), getItems(), getJSTemplate(), getListTitle(), getOnClickMode(), getOnloadCode(), getPullRight(), getSelectCallback(), getSelectedValue(), getSelectionHeaderSpanClass(), getStyle(), getTriggerEvent(), getUseImages(), ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by getToolbarHTML().

                                                                  : string
     {
         $items = $this->getItems();
 
         // do not show list, if no item is in list
         if (count($items) === 0 && !$this->getAsynch() && $this->getGroupedList() === null) {
             return "";
         }
 
         $this->global_tpl->addJavaScript("./Services/UIComponent/AdvancedSelectionList/js/AdvancedSelectionList.js");
 
         $tpl = new ilTemplate(
             "tpl.adv_selection_list.html",
             true,
             true,
             "Services/UIComponent/AdvancedSelectionList",
             "DEFAULT",
             false,
             true
         );
 
         reset($items);
 
         $cnt = 0;
 
         if ($this->getAsynch()) {
             $tpl->setCurrentBlock("asynch_request");
             $tpl->setVariable("IMG_LOADER", ilUtil::getImagePath("loader.svg"));
             $tpl->parseCurrentBlock();
         } elseif ($this->getGroupedList() !== null) {
             $tpl->setVariable("GROUPED_LIST_HTML", $this->getGroupedList()->getHTML());
         } else {
             foreach ($items as $item) {
                 $this->css_row = ($this->css_row !== "tblrow1_mo")
                     ? "tblrow1_mo"
                     : "tblrow2_mo";
 
                 if (isset($item['component'])) {
                     $tpl->setCurrentBlock('component');
                     $tpl->setVariable('COMPONENT', $this->renderer->render([$item['component']]));
                     $tpl->parseCurrentBlock();
 
                     $tpl->setCurrentBlock('item_loop');
                     $tpl->parseCurrentBlock();
                     continue;
                 }
 
                 $item["value"] = htmlspecialchars($item["value"] ?? '', ENT_QUOTES);
 
                 if ($this->getUseImages()) {
                     if ($item["img"]) {
                         $tpl->setCurrentBlock("image");
                         $tpl->setVariable("IMG_ITEM", $item["img"]);
                         $tpl->setVariable("ALT_ITEM", $item["alt"]);
                         $tpl->parseCurrentBlock();
                     } else {
                         $tpl->touchBlock("no_image");
                     }
                 }
 
                 if ($this->getOnClickMode() === self::ON_ITEM_CLICK_HREF || $this->getItemLinkClass() !== "") {
                     if ($item["frame"]) {
                         $tpl->setCurrentBlock("frame");
                         $tpl->setVariable("TARGET_ITEM", $item["frame"]);
                         $tpl->parseCurrentBlock();
                     }
 
                     if ($this->getItemLinkClass() !== "") {
                         $tpl->setCurrentBlock("item_link_class");
                         $tpl->setVariable("ITEM_LINK_CLASS", $this->getItemLinkClass());
                         $tpl->parseCurrentBlock();
                     }
 
                     if (is_array($item["data"])) {
                         foreach ($item["data"] as $k => $v) {
                             $tpl->setCurrentBlock("f_data");
                             $tpl->setVariable("DATA_KEY", $k);
                             $tpl->setVariable("DATA_VAL", ilLegacyFormElementsUtil::prepareFormOutput($v));
                             $tpl->parseCurrentBlock();
                         }
                     }
                     if ($item["value"] != "") {
                         $tpl->setCurrentBlock("item_id");
                         $tpl->setVariable("ID_ITEM", $this->getId() . "_" . $item["value"]);
                         $tpl->parseCurrentBlock();
                     }
 
                     $tpl->setCurrentBlock("href_s");
                     $tpl->setVariable("HREF_ITEM", 'href="' . $item["link"] . '"');
                     $tpl->parseCurrentBlock();
 
                     $tpl->touchBlock("href_e");
                 }
 
                 $tpl->setCurrentBlock("item");
                 if ($this->getOnClickMode() === self::ON_ITEM_CLICK_HREF) {
                     if ($item["prevent_background_click"]) {
                         $tpl->setVariable("ONCLICK_ITEM", '');
                     } elseif ($item["onclick"] == "" && $item["frame"] != "") {       // see #28730
                         $tpl->setVariable(
                             "ONCLICK_ITEM",
                             'onclick="' . "return il.AdvancedSelectionList.openTarget('" . $item["link"] . "','" . $item["frame"] . "');" . '"'
                         );
                     } elseif ($item["onclick"] != "") {
                         $tpl->setVariable(
                             "ONCLICK_ITEM",
                             'onclick="' . "return " . $item["onclick"] . ";" . '"'
                         );
                     }
                 } elseif ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SUBMIT) {
                     $tpl->setVariable(
                         "ONCLICK_ITEM",
                         'onclick="return il.AdvancedSelectionList.submitForm(\'' . $this->getId() . '\'' .
                             ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                             "'" . $this->on_click_form_id . "','" . $this->form_mode["button_cmd"] . "');\""
                     );
                 } elseif ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SELECT) {
                     $tpl->setVariable(
                         "ONCLICK_ITEM",
                         'onclick="return il.AdvancedSelectionList.selectForm(\'' . $this->getId() . '\'' .
                             ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                             "'" . $item["title"] . "');\""
                     );
                 } elseif ($this->getOnClickMode() === self::ON_ITEM_CLICK_NOP) {
                     $tpl->setVariable(
                         "ONCLICK_ITEM",
                         'onclick="il.AdvancedSelectionList.clickNop(\'' . $this->getId() . '\'' .
                             ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                             "'" . $item["title"] . "');\""
                     );
                 }
 
                 $tpl->setVariable("CSS_ROW", $this->css_row);
                 if ($item["html"] == "") {
                     $tpl->setVariable("TXT_ITEM", $item["title"]);
                 } else {
                     $tpl->setVariable("TXT_ITEM", $item["html"]);
                 }
 
                 $tpl->setVariable("ID_ITEM_TR", $this->getId() . "_" . $item["value"] . "_tr");
                 if ($item["ttip"] != "") {
                     ilTooltipGUI::addTooltip(
                         $this->getId() . "_" . $item["value"] . "_tr",
                         $item["ttip"],
                         "",
                         $item["tt_my"],
                         $item["tt_at"],
                         $item["tt_use_htmlspecialchars"]
                     );
                 }
 
                 $tpl->parseCurrentBlock();
 
                 $tpl->setCurrentBlock('item_loop');
                 $tpl->parseCurrentBlock();
             }
 
             // output hidden input, if click mode is form submission
             if ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SUBMIT) {
                 $tpl->setCurrentBlock("hidden_input");
                 $tpl->setVariable("HID", $this->getId());
                 $tpl->parseCurrentBlock();
             }
 
             // output hidden input and initialize
             if ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SELECT) {
                 if ($this->getSelectedValue() !== "") {
                     $tpl->setCurrentBlock("selected_val");
                     $tpl->setVariable("SEL_VAL", $this->getSelectedValue());
                     $tpl->parseCurrentBlock();
                 }
                 $tpl->setCurrentBlock("hidden_input");
                 $tpl->setVariable("HID", $this->getId());
                 $tpl->parseCurrentBlock();
             }
         }
 
         if ($a_only_cmd_list_asynch) {
             $tpl->touchBlock("cmd_table");
             return $tpl->get("item_loop");
         }
 
         if ($this->getGroupedList() === null) {
             $tpl->setCurrentBlock("dd_content");
             if ($this->getPullRight()) {
                 $tpl->setVariable("UL_CLASS", "dropdown-menu pull-right");
             } else {
                 $tpl->setVariable("UL_CLASS", "dropdown-menu");
             }
             $tpl->setVariable("TABLE_ID", $this->getId());
             $tpl->parseCurrentBlock();
         }
 
         if ($this->getHeaderIcon() !== self::NO_ICON) {
             $tpl->setCurrentBlock("top_img");
             switch ($this->getHeaderIcon()) {
                 case self::ICON_CONFIG:
                     $tpl->setVariable("IMG_SPAN_STYLE", self::ICON_CONFIG);
                     break;
 
                 case self::DOWN_ARROW_DARK:
                 default:
                     $tpl->setVariable("IMG_SPAN_STYLE", self::ICON_ARROW);
                     break;
             }
             $tpl->parseCurrentBlock();
         }
 
 
         if ($this->getAsynch()) {
             $js_tpl = $this->getJSTemplate();
             $js_tpl->setVariable("ID", $this->getId());
             $js_tpl->setCurrentBlock("asynch_bl");
             $js_tpl->setVariable("ASYNCH_URL", $this->getAsynchUrl());
             $js_tpl->setVariable("ASYNCH_ID", $this->getId());
             $js_tpl->setVariable("ASYNCH_TRIGGER_ID", $this->getId());
             $js_tpl->parseCurrentBlock();
             $this->global_tpl->addOnloadCode(
                 $js_tpl->get()
             );
         }
 
         // js section
         $tpl->setCurrentBlock("js_section");
 
         $cfg["trigger_event"] = $this->getTriggerEvent();
         $cfg["auto_hide"] = $this->getAutoHide();
 
         if ($this->getSelectCallback() !== "") {
             $cfg["select_callback"] = $this->getSelectCallback();
         }
         $cfg["anchor_id"] = "ilAdvSelListAnchorElement_" . $this->getId();
         $cfg["asynch"] = $this->getAsynch();
         $cfg["asynch_url"] = $this->getAsynchUrl();
         $toggle = $this->getAdditionalToggleElement();
         if (is_array($toggle)) {
             $cfg["toggle_el"] = $toggle["el"];
             $cfg["toggle_class_on"] = $toggle["class_on"];
         }
         //echo "<br>".htmlentities($this->getAsynchUrl());
         $tpl->setVariable("CFG", json_encode($cfg, JSON_THROW_ON_ERROR));
 
         //echo htmlentities(json_encode($cfg, JSON_THROW_ON_ERROR));
 
         $tpl->setVariable("TXT_SEL_TOP", $this->getListTitle());
         if ($this->getListTitle() === "" || $this->getAriaListTitle() !== "") {
             $aria_title = ($this->getAriaListTitle() !== "")
                 ? $this->getAriaListTitle()
                 : $this->lng->txt("actions");
             $tpl->setVariable("TXT_ARIA_TOP", $aria_title);
         }
         $tpl->setVariable("ID", $this->getId());
 
         //$tpl->setVariable("CLASS_SEL_TOP", $this->getSelectionHeaderClass());
         switch ($this->getStyle()) {
             case self::STYLE_DEFAULT:
                 $tpl->setVariable("BTN_CLASS", "btn btn-default");
                 $tpl->setVariable("TAG", "button");
                 break;
 
             case self::STYLE_EMPH:
                 $tpl->setVariable("BTN_CLASS", "btn btn-primary");
                 $tpl->setVariable("TAG", "button");
                 break;
 
             case self::STYLE_LINK_BUTTON:
                 $tpl->setVariable("BTN_CLASS", "btn btn-link");
                 $tpl->setVariable("TAG", "button");
                 break;
 
             case self::STYLE_LINK:
                 $tpl->setVariable("BTN_CLASS", "");
                 $tpl->setVariable("TAG", "a");
                 $tpl->touchBlock("href_link");
                 break;
         }
 
 
         if ($this->getSelectionHeaderSpanClass() !== "") {
             $tpl->setVariable(
                 "CLASS_SEL_TOP_SPAN",
                 $this->getSelectionHeaderSpanClass()
             );
         }
 
         // set the async url to an extra template variable
         // (needed for a mobile skin)
         // $tpl->setVariable("ASYNC_URL", $this->getAsynchUrl());
 
         $tpl->parseCurrentBlock();
 
         foreach ($this->getOnloadCode() as $code) {
             $this->global_tpl->addOnLoadCode(
                 $code
             );
         }
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilAdvancedSelectionListGUI::getId ( )

Definition at line 312 of file class.ilAdvancedSelectionListGUI.php.

References $id.

Referenced by getHTML(), and getOnloadCode().

                            : string
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getItemLinkClass()

ilAdvancedSelectionListGUI::getItemLinkClass ( )

Definition at line 302 of file class.ilAdvancedSelectionListGUI.php.

References $itemlinkclass.

Referenced by getHTML().

                                       : string
     {
         return $this->itemlinkclass;
     }

Here is the caller graph for this function:

◆ getItems()

ilAdvancedSelectionListGUI::getItems ( )

Definition at line 212 of file class.ilAdvancedSelectionListGUI.php.

References $items.

Referenced by getHTML(), and getOnloadCode().

                               : array
     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ getJSTemplate()

ilAdvancedSelectionListGUI::getJSTemplate ( )

protected

Definition at line 744 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML(), and getOnloadCode().

                                       : ilTemplate
     {
         return new ilTemplate(
             "tpl.adv_selection_list_js_init.js",
             true,
             true,
             "Services/UIComponent/AdvancedSelectionList",
             "DEFAULT",
             false,
             true
         );
     }

Here is the caller graph for this function:

◆ getListTitle()

ilAdvancedSelectionListGUI::getListTitle ( )

Definition at line 222 of file class.ilAdvancedSelectionListGUI.php.

References $listtitle.

Referenced by getHTML().

                                   : string
     {
         return $this->listtitle;
     }

Here is the caller graph for this function:

◆ getNoJSLinkClass()

ilAdvancedSelectionListGUI::getNoJSLinkClass ( )

Definition at line 292 of file class.ilAdvancedSelectionListGUI.php.

References $nojslinkclass.

                                       : string
     {
         return $this->nojslinkclass;
     }

◆ getOnClickMode()

ilAdvancedSelectionListGUI::getOnClickMode ( )

Definition at line 363 of file class.ilAdvancedSelectionListGUI.php.

References $on_click.

Referenced by getHTML(), and getOnloadCode().

                                     : string
     {
         return $this->on_click;
     }

Here is the caller graph for this function:

◆ getOnloadCode()

ilAdvancedSelectionListGUI::getOnloadCode ( )

Definition at line 757 of file class.ilAdvancedSelectionListGUI.php.

References getAsynch(), getGroupedList(), getId(), getItems(), getJSTemplate(), getOnClickMode(), and getSelectedValue().

Referenced by getHTML().

                                    : array
     {
         $items = $this->getItems();
 
         // do not show list, if no item is in list
         if (count($items) === 0 && !$this->getAsynch() && $this->getGroupedList() === null) {
             return [];
         }
 
         $js_tpl = $this->getJSTemplate();
 
         $cnt = 0;
 
         if (!$this->getAsynch() && $this->getGroupedList() === null) {
             foreach ($items as $item) {
                 if (isset($item['component'])) {
                     continue;
                 }
 
                 // add item to js object
                 $js_tpl->setCurrentBlock("js_item");
                 $js_tpl->setVariable("IT_ID", $this->getId());
                 $js_tpl->setVariable("IT_HID_NAME", $this->form_mode["select_name"]);
 
                 $js_tpl->setVariable("IT_HID_VAL", $item["value"]);
                 $js_tpl->setVariable("IT_TITLE", str_replace("'", "\\'", $item["title"]));
                 $js_tpl->parseCurrentBlock();
             }
 
             // output hidden input, if click mode is form submission
             if ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SUBMIT) {
                 $js_tpl->setCurrentBlock("hidden_input");
                 $js_tpl->setVariable("HID", $this->getId());
                 $js_tpl->parseCurrentBlock();
             }
 
             // output hidden input and initialize
             if ($this->getOnClickMode() === self::ON_ITEM_CLICK_FORM_SELECT) {
                 // init hidden input with selected value
                 $js_tpl->setCurrentBlock("init_hidden_input");
                 $js_tpl->setVariable("H2ID", $this->getId());
                 $js_tpl->setVariable("HID_NAME", $this->form_mode["select_name"]);
                 $js_tpl->setVariable("HID_VALUE", $this->getSelectedValue());
                 $js_tpl->parseCurrentBlock();
             }
         }
 
         $js_tpl->setVariable("ID", $this->getId());
 
         return [$js_tpl->get()];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPullRight()

ilAdvancedSelectionListGUI::getPullRight ( )

Definition at line 434 of file class.ilAdvancedSelectionListGUI.php.

References $dd_pullright.

Referenced by getHTML().

                                   : bool
     {
         return $this->dd_pullright;
     }

Here is the caller graph for this function:

◆ getSelectCallback()

ilAdvancedSelectionListGUI::getSelectCallback ( )

Definition at line 424 of file class.ilAdvancedSelectionListGUI.php.

References $select_callback.

Referenced by getHTML().

                                        : string
     {
         return $this->select_callback;
     }

Here is the caller graph for this function:

◆ getSelectedValue()

ilAdvancedSelectionListGUI::getSelectedValue ( )

Definition at line 373 of file class.ilAdvancedSelectionListGUI.php.

References $selected_value.

Referenced by getHTML(), and getOnloadCode().

                                       : string
     {
         return $this->selected_value;
     }

Here is the caller graph for this function:

◆ getSelectionHeaderClass()

ilAdvancedSelectionListGUI::getSelectionHeaderClass ( )

Definition at line 246 of file class.ilAdvancedSelectionListGUI.php.

References $selectionheaderclass.

                                              : string
     {
         return $this->selectionheaderclass;
     }

◆ getSelectionHeaderSpanClass()

ilAdvancedSelectionListGUI::getSelectionHeaderSpanClass ( )

Definition at line 272 of file class.ilAdvancedSelectionListGUI.php.

References $sel_head_span_class.

Referenced by getHTML().

                                                  : string
     {
         return $this->sel_head_span_class;
     }

Here is the caller graph for this function:

◆ getStyle()

ilAdvancedSelectionListGUI::getStyle ( )

Returns: int button style STYLE_DEFAULT, STYLE_LINK, STYLE_EMPH

Definition at line 262 of file class.ilAdvancedSelectionListGUI.php.

References $style.

Referenced by getHTML().

                               : int
     {
         return $this->style;
     }

Here is the caller graph for this function:

◆ getToolbarHTML()

ilAdvancedSelectionListGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 439 of file class.ilAdvancedSelectionListGUI.php.

References getHTML().

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

Here is the call graph for this function:

◆ getTriggerEvent()

ilAdvancedSelectionListGUI::getTriggerEvent ( )

Definition at line 332 of file class.ilAdvancedSelectionListGUI.php.

References $trigger_event.

Referenced by getHTML().

                                      : string
     {
         return $this->trigger_event;
     }

Here is the caller graph for this function:

◆ getUseImages()

ilAdvancedSelectionListGUI::getUseImages ( )

Definition at line 322 of file class.ilAdvancedSelectionListGUI.php.

References $useimages.

Referenced by getHTML().

                                   : bool
     {
         return $this->useimages;
     }

Here is the caller graph for this function:

◆ setAdditionalToggleElement()

ilAdvancedSelectionListGUI::setAdditionalToggleElement	(	string	$a_el,
		string	$a_on
	)

Set additional toggle element.

Parameters

string	$a_el	element id
string	$a_on	class for "on"

Definition at line 383 of file class.ilAdvancedSelectionListGUI.php.

                                                                           : void
     {
         $this->toggle = array("el" => $a_el, "class_on" => $a_on);
     }

◆ setAriaListTitle()

ilAdvancedSelectionListGUI::setAriaListTitle ( string $a_listtitle )

Definition at line 227 of file class.ilAdvancedSelectionListGUI.php.

                                                          : void
     {
         $this->aria_listtitle = $a_listtitle;
     }

◆ setAsynch()

ilAdvancedSelectionListGUI::setAsynch ( bool $a_val )

Definition at line 396 of file class.ilAdvancedSelectionListGUI.php.

References ilYuiUtil\initConnection().

                                           : void
     {
         if ($a_val) {
             ilYuiUtil::initConnection();
         }
         $this->asynch = $a_val;
     }

Here is the call graph for this function:

◆ setAsynchUrl()

ilAdvancedSelectionListGUI::setAsynchUrl ( string $a_val )

Definition at line 409 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setAutoHide()

ilAdvancedSelectionListGUI::setAutoHide ( bool $a_val )

Definition at line 337 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setFormSelectMode()

ilAdvancedSelectionListGUI::setFormSelectMode	(	string	$a_select_name,
		string	$a_select_class = `""`,
		bool	$a_include_form_tag = `false`,
		string	$a_form_action = `""`,
		string	$a_form_id = `""`,
		string	$a_form_class = `""`,
		string	$a_form_target = `"_top"`,
		string	$a_button_text = `""`,
		string	$a_button_class = `""`,
		string	$a_button_cmd = `""`
	)

Set form mode (for no js fallback) Outputs form selection including surrounding form.

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

      : void {
         $this->mode = self::MODE_FORM_SELECT;
         $this->form_mode = array(
             "select_name" => $a_select_name,
             "select_class" => $a_select_class,
             "include_form_tag" => $a_include_form_tag,
             "form_action" => $a_form_action,
             "form_id" => $a_form_id,
             "form_class" => $a_form_class,
             "form_target" => $a_form_target,
             "button_text" => $a_button_text,
             "button_class" => $a_button_class,
             "button_cmd" => $a_button_cmd
             );
     }

◆ setGroupedList()

ilAdvancedSelectionListGUI::setGroupedList ( ilGroupedListGUI $a_val )

Definition at line 197 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setHeaderIcon()

ilAdvancedSelectionListGUI::setHeaderIcon ( string $a_headericon )

Definition at line 277 of file class.ilAdvancedSelectionListGUI.php.

                                                        : void
     {
         $this->headericon = $a_headericon;
     }

◆ setId()

ilAdvancedSelectionListGUI::setId ( string $a_id )

Definition at line 307 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setItemLinkClass()

ilAdvancedSelectionListGUI::setItemLinkClass ( string $a_itemlinkclass )

Definition at line 297 of file class.ilAdvancedSelectionListGUI.php.

                                                              : void
     {
         $this->itemlinkclass = $a_itemlinkclass;
     }

◆ setLinksMode()

ilAdvancedSelectionListGUI::setLinksMode ( string $a_link_class = "" )

Set links mode (for no js fallback)

Definition at line 128 of file class.ilAdvancedSelectionListGUI.php.

      : void {
         $this->mode = self::MODE_LINKS;
         $this->links_mode = array(
             "link_class" => $a_link_class);
     }

◆ setListTitle()

ilAdvancedSelectionListGUI::setListTitle ( string $a_listtitle )

Definition at line 217 of file class.ilAdvancedSelectionListGUI.php.

                                                      : void
     {
         $this->listtitle = $a_listtitle;
     }

◆ setNoJSLinkClass()

ilAdvancedSelectionListGUI::setNoJSLinkClass ( string $a_nojslinkclass )

Definition at line 287 of file class.ilAdvancedSelectionListGUI.php.

                                                              : void
     {
         $this->nojslinkclass = $a_nojslinkclass;
     }

◆ setOnClickMode()

ilAdvancedSelectionListGUI::setOnClickMode	(	string	$a_val,
		string	$a_onclick_form_id = `""`
	)

Set "onClick"- Mode.

Valid values are: ilAdvancedSelectionList::ON_ITEM_CLICK_HREF or ilAdvancedSelectionList::ON_ITEM_CLICK_FORM_SUBMIT ilAdvancedSelectionList::ON_ITEM_CLICK_FORM_SELECT

Definition at line 355 of file class.ilAdvancedSelectionListGUI.php.

      : void {
         $this->on_click = $a_val;
         $this->on_click_form_id = $a_onclick_form_id;
     }

◆ setPullRight()

ilAdvancedSelectionListGUI::setPullRight ( bool $a_val )

Definition at line 429 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setSelectCallback()

ilAdvancedSelectionListGUI::setSelectCallback ( string $a_val )

Definition at line 419 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setSelectedValue()

ilAdvancedSelectionListGUI::setSelectedValue ( string $a_val )

Definition at line 368 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setSelectionHeaderClass()

ilAdvancedSelectionListGUI::setSelectionHeaderClass ( string $a_selectionheaderclass )

DEPRECATED use set style instead.

Deprecated:

Definition at line 241 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setSelectionHeaderSpanClass()

ilAdvancedSelectionListGUI::setSelectionHeaderSpanClass ( string $a_val )

Definition at line 267 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setStyle()

ilAdvancedSelectionListGUI::setStyle ( int $a_val )

Parameters

int $a_val button style STYLE_DEFAULT, STYLE_LINK, STYLE_EMPH

Definition at line 254 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setTriggerEvent()

ilAdvancedSelectionListGUI::setTriggerEvent ( string $a_val )

Definition at line 327 of file class.ilAdvancedSelectionListGUI.php.

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

◆ setUseImages()

ilAdvancedSelectionListGUI::setUseImages ( bool $a_useimages )

Definition at line 317 of file class.ilAdvancedSelectionListGUI.php.

                                                    : void
     {
         $this->useimages = $a_useimages;
     }

Field Documentation

◆ $access_key

bool ilAdvancedSelectionListGUI::$access_key = false

protected

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

◆ $aria_listtitle

string ilAdvancedSelectionListGUI::$aria_listtitle = ""

protected

Definition at line 61 of file class.ilAdvancedSelectionListGUI.php.

◆ $asynch

bool ilAdvancedSelectionListGUI::$asynch = false

private

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

Referenced by getAsynch().

◆ $asynch_url

string ilAdvancedSelectionListGUI::$asynch_url = ''

protected

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

Referenced by getAsynchUrl().

◆ $auto_hide

bool ilAdvancedSelectionListGUI::$auto_hide = false

protected

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

Referenced by getAutoHide().

◆ $css_row

string ilAdvancedSelectionListGUI::$css_row = ""

protected

Definition at line 49 of file class.ilAdvancedSelectionListGUI.php.

◆ $dd_pullright

bool ilAdvancedSelectionListGUI::$dd_pullright = true

private

Definition at line 58 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getPullRight().

◆ $form_mode

array ilAdvancedSelectionListGUI::$form_mode

protected

Initial value:

= [

"select_name" => ''

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

◆ $global_tpl

ilGlobalTemplateInterface ilAdvancedSelectionListGUI::$global_tpl

protected

Definition at line 90 of file class.ilAdvancedSelectionListGUI.php.

◆ $grouped_list

ilGroupedListGUI ilAdvancedSelectionListGUI::$grouped_list = null

protected

Definition at line 56 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getGroupedList().

◆ $headericon

string ilAdvancedSelectionListGUI::$headericon = ""

protected

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

Referenced by getHeaderIcon().

◆ $id

string ilAdvancedSelectionListGUI::$id = "asl"

private

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

Referenced by getId().

◆ $itemlinkclass

string ilAdvancedSelectionListGUI::$itemlinkclass = ''

protected

Definition at line 63 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getItemLinkClass().

◆ $items

array ilAdvancedSelectionListGUI::$items = array()

private

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

Referenced by getItems().

◆ $links_mode

array ilAdvancedSelectionListGUI::$links_mode = []

protected

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

◆ $listtitle

string ilAdvancedSelectionListGUI::$listtitle = ""

protected

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

Referenced by getListTitle().

◆ $lng

ilLanguage ilAdvancedSelectionListGUI::$lng

protected

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

◆ $mode

string ilAdvancedSelectionListGUI::$mode = ""

protected

Definition at line 64 of file class.ilAdvancedSelectionListGUI.php.

◆ $nojslinkclass

string ilAdvancedSelectionListGUI::$nojslinkclass = ""

protected

Definition at line 68 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getNoJSLinkClass().

◆ $on_click

string ilAdvancedSelectionListGUI::$on_click = ""

protected

Definition at line 69 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getOnClickMode().

◆ $on_click_form_id

string ilAdvancedSelectionListGUI::$on_click_form_id

protected

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

◆ $renderer

ILIAS UI Renderer ilAdvancedSelectionListGUI::$renderer

private

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

◆ $sel_head_span_class

string ilAdvancedSelectionListGUI::$sel_head_span_class = ''

protected

Definition at line 86 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getSelectionHeaderSpanClass().

◆ $select_callback

string ilAdvancedSelectionListGUI::$select_callback = ''

protected

Definition at line 85 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getSelectCallback().

◆ $selected_value

string ilAdvancedSelectionListGUI::$selected_value = ""

protected

Definition at line 53 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getSelectedValue().

◆ $selectionheaderclass

string ilAdvancedSelectionListGUI::$selectionheaderclass = ""

protected

Definition at line 66 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getSelectionHeaderClass().

◆ $style

int ilAdvancedSelectionListGUI::$style = 0

protected

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

Referenced by getStyle().

◆ $toggle

array ilAdvancedSelectionListGUI::$toggle = null

protected

Definition at line 51 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getAdditionalToggleElement().

◆ $trigger_event

string ilAdvancedSelectionListGUI::$trigger_event = "click"

protected

Definition at line 54 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getTriggerEvent().

◆ $useimages

bool ilAdvancedSelectionListGUI::$useimages = false

protected

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

Referenced by getUseImages().

◆ DOWN_ARROW_DARK

const ilAdvancedSelectionListGUI::DOWN_ARROW_DARK = "down_arrow_dark"

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

Referenced by ilAdvSelectInputGUI\getAdvSelection(), ilPCParagraphGUI\getCharStyleSelector(), ilPCParagraphGUI\getStyleSelector(), ilObjectListGUI\insertCommands(), ilCalendarPresentationGUI\prepareOutput(), ilNewsTimelineItemGUI\render(), and ilDashboardGUI\show().

◆ ICON_ARROW

const ilAdvancedSelectionListGUI::ICON_ARROW = "caret"

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

◆ ICON_CONFIG

const ilAdvancedSelectionListGUI::ICON_CONFIG = "glyphicon glyphicon-cog"

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

Referenced by ilBlockGUI\fillHeaderCommands().

◆ MODE_FORM_SELECT

const ilAdvancedSelectionListGUI::MODE_FORM_SELECT = "select"

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

◆ MODE_LINKS

const ilAdvancedSelectionListGUI::MODE_LINKS = "links"

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

◆ NO_ICON

const ilAdvancedSelectionListGUI::NO_ICON = ""

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

Referenced by ilNavigationHistoryGUI\getHTML().

◆ ON_ITEM_CLICK_FORM_SELECT

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SELECT = "select"

Definition at line 41 of file class.ilAdvancedSelectionListGUI.php.

Referenced by ilAdvSelectInputGUI\getAdvSelection(), and ilPCParagraphGUI\getStyleSelector().

◆ ON_ITEM_CLICK_FORM_SUBMIT

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SUBMIT = "submit"

Definition at line 40 of file class.ilAdvancedSelectionListGUI.php.

◆ ON_ITEM_CLICK_HREF

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF = "href"

Definition at line 39 of file class.ilAdvancedSelectionListGUI.php.

◆ ON_ITEM_CLICK_NOP

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_NOP = "nop"

Definition at line 42 of file class.ilAdvancedSelectionListGUI.php.

Referenced by ilPCParagraphGUI\getCharStyleSelector().

◆ select_class

array ilAdvancedSelectionListGUI::select_class

Initial value:

=> '',
        "include_form_tag" => false,
        "form_action" => '',
        "form_id" => '',
        "form_class" => '',
        "form_target" => '',
        "button_text" => '',
        "button_class" => '',
        "button_cmd" => ''
    ]

Definition at line 74 of file class.ilAdvancedSelectionListGUI.php.

◆ STYLE_DEFAULT

const ilAdvancedSelectionListGUI::STYLE_DEFAULT = 0

Definition at line 44 of file class.ilAdvancedSelectionListGUI.php.

◆ STYLE_EMPH

const ilAdvancedSelectionListGUI::STYLE_EMPH = 2

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

Referenced by ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilEmployeeTalkMyStaffUserGUI\loadActionBar(), and ilObjectAddNewItemGUI\render().

◆ STYLE_LINK

const ilAdvancedSelectionListGUI::STYLE_LINK = 1

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

Referenced by ilWikiFunctionsBlockGUI\getLegacyContent().

◆ STYLE_LINK_BUTTON

const ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON = 3

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

Referenced by ilTable2GUI\fillFooter(), and ilBlockGUI\fillHeaderCommands().

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

Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ addComponent()

◆ addItem()

◆ flush()

◆ getAdditionalToggleElement()

◆ getAriaListTitle()

◆ getAsynch()

◆ getAsynchUrl()

◆ getAutoHide()

◆ getGroupedList()

◆ getHeaderIcon()

◆ getHTML()

◆ getId()

◆ getItemLinkClass()

◆ getItems()

◆ getJSTemplate()

◆ getListTitle()

◆ getNoJSLinkClass()

◆ getOnClickMode()

◆ getOnloadCode()

◆ getPullRight()

◆ getSelectCallback()

◆ getSelectedValue()

◆ getSelectionHeaderClass()

◆ getSelectionHeaderSpanClass()

◆ getStyle()

◆ getToolbarHTML()

◆ getTriggerEvent()

◆ getUseImages()

◆ setAdditionalToggleElement()

◆ setAriaListTitle()

◆ setAsynch()

◆ setAsynchUrl()

◆ setAutoHide()

◆ setFormSelectMode()

◆ setGroupedList()

◆ setHeaderIcon()

◆ setId()

◆ setItemLinkClass()

◆ setLinksMode()

◆ setListTitle()

◆ setNoJSLinkClass()

◆ setOnClickMode()

◆ setPullRight()

◆ setSelectCallback()

◆ setSelectedValue()

◆ setSelectionHeaderClass()

◆ setSelectionHeaderSpanClass()

◆ setStyle()

◆ setTriggerEvent()

◆ setUseImages()

Field Documentation

◆ $access_key

◆ $aria_listtitle

◆ $asynch

◆ $asynch_url

◆ $auto_hide

◆ $css_row

◆ $dd_pullright

◆ $form_mode

◆ $global_tpl

◆ $grouped_list

◆ $headericon

◆ $id

◆ $itemlinkclass

◆ $items

◆ $links_mode

◆ $listtitle

◆ $lng

◆ $mode

◆ $nojslinkclass

◆ $on_click

◆ $on_click_form_id

◆ $renderer