Inheritance diagram for NavigationMenuItem:

Public Member Functions
	getContent ($locale)

	getContextId ()

	getIsChildVisible ()

	getIsDisplayed ()

	getLocalizedContent ()

	getLocalizedRemoteUrl ()

	getLocalizedTitle ()

	getPath ()

	getRemoteUrl ($locale)

	getSequence ()

	getTitle ($locale)

	getTitleLocaleKey ()

	getType ()

	getUrl ()

	setContent ($content, $locale)

	setContextId ($contextId)

	setIsChildVisible ($isChildVisible)

	setIsDisplayed ($isDisplayed)

	setPath ($path)

	setRemoteUrl ($url, $locale)

	setSequence ($seq)

	setTitle ($title, $locale)

	setTitleLocaleKey ($titleLocaleKey)

	setType ($type)

	setUrl ($url)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	getMetadataFieldNames ($translated=true)

	getSetMetadataFieldNames ($translated=true)

	getSupportedExtractionAdapters ()

	getSupportedInjectionAdapters ()

	getSupportedMetadataSchemas ()

	hasData ($key, $locale=null)

	injectMetadata ($metadataDescription)

	removeSupportedMetadataAdapter ($metadataSchemaName)

	setAllData (&$data)

	setData ($key, $value, $locale=null)

	setHasLoadableAdapters ($hasLoadableAdapters)

	setId ($id)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Data Fields
	$_isChildVisible = false

	$_isDisplayed = true

	$navigationMenuItems = array()

Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

Basic class describing a NavigationMenuItem.

See also: NavigationMenuItemDAO

Definition at line 36 of file NavigationMenuItem.inc.php.

Member Function Documentation

◆ getContent()

NavigationMenuItem::getContent ( $locale )

Get the content of the navigation menu item.

Parameters

$locale string

Returns: string

Definition at line 153 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getContextId()

NavigationMenuItem::getContextId ( )

Get contextId for this navigation menu item.

Returns: int

Definition at line 102 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getIsChildVisible()

NavigationMenuItem::getIsChildVisible ( )

Get $isChildVisible for this navigation menu item.

Returns: boolean true if at least one NMI child is visible. It is defined at the Service functionality level

Definition at line 202 of file NavigationMenuItem.inc.php.

References $_isChildVisible.

◆ getIsDisplayed()

NavigationMenuItem::getIsDisplayed ( )

Get $isDisplayed for this navigation menu item.

Returns: boolean

Definition at line 186 of file NavigationMenuItem.inc.php.

References $_isDisplayed.

◆ getLocalizedContent()

NavigationMenuItem::getLocalizedContent ( )

Get the content of the navigation Menu.

Returns: string

Definition at line 144 of file NavigationMenuItem.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedRemoteUrl()

NavigationMenuItem::getLocalizedRemoteUrl ( )

Get the remoteUrl of the navigation Menu.

Returns: string

Definition at line 234 of file NavigationMenuItem.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedTitle()

NavigationMenuItem::getLocalizedTitle ( )

Get the title of the navigation Menu.

Returns: string

Definition at line 118 of file NavigationMenuItem.inc.php.

References DataObject\getLocalizedData().

◆ getPath()

NavigationMenuItem::getPath ( )

Get path for this navigation menu item.

Returns: string

Definition at line 62 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getRemoteUrl()

NavigationMenuItem::getRemoteUrl ( $locale )

Get the remoteUrl of the navigation menu item.

Parameters

$locale string

Definition at line 242 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getSequence()

NavigationMenuItem::getSequence ( )

Get seq for this navigation menu item.

Returns: int

Definition at line 170 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getTitle()

NavigationMenuItem::getTitle ( $locale )

Get the title of the navigation menu item.

Parameters

$locale string

Returns: string

Definition at line 127 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getTitleLocaleKey()

NavigationMenuItem::getTitleLocaleKey ( )

Get the titleLocaleKey of the navigation Menu.

Returns: string

Definition at line 218 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getType()

NavigationMenuItem::getType ( )

Get type for this navigation menu item.

Returns: string

Definition at line 94 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ getUrl()

NavigationMenuItem::getUrl ( )

Get url for this navigation menu item.

Returns: string

Definition at line 78 of file NavigationMenuItem.inc.php.

References DataObject\getData().

◆ setContent()

NavigationMenuItem::setContent	(	$content,
		$locale
	)

Set the content of the navigation menu item.

Parameters

$content	string
$locale	string

Definition at line 162 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setContextId()

NavigationMenuItem::setContextId ( $contextId )

Set context_id for this navigation menu item.

Parameters

$contextId int

Definition at line 110 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setIsChildVisible()

NavigationMenuItem::setIsChildVisible ( $isChildVisible )

Set $isChildVisible for this navigation menu item.

Parameters

$isChildVisible boolean true if at least one NMI child is visible. It is defined at the Service functionality level

Definition at line 210 of file NavigationMenuItem.inc.php.

◆ setIsDisplayed()

NavigationMenuItem::setIsDisplayed ( $isDisplayed )

Set $isDisplayed for this navigation menu item.

Parameters

$isDisplayed boolean

Definition at line 194 of file NavigationMenuItem.inc.php.

◆ setPath()

NavigationMenuItem::setPath ( $path )

Set path for this navigation menu item.

Parameters

$path string

Definition at line 54 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setRemoteUrl()

NavigationMenuItem::setRemoteUrl	(	$url,
		$locale
	)

Set the remoteUrl of the navigation menu item.

Parameters

$url	string
$locale	string

Definition at line 251 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setSequence()

NavigationMenuItem::setSequence ( $seq )

Set seq for this navigation menu item.

Parameters

$seq int

Definition at line 178 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setTitle()

NavigationMenuItem::setTitle	(	$title,
		$locale
	)

Set the title of the navigation menu item.

Parameters

$title	string
$locale	string

Definition at line 136 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setTitleLocaleKey()

NavigationMenuItem::setTitleLocaleKey ( $titleLocaleKey )

Set titleLocaleKey for this navigation menu item.

Parameters

$titleLocaleKey string

Definition at line 226 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setType()

NavigationMenuItem::setType ( $type )

Set type for this navigation menu item.

Parameters

$type string

Definition at line 86 of file NavigationMenuItem.inc.php.

References DataObject\setData().

◆ setUrl()

NavigationMenuItem::setUrl ( $url )

Set url for this navigation menu item.

Parameters

$url string

Definition at line 70 of file NavigationMenuItem.inc.php.

References DataObject\setData().

Field Documentation

◆ $_isChildVisible

NavigationMenuItem::$_isChildVisible = false

Definition at line 44 of file NavigationMenuItem.inc.php.

Referenced by getIsChildVisible().

◆ $_isDisplayed

NavigationMenuItem::$_isDisplayed = true

Definition at line 43 of file NavigationMenuItem.inc.php.

Referenced by getIsDisplayed().

◆ $navigationMenuItems

$navigationMenuItems NavigationMenuItem::$navigationMenuItems = array()

array The navigationMenuItems underneath this navigationMenuItem

Definition at line 41 of file NavigationMenuItem.inc.php.

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

NavigationMenuItem.inc.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getContent()

◆ getContextId()

◆ getIsChildVisible()

◆ getIsDisplayed()

◆ getLocalizedContent()

◆ getLocalizedRemoteUrl()

◆ getLocalizedTitle()

◆ getPath()

◆ getRemoteUrl()

◆ getSequence()

◆ getTitle()

◆ getTitleLocaleKey()

◆ getType()

◆ getUrl()

◆ setContent()

◆ setContextId()

◆ setIsChildVisible()

◆ setIsDisplayed()

◆ setPath()

◆ setRemoteUrl()

◆ setSequence()

◆ setTitle()

◆ setTitleLocaleKey()

◆ setType()

◆ setUrl()

Field Documentation

◆ $_isChildVisible

◆ $_isDisplayed

◆ $navigationMenuItems