Open Journal Systems  3.3.0
NavigationMenu Class Reference
Inheritance diagram for NavigationMenu:
DataObject

Public Member Functions

 getAreaName ()
 
 getContextId ()
 
 getTitle ()
 
 setAreaName ($areaName)
 
 setContextId ($contextId)
 
 setTitle ($title)
 
- 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

 $menuTree = null
 
- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class describing a NavigationMenu.

See also
NavigationMenuDAO

Definition at line 17 of file NavigationMenu.inc.php.

Member Function Documentation

◆ getAreaName()

NavigationMenu::getAreaName ( )

Get areaName of this NavigationMenu. Not localized.

Returns
string

Definition at line 64 of file NavigationMenu.inc.php.

References DataObject\getData().

◆ getContextId()

NavigationMenu::getContextId ( )

Get contextId of this NavigationMenu

Returns
int

Definition at line 32 of file NavigationMenu.inc.php.

References DataObject\getData().

◆ getTitle()

NavigationMenu::getTitle ( )

Get title of this NavigationMenu. Not localized.

Returns
string

Definition at line 48 of file NavigationMenu.inc.php.

References DataObject\getData().

◆ setAreaName()

NavigationMenu::setAreaName (   $areaName)

Set navigationArea name of this NavigationMenu. Not localized.

Parameters
$areaNamestring

Definition at line 72 of file NavigationMenu.inc.php.

References DataObject\setData().

◆ setContextId()

NavigationMenu::setContextId (   $contextId)

Set contextId of this NavigationMenu

Parameters
$contextIdint

Definition at line 40 of file NavigationMenu.inc.php.

References DataObject\setData().

◆ setTitle()

NavigationMenu::setTitle (   $title)

Set title of this NavigationMenu. Not localized.

Parameters
$titlestring

Definition at line 56 of file NavigationMenu.inc.php.

References DataObject\setData().

Field Documentation

◆ $menuTree

$menuTree NavigationMenu::$menuTree = null

array Hierarchical array of NavigationMenuItems

Definition at line 22 of file NavigationMenu.inc.php.


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