Inheritance diagram for ilToolbarGUI:

Collaboration diagram for ilToolbarGUI:

Public Member Functions
	__construct ()

	setFormAction ($a_val, $a_multipart=false, $a_target="")
	Set form action (if form action is set, toolbar is wrapped into form tags) More...

	getFormAction ()
	Get form action. More...

	setLeadingImage ($a_img, $a_alt)
	Set leading image. More...

	setHidden ($a_val)
	Set hidden. More...

	getHidden ()
	Get hidden. More...

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

	getId ()
	Get id. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	addButton ( $a_txt, $a_cmd, $a_target="", $a_acc_key="", $a_additional_attrs='', $a_id="", $a_class='submit')
	Add button to toolbar. More...

	addFormButton ($a_txt, $a_cmd, $a_acc_key="", $a_primary=false, $a_class=false)
	Add form button to toolbar. More...

	addInputItem (ilToolbarItem $a_item, $a_output_label=false)
	Add input item. More...

	addStickyItem ($a_item, $a_output_label=false)
	Add a sticky item. More...

	addButtonInstance (ilButtonBase $a_button)
	Add button instance. More...

	addDropDown ($a_txt, $a_dd_html)
	Add input item. More...

	addSeparator ()
	Add separator. More...

	addText ($a_text)
	Add text. More...

	addSpacer ($a_width=null)
	Add spacer. More...

	addComponent (\ILIAS\UI\Component\Component $a_comp)
	Add component. More...

	addLink ($a_caption, $a_url, $a_disabled=false)
	Add link. More...

	setOpenFormTag ($a_val)
	Set open form tag. More...

	getOpenFormTag ()
	Get open form tag. More...

	setCloseFormTag ($a_val)
	Set close form tag. More...

	getCloseFormTag ()
	Get close form tag. More...

	setFormName ($a_val)
	Set form name. More...

	getFormName ()
	Get form name. More...

	getGroupedItems ()
	Get all groups (items separated by a separator) More...

	getItems ()

	setItems ($items)

Data Fields
	$items = array()

Protected Member Functions
	applyAutoStickyToSingleElement ()
	If the toolbar consists of only one button, make it sticky Note: Atm this is only possible for buttons. More...

Protected Attributes
	$lng

	$id = ''

	$form_action = ''

	$hidden

	$lead_img

	$open_form_tag = true

	$close_form_tag = true

	$form_target = ""

	$form_name = ""

	$prevent_double_submission = false

	$sticky_items = array()

	$has_separator = false

Static Protected Attributes
static	$instances = 0

Detailed Description

Toolbar.

The toolbar currently only supports a list of buttons as links.

A default toolbar object is available in the $ilToolbar global object.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilToolbarGUI::__construct ( )

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

References $DIC.

     {
         global $DIC;
         $this->lng = $DIC->language();
 
         $this->ui = $DIC->ui();
 
         self::$instances++;
     }

Member Function Documentation

◆ addButton()

ilToolbarGUI::addButton	(	$a_txt,
		$a_cmd,
		$a_target = `""`,
		$a_acc_key = `""`,
		$a_additional_attrs = `''`,
		$a_id = `""`,
		$a_class = `'submit'`
	)

Add button to toolbar.

Deprecated:: use addButtonInstance() instead!

Parameters

string	text
string	link href / submit command
string	frame target
string	access key

Definition at line 209 of file class.ilToolbarGUI.php.

References array.

Referenced by ilTestResultsToolbarGUI\build(), ilObjTestGUI\populateQuestionBrowserToolbarButtons(), ilBookingScheduleGUI\render(), ilBookingObjectGUI\render(), ilMembershipGUI\showMailToMemberToolbarButton(), and ilMembershipGUI\showMemberExportToolbarButton().

       {
         $this->items[] = array("type" => "button", "txt" => $a_txt, "cmd" => $a_cmd,
             "target" => $a_target, "acc_key" => $a_acc_key, 'add_attrs' => $a_additional_attrs,
             "id" => $a_id, "class" => $a_class);
     }

Here is the caller graph for this function:

◆ addButtonInstance()

ilToolbarGUI::addButtonInstance ( ilButtonBase $a_button )

Add button instance.

Parameters

ilButtonBase $a_button

Definition at line 280 of file class.ilToolbarGUI.php.

References addStickyItem(), array, and ilButtonBase\isPrimary().

Referenced by ilTestNavigationToolbarGUI\addFinishTestButton(), ilTestNavigationToolbarGUI\addQuestionListButton(), ilTestNavigationToolbarGUI\addQuestionSelectionButton(), ilTestNavigationToolbarGUI\addQuestionTreeButton(), ilTestNavigationToolbarGUI\addSuspendTestButton(), ilTestResultsToolbarGUI\build(), and ilTestSkillEvaluationToolbarGUI\build().

     {
         if ($a_button->isPrimary()) {
             $this->addStickyItem($a_button);
         } else {
             $this->items[] = array("type" => "button_obj", "instance" => $a_button);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addComponent()

ilToolbarGUI::addComponent ( \ILIAS\UI\Component\Component $a_comp )

Add component.

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

References array.

     {
         $this->items[] = array("type" => "component", "component" => $a_comp);
     }

◆ addDropDown()

ilToolbarGUI::addDropDown	(	$a_txt,
		$a_dd_html
	)

Add input item.

Definition at line 293 of file class.ilToolbarGUI.php.

References array.

     {
         $this->items[] = array("type" => "dropdown", "txt" => $a_txt, "dd_html" => $a_dd_html);
     }

◆ addFormButton()

ilToolbarGUI::addFormButton	(	$a_txt,
		$a_cmd,
		$a_acc_key = `""`,
		$a_primary = `false`,
		$a_class = `false`
	)

Add form button to toolbar.

Deprecated:: use addButtonInstance() instead!

Parameters

string	text
string	link href / submit command
string	access key
bool	primary action
string	css class

Definition at line 234 of file class.ilToolbarGUI.php.

References addStickyItem(), array, and ilSubmitButton\getInstance().

Referenced by ilDidacticTemplateGUI\appendToolbarSwitch(), ilAssQuestionPreviewToolbarGUI\build(), ilTestSkillEvaluationToolbarGUI\build(), ilTestInfoScreenToolbarGUI\build(), and ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\populateNewQuestionSelectionRuleInputs().

     {
         if ($a_primary) {
             $button = ilSubmitButton::getInstance();
             $button->setPrimary(true);
             $button->setCaption($a_txt, false);
             $button->setCommand($a_cmd);
             $button->setAccessKey($a_acc_key);
             $this->addStickyItem($button);
         } else {
             $this->items[] = array("type" => "fbutton", "txt" => $a_txt, "cmd" => $a_cmd,
                 "acc_key" => $a_acc_key, "primary" => $a_primary, "class" => $a_class);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addInputItem()

ilToolbarGUI::addInputItem	(	ilToolbarItem	$a_item,
			$a_output_label = `false`
	)

Add input item.

Parameters

ilToolbarItem	$a_item
bool	$a_output_label

Definition at line 256 of file class.ilToolbarGUI.php.

References array.

Referenced by ilDidacticTemplateGUI\appendToolbarSwitch(), ilTestResultsToolbarGUI\build(), and ilTestSkillEvaluationToolbarGUI\build().

     {
         $this->items[] = array("type" => "input", "input" => $a_item, "label" => $a_output_label);
     }

Here is the caller graph for this function:

◆ addLink()

ilToolbarGUI::addLink	(	$a_caption,
		$a_url,
		$a_disabled = `false`
	)

Add link.

Parameters

string	$a_caption
string	$a_url
boolean	$a_disabled

Definition at line 339 of file class.ilToolbarGUI.php.

References array.

     {
         $this->items[] = array("type" => "link", "txt" => $a_caption, "cmd" => $a_url, "disabled" => $a_disabled);
     }

◆ addSeparator()

ilToolbarGUI::addSeparator ( )

Add separator.

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

References array.

Referenced by ilTestResultsToolbarGUI\build(), ilTestSkillEvaluationToolbarGUI\build(), ilTestInfoScreenToolbarGUI\build(), ilMembershipGUI\showMailToMemberToolbarButton(), and ilMembershipGUI\showMemberExportToolbarButton().

     {
         $this->items[] = array("type" => "separator");
         $this->has_separator = true;
     }

Here is the caller graph for this function:

◆ addSpacer()

ilToolbarGUI::addSpacer ( $a_width = null )

Add spacer.

Definition at line 319 of file class.ilToolbarGUI.php.

References array.

     {
         $this->items[] = array("type" => "spacer", "width" => $a_width);
     }

◆ addStickyItem()

ilToolbarGUI::addStickyItem	(	$a_item,
		$a_output_label = `false`
	)

Add a sticky item.

Sticky items are always visible, also if the toolbar is collapsed (responsive view). Sticky items are displayed first in the toolbar.

Parameters

ilToolbarItem \| \ILIAS\UI\Component\Component	$a_item
bool	$a_output_label

Definition at line 269 of file class.ilToolbarGUI.php.

References array.

Referenced by addButtonInstance(), addFormButton(), and applyAutoStickyToSingleElement().

     {
         $this->sticky_items[] = array("item"=>$a_item, "label"=>$a_output_label);
     }

Here is the caller graph for this function:

◆ addText()

ilToolbarGUI::addText ( $a_text )

Add text.

Definition at line 311 of file class.ilToolbarGUI.php.

References array.

Referenced by ilDidacticTemplateGUI\appendToolbarSwitch().

     {
         $this->items[] = array("type" => "text", "text" => $a_text);
     }

Here is the caller graph for this function:

◆ applyAutoStickyToSingleElement()

ilToolbarGUI::applyAutoStickyToSingleElement ( )

protected

If the toolbar consists of only one button, make it sticky Note: Atm this is only possible for buttons.

If we are dealing with objects implementing the ilToolbarItem interface one day, other elements can be added as sticky.

Definition at line 669 of file class.ilToolbarGUI.php.

References addStickyItem(), array, ilSubmitButton\getInstance(), and ilLinkButton\getInstance().

Referenced by getGroupedItems().

     {
         if (count($this->items) == 1 && count($this->sticky_items) == 0) {
             $supported_types = array('button', 'fbutton', 'button_obj');
             $item = $this->items[0];
             if (!in_array($item['type'], $supported_types)) {
                 return;
             }
             $button = null;
             switch ($item['type']) {
                 case 'button_obj':
                     $button = $item['instance'];
                     break;
                 case 'fbutton':
                     $button = ilSubmitButton::getInstance();
                     $button->setPrimary($item['primary']);
                     $button->setCaption($item['txt'], false);
                     $button->setCommand($item['cmd']);
                     $button->setAccessKey($item['acc_key']);
                     break;
                 case 'button':
                     $button = ilLinkButton::getInstance();
                     $button->setCaption($item['txt'], false);
                     $button->setUrl($item['cmd']);
                     $button->setTarget($item['target']);
                     $button->setId($item['id']);
                     $button->setAccessKey($item['acc_key']);
                     break;
             }
             $this->addStickyItem($button);
             $this->items = array();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCloseFormTag()

ilToolbarGUI::getCloseFormTag ( )

Get close form tag.

Returns: boolean close form tag

Definition at line 379 of file class.ilToolbarGUI.php.

References $close_form_tag.

Referenced by getGroupedItems().

     {
         return $this->close_form_tag;
     }

Here is the caller graph for this function:

◆ getFormAction()

ilToolbarGUI::getFormAction ( )

Get form action.

Returns: string form action

Definition at line 122 of file class.ilToolbarGUI.php.

References $form_action.

Referenced by getGroupedItems().

     {
         return $this->form_action;
     }

Here is the caller graph for this function:

◆ getFormName()

ilToolbarGUI::getFormName ( )

Get form name.

Returns: string form name

Definition at line 399 of file class.ilToolbarGUI.php.

References $form_name.

Referenced by getGroupedItems().

     {
         return $this->form_name;
     }

Here is the caller graph for this function:

◆ getGroupedItems()

ilToolbarGUI::getGroupedItems ( )

Get all groups (items separated by a separator)

Returns: array

Definition at line 410 of file class.ilToolbarGUI.php.

References $GLOBALS, $i, $lng, $tpl, applyAutoStickyToSingleElement(), array, ilAccessKeyGUI\getAttribute(), getCloseFormTag(), getFormAction(), getFormName(), getHidden(), getId(), getOpenFormTag(), and getPreventDoubleSubmission().

     {
         $groups = array();
         $group = array();
         foreach ($this->items as $item) {
             if ($item['type'] == 'separator') {
                 $groups[] = $group;
                 $group = array();
             } else {
                 $group[] = $item;
             }
         }
         if (count($group)) {
             $groups[] = $group;
         }
 
         return $groups;
     }

Here is the call graph for this function:

◆ getHidden()

ilToolbarGUI::getHidden ( )

Get hidden.

Returns: boolean hidden

Definition at line 154 of file class.ilToolbarGUI.php.

References $hidden.

Referenced by getGroupedItems().

     {
         return $this->hidden;
     }

Here is the caller graph for this function:

◆ getId()

ilToolbarGUI::getId ( )

Get id.

Returns: string id

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

Referenced by ilTestInfoScreenToolbarGUI\build(), and getGroupedItems().

     {
         return $this->id ? $this->id : self::$instances;
     }

Here is the caller graph for this function:

◆ getItems()

ilToolbarGUI::getItems ( )

Returns: array

Definition at line 649 of file class.ilToolbarGUI.php.

References $items.

Referenced by ilTestInfoScreenToolbarGUI\build().

     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ getOpenFormTag()

ilToolbarGUI::getOpenFormTag ( )

Get open form tag.

Returns: boolean open form tag

Definition at line 359 of file class.ilToolbarGUI.php.

References $open_form_tag.

Referenced by getGroupedItems().

     {
         return $this->open_form_tag;
     }

Here is the caller graph for this function:

◆ getPreventDoubleSubmission()

ilToolbarGUI::getPreventDoubleSubmission ( )

Get prevent double submission.

Returns: bool prevent double submission

Definition at line 194 of file class.ilToolbarGUI.php.

References $prevent_double_submission.

Referenced by getGroupedItems().

     {
         return $this->prevent_double_submission;
     }

Here is the caller graph for this function:

◆ setCloseFormTag()

ilToolbarGUI::setCloseFormTag ( $a_val )

Set close form tag.

Parameters

boolean $a_val close form tag

Definition at line 369 of file class.ilToolbarGUI.php.

     {
         $this->close_form_tag = $a_val;
     }

◆ setFormAction()

ilToolbarGUI::setFormAction	(	$a_val,
		$a_multipart = `false`,
		$a_target = `""`
	)

Set form action (if form action is set, toolbar is wrapped into form tags)

Parameters

string	$a_val	form action
bool	$a_multipart
string	$a_target

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

Referenced by ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\build(), and ilTestSkillEvaluationToolbarGUI\build().

     {
         $this->form_action = $a_val;
         $this->multipart = $a_multipart;
         $this->form_target = $a_target;
     }

Here is the caller graph for this function:

◆ setFormName()

ilToolbarGUI::setFormName ( $a_val )

Set form name.

Parameters

string $a_val form name

Definition at line 389 of file class.ilToolbarGUI.php.

     {
         $this->form_name = $a_val;
     }

◆ setHidden()

ilToolbarGUI::setHidden ( $a_val )

Set hidden.

Parameters

boolean $a_val hidden

Definition at line 144 of file class.ilToolbarGUI.php.

     {
         $this->hidden = $a_val;
     }

◆ setId()

ilToolbarGUI::setId ( $a_val )

Set id.

Parameters

string $a_val id

Definition at line 164 of file class.ilToolbarGUI.php.

Referenced by ilTestResultsToolbarGUI\build().

     {
         $this->id = $a_val;
     }

Here is the caller graph for this function:

◆ setItems()

ilToolbarGUI::setItems ( $items )

Parameters

array $items

Definition at line 658 of file class.ilToolbarGUI.php.

References $items.

Referenced by ilTestInfoScreenToolbarGUI\clearItems().

     {
         $this->items = $items;
     }

Here is the caller graph for this function:

◆ setLeadingImage()

ilToolbarGUI::setLeadingImage	(	$a_img,
		$a_alt
	)

Set leading image.

Parameters

string	$a_img
string	$a_alt

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

References array.

     {
         $this->lead_img = array("img" => $a_img, "alt" => $a_alt);
     }

◆ setOpenFormTag()

ilToolbarGUI::setOpenFormTag ( $a_val )

Set open form tag.

Parameters

boolean $a_val open form tag

Definition at line 349 of file class.ilToolbarGUI.php.

     {
         $this->open_form_tag = $a_val;
     }

◆ setPreventDoubleSubmission()

ilToolbarGUI::setPreventDoubleSubmission ( $a_val )

Set prevent double submission.

Parameters

bool $a_val prevent double submission

Definition at line 184 of file class.ilToolbarGUI.php.

     {
         $this->prevent_double_submission = $a_val;
     }

Field Documentation

◆ $close_form_tag

ilToolbarGUI::$close_form_tag = true

protected

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

Referenced by getCloseFormTag().

◆ $form_action

ilToolbarGUI::$form_action = ''

protected

Definition at line 38 of file class.ilToolbarGUI.php.

Referenced by getFormAction().

◆ $form_name

ilToolbarGUI::$form_name = ""

protected

Definition at line 76 of file class.ilToolbarGUI.php.

Referenced by getFormName().

◆ $form_target

ilToolbarGUI::$form_target = ""

protected

Definition at line 71 of file class.ilToolbarGUI.php.

◆ $has_separator

ilToolbarGUI::$has_separator = false

protected

Definition at line 91 of file class.ilToolbarGUI.php.

◆ $hidden

ilToolbarGUI::$hidden

protected

Definition at line 43 of file class.ilToolbarGUI.php.

Referenced by getHidden().

◆ $id

ilToolbarGUI::$id = ''

protected

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

◆ $instances

ilToolbarGUI::$instances = 0

staticprotected

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

◆ $items

ilToolbarGUI::$items = array()

Definition at line 48 of file class.ilToolbarGUI.php.

Referenced by getItems(), and setItems().

◆ $lead_img

ilToolbarGUI::$lead_img

protected

Initial value:

= array(
        'img' => '',
        'alt' => '',
    )

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

◆ $lng

ilToolbarGUI::$lng

protected

Definition at line 22 of file class.ilToolbarGUI.php.

Referenced by getGroupedItems().

◆ $open_form_tag

ilToolbarGUI::$open_form_tag = true

protected

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

Referenced by getOpenFormTag().

◆ $prevent_double_submission

ilToolbarGUI::$prevent_double_submission = false

protected

Definition at line 81 of file class.ilToolbarGUI.php.

Referenced by getPreventDoubleSubmission().

◆ $sticky_items

ilToolbarGUI::$sticky_items = array()

protected

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

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

Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addButton()

◆ addButtonInstance()

◆ addComponent()

◆ addDropDown()

◆ addFormButton()

◆ addInputItem()

◆ addLink()

◆ addSeparator()

◆ addSpacer()

◆ addStickyItem()

◆ addText()

◆ applyAutoStickyToSingleElement()

◆ getCloseFormTag()

◆ getFormAction()

◆ getFormName()

◆ getGroupedItems()

◆ getHidden()

◆ getId()

◆ getItems()

◆ getOpenFormTag()

◆ getPreventDoubleSubmission()

◆ setCloseFormTag()

◆ setFormAction()

◆ setFormName()

◆ setHidden()

◆ setId()

◆ setItems()

◆ setLeadingImage()

◆ setOpenFormTag()

◆ setPreventDoubleSubmission()

Field Documentation

◆ $close_form_tag

◆ $form_action

◆ $form_name

◆ $form_target

◆ $has_separator

◆ $hidden

◆ $id

◆ $instances

◆ $items

◆ $lead_img

◆ $lng

◆ $open_form_tag

◆ $prevent_double_submission

◆ $sticky_items