Docs For Class de_linkm_events

Description

Events Navigation interface class

todo: document

Located in /de.linkm.events/navigation.php (line 17)

PEAR
   |
   --midcom_baseclasses_core_object
      |
      --midcom_baseclasses_components_navigation
         |
         --de_linkm_events_navigation

Variable Summary

mixed $_config

midcom_db_topic $_content_topic

mixed $_l10n

mixed $_l10n_midcom

mixed $_schemas

mixed $_topic

Method Summary

de_linkm_events_navigation de_linkm_events_navigation ()

void get_leaves ()

void get_node ()

void _determine_content_topic ()

void _on_set_object ()

Variables

mixed $_config (line 20)

Redefinition of:

midcom_baseclasses_components_navigation::$_config: The current configuration.

midcom_db_topic $_content_topic = null (line 32)

The topic in which to look for articles. This defaults to the current content topic unless overridden by the symlink topic feature.

access: private

mixed $_l10n (line 21)

Redefinition of:

midcom_baseclasses_components_navigation::$_l10n: The components' L10n string database

mixed $_l10n_midcom (line 22)

Redefinition of:

midcom_baseclasses_components_navigation::$_l10n_midcom: The global MidCOM string database

mixed $_schemas = array() (line 23)

mixed $_topic (line 19)

Redefinition of:

midcom_baseclasses_components_navigation::$_topic: The topic for which we are handling a requiest.

Inherited Variables

Inherited from midcom_baseclasses_components_navigation

midcom_baseclasses_components_navigation::$_component
midcom_baseclasses_components_navigation::$_component_data
midcom_baseclasses_components_navigation::$_i18n

Methods

Constructor de_linkm_events_navigation (line 34)

de_linkm_events_navigation de_linkm_events_navigation ()

get_leaves (line 144)

void get_leaves ()

Redefinition of:

midcom_baseclasses_components_navigation::get_leaves(): Leaf listing function, the default implementation returns an empty array indicating no leaves. Note, that the active leaf index set by the other parts of the component must match one leav out of this list.

get_node (line 97)

void get_node ()

Redefinition of:

midcom_baseclasses_components_navigation::get_node(): Return the node configuration. This defaults to use the topic the NAP instance has been set to directly. You can usually fall back to this behavoir safely, adding a toolbar using the $toolbar parameter in child classes.

_determine_content_topic (line 60)

Set the content topic to use. This will check against the configuration setting 'symlink_topic'.

access: protected

void _determine_content_topic ()

_on_set_object (line 43)

This event handler will determine the content topic, which might differ due to a set content symlink.

void _on_set_object ()

Redefinition of:

midcom_baseclasses_components_navigation::_on_set_object(): Event handler called after a new topic has been set. The configuration is already loaded at this point.

Inherited Methods

Inherited From midcom_baseclasses_components_navigation

midcom_baseclasses_components_navigation::midcom_baseclasses_components_navigation()
midcom_baseclasses_components_navigation::get_leaves()
midcom_baseclasses_components_navigation::get_node()
midcom_baseclasses_components_navigation::initialize()
midcom_baseclasses_components_navigation::set_object()
midcom_baseclasses_components_navigation::_on_set_object()

Inherited From midcom_baseclasses_core_object

midcom_baseclasses_core_object::midcom_baseclasses_core_object()