Extra menus event - Revision history

Twilllig at 10:54, 28 April 2023

2023-04-28T10:54:07Z

← Older revision		Revision as of 12:54, 28 April 2023
Line 74:		Line 74:
	\| getMenuItems \|\| Return array of dropdown menu items		\| getMenuItems \|\| Return array of dropdown menu items
	\|-		\|-
	\| isPrepended \|\| Returns true if the item is displayed on the left side of the admin menu		\| isInMiddleSection \|\| Returns true if the item is displayed in the middle section of the admin menu (LS6)
			\|-
			\| isPrepended \|\| Returns true if the item is displayed on the left side of the admin menu section
	\|-		\|-
	\| isButton \|\| Returns true if the item is a button		\| isButton \|\| Returns true if the item is a button

Twilllig: /* Examples */

2023-04-28T08:19:03Z

Examples

← Older revision		Revision as of 10:19, 28 April 2023
Line 22:		Line 22:
	$event = $this->getEvent();		$event = $this->getEvent();
	$event->set('extraMenus', array(		$event->set('extraMenus', array(
	new ~~ExtraMenu~~(array(		new Menu(array(
	'isDropDown' => true,		'isDropDown' => true,
	'menuItems' => array(		'menuItems' => array(
	new ~~ExtraMenuItem~~(null),		new MenuItem(null),
	new ~~ExtraMenuItem~~(null),		new MenuItem(null),
	new ~~ExtraMenuItem~~(array('isDivider' => true)),		new MenuItem(array('isDivider' => true)),
	new ~~ExtraMenuItem~~(null)		new MenuItem(null)
	)		)
	))		))
Line 56:		Line 56:
	$event->append('extraMenus', [$menuTestButton]);		$event->append('extraMenus', [$menuTestButton]);
	</syntaxhighlight>		</syntaxhighlight>


	== Interfaces ==		== Interfaces ==

Twilllig at 06:34, 7 October 2022

2022-10-07T06:34:00Z

← Older revision		Revision as of 08:34, 7 October 2022
Line 39:		Line 39:


	And this example shows how to add a button menu item on the left side of the admin menu:		And this example shows how to add a button menu item on the left side of the admin menu (since LimeSurvey 5.4):

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 45:		Line 45:
	$buttonTestOptions = [		$buttonTestOptions = [
	'buttonId' => 'test-button',		'buttonId' => 'test-button',
	'label' => "Test button",		'label' => 'Test button',
	'href' => 'https://limesurvey.org',		'href' => 'https://limesurvey.org',
	'iconClass' => 'fa fa-link',		'iconClass' => 'fa fa-link',
	'openInNewTab' => true,		'openInNewTab' => true,
	'isPrepended' => true,		'isPrepended' => true,
	'tooltip' => "You can add a tooltip here",		'tooltip' => 'You can add a tooltip here',
	];		];

Twilllig at 15:11, 6 October 2022

2022-10-06T15:11:16Z

← Older revision		Revision as of 17:11, 6 October 2022
Line 1:		Line 1:
	Description of the event to generate extra menus at top bar (besides configuration, logout, etc).		Description of the event to generate extra menus at top bar (besides configuration, logout, etc).

	~~Two~~ types of menus:		Three types of menus:
	* Dropdown		* Dropdown
	* Link		* Link
			* Button (since LimeSurvey 5.4)

	For dropdown, we have two kinds of menu items:		For dropdown, we have two kinds of menu items:
Line 13:		Line 14:
	Plugin will set property <code>extraMenus</code>. Each element in that array must implement interface <code>ExtraMenuInterface</code>.		Plugin will set property <code>extraMenus</code>. Each element in that array must implement interface <code>ExtraMenuInterface</code>.

	== ~~Example~~ ==		== Examples ==

	This example with create a dropdown menu with three empty menu items and one divider:		This example with create a dropdown menu with three empty menu items and one divider:
Line 32:		Line 33:
	));		));
	</syntaxhighlight>		</syntaxhighlight>


	How it would look:		How it would look:

	[[File:extramenu.jpg]]		[[File:extramenu.jpg]]


			And this example shows how to add a button menu item on the left side of the admin menu:

			<syntaxhighlight lang="php">
			$event = $this->getEvent();
			$buttonTestOptions = [
			'buttonId' => 'test-button',
			'label' => "Test button",
			'href' => 'https://limesurvey.org',
			'iconClass' => 'fa fa-link',
			'openInNewTab' => true,
			'isPrepended' => true,
			'tooltip' => "You can add a tooltip here",
			];

			$menuTestButton = new \LimeSurvey\Menu\MenuButton($buttonTestOptions);
			$event->append('extraMenus', [$menuTestButton]);
			</syntaxhighlight>


	== Interfaces ==		== Interfaces ==
Line 54:		Line 74:
	\|-		\|-
	\| getMenuItems \|\| Return array of dropdown menu items		\| getMenuItems \|\| Return array of dropdown menu items
			\|-
			\| isPrepended \|\| Returns true if the item is displayed on the left side of the admin menu
			\|-
			\| isButton \|\| Returns true if the item is a button
	\|}		\|}

Olle: /* Interfaces */

2016-04-27T22:51:52Z

Interfaces

← Older revision		Revision as of 00:51, 28 April 2016
Line 44:		Line 44:
	\|-		\|-
	\| isDropDown \|\| Returns true if this menu is a dropdown menu		\| isDropDown \|\| Returns true if this menu is a dropdown menu
			\|-
			\| isSmallText \|\| Returns true if this item is a small text header (uses label as text)
	\|-		\|-
	\| getLabel \|\| Returns the actual name of the menu		\| getLabel \|\| Returns the actual name of the menu
			\|-
			\| getIconClass \|\| Return CSS class for icon to display left of link
	\|-		\|-
	\| getHref \|\| If it's not a dropdown menu, this is just for the link		\| getHref \|\| If it's not a dropdown menu, this is just for the link

Olle: /* Interfaces */

2016-04-25T20:49:58Z

Interfaces

← Older revision		Revision as of 22:49, 25 April 2016
Line 61:		Line 61:
	\| getLabel \|\| The text for the link		\| getLabel \|\| The text for the link
	\|-		\|-
	\| isDivider \|\| Return true if the item is a divider ~~(kind of like <hr>)~~		\| isDivider \|\| Return true if the item is a divider
	\|}		\|}

Olle: /* Interfaces */

2016-04-25T20:49:44Z

Interfaces

← Older revision		Revision as of 22:49, 25 April 2016
Line 60:		Line 60:
	\|-		\|-
	\| getLabel \|\| The text for the link		\| getLabel \|\| The text for the link
			\|-
			\| isDivider \|\| Return true if the item is a divider (kind of like <hr>)
	\|}		\|}

Olle: /* Example */

2016-04-25T20:45:32Z

Example

← Older revision		Revision as of 22:45, 25 April 2016
Line 20:		Line 20:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$event = $this->getEvent();		$event = $this->getEvent();
	~~$event->set('extraMenus', array(~~
	~~new ExtraMenu(null)~~
	~~));~~
	$event->set('extraMenus', array(		$event->set('extraMenus', array(
	new ExtraMenu(array(		new ExtraMenu(array(

Olle: /* Example */

2016-04-25T20:44:43Z

Example

← Older revision		Revision as of 22:44, 25 April 2016
Line 16:		Line 16:

	This example with create a dropdown menu with three empty menu items and one divider:		This example with create a dropdown menu with three empty menu items and one divider:


	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">

Olle: /* Example */

2016-04-25T20:44:34Z

Example

← Older revision		Revision as of 22:44, 25 April 2016
Line 37:		Line 37:

	How it would look:		How it would look:


	[[File:extramenu.jpg]]		[[File:extramenu.jpg]]