MidCOM NAP Constants

From OpenPSA Wiki

MidCOM NAP info such as the current Node and Leaf URL can be accessed via midcom.helper.nav, and is returned in a key => value array. The keys can be found below. It is also possible to access the values for NAP nodes or leaves. The global NAP instance can be retrieved with this method:

$_MIDCOM->get_context_data(MIDCOM_CONTEXT_NAP);

[edit] NAP constants

• MIDCOM_NAV_ACL
• MIDCOM_NAV_ADMIN
• MIDCOM_NAV_COMPONENT - the name of the current Component
• MIDCOM_NAV_GUID
• MIDCOM_NAV_ICON
• MIDCOM_NAV_ID - The ID of the element in question.
• MIDCOM_NAV_INTERNAL - To be documented...
• MIDCOM_NAV_LEAVES
• MIDCOM_NAV_NAME - The clear text name of the element in question.
• MIDCOM_NAV_NODEID - Some Uplink ID to another node.
• MIDCOM_NAV_NOENTRY
• MIDCOM_NAV_OBJECT
• MIDCOM_NAV_SCORE - The object's numerical position in the sorting order under its node.
• MIDCOM_NAV_SITE - returns an array
• MIDCOM_NAV_SUBNODES - Yet unused.
• MIDCOM_NAV_TYPE - The Type of the element in question ("node" or "leaf").
• MIDCOM_NAV_TOOLBAR
• MIDCOM_NAV_VIEWERGROUPS
• MIDCOM_NAV_VISIBLE - Should this node be displayed? (may be deprecated)

[edit] URLs

• MIDCOM_NAV_ABSOLUTEURL - The absolute URL of the current Topic, excluding the domain name, Host prefix and Page
• MIDCOM_NAV_FULLURL - The full URL, including the domain name
• MIDCOM_NAV_PERMALINK
• MIDCOM_NAV_RELATIVEURL - The URL name of the element in question (relative to the Root Topic of the current Page or Host)
• MIDCOM_NAV_URL - The URL name of the element in question (relative to the Topic of the current MidCOM Component).

[edit] MidCOM NAP Sorting Modes

• MIDCOM_NAVORDER_DEFAULT
• MIDCOM_NAVORDER_ARTICLESFIRST
• MIDCOM_NAVORDER_TOPICSFIRST
• MIDCOM_NAVORDER_SCORE