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...

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

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

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

	setWeight ($priority)
	Set the priority of the menu item. More...

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

	setPriority ($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...

	getContent (array $vars=array())
	Get the menu item content (usually a link) More...

Static Public Member Functions
static	factory ($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

Examples: /root/Elgg/engine/lib/views.php.

Definition at line 15 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 80 of file ElggMenuItem.php.

Member Function Documentation

◆ addChild()

ElggMenuItem::addChild ( $item )

Add a child menu item.

This is reserved for the \ElggMenuBuilder.

Parameters

\ElggMenuItem $item A child menu item

Returns: void @access private

Definition at line 575 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 451 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 439 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 394 of file ElggMenuItem.php.

◆ factory()

static ElggMenuItem::factory ( $options )

static

Create an ElggMenuItem from an associative array.

Required keys are name, text, and href.

Parameters

array $options Option array of key value pairs

name => STR Menu item identifier (required) text => STR Menu item display text as HTML (required) href => STR Menu item URL (required) (false for non-links.

Warning: If you disable the href the tag will not appear, so the link_class will not apply. If you put tags in manually through the 'text' option the default CSS selector .elgg-menu-$menu > li > a may affect formatting. Wrap in a if it does.)

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. data => ARR Custom attributes stored in the menu item.

Returns: ElggMenuItem or null on error

Definition at line 117 of file ElggMenuItem.php.

◆ getChildren()

ElggMenuItem::getChildren ( )

Get the children menu items.

This is reserved for the \ElggMenuBuilder.

Returns: array @access private

Definition at line 600 of file ElggMenuItem.php.

◆ getConfirmText()

ElggMenuItem::getConfirmText ( )

Get the confirm text.

Returns: string

Definition at line 361 of file ElggMenuItem.php.

◆ getContent()

ElggMenuItem::getContent ( array $vars = array() )

Get the menu item content (usually a link)

Parameters

array $vars Options to pass to output/url if a link

Returns: string

Definition at line 640 of file ElggMenuItem.php.

◆ getContext()

ElggMenuItem::getContext ( )

Get an array of context strings.

Returns: array

Definition at line 280 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 196 of file ElggMenuItem.php.

◆ getHref()

ElggMenuItem::getHref ( )

Get the URL of the menu item.

Returns: string

Definition at line 258 of file ElggMenuItem.php.

◆ getItemClass()

ElggMenuItem::getItemClass ( )

Get the li classes as text.

Returns: string

Definition at line 417 of file ElggMenuItem.php.

◆ getLinkClass()

ElggMenuItem::getLinkClass ( )

Get the anchor classes as text.

Returns: string

Definition at line 384 of file ElggMenuItem.php.

◆ getName()

ElggMenuItem::getName ( )

Get the identifier of the menu item.

Returns: string

Definition at line 219 of file ElggMenuItem.php.

◆ getParent()

ElggMenuItem::getParent ( )

Get the parent menu item.

This is reserved for the \ElggMenuBuilder.

Returns: \ElggMenuItem or null @access private

Definition at line 562 of file ElggMenuItem.php.

◆ getParentName()

ElggMenuItem::getParentName ( )

Get the parent identifier.

Returns: string

Definition at line 537 of file ElggMenuItem.php.

◆ getPriority()

ElggMenuItem::getPriority ( )

Get the priority of the menu item.

Returns: int

Definition at line 499 of file ElggMenuItem.php.

◆ getSection()

ElggMenuItem::getSection ( )

Get the section identifier.

Returns: string

Definition at line 518 of file ElggMenuItem.php.

◆ getSelected()

ElggMenuItem::getSelected ( )

Get selected state.

Returns: bool

Definition at line 323 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 238 of file ElggMenuItem.php.

◆ getTooltip()

ElggMenuItem::getTooltip ( )

Get the tool tip text.

Returns: string

Definition at line 342 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 626 of file ElggMenuItem.php.

◆ getWeight()

ElggMenuItem::getWeight ( )

Get the priority of the menu item.

Returns: int

Definition at line 479 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 291 of file ElggMenuItem.php.

◆ setChildren()

ElggMenuItem::setChildren ( $children )

Set the menu item's children.

This is reserved for the \ElggMenuBuilder.

Parameters

array $children Array of \ElggMenuItems

Returns: void @access private

Definition at line 588 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 352 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 268 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 182 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 249 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 404 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 371 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 210 of file ElggMenuItem.php.

◆ setParent()

ElggMenuItem::setParent ( $parent )

Set the parent menu item.

This is reserved for the \ElggMenuBuilder.

Parameters

\ElggMenuItem $parent The parent of this menu item

Returns: void @access private

Definition at line 550 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 528 of file ElggMenuItem.php.

◆ setPriority()

ElggMenuItem::setPriority ( $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 490 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 509 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 314 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 229 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 333 of file ElggMenuItem.php.

◆ setWeight()

ElggMenuItem::setWeight ( $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 468 of file ElggMenuItem.php.

◆ sortChildren()

ElggMenuItem::sortChildren ( $sortFunction )

Sort the children.

This is reserved for the \ElggMenuBuilder.

Parameters

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

Returns: void @access private

Definition at line 613 of file ElggMenuItem.php.

Member Data Documentation

◆ $confirm

ElggMenuItem::$confirm = ''

protected

Definition at line 70 of file ElggMenuItem.php.

◆ $data

ElggMenuItem::$data

protected

Definition at line 20 of file ElggMenuItem.php.

◆ $href

ElggMenuItem::$href = null

protected

Definition at line 60 of file ElggMenuItem.php.

◆ $text

ElggMenuItem::$text

protected

Definition at line 55 of file ElggMenuItem.php.

◆ $title

ElggMenuItem::$title = false

protected

Definition at line 65 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()

◆ addItemClass()

◆ addLinkClass()

◆ factory()

◆ getChildren()

◆ getConfirmText()

◆ getContent()

◆ getContext()

◆ getData()

◆ getHref()

◆ getItemClass()

◆ getLinkClass()

◆ getName()

◆ getParent()

◆ getParentName()

◆ getPriority()

◆ getSection()

◆ getSelected()

◆ getText()

◆ getTooltip()

◆ getValues()

◆ getWeight()

◆ inContext()

◆ setChildren()

◆ setConfirmText()

◆ setContext()

◆ setData()

◆ setHref()

◆ setItemClass()

◆ setLinkClass()

◆ setName()

◆ setParent()

◆ setParentName()

◆ setPriority()

◆ setSection()

◆ setSelected()

◆ setText()

◆ setTooltip()

◆ setWeight()

◆ sortChildren()

Member Data Documentation

◆ $confirm

◆ $data

◆ $href

◆ $text

◆ $title