[midcom] element index

Package indexes

All elements

_

top

$_adminmode: midcom_helper__basicnav::$_adminmode in _basicnav.php

This one is true, if the system is in content administration mode and therefore working with a different topic. See Constructor Documentation for details.
$_basicnav: midcom_helper_itemlist::$_basicnav in itemlist.php

A reference to the NAP instance we belong to.
$_basicnav: midcom_helper_nav::$_basicnav in nav.php

A reference to the basicnav instance in use.
$_body: midcom_helper_mailtemplate::$_body in mailtemplate.php

The parsed body.
$_cache: midcom_helper_metadata::$_cache in metadata.php

Holds the values alread read from the database.
$_cached_host_name: midcom_application::$_cached_host_name in application.php

Host name cache to avoid computing it each time.
$_cached_host_prefix: midcom_application::$_cached_host_prefix in application.php

Host prefix cache to avoid computing it each time.
$_client: midcom_application::$_client in application.php

The client status array.
$_component_classes: midcom_helper__componentloader::$_component_classes in _componentloader.php

This is a part of the component cache. It stores references to the COMPONENT classes of the different loaded components, indexed by their MidCOM Path.
$_component_properties: midcom_helper__componentloader::$_component_properties in _componentloader.php

This is a part of the component cache. It stores the properties of the already loaded components.
$_contentadmin_classes: midcom_helper__componentloader::$_contentadmin_classes in _componentloader.php

This is a part of the component cache. It stores references to the Content Administration variant of the COMPONENT classes of the different loaded components, indexed by their MidCOM Path.
$_context: midcom_application::$_context in application.php

Holds the component context information. This is an array of arrays, the outer one indexed by context IDs, thie inner one indexed by context keys. Only valid of the system has left the code-init phase.
$_context: midcom_helper__styleloader::$_context in _styleloader.php

Current context
$_contextid: midcom_helper_nav::$_contextid in nav.php

The context ID we're accociated with.
$_curobject: midcom_helper_urlparser::$_curobject in urlparser.php

Stores a copy of the last parsed object. Type is stored in $_curtype.
$_current: midcom_helper__basicnav::$_current in _basicnav.php

The GUID of the currently active Navigation Node, determied by the active MidCOM Topic or one of its uplinks, if the subtree in question is invisible.
$_currentcomponent: midcom_application::$_currentcomponent in application.php

The active component.
$_currentcontext: midcom_application::$_currentcontext in application.php

Contains the ID of the currently active context or FALSE is none is active.
$_currentleaf: midcom_helper__basicnav::$_currentleaf in _basicnav.php

The GUID of the currently active leaf.
$_current_prefix: midcom_debug::$_current_prefix in debug.php

Current logging prefix
$_curtype: midcom_helper_urlparser::$_curtype in urlparser.php

Stores the type of $_curobject, represented by one of the MIDCOM_HELPER_URLPARSER_... constants.
$_curURL: midcom_helper_urlparser::$_curURL in urlparser.php

This is the URL to the currently requested object in the form
$_datamanager: midcom_helper_metadata::$_datamanager in metadata.php

Datamanager instance for the given object.
$_enabled: midcom_debug::$_enabled in debug.php

Flag which is true if the debugger is enabled.
$_filename: midcom_debug::$_filename in debug.php

Logfile name
$_global: midcom_helper_configuration::$_global in configuration.php

Globally assigned configuration data.
$_guid_map: midcom_helper__basicnav::$_guid_map in _basicnav.php

This map tracks all loaded GUIDs along with their NAP structures. This cache is used by nav's resolve_guid function to short-circut already known GUIDs.
$_i18n: midcom_helper_mailtemplate::$_i18n in mailtemplate.php

I18n service object reference, used for charset conversions.
$_interface_classes: midcom_helper__componentloader::$_interface_classes in _componentloader.php

This is a part of the component cache. It stores references to the interface classes of the different loaded components, indexed by their MidCOM Path.
$_jshead: midcom_application::$_jshead in application.php

String with all JavaScript declarations for the page's head.
$_jsonload: midcom_application::$_jsonload in application.php

Array with all methods for the BODY's onload event.
$_lastgoodnode: midcom_helper__basicnav::$_lastgoodnode in _basicnav.php

This is a temporary storage where _loadNode can return the last known good node in case the current node not visible. It is evaluated by the constructor.
$_leaves: midcom_helper__basicnav::$_leaves in _basicnav.php

This is the leaf cache. It is an array which contains elements indexed by their leaf ID. The data is again stored in an accociative array:
$_link_head: midcom_application::$_link_head in application.php

String with all link elements to be included in a page's head.
$_loaded: midcom_helper__componentloader::$_loaded in _componentloader.php

This indexed array stores the MidCOM paths of all loaded components. Its elements are used as keys for the cache storage.
$_loaded_leaves: midcom_helper__basicnav::$_loaded_leaves in _basicnav.php

This array holds a list of all topics for which the leaves have been loaded.
$_loader: midcom_application::$_loader in application.php

The component loader.
$_loader: midcom_helper__basicnav::$_loader in _basicnav.php

This is a reference to the systemwide component loader class.
$_local: midcom_helper_configuration::$_local in configuration.php

Locally overriden configuration data.
$_loglevel: midcom_debug::$_loglevel in debug.php

Current loglevel
$_mail: midcom_helper_mailtemplate::$_mail in mailtemplate.php

PEAR class in use.
$_mail_mime: midcom_helper_mailtemplate::$_mail_mime in mailtemplate.php

PEAR class in use.
$_memberships: midcom_application::$_memberships in application.php

This array contains the GUIDs of all groups the user authenticated during the constructor was part of. It is used for check_memeberships.
$_merged: midcom_helper_configuration::$_merged in configuration.php

Merged, current configuration state.
$_meta_head: midcom_application::$_meta_head in application.php

string with all metatags to go into the page head.
$_midcom_classes: midcom_helper__componentloader::$_midcom_classes in _componentloader.php

This is a part of the component cache. It stores references to the MIDCOM classes of the different loaded component, indexed by their MidCOM Path.
$_nap_cache: midcom_helper__basicnav::$_nap_cache in _basicnav.php

A reference to the NAP cache store
$_nap_classes: midcom_helper__componentloader::$_nap_classes in _componentloader.php

This is a part of the component cache. It stores references to the NAP classes of the different loaded component, indexed by their MidCOM Path.
$_nodes: midcom_helper__basicnav::$_nodes in _basicnav.php

This is the node cache. It is an array which contains elements indexed by their node ID. The data is again stored in an accociative array:
$_object_head: midcom_application::$_object_head in application.php

string with all object tags to go into a page's head.
$_origArgc: midcom_helper_urlparser::$_origArgc in urlparser.php

The argc value that has been used to initialize the URL parser.
$_origArgv: midcom_helper_urlparser::$_origArgv in urlparser.php

The argv value that has been used to initialize the URL parser.
$_output_classes: midcom_helper__componentloader::$_output_classes in _componentloader.php

This is a part of the component cache. It stores references to the OUTPUT classes of the different loaded component, indexed by their MidCOM Path.
$_parameters: midcom_helper_mailtemplate::$_parameters in mailtemplate.php

The parameters to use for the Mail template.
$_parameters_encoding: midcom_helper_mailtemplate::$_parameters_encoding in mailtemplate.php

The parameter character encoding hint, if unknown, this is null.
$_parsed: midcom_helper_mailtemplate::$_parsed in mailtemplate.php

Flag indicating if the template has already been parsed
$_parser: midcom_application::$_parser in application.php

The URL parser.
$_prefix: midcom_application::$_prefix in application.php

The prefix, which is appended to get_midgard()->self (i.e. the Midgard Page URL). This may be needed when MidCOM is run by wrapper.
$_prefixes: midcom_debug::$_prefixes in debug.php

Prefix stack
$_root: midcom_helper__basicnav::$_root in _basicnav.php

The GUID of the MidCOM Root Content Topic
$_roottopic: midcom_helper_urlparser::$_roottopic in urlparser.php

Stores the Topic from which the parsing has started.
$_schemadb: midcom_helper_metadata::$_schemadb in metadata.php

The schema database to use for this instance.
$_scope: midcom_helper__styleloader::$_scope in _styleloader.php

Current style scope
$_services: midcom_application::$_services in application.php

This is the interface to MidCOMs Object Services. Each service is indexed by its string-name (for example "i18n" for all i18n stuff).
$_snippetdir: midcom_helper__styleloader::$_snippetdir in _styleloader.php

Default style path
$_snippets: midcom_helper__styleloader::$_snippets in _styleloader.php

Default style element cache
$_standard_midgard_sortparams: midcom_helper_itemlist::$_standard_midgard_sortparams in itemlist.php

A list of standard Midgard sorting orders.
$_status: midcom_application::$_status in application.php

Integer constant resembling the current MidCOM state.
$_styles: midcom_helper__styleloader::$_styles in _styleloader.php

Style element cache
$_style_head: midcom_application::$_style_head in application.php

String with all css styles to go into a page's head.
$_subject: midcom_helper_mailtemplate::$_subject in mailtemplate.php

The parsed subject.
$_template: midcom_helper_mailtemplate::$_template in mailtemplate.php

The Mail template, a mailtemplate datamanger type.
$_topic: midcom_helper__styleloader::$_topic in _styleloader.php

Current topic
_basicnav.php: _basicnav.php in _basicnav.php
_componentloader.php: _componentloader.php in _componentloader.php
_styleloader.php: _styleloader.php in _styleloader.php
_charset_convert: midcom_helper_mailtemplate::_charset_convert() in mailtemplate.php

Internal helper doing character conversion for the parameters.
_checkobject: midcom_application::_checkobject() in application.php

Check, wether a given component is able to handle the current request.
_check_index: midcom_helper_toolbar::_check_index() in toolbar.php

Private helper function which checks an index for validity.
_check_leaf_id: midcom_helper__basicnav::_check_leaf_id() in _basicnav.php

Verifies the existence of a given leaf. Call this before getting a leaf from the $_leaves cache. It will load all neccessary nodes/leaves as neccessary.
_check_local_array: midcom_helper_configuration::_check_local_array() in configuration.php

Check local data array for validity
_check_toolbar_permissions: midcom_helper_nav::_check_toolbar_permissions() in nav.php

Checks for the toolbar permissions, uses the cache variables $_user and $_admin to cache the data against repeated calls.
_create_context: midcom_application::_create_context() in application.php

Create and prepare a new component context.
_exec_file: midcom_application::_exec_file() in application.php

This is a heleper to execute any given Script in the current MidCOM context. All files have to be in $component_dir/exec directly, otherwise the script will not execute.
_format_array: midcom_helper_mailtemplate::_format_array() in mailtemplate.php

Helper function to convert an array into a string representation
_format_dm: midcom_helper_mailtemplate::_format_dm() in mailtemplate.php

Helper function to convert a filled datamanager instance into a string representation.
_format_object: midcom_helper_mailtemplate::_format_object() in mailtemplate.php

Helper function to convert an object into a string representation.
_getComponentSnippetdir: midcom_helper__styleloader::_getComponentSnippetdir() in _styleloader.php

Gets the component snippetdir.
_getComponentStyle: midcom_helper__styleloader::_getComponentStyle() in _styleloader.php

Gets the component style.
_get_element_in_styletree: midcom_helper__styleloader::_get_element_in_styletree() in _styleloader.php

Returns a style element that matches $name and is in style $id.
_get_leaves: midcom_helper__basicnav::_get_leaves() in _basicnav.php

Return the list of leaves for a given node. This helper will construct complete leaf data structures for each leaf found. It will first check the cache for the leaf structures, and query the database only if the corresponding objects have not been found there.
_get_leaves_from_database: midcom_helper__basicnav::_get_leaves_from_database() in _basicnav.php

This helper is responsible for loading the leaves for a given node out of the database. It will complete all default fields to provide full blown nap structures.
_get_node: midcom_helper__basicnav::_get_node() in _basicnav.php

This helper object will construct a complete node data structure for a given topic, without any dependant objects like subtopics or leaves. It does not do any visibility checks, it just prepares the object for later processing.
_get_node_from_database: midcom_helper__basicnav::_get_node_from_database() in _basicnav.php

Reads a node data structure from the database, completes all defaults and derived properties (like ViewerGroups).
_get_style_id_from_path: midcom_helper__styleloader::_get_style_id_from_path() in _styleloader.php

Returns the id of the style described by $path.
_handle: midcom_application::_handle() in application.php

Handle the request.
_init: midcom_helper_itemlist::_init() in itemlist.php

Initialize the object, used by the factory function.
_is_object_visible: midcom_helper__basicnav::_is_object_visible() in _basicnav.php

Checks, if the NAP object indicated by $napdata is visible within the current runtime environment. It will work with both nodes and leaves.
_load: midcom_helper__componentloader::_load() in _componentloader.php

This function will load the component specified by the MidCOM path $path. If the component could not be loaded successfully due to integrity errors (missing SnippetDirs, Classes, etc.), it will return false and populate $midcom_errstr accordingly.
_loadconfig: midcom_application::_loadconfig() in application.php

Load the configuration for a given object.
_loadNode: midcom_helper__basicnav::_loadNode() in _basicnav.php

This function is the controlling instance of the loading mechanism. It
_loadNodeData: midcom_helper__basicnav::_loadNodeData() in _basicnav.php

Load the Navigational information accociated with the topic $param, which can be passed as an ID or as a MidgardTopic object. This is differentiated by the flag $idmode (true for id, false for MidgardTopic).
_load_all_dir: midcom_helper__componentloader::_load_all_dir() in _componentloader.php

This function is a helper of load_all. It iterates through the available
_load_leaves: midcom_helper__basicnav::_load_leaves() in _basicnav.php

Loads the leaves for a given node from the cache or database.
_output: midcom_application::_output() in application.php

Execute the output callback.
_populate_client: midcom_application::_populate_client() in application.php

Populates the client status array that can be queried using the get_client() method.
_process: midcom_application::_process() in application.php

Process the request
_retrieve_value: midcom_helper_metadata::_retrieve_value() in metadata.php

Retrieves a given metadata key, postprocesses it where neccessary and stores it into the local cache.
_set_context_data: midcom_application::_set_context_data() in application.php

Update the component context
_set_current_context: midcom_application::_set_current_context() in application.php

Sets a new context, doing some minor sanity checking.
_showdebuglog: midcom_application::_showdebuglog() in application.php

Shows the contents of the current debuglog. You have to enable this interface
_store_from_object: midcom_helper_configuration::_store_from_object() in configuration.php

This function will fetch the configuration data stored in the parameter domain $path of the Midgard Object $object.
_update_cache: midcom_helper_configuration::_update_cache() in configuration.php

This method will merge the local and the global configuration arrays into the cache array.
_update_leaflist_urls: midcom_helper__basicnav::_update_leaflist_urls() in _basicnav.php

This helper updates the URLs in the reference-passed leaf list.
_validate_path: midcom_helper__componentloader::_validate_path() in _componentloader.php

_validate_path is used to validate the component located at the snippetdir Path $snippetpath. This is a fully qualified snippetdir path to the component in question.
_validate_url: midcom_helper__componentloader::_validate_url() in _componentloader.php

Will validate the given MidCOM Path $path for syntactical
_write_leaves_to_cache: midcom_helper__basicnav::_write_leaves_to_cache() in _basicnav.php

Writes the leaves passed to this function to the cache, assigning them to the specified node.

a

top

$argc: midcom_helper_urlparser::$argc in urlparser.php

The currently remaining argument count.
$argv: midcom_helper_urlparser::$argv in urlparser.php

The currently remaining argument list.
add_item: midcom_helper_toolbar::add_item() in toolbar.php

This function will add an Item to the toolbar. Set before to the index of the element before which you want to insert the item or use -1 if you want to append an item. Alternativly, instead of specifying an index, you can specify an URL instead.
add_jscript: midcom_application::add_jscript() in application.php

Register JavaScript Code for output directly in the page.
add_jsfile: midcom_application::add_jsfile() in application.php

Register JavaScript File for referring in the page.
add_jsonload: midcom_application::add_jsonload() in application.php

Register a JavaScript method for the body onload event
add_link_head: midcom_application::add_link_head() in application.php

Register a linkelement to be placed in the pagehead.
add_meta_head: midcom_application::add_meta_head() in application.php

Register a metatag to be added to the head element.
add_object_head: midcom_application::add_object_head() in application.php

Register some object tags to be added to the head element.
add_style_head: midcom_application::add_style_head() in application.php

Register a styleblock / style link to be added to the head element.
approve: midcom_helper_metadata::approve() in metadata.php

Approves the object.
application.php: application.php in application.php
articlesfirst.php: articlesfirst.php in articlesfirst.php

c

top

$cache: midcom_application::$cache in application.php

The main caching Engine which is responsible for the current page output.
$class_style: midcom_helper_toolbar::$class_style in toolbar.php

The CSS class-Style rule that should be used for the toolbar.
check_memberships: midcom_application::check_memberships() in application.php

Check group memberships.
codeinit: midcom_application::codeinit() in application.php

Initialize the URL parser and process the request.
content: midcom_application::content() in application.php

Display the output of the component
convert_legacy_metadata.php: convert_legacy_metadata.php in convert_legacy_metadata.php
configuration.php: configuration.php in configuration.php

d

top

debug_add: debug_add() in debug.php

Shortcut: Log a message
debug_dump_mem: debug_dump_mem() in debug.php

Shortcut: Dump the current memory usage and the delta to the last call of this function.
debug_pop: debug_pop() in debug.php

Shortcut: Restore the last debug prefix
debug_print_r: debug_print_r() in debug.php

Shortcut: Dump a variable (by reference)
debug_print_type: debug_print_type() in debug.php

Shortcut: Dump a variables type (by reference)
debug_push: debug_push() in debug.php

Shortcut: Set a new debug prefix
debug_push_class: debug_push_class() in debug.php

Shortcut for adding a class/method debug prefix, the class name is obtained from the first parameter, the prefix is appended using ::$prefix notation.
disable: midcom_debug::disable() in debug.php

Disable the Debugger
disable_item: midcom_helper_toolbar::disable_item() in toolbar.php

Set's an item's enabled flag to false.
dump_mem: dump_mem() in misc.php
dynamic_load: midcom_application::dynamic_load() in application.php

Dynamically execute a subrequest and insert its output in place of the function call.
debug.php: debug.php in debug.php

e

top

edit_current_page_url: midcom_helper_nav::edit_current_page_url() in nav.php

This function provides an interface to construct links like "Edit this page".
enable: midcom_debug::enable() in debug.php

Enable the Debugger
enable_item: midcom_helper_toolbar::enable_item() in toolbar.php

Set's an item's enabled flag to true.
enter_context: midcom_helper__styleloader::enter_context() in _styleloader.php

Switches the context (see dymamic load). Private variables $_context, $_topic and $_snippetdir are adjusted.
exists: midcom_helper_configuration::exists() in configuration.php

Checks for the existence of a configuration key.

f

top

$failed: midcom_helper_mailtemplate::$failed in mailtemplate.php

Number of E-Mails that failed sending.
fetch_article: midcom_helper_urlparser::fetch_article() in urlparser.php

Try to fetch an article.
fetch_attachment: midcom_helper_urlparser::fetch_attachment() in urlparser.php

Try to fetch an attachment.
fetch_object: midcom_helper_urlparser::fetch_object() in urlparser.php

Returns a copy of the currently active object that has been successfully parsed so far.
fetch_topic: midcom_helper_urlparser::fetch_topic() in urlparser.php

Try to fetch a topic.
fetch_URL: midcom_helper_urlparser::fetch_URL() in urlparser.php

Returns the URL to the currently selected object including the Midgard Page Prefix.
fetch_variable: midcom_helper_urlparser::fetch_variable() in urlparser.php

Try to fetch an URL variable.
finish: midcom_application::finish() in application.php

Exit from the framework, execute after all output has been made.

g

top

$GLOBALS["midcom_debugger"]: $GLOBALS["midcom_debugger"] in debug.php

Global debugger instance
$GLOBALS['midcom_config']: $GLOBALS['midcom_config'] in midcom_config.php

Current MidCOM configuration
$GLOBALS['midcom_config_default']: $GLOBALS['midcom_config_default'] in midcom_config.php

MidCOM core configuration option defaults.
$GLOBALS['midcom_config_local']: $GLOBALS['midcom_config_local'] in midcom_config.php

Local MidCOM configuration options, specific to this Instance.
$GLOBALS['midcom_config_site']: $GLOBALS['midcom_config_site'] in midcom_config.php

MidCOM site specific configuration, read from /etc/midgard/midcom.conf.
generate_error: midcom_application::generate_error() in application.php

Generate an error page.
get: midcom_helper_metadata::get() in metadata.php

This function will return a single metadata key from the object. Its return type depends on the metadata key that is requested (see the class introduction).
get: midcom_helper_configuration::get() in configuration.php

Retrieve a configuration key
get_all: midcom_helper_configuration::get_all() in configuration.php

Retrieve a copy the complete configuration array.
get_basic_nav: midcom_application::get_basic_nav() in application.php

If the system is in the output phase (see above), the systemwide low-level NAP interface can be accessed through this function. A reference is returned.
get_breadcrumb_line: midcom_helper_nav::get_breadcrumb_line() in nav.php

Construct a breadcrumb line.
get_client: midcom_application::get_client() in application.php

Returns the Client Status Array which gives you all available information about the client accessing us.Currently incorprated is a recognition of client OS and client browser.
get_combined_toolbar: midcom_helper_nav::get_combined_toolbar() in nav.php

Compute a toolbar out of the NAP information for a given leaf and its node. Merges both toolbars into one. Always based on a leaf.
get_component_class: midcom_helper__componentloader::get_component_class() in _componentloader.php

Returns a reference to an instance of the specified component's
get_component_loader: midcom_application::get_component_loader() in application.php

Return the reference to the component loader.
get_component_property: midcom_helper__componentloader::get_component_property() in _componentloader.php

Returns a property value for the component identified by the
get_contentadmin_class: midcom_helper__componentloader::get_contentadmin_class() in _componentloader.php

Returns a reference to an instance of the specified component's
get_content_topic: midcom_application::get_content_topic() in application.php
get_context_data: midcom_application::get_context_data() in application.php

Access the MidCOM component context
get_current_context: midcom_application::get_current_context() in application.php

Returns the ID of the currently active context. This is FALSE if there is no context running.
get_current_leaf: midcom_helper__basicnav::get_current_leaf() in _basicnav.php

Retrieve the ID of the currently displayed leaf. This is a leaf that is displayed by the handling topic. If no leaf is active, this function returns FALSE. (Remeber to make a type sensitve check, e.g.
get_current_leaf: midcom_helper_nav::get_current_leaf() in nav.php

Retrieve the ID of the currently displayed leaf. This is a leaf that is displayed by the handling topic. If no leaf is active, this function returns FALSE. (Remeber to make a type sensitve check, e.g.
get_current_node: midcom_helper__basicnav::get_current_node() in _basicnav.php

Retrieve the ID of the currently displayed node. Defined by the topic of the component that declared able to handle the request.
get_current_node: midcom_helper_nav::get_current_node() in nav.php

Retrieve the ID of the currently displayed node. Defined by the topic of the component that declared able to handle the request.
get_custom_context_data: midcom_application::get_custom_context_data() in application.php

Retrieve arbitary, component-specific information in the component context
get_datamanager: midcom_helper_metadata::get_datamanager() in metadata.php

Return a Datamanager instance for the current object.
get_host_name: midcom_application::get_host_name() in application.php

Retrieves the name of the current host, fully qualified with protocol and port.
get_host_prefix: midcom_application::get_host_prefix() in application.php

Return the prefix required to build relative links on the current site.
get_index_from_url: midcom_helper_toolbar::get_index_from_url() in toolbar.php

This function will traverse all available items and return the first element whose URL matches the value passed to the function.
get_interface_class: midcom_helper__componentloader::get_interface_class() in _componentloader.php

Returns a reference to an instance of the specified component's interface class. The component is given in $path as a MidCOM path.
get_leaf: midcom_helper__basicnav::get_leaf() in _basicnav.php

This will give you a key-value pair describeing the leaf with the ID $node_id. The defined keys are described above in leaf data interchange format. You will get false if the leaf ID is invalid.
get_leaf: midcom_helper_nav::get_leaf() in nav.php

This will give you a key-value pair describeing the leaf with the ID $node_id. The defined keys are described above in leaf data interchange format. You will get false if the leaf ID is invalid.
get_leaf_toolbar: midcom_helper_nav::get_leaf_toolbar() in nav.php

Compute a toolbar out of the NAP information for a given leaf.
get_leaf_uplink: midcom_helper__basicnav::get_leaf_uplink() in _basicnav.php

Returns the ID of the node to which $leaf_id is accociated to, false on failure.
get_leaf_uplink: midcom_helper_nav::get_leaf_uplink() in nav.php

Returns the ID of the node to which $leaf_id is accociated to, false on failure.
get_loaded_object_by_guid: midcom_helper__basicnav::get_loaded_object_by_guid() in _basicnav.php

This is a helper function used by midcom_helper_nav::resolve_guid(). It checks if the object denoted by the passed GUID is already loaded into memory and returns it, if available. This should speed up GUID lookup heavy code.
get_midcom_class: midcom_helper__componentloader::get_midcom_class() in _componentloader.php

Returns a reference to an instance of the specified component's MIDCOM class. The component is given in $path as a MidCOM path.
get_midgard: midcom_application::get_midgard() in application.php

A mgd_get_midgard replacement
get_nap_class: midcom_helper__componentloader::get_nap_class() in _componentloader.php

Returns a reference to an instance of the specified component's
get_node: midcom_helper__basicnav::get_node() in _basicnav.php

This will give you a key-value pair describeing the node with the ID $node_id. The defined keys are described above in Node data interchange format. You will get false if the node ID is invalid.
get_node: midcom_helper_nav::get_node() in nav.php

This will give you a key-value pair describeing the node with the ID $node_id. The defined keys are described above in Node data interchange format. You will get false if the node ID is invalid.
get_node_toolbar: midcom_helper_nav::get_node_toolbar() in nav.php

Compute a toolbar out of the NAP information for a given node.
get_node_uplink: midcom_helper_nav::get_node_uplink() in nav.php

Returns the ID of the node to which $node_id is accociated to, false on failure. The root node's uplink is -1.
get_node_uplink: midcom_helper__basicnav::get_node_uplink() in _basicnav.php

Returns the ID of the node to which $node_id is accociated to, false on failure. The root node's uplink is -1.
get_parameters: midcom_helper_mailtemplate::get_parameters() in mailtemplate.php

Returns the currently set parameters.
get_parameters_encoding: midcom_helper_mailtemplate::get_parameters_encoding() in mailtemplate.php

Retrieve the current parameter character encoding.
get_root_node: midcom_helper__basicnav::get_root_node() in _basicnav.php

Retrieve the ID of the root node. Note that this ID is dependent from the ID of the MidCOM Root topic and therefore will change as easily as the root topic ID might. The MIDCOM_NAV_URL entry of the root node's data will always be empty.
get_root_node: midcom_helper_nav::get_root_node() in nav.php

Retrieve the ID of the root node. Note that this ID is dependent from the ID of the MidCOM Root topic and therefore will change as easily as the root topic ID might. The MIDCOM_NAV_URL entry of the root node's data will always be empty.
get_service: midcom_application::get_service() in application.php

Return a reference to a given service.
get_sorted_list: midcom_helper_itemlist::get_sorted_list() in itemlist.php

Returns the sorted list for this topic according to our sorting criteria.
get_sorted_list: midcom_helper_itemlist_score::get_sorted_list() in score.php
get_sorted_list: midcom_helper_itemlist_articlesfirst::get_sorted_list() in articlesfirst.php
get_sorted_list: midcom_helper_itemlist_topicsfirst::get_sorted_list() in topicsfirst.php
get_status: midcom_application::get_status() in application.php

Get the current MidCOM processing state.
get_toolbar_definition: midcom_helper_nav::get_toolbar_definition() in nav.php

This function returns the toolbar definition for the NAP object passed. This must superseed all calls to $nap_object[MIDCOM_NAV_TOOLBAR] as this information is not usable directly - it would result from the MidCOM cache and thus be out of date always (and especially not adapted to the current user).
get_toolbar_definition: midcom_helper__basicnav::get_toolbar_definition() in _basicnav.php

This function returns the toolbar definition for the NAP object passed. This must superseed all calls to $nap_object[MIDCOM_NAV_TOOLBAR] as this information is not usable directly - it would result from the MidCOM cache and thus be out of date always (and especially not adapted to the current user).

h

top

header: midcom_application::header() in application.php

Sends a header out to the client.
hide_unapproved_photos: hide_unapproved_photos() in convert_legacy_metadata.php

i

top

$id_style: midcom_helper_toolbar::$id_style in toolbar.php

The CSS ID-Style rule that should be used for the toolbar.
$items: midcom_helper_toolbar::$items in toolbar.php

The items in the toolbar. The array consists of Arrays outlined
ImageCopyResampleBicubic: ImageCopyResampleBicubic() in misc.php

Bicubic resampling of an Image, truecolor version
ImageCopyResampleBicubicPalette: ImageCopyResampleBicubicPalette() in misc.php

Bicubic resampling of an Image, 256 color version
index_object: index_object() in index-legacy-attachments.php

Indexes a given object using the indexer passed to the function.
is_approved: midcom_helper_metadata::is_approved() in metadata.php

Checks wether the article has been approved since its last editing.
is_enabled: midcom_debug::is_enabled() in debug.php

Is the debugger enabled?
is_loaded: midcom_helper__componentloader::is_loaded() in _componentloader.php

Returns TRUE if the component identified by the MidCOM path $url is already loaded and available for usage.
is_node_in_tree: midcom_helper_nav::is_node_in_tree() in nav.php

Checks if the given node is within the tree of another node.
is_object_visible_onsite: midcom_helper_metadata::is_object_visible_onsite() in metadata.php

This is a helper function which indicates wether a given object may be shown onsite taking approval, scheduling and visibility settings into account. The important point here is that it also checks the global configuration defaults, so that this is basically the same base on which NAP decides wether to show an item or not.
is_visible: midcom_helper_metadata::is_visible() in metadata.php

Checks the object's visibility regarding scheduling and the hide flag.
index-legacy-attachments.php: index-legacy-attachments.php in index-legacy-attachments.php
itemlist.php: itemlist.php in itemlist.php

l

top

leave_context: midcom_helper__styleloader::leave_context() in _styleloader.php

Switches the context (see dymamic load). Private variables $_context, $_topic and $_snippetdir are adjusted.
list_helpers.php: list_helpers.php in list_helpers.php
list_child_elements: midcom_helper_nav::list_child_elements() in nav.php

List all child elements, nodes and leaves alike, of the node with ID $parent_node_id. For every child element, an array of ID and type (node/leaf) is given as
list_leaves: midcom_helper__basicnav::list_leaves() in _basicnav.php

Lists all leaves of $parent_node. If there are no leaves you will get an empty array, if there was an error (for instance an unknown parent node ID) you will get FALSE.
list_leaves: midcom_helper_nav::list_leaves() in nav.php

Lists all leaves of $parent_node. If there are no leaves you will get an empty array, if there was an error (for instance an unknown parent node ID) you will get FALSE.
list_loaded_components: midcom_helper__componentloader::list_loaded_components() in _componentloader.php

Retrieve a list of all loaded components. The Array will contain an unsortet collection of MidCOM Paths.
list_nodes: midcom_helper_nav::list_nodes() in nav.php

Lists all Sub-nodes of $parent_node. If there are no subnodes you will get an empty array, if there was an error (for instance an unkown parent node ID) you will get FALSE.
list_nodes: midcom_helper__basicnav::list_nodes() in _basicnav.php

Lists all Sub-nodes of $parent_node. If there are no subnodes you will get an empty array, if there was an error (for instance an unkown parent node ID) you will get FALSE.
load: midcom_helper__componentloader::load() in _componentloader.php

This function will invoke _load directly. If the loading process is unsucessful, it will call generate_error.
load_all: midcom_helper__componentloader::load_all() in _componentloader.php

This function tries to load all available components by traversing
load_datamanager: midcom_helper_metadata::load_datamanager() in metadata.php

Loads the datamanager for this instance. This will patch the schema in case we are dealing with an article.
load_library: midcom_application::load_library() in application.php

Load a code library
load_snippet: midcom_application::load_snippet() in application.php
log: midcom_debug::log() in debug.php

Log a message

m

top

$midgard: midcom_application::$midgard in application.php

Contains the output of get_midgard. You can directly access it here.
midcom_config.php: midcom_config.php in midcom_config.php
mailtemplate.php