NavigationItem Class Reference

Inheritance diagram for NavigationItem:

Public Member Functions
	__construct ($oParent)
	getLevel ()
	getChildren ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	hasChildren ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	isRoot ()
	isCurrent ()
	isActive ()
	isSiblingOfCurrent ()
	isSiblingOfActive ()
	isChildOfCurrent ()
	isDescendantOfCurrent ()
	getTitle ($sLanguageId=null)
	getLinkText ($sLanguageId=null)
	getDescription ($sLanguageId=null)
	getName ()
	getType ()
	getIdentifier ()
	getLink ()
	getId ()
	getParent ()
	getFirstChild ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	getCanonical ($sLanguageId=null)
	isProtected ()
	isAccessible ()
	isVisible ()
	isEnabled ()
	isFolder ()
	isVirtual ()
	addChild (NavigationItem $oChild)
	namedChild ($sName, $sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	isIndexed ()
	__sleep ()

Protected Member Functions
	getChildrenImpl ($sLanguageId, $bIncludeDisabled, $bIncludeInvisible)
	hasChildrenImpl ($sLanguageId, $bIncludeDisabled, $bIncludeInvisible)
	getCustomChildren ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	hasCustomChildren ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
	getIdImpl ()
	getCanonicalImpl ($sLanguageId=null)

Protected Attributes
	$oParent
	$aCustomChildren
	$aChildren

Member Function Documentation

NavigationItem::getIdImpl ( )

abstractprotected

Gets a value uniquely identifying this navigation item. This could be a full path or an internal id of the backing store. Note: This is NOT the same as the identifier retrieved using getIdentifier()) as that is allowed to return null in some implementations.

NavigationItem::isIndexed

(

)

Returns

Whether to include this navigation item in the search index

---

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

• cms-full/base/lib/classes/NavigationItem.php