Inheritance diagram for ElggMenuItem:

Public Member Functions
	__construct ($name, $text, $href)
	\ElggMenuItem constructor More...

	setData ($key, $value=null)
	Set a data key/value pair or a set of key/value pairs. More...

	getData ($key)
	Get stored data. More...

	setName ($name)
	Set the identifier of the menu item. More...

	getName ()
	Get the identifier of the menu item. More...

	setText ($text)
	Set the display text of the menu item. More...

	getText ()
	Get the display text of the menu item. More...

	setHref ($href)
	Set the URL of the menu item. More...

	getHref ()
	Get the URL of the menu item. More...

	setContext ($contexts)
	Set the contexts that this menu item is available for. More...

	getContext ()
	Get an array of context strings. More...

	inContext ($context='')
	Should this menu item be used given the current context. More...

	setSelected ($state=true)
	Set the selected flag. More...

	getSelected ()
	Get selected state. More...

	setTooltip ($text)
	Set the tool tip text. More...

	getTooltip ()
	Get the tool tip text. More...

	setConfirmText ($text)
	Set the confirm text shown when link is clicked. More...

	getConfirmText ()
	Get the confirm text. More...

	setLinkClass ($class)
	Set the anchor class. More...

	getLinkClass ()
	Get the anchor classes as text. More...

	addLinkClass ($class)
	Add a link class. More...

	setDeps ($modules)
	Set required ES modules. More...

	getDeps ()
	Get required ES modules. More...

	addDeps ($modules)
	Add required ES modules. More...

	setChildMenuOptions (array $options=[])
	Set child menu options for a parent item. More...

	getChildMenuOptions ()
	Returns child menu options for parent items. More...

	setItemClass ($class)
	Set the li classes. More...

	getItemClass ()
	Get the li classes as text. More...

	addItemClass ($class)
	Add a li class. More...

	setPriority (int $priority)
	Set the priority of the menu item. More...

	getPriority ()
	Get the priority of the menu item. More...

	setSection ($section)
	Set the section identifier. More...

	getSection ()
	Get the section identifier. More...

	setParentName ($name)
	Set the parent identifier. More...

	getParentName ()
	Get the parent identifier. More...

	setParent ($parent)
	Set the parent menu item. More...

	getParent ()
	Get the parent menu item. More...

	addChild ($item)
	Add a child menu item. More...

	setChildren ($children)
	Set the menu item's children. More...

	getChildren ()
	Get the children menu items. More...

	sortChildren ($sortFunction)
	Sort the children. More...

	getValues ()
	Get all the values for this menu item. More...

	getID ()
	Get unique item identifier within a collection. More...

	setItemContentsView (string $view_name)
	Set the item contents view. More...

	getItemContentsView ()
	Get the item contents view. More...

	hasItemContentsView ()
	Check if the menu items has a contents view set. More...

Static Public Member Functions
static	factory (array $options)
	Create an ElggMenuItem from an associative array. More...

Protected Member Functions
	addClass (array &$current, $additional)
	Add additional classes. More...

Protected Attributes
	$data

	$text

	$href = null

	$title = false

	$confirm = ''

Detailed Description

Elgg Menu Item.

To create a menu item that is not a link, pass false for $href.

Any undocumented properties set will be passed to the output/url view during rendering. E.g. to give a menu item a "target" attribute, set $item->target, or include a "target" key in the options array for factory().

Since: 1.8.0

Definition at line 14 of file ElggMenuItem.php.

Constructor & Destructor Documentation

◆ __construct()

ElggMenuItem::__construct	(	$name,
		$text,
		$href
	)

\ElggMenuItem constructor

Parameters

string	$name	Identifier of the menu item
string	$text	Display text of the menu item (HTML)
string	$href	URL of the menu item (false if not a link)

Definition at line 90 of file ElggMenuItem.php.

Member Function Documentation

◆ addChild()

ElggMenuItem::addChild ( $item )

Add a child menu item.

Parameters

\ElggMenuItem $item A child menu item

Returns: void

Definition at line 633 of file ElggMenuItem.php.

◆ addClass()

ElggMenuItem::addClass	(	array &	$current,
			$additional
	)

protected

Add additional classes.

Parameters

array	$current	The current array of classes
mixed	$additional	Additional classes (either array of string)

Returns: void

Definition at line 532 of file ElggMenuItem.php.

◆ addDeps()

ElggMenuItem::addDeps ( $modules )

Add required ES modules.

Parameters

string[] | string $modules One or more required ES modules

Returns: void

Definition at line 455 of file ElggMenuItem.php.

◆ addItemClass()

ElggMenuItem::addItemClass ( $class )

Add a li class.

Parameters

mixed $class An array of class names, or a single string class name.

Returns: void

Since: 1.9.0

Definition at line 520 of file ElggMenuItem.php.

◆ addLinkClass()

ElggMenuItem::addLinkClass ( $class )

Add a link class.

Parameters

mixed $class An array of class names, or a single string class name.

Returns: void

Definition at line 421 of file ElggMenuItem.php.

◆ factory()

static ElggMenuItem::factory ( array $options )

static

Create an ElggMenuItem from an associative array.

Required keys are name, text, and href.

Commonly used params: name => STR Menu item identifier (required) text => STR Menu item display text as HTML (required) href => STR Menu item URL (required) false = do not create a link. null = current URL. "" = current URL. "/" = site home page.

section => STR Menu section identifier link_class => STR A class or classes for the tag item_class => STR A class or classes for the tag parent_name => STR Identifier of the parent menu item contexts => ARR Page context strings title => STR Menu item tooltip selected => BOOL Is this menu item currently selected? confirm => STR If set, the link will be drawn with the output/confirmlink view instead of output/url. deps => ARR ES modules required by this menu item child_menu => ARR Options for the child menu data => ARR Custom attributes stored in the menu item.

Parameters

array $options Option array of key value pairs

Returns: \ElggMenuItem

Exceptions

Definition at line 130 of file ElggMenuItem.php.

◆ getChildMenuOptions()

ElggMenuItem::getChildMenuOptions ( )

Returns child menu options for parent items.

Returns: array

Definition at line 476 of file ElggMenuItem.php.

◆ getChildren()

ElggMenuItem::getChildren ( )

Get the children menu items.

Returns: ElggMenuItem[]

Definition at line 657 of file ElggMenuItem.php.

◆ getConfirmText()

ElggMenuItem::getConfirmText ( )

Get the confirm text.

Returns: string

Definition at line 386 of file ElggMenuItem.php.

◆ getContext()

ElggMenuItem::getContext ( )

Get an array of context strings.

Returns: array

Definition at line 291 of file ElggMenuItem.php.

◆ getData()

ElggMenuItem::getData ( $key )

Get stored data.

Parameters

string $key The key for the requested key/value pair

Returns: mixed

Definition at line 208 of file ElggMenuItem.php.

◆ getDeps()

ElggMenuItem::getDeps ( )

Get required ES modules.

Returns: string[]

Definition at line 441 of file ElggMenuItem.php.

◆ getHref()

ElggMenuItem::getHref ( )

Get the URL of the menu item.

Returns: string|false|null

Definition at line 267 of file ElggMenuItem.php.

◆ getID()

ElggMenuItem::getID ( )

Get unique item identifier within a collection.

Returns: string|int

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 697 of file ElggMenuItem.php.

◆ getItemClass()

ElggMenuItem::getItemClass ( )

Get the li classes as text.

Returns: string

Definition at line 500 of file ElggMenuItem.php.

◆ getItemContentsView()

ElggMenuItem::getItemContentsView ( )

Get the item contents view.

Returns: string|null

Since: 4.2

Definition at line 719 of file ElggMenuItem.php.

◆ getLinkClass()

ElggMenuItem::getLinkClass ( )

Get the anchor classes as text.

Returns: string

Definition at line 410 of file ElggMenuItem.php.

◆ getName()

ElggMenuItem::getName ( )

Get the identifier of the menu item.

Returns: string

Definition at line 228 of file ElggMenuItem.php.

◆ getParent()

ElggMenuItem::getParent ( )

Get the parent menu item.

Returns: \ElggMenuItem or null

Definition at line 620 of file ElggMenuItem.php.

◆ getParentName()

ElggMenuItem::getParentName ( )

Get the parent identifier.

Returns: string

Definition at line 596 of file ElggMenuItem.php.

◆ getPriority()

ElggMenuItem::getPriority ( )

Get the priority of the menu item.

Returns: int

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 556 of file ElggMenuItem.php.

◆ getSection()

ElggMenuItem::getSection ( )

Get the section identifier.

Returns: string

Definition at line 576 of file ElggMenuItem.php.

◆ getSelected()

ElggMenuItem::getSelected ( )

Get selected state.

Returns: bool

Definition at line 337 of file ElggMenuItem.php.

◆ getText()

ElggMenuItem::getText ( )

Get the display text of the menu item.

Returns: string The display text as HTML

Definition at line 247 of file ElggMenuItem.php.

◆ getTooltip()

ElggMenuItem::getTooltip ( )

Get the tool tip text.

Returns: string

Definition at line 366 of file ElggMenuItem.php.

◆ getValues()

ElggMenuItem::getValues ( )

Get all the values for this menu item.

Useful for rendering.

Returns: array

Since: 1.9.0

Definition at line 685 of file ElggMenuItem.php.

◆ hasItemContentsView()

ElggMenuItem::hasItemContentsView ( )

Check if the menu items has a contents view set.

Returns: bool

Since: 4.2

Definition at line 729 of file ElggMenuItem.php.

◆ inContext()

ElggMenuItem::inContext ( $context = '' )

Should this menu item be used given the current context.

Parameters

string $context A context string (default is empty string for current context stack).

Returns: bool

Definition at line 303 of file ElggMenuItem.php.

◆ setChildMenuOptions()

ElggMenuItem::setChildMenuOptions ( array $options = [] )

Set child menu options for a parent item.

Parameters

array $options Options

Returns: void

Definition at line 467 of file ElggMenuItem.php.

◆ setChildren()

ElggMenuItem::setChildren ( $children )

Set the menu item's children.

Parameters

ElggMenuItem[] $children Array of items

Returns: void

Definition at line 646 of file ElggMenuItem.php.

◆ setConfirmText()

ElggMenuItem::setConfirmText ( $text )

Set the confirm text shown when link is clicked.

Parameters

string $text The text to show

Returns: void

Definition at line 377 of file ElggMenuItem.php.

◆ setContext()

ElggMenuItem::setContext ( $contexts )

Set the contexts that this menu item is available for.

Parameters

array $contexts An array of context strings. Use 'all' to match all contexts.

Returns: void

Definition at line 278 of file ElggMenuItem.php.

◆ setData()

ElggMenuItem::setData	(	$key,
		$value = `null`
	)

Set a data key/value pair or a set of key/value pairs.

This method allows storage of arbitrary data with this menu item. The data can be used for sorting, custom rendering, or any other use.

Parameters

mixed	$key	String key or an associative array of key/value pairs
mixed	$value	The value if $key is a string

Returns: void

Definition at line 193 of file ElggMenuItem.php.

◆ setDeps()

ElggMenuItem::setDeps ( $modules )

Set required ES modules.

Parameters

string[] | string $modules One or more required ES modules

Returns: void

Definition at line 432 of file ElggMenuItem.php.

◆ setHref()

ElggMenuItem::setHref ( $href )

Set the URL of the menu item.

Parameters

string $href URL or false if not a link

Returns: void

Definition at line 258 of file ElggMenuItem.php.

◆ setItemClass()

ElggMenuItem::setItemClass ( $class )

Set the li classes.

Parameters

mixed $class An array of class names, or a single string class name.

Returns: void

Definition at line 487 of file ElggMenuItem.php.

◆ setItemContentsView()

ElggMenuItem::setItemContentsView ( string $view_name )

Set the item contents view.

Parameters

string $view_name the name of the output view

Returns: void

Since: 4.2

Definition at line 709 of file ElggMenuItem.php.

◆ setLinkClass()

ElggMenuItem::setLinkClass ( $class )

Set the anchor class.

Parameters

mixed $class An array of class names, or a single string class name.

Returns: void

Definition at line 397 of file ElggMenuItem.php.

◆ setName()

ElggMenuItem::setName ( $name )

Set the identifier of the menu item.

Parameters

string $name Unique identifier

Returns: void

Definition at line 219 of file ElggMenuItem.php.

◆ setParent()

ElggMenuItem::setParent ( $parent )

Set the parent menu item.

Parameters

\ElggMenuItem $parent The parent of this menu item

Returns: void

Definition at line 609 of file ElggMenuItem.php.

◆ setParentName()

ElggMenuItem::setParentName ( $name )

Set the parent identifier.

Parameters

string $name The identifier of the parent \ElggMenuItem

Returns: void

Definition at line 587 of file ElggMenuItem.php.

◆ setPriority()

ElggMenuItem::setPriority ( int $priority )

Set the priority of the menu item.

Parameters

int $priority The smaller numbers mean higher priority (1 before 100)

Returns: void

Definition at line 547 of file ElggMenuItem.php.

◆ setSection()

ElggMenuItem::setSection ( $section )

Set the section identifier.

Parameters

string $section The identifier of the section

Returns: void

Definition at line 567 of file ElggMenuItem.php.

◆ setSelected()

ElggMenuItem::setSelected ( $state = true )

Set the selected flag.

Parameters

bool $state Selected state (default is true)

Returns: void

Definition at line 328 of file ElggMenuItem.php.

◆ setText()

ElggMenuItem::setText ( $text )

Set the display text of the menu item.

Parameters

string $text The display text as HTML

Returns: void

Definition at line 238 of file ElggMenuItem.php.

◆ setTooltip()

ElggMenuItem::setTooltip ( $text )

Set the tool tip text.

Parameters

string $text The text of the tool tip

Returns: void

Definition at line 357 of file ElggMenuItem.php.

◆ sortChildren()

ElggMenuItem::sortChildren ( $sortFunction )

Sort the children.

Parameters

callable $sortFunction A function that is passed to usort()

Returns: void

Definition at line 670 of file ElggMenuItem.php.

Member Data Documentation

◆ $confirm

ElggMenuItem::$confirm = ''

protected

Definition at line 81 of file ElggMenuItem.php.

◆ $data

ElggMenuItem::$data

protected

Definition at line 19 of file ElggMenuItem.php.

◆ $href

ElggMenuItem::$href = null

protected

Definition at line 71 of file ElggMenuItem.php.

◆ $text

ElggMenuItem::$text

protected

Definition at line 66 of file ElggMenuItem.php.

◆ $title

ElggMenuItem::$title = false

protected

Definition at line 76 of file ElggMenuItem.php.

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

engine/classes/ElggMenuItem.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addChild()

◆ addClass()

◆ addDeps()

◆ addItemClass()

◆ addLinkClass()

◆ factory()

◆ getChildMenuOptions()

◆ getChildren()

◆ getConfirmText()

◆ getContext()

◆ getData()

◆ getDeps()

◆ getHref()

◆ getID()

◆ getItemClass()

◆ getItemContentsView()

◆ getLinkClass()

◆ getName()

◆ getParent()

◆ getParentName()

◆ getPriority()

◆ getSection()

◆ getSelected()

◆ getText()

◆ getTooltip()

◆ getValues()

◆ hasItemContentsView()

◆ inContext()

◆ setChildMenuOptions()

◆ setChildren()

◆ setConfirmText()

◆ setContext()

◆ setData()

◆ setDeps()

◆ setHref()

◆ setItemClass()

◆ setItemContentsView()

◆ setLinkClass()

◆ setName()

◆ setParent()

◆ setParentName()

◆ setPriority()

◆ setSection()

◆ setSelected()

◆ setText()

◆ setTooltip()

◆ sortChildren()

Member Data Documentation

◆ $confirm

◆ $data

◆ $href

◆ $text

◆ $title