Public Member Functions
	condition ($state)

	conditionAll ($state)

	addLink ($url, $label="", Icon $icon=null, array $attributes=[], $index=null, $before=null)

	removeLink ($index)

	addButton ($name, $label, Icon $icon=null, array $attributes=[])

	addCheckbox ($name, $label, bool $checked, array $attributes=[])

	addRadioButton ($name, $label, bool $checked, array $attributes=[])

	addMultiPersonSearch (MultiPersonSearch $mp)

	addSeparator ()

	addCSSClass ($class)

	addAttribute ($key, $value, $append=false)

	render ()

	__toString ()

	setContext (string $context)

	setRenderingMode (?string $mode)

	getRenderingMode ()

	setTitle (string $title)

	generateTitle ()

Static Public Member Functions
static	get ()

Data Fields
const	TEMPLATE_FILE_SINGLE = 'shared/action-menu-single.php'

const	TEMPLATE_FILE_MULTIPLE = 'shared/action-menu.php'

const	RENDERING_MODE_ICONS = 'icons'

const	RENDERING_MODE_MENU = 'menu'

Protected Member Functions
	checkCondition ()

	countActions ()

	getKeyForIndex ($index)

Protected Attributes
	$context = ''

	$rendering_mode = null

Detailed Description

This class represents the action menu used to group actions.

Author: Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version

Since: Stud.IP 3.5

Member Function Documentation

◆ __toString()

__toString ( )

Magic method to render the menu as a string.

Returns: String containing the html representation of the action menu

See also: ActionMenu::render()

◆ addAttribute()

addAttribute	(	$key,
		$value,
		$append = `false`
	)

Adds an attribute to the root element in html.

Parameters

string	$key	Name of the attribute
string	$value	Value of the attribute
boolean	$append	Whether a current value should be append or not.

◆ addButton()

addButton	(		$name,
			$label,
		Icon	$icon = `null`,
		array	$attributes = `[]`
	)

Adds a button to the list of actions.

Parameters

String	$name	Button name
String	$label	Textual representation of the name
mixed	$icon	Optional icon (as Icon object)
array	$attributes	Optional attributes to add to the tag

Returns: ActionMenu instance to allow chaining

◆ addCheckbox()

addCheckbox	(		$name,
			$label,
		bool	$checked,
		array	$attributes = `[]`
	)

Adds a checkbox to the list of actions.

Parameters

String	$name	Input name
String	$label	Label displayed in the menu
bool	$checked	Checked state of the action
array	$attributes	Optional attributes to add to the button

Returns: ActionMenu instance to allow chaining

◆ addCSSClass()

addCSSClass ( $class )

Adds a css classs to the root element in html.

Parameters

string $class Name of the css class

Returns: ActionMenu instance to allow chaining

◆ addLink()

addLink	(		$url,
			$label = `""`,
		Icon	$icon = `null`,
		array	$attributes = `[]`,
			$index = `null`,
			$before = `null`
	)

Adds a link to the list of actions.

Parameters

String \| StudipLink	$url	Link target, eithe as string or Stud.IP link. In the latter case, all other parameters are ignored.
String \| array	$label	Textual representation of the link
mixed	$icon	Optional icon (as Icon object)
array	$attributes	Optional attributes to add to the tag
mixed	$index	Optional index to access this link (remove for example) afterwards
mixed	$before	Optional index to insert this link before the link with given index.

Returns: ActionMenu instance to allow chaining

◆ addMultiPersonSearch()

addMultiPersonSearch ( MultiPersonSearch $mp )

Adds a MultiPersonSearch object to the list of actions.

Parameters

MultiPersonSearch $mp MultiPersonSearch object

Returns: ActionMenu instance to allow chaining

◆ addRadioButton()

addRadioButton	(		$name,
			$label,
		bool	$checked,
		array	$attributes = `[]`
	)

Adds a radio button to the list of actions.

Parameters

String	$name	Input name
String	$label	Label displayed in the menu
bool	$checked	Checked state of the action
array	$attributes	Optional attributes to add to the button

Returns: ActionMenu instance to allow chaining

◆ addSeparator()

addSeparator ( )

Adds a separator line to the list of actions.

Returns: ActionMenu instance to allow chaining

◆ checkCondition()

checkCondition ( )

protected

Checks the condition. Takes global and local (conditionAll() & condition()) conditions into account.

Returns: bool indicating whether the condition is met or not

◆ condition()

condition ( $state )

Set condition for the next added item. If condition is false, the item will not be added.

Parameters

bool $state State of the condition

Returns: ActionMenu instance to allow chaining

◆ conditionAll()

conditionAll ( $state )

Set condition for all the next added items. If condition is false, no items will be added.

Parameters

bool $state State of the condition

Returns: ActionMenu instance to allow chaining

◆ countActions()

countActions ( )

protected

Returns the number of action menu items (not counting separators).

Returns: int count

◆ generateTitle()

generateTitle ( )

Generates the title of the action menu, including its context, if the context has been set.

Returns: string The title of the action menu.

◆ get()

static get ( )

static

Returns an instance.

Returns: ActionMenu

◆ getKeyForIndex()

getKeyForIndex ( $index )

protected

◆ getRenderingMode()

getRenderingMode ( )

Returns the rendering mode for this action menu. This is set by either calling setRenderingMode or automatically determined by the configured threshold.

Returns: string

◆ removeLink()

removeLink ( $index )

Tries to remove the link with the given index and returns true on success (else false)

Parameters

$index : the index of the link. If the link had no special index it's md5($url.json_encode($ttributes)).

Returns: bool : true if link was removed, false if index didn't exist

◆ render()

render ( )

Renders the action menu. If no item was added, an empty string will be returned. If a single item was added, the item itself will be displayed. Otherwise the whole menu will be rendered.

Returns: String containing the html representation of the action menu

◆ setContext()

setContext ( string $context )

Sets the context for the menu.

Parameters

string $context The context to be set.

Returns: ActionMenu The action menu instance (to allow chaining).

◆ setRenderingMode()

setRenderingMode ( ?string $mode )

Forces an explicit rendering mode.

Parameters

string | null $mode The desired rendering mode or null for automatic detection

Returns: ActionMenu The action menu instance to allow chaining

Exceptions

Exception

◆ setTitle()

setTitle ( string $title )

Sets the title for the action menu.

Parameters

string $title display title

Returns: ActionMenu instance to allow chaining

Field Documentation

◆ $context

$context = ''

protected

◆ $rendering_mode

$rendering_mode = null

protected

◆ RENDERING_MODE_ICONS

const RENDERING_MODE_ICONS = 'icons'

◆ RENDERING_MODE_MENU

const RENDERING_MODE_MENU = 'menu'

◆ TEMPLATE_FILE_MULTIPLE

const TEMPLATE_FILE_MULTIPLE = 'shared/action-menu.php'

◆ TEMPLATE_FILE_SINGLE

const TEMPLATE_FILE_SINGLE = 'shared/action-menu-single.php'

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

lib/classes/ActionMenu.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __toString()

◆ addAttribute()

◆ addButton()

◆ addCheckbox()

◆ addCSSClass()

◆ addLink()

◆ addMultiPersonSearch()

◆ addRadioButton()

◆ addSeparator()

◆ checkCondition()

◆ condition()

◆ conditionAll()

◆ countActions()

◆ generateTitle()

◆ get()

◆ getKeyForIndex()

◆ getRenderingMode()

◆ removeLink()

◆ render()

◆ setContext()

◆ setRenderingMode()

◆ setTitle()

Field Documentation

◆ $context

◆ $rendering_mode

◆ RENDERING_MODE_ICONS

◆ RENDERING_MODE_MENU

◆ TEMPLATE_FILE_MULTIPLE

◆ TEMPLATE_FILE_SINGLE