NavigationMenuItemAssignment Class Reference

Inheritance diagram for NavigationMenuItemAssignment:

Public Member Functions
	getLocalizedTitle ()
	getMenuId ()
	getMenuItem ()
	getMenuItemId ()
	getParentId ()
	getSequence ()
	getTitle ($locale)
	setMenuId ($menuId)
	setMenuItem ($obj)
	setMenuItemId ($menuItemId)
	setParentId ($parentId)
	setSequence ($seq)
	setTitle ($title, $locale)
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
	$children = array()
	$navigationMenuItem = null
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

Basic class describing a NavigationMenuItemAssignment. Each assignment describes a NavigationMenuItem assigned to a NavigationMenu, including it's position and if it's nested within another NavigationMenuItem.

Operations for retrieving and modifying NavigationMenuItemAssignment objects.

See also

NavigationMenuItemAssignmentDAO

NavigationMenuItem

Definition at line 19 of file NavigationMenuItemAssignment.inc.php.

Member Function Documentation

getLocalizedTitle()

NavigationMenuItemAssignment::getLocalizedTitle

(

)

Get the title of the object.

Returns

string

Definition at line 123 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getLocalizedData().

getMenuId()

NavigationMenuItemAssignment::getMenuId

(

)

Get menuId for this navigation menu item assignment.

Returns

int

Definition at line 39 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getData().

getMenuItem()

NavigationMenuItemAssignment::getMenuItem

(

)

Get the NavigationMenuItem this assignment represents.

This object is only available in some cases, when the NavigationMenuItem has been stored for re-use.

Returns

int

Definition at line 107 of file NavigationMenuItemAssignment.inc.php.

References $navigationMenuItem.

getMenuItemId()

NavigationMenuItemAssignment::getMenuItemId

(

)

Get menuItemId for this navigation menu item assignment.

Returns

int

Definition at line 55 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getData().

getParentId()

NavigationMenuItemAssignment::getParentId

(

)

Get parent menu item ID

Returns

int

Definition at line 71 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getData().

getSequence()

NavigationMenuItemAssignment::getSequence

(

)

Get seq for this navigation menu item.

Returns

int

Definition at line 87 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getData().

getTitle()

NavigationMenuItemAssignment::getTitle

(

$locale

)

Get the title of the object.

Parameters

$locale

string

Returns

string

Definition at line 132 of file NavigationMenuItemAssignment.inc.php.

References DataObject\getData().

setMenuId()

NavigationMenuItemAssignment::setMenuId

(

$menuId

)

Set menuId for this navigation menu item assignment.

Parameters

$menuId

int

Definition at line 47 of file NavigationMenuItemAssignment.inc.php.

References DataObject\setData().

setMenuItem()

NavigationMenuItemAssignment::setMenuItem

(

$obj

)

Set the NavigationMenuItem this assignment represents

Parameters

$seq

int

Definition at line 115 of file NavigationMenuItemAssignment.inc.php.

setMenuItemId()

NavigationMenuItemAssignment::setMenuItemId

(

$menuItemId

)

Set menuItemId for this navigation menu item assignment.

Parameters

$menuItemId

int

Definition at line 63 of file NavigationMenuItemAssignment.inc.php.

References DataObject\setData().

setParentId()

NavigationMenuItemAssignment::setParentId

(

$parentId

)

Set parent menu item ID

Parameters

$parentId

int

Definition at line 79 of file NavigationMenuItemAssignment.inc.php.

References DataObject\setData().

setSequence()

NavigationMenuItemAssignment::setSequence

(

$seq

)

Set seq for this navigation menu item.

Parameters

$seq

int

Definition at line 95 of file NavigationMenuItemAssignment.inc.php.

References DataObject\setData().

setTitle()

NavigationMenuItemAssignment::setTitle	(		$title,
			$locale
	)

Set the title of the object.

Parameters

$title	string
$locale	string

Definition at line 141 of file NavigationMenuItemAssignment.inc.php.

References DataObject\setData().

Field Documentation

$children

$children NavigationMenuItemAssignment::$children = array()

array List of NavigationMenuItem objects nested under this one.

Definition at line 30 of file NavigationMenuItemAssignment.inc.php.

$navigationMenuItem

$navigationMenuItem NavigationMenuItemAssignment::$navigationMenuItem = null

NavigationMenuItem The object this assignment refers to

Definition at line 24 of file NavigationMenuItemAssignment.inc.php.

Referenced by getMenuItem().

---

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

• NavigationMenuItemAssignment.inc.php