[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.
$_all_groups: midcom_core_user::$_all_groups in user.php

Lists all groups in which a user is a member, both directly and indirectly.
$_basicnav: midcom_helper_nav::$_basicnav in nav.php

A reference to the basicnav instance in use.
$_basicnav: midcom_helper_itemlist::$_basicnav in itemlist.php

A reference to the NAP instance we belong to.
$_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.
$_cached_object: midcom_core_privilege::$_cached_object in privilege.php

Cached content object, based on $objectguid.
$_cached_page_prefix: midcom_application::$_cached_page_prefix in application.php

Page prefix cache to avoid computing it each time.
$_cached_parent_group: midcom_core_group_midgard::$_cached_parent_group in group_midgard.php

Contains the parent of the current group, cached for repeated accesses.
$_client: midcom_application::$_client in application.php

The client status array.
$_component: midcom_core_group_virtual::$_component in group_virtual.php

Internal state variable, the component we are assigned to.
$_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.
$_constraint_count: midcom_core_querybuilder::$_constraint_count in querybuilder.php

This is an internal count which is incremented by one each time a constraint is added.
$_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.
$_direct_groups: midcom_core_user::$_direct_groups in user.php

Lists all groups in which a user is an immediate member.
$_enabled: midcom_debug::$_enabled in debug.php

Flag which is true if the debugger is enabled.
$_filedirs: midcom_helper__styleloader::$_filedirs in _styleloader.php

Path to filestyles.
$_filename: midcom_debug::$_filename in debug.php

Logfile name
$_filename: midcom_helper_imagefilter::$_filename in imagefilter.php

The file currently being processed.
$_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.
$_inheritance_chains: midcom_core_user::$_inheritance_chains in user.php

This array lists all groups the user is a member in orderd by their inheritance
$_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:
$_limit: midcom_core_querybuilder::$_limit in querybuilder.php

The number of records to return to the client at most.
$_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_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.
$_localname: midcom_core_group_virtual::$_localname in group_virtual.php

Internal state variable, the local vgroup name within our component.
$_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.
$_offset: midcom_core_querybuilder::$_offset in querybuilder.php

The offset of the first record the client wants to have available.
$_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.
$_per_class_privileges: midcom_core_user::$_per_class_privileges in user.php

List of all privileges assigned to that user based on the class he is accessing. It is to be considered read-only.
$_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
$_privileges: midcom_core_user::$_privileges in user.php

List of all privileges assigned to that user. It is to be considered read-only.
$_qb: midcom_core_querybuilder::$_qb in querybuilder.php

The query builder instance that is internally used.
$_quality: midcom_helper_imagefilter::$_quality in imagefilter.php

The quality to use for JPEG manipulation, this is not yet settable from the outside. Stored as a valid imagemagick option, defaults to '-quality 90' right now.
$_raw_data: midcom_core_manifest::$_raw_data in manifest.php

The raw manifest array as loaded from disc.
$_real_class: midcom_core_querybuilder::$_real_class in querybuilder.php

This private helper holds the type that the application expects to retrieve from this instance.
$_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 URL 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.
$_storage: midcom_core_user::$_storage in user.php

The storage object on which we are based. This is no MidCOM DBA layer object since it must not do any Access Control for the internal system to work. The instance may not be accessed from the outside.
$_storage: midcom_core_group::$_storage in group.php

The storage object on which we are based. This is usually a midgard_group directly, as this class has to work outside of the ACLs. It must not be used from the outside.
$_styledirs: midcom_helper__styleloader::$_styledirs in _styleloader.php

The stack of directories to check for styles.
$_styledirs_append: midcom_helper__styleloader::$_styledirs_append in _styleloader.php

List of styledirs to handle after componentstyle
$_styledirs_prepend: midcom_helper__styleloader::$_styledirs_prepend in _styleloader.php

List of styledirs to handle before componentstyle
$_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
$_tried_to_load: midcom_helper__componentloader::$_tried_to_load in _componentloader.php

This array contains a list of components that were tried to be loaded.
$_watches: midcom_helper__componentloader::$_watches in _componentloader.php

This array contains all registered MidCOM operation watches. They are indexed by operation and map to components / libraries which have registered to classes.
$_watch_notifications: midcom_helper__componentloader::$_watch_notifications in _componentloader.php

This is an array containing a list of watches that need to be executed at the end
_basicnav.php: _basicnav.php in _basicnav.php
_componentloader.php: _componentloader.php in _componentloader.php
_dbfactory.php: _dbfactory.php in _dbfactory.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.
_generate_class_manifest_cache: midcom_helper__componentloader::_generate_class_manifest_cache() in _componentloader.php

This function is called from the class manifest loader in case of a cache miss.
_getComponentSnippetdir: midcom_helper__styleloader::_getComponentSnippetdir() in _styleloader.php

Gets the component styledir assosiated with the topics component.
_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_privileges: midcom_core_user::_get_privileges() in user.php

Return a list of privileges assigned directly to the user.
_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.
_get_tempfile: midcom_helper_imagefilter::_get_tempfile() in imagefilter.php

Returns the name of a temporary file to be used to write the transformed image to. Has to be managed by the callee.
_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.
_invalidate_cache: midcom_core_privilege::_invalidate_cache() in privilege.php

This is an internal helper called after all I/O operation which invalidates the memcache accordingly.
_is_magic_assignee: midcom_core_privilege::_is_magic_assignee() in privilege.php

Internal helper, encaspulating the check wether an assignee string is a known magic assignee.
_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.
_is_privilege_valid: midcom_core_privilege::_is_privilege_valid() in privilege.php

Internal helper function, determines wether a given privilege applies for the given user in content mode. This means, that all SELF privileges are skipped at this point, EVERYONE privileges apply always, and all other privileges are checked against the user.
_load: midcom_core_group_midgard::_load() in group_midgard.php

Helper function that will look up a group and assign the object to the $storage member.
_load: midcom_core_group::_load() in group.php

Helper function that will look up a group and assign the object to the $storage member.
_load: midcom_core_group_virtual::_load() in group_virtual.php

Callback to load the virtual group. Checks wether the component in question is already loaded. It then queries its vgroup listing for the name of this group.
_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.
_load: midcom_core_user::_load() in user.php

Helper function that will look up a user in the Midgard Database and assign the object to the $storage member.
_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_groups: midcom_core_user::_load_all_groups() in user.php

Loads the complete group hierarchy the user is a member in.
_load_direct_groups: midcom_core_user::_load_direct_groups() in user.php

Loads all groups the user is a direct member and assignes them to the _direct_groups member.
_load_leaves: midcom_helper__basicnav::_load_leaves() in _basicnav.php

Loads the leaves for a given node from the cache or database.
_load_manifest: midcom_core_manifest::_load_manifest() in manifest.php

This internal helper loads and evaluates the given manifest file.
_load_privileges: midcom_core_user::_load_privileges() in user.php

Load the privileges from the database. This uses the inheritance chains loaded by _load_all_groups().
_merge_privileges: midcom_core_user::_merge_privileges() in user.php

Merge privileges helper. It loads the privileges of the given object and loads all "SELF" assignee privileges into the class.
_merge_styledirs: midcom_helper__styleloader::_merge_styledirs() in _styleloader.php

This function merges the prepend and append styles with the componentstyle. This happens when the enter_context function is called.
_on_creating: midcom_core_temporary_object::_on_creating() in temporary_object.php

Update the object timestamp.
_on_updating: midcom_core_temporary_object::_on_updating() in temporary_object.php

Update the object timestamp.
_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
_process_privileges: midcom_core_manifest::_process_privileges() in manifest.php

This is an internal startup helper which extracts and post-processes the privilege definitions in the loaded manifest information. It will not complete any missing owner default privileges, this is done by the Authentication service upon privilege registering.
_process_tempfile: midcom_helper_imagefilter::_process_tempfile() in imagefilter.php

This will replace the original file with the processed copy of $tmpfile, deleting the temporary file afterwards.
_query_all_privileges: midcom_core_privilege::_query_all_privileges() in privilege.php

This is an internal helper function, which may only be called statically.
_render_link_item: midcom_helper_toolbar::_render_link_item() in toolbar.php

Helper function, renders a regular a href... based link target.
_render_post_item: midcom_helper_toolbar::_render_post_item() in toolbar.php

Helper function, renders a form based link target.
_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.
_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.
$assignee: midcom_core_privilege::$assignee in privilege.php

The Assignee identifier.
$auth: midcom_application::$auth in application.php

Authentication / Authorization service.
add_constraint: midcom_core_querybuilder::add_constraint() in querybuilder.php

Add a constraint to the query builder.
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_item_to_index: midcom_helper_toolbar::add_item_to_index() in toolbar.php

This function adds an item to another item by either adding the item to the MIDCOM_TOOLBAR_SUBMENU or creating a new subtoolbar and adding the item there.
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_option_to_configfile: add_option_to_configfile() in autoconf.php

Autoconf Script which scans the system for all required utilities and prerequisits.
add_order: midcom_core_querybuilder::add_order() in querybuilder.php

Add a ordering constraint to the query builder.
add_style_head: midcom_application::add_style_head() in application.php

Register a styleblock / style link to be added to the head element.
append_component_styledir: midcom_helper__styleloader::append_component_styledir() in _styleloader.php

append the styledir of a component to the queue of styledirs.
append_styledir: midcom_helper__styleloader::append_styledir() in _styleloader.php

Function append styledir
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
autoconf.php: autoconf.php in autoconf.php

b

top

begin_group: midcom_core_querybuilder::begin_group() in querybuilder.php

Creates a new logical group within the query. They are set in parantheses in the final SQL and will thus be evaluated with precedence over the normal out-of-group constraints.
bind_to: midcom_helper_toolbar::bind_to() in toolbar.php

Binds this toolbar instance to a DBA content object using the MidCOM toolbar service.
bind_view_to_object: midcom_application::bind_view_to_object() in application.php

Binds the current page view to a particular object. This will automatically connect such things like metadata and toolbars to the correct object.

c

top

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

The main caching Engine which is responsible for the current page output.
$classname: midcom_core_privilege::$classname in privilege.php

The class name to limit SELF privileges to.
$class_definitions: midcom_core_manifest::$class_definitions in manifest.php

A list of class definition filenames (all looked up in the components configuration directory).
$class_style: midcom_helper_toolbar::$class_style in toolbar.php

The CSS class-Style rule that should be used for the toolbar.
$componentloader: midcom_application::$componentloader in application.php

The component loader.
$count: midcom_core_querybuilder::$count in querybuilder.php

The number of records found by the last execute() run. This is -1 as long as no query has been executed. This member is read-only.
$customdata: midcom_core_manifest::$customdata in manifest.php

Custom place to extend the schema, the array holds data indexed by the component name they are relevant to.
$customdata: midcom_helper_toolbar::$customdata in toolbar.php

Allow our users to add arbitary data to the toolbar. This is for example used to track which items have been added to a toolbar when it is possible that the adders are called repeatedly.
check_memberships: midcom_application::check_memberships() in application.php

Check group memberships.
clean_item: midcom_helper_toolbar::clean_item() in toolbar.php

Clean up an item that is added, making sure that the item has all the needed options and indexes.
codeinit: midcom_application::codeinit() in application.php

Initialize the URL parser and process the request.
collect_content_privileges: midcom_core_privilege::collect_content_privileges() in privilege.php

Collects all privileges applicable for a user over a content object.
content: midcom_application::content() in application.php

Display the output of the component
convert: midcom_helper_imagefilter::convert() in imagefilter.php

This function converts the image to the specified image format. It must be a suiteable extension to use with the Imagemagick convert utility. The file will not be renamed, you have to do this yourself.
convert_midgard_to_midcom: midcom_helper__dbfactory::convert_midgard_to_midcom() in _dbfactory.php

Helper function, it takes a Legacy Midgard object (pre MgdSchema) and converts it into one of the new MgdSchema based midcom_baseclasses_database_* objects.
count: midcom_core_querybuilder::count() in querybuilder.php

Returns the number of elements matching the current query.
count_unchecked: midcom_core_querybuilder::count_unchecked() in querybuilder.php

This is a mapping to the real count function of the Midgard Query Builder. It is mainly intended when speed is important over accuracy, as it bypasses access control to get a fast impression of how many objects are available in a given query. It should always be kept in mind that this is a preliminary number, not a final one.
constants.php: constants.php in constants.php
convert_legacy_metadata.php: convert_legacy_metadata.php in convert_legacy_metadata.php
configuration.php: configuration.php in configuration.php

d

top

$dbclassloader: midcom_application::$dbclassloader in application.php

Database class loader service.
$dbfactory: midcom_application::$dbfactory in application.php

Helper class which provides access to the MgdSchema driven Midgard Database.
$denied: midcom_core_querybuilder::$denied in querybuilder.php

The number of objects for which access was denied.
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_function_stack: debug_print_function_stack() in debug.php

Shortcut: Create a stack trace and dump it. Works only if XDEBUG is installed.
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.
delete: midcom_core_user::delete() in user.php

Deletes the current user account. This will cleanup all information accociated with the user that is managed by the core (like login sessions and privilege records).
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.
disable_view_page: midcom_helper_toolbar::disable_view_page() in toolbar.php

Dummy function to hide that this is not a midcom_admin_content_toolbar.
drop: midcom_core_privilege::drop() in privilege.php

Drop the privilge. If we are a known DB record, we delete us, otherwise we return silently.
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.
end_group: midcom_core_querybuilder::end_group() in querybuilder.php

Ends a group previously started with begin_group().
enter_context: midcom_helper__styleloader::enter_context() in _styleloader.php

Switches the context (see dymamic load). Private variables $_context, $_topic and $_snippetdir are adjusted.
execute: midcom_core_querybuilder::execute() in querybuilder.php

This function will execute the Querybuilder and call the appropriate callbacks from the class it is accociated to. This way, class authors have full control over what is actually returned to the application.
execute_unchecked: midcom_core_querybuilder::execute_unchecked() in querybuilder.php

Temporary helper until execute can be optimized with rerunnable QBs, runs a query where limit and offset is taken into account prior to execution in the core.
execute_user_callback: midcom_helper_imagefilter::execute_user_callback() in imagefilter.php

Executes a custom image manipulation callback. The command name is the function that is searched. The function must use the following signature:
exec_query_builder: midcom_helper__dbfactory::exec_query_builder() in _dbfactory.php

This function will execute the Querybuilder.
exifrotate: midcom_helper_imagefilter::exifrotate() in imagefilter.php

Automatic rotation for the image using EXIF tags.
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
$guid: midcom_core_user::$guid in user.php

The GUID identifying this user, made directly available for easier linking.
$guid: midcom_helper_metadata::$guid in metadata.php

The guid of the object, it is cached for fast access to avoid repeated database queries.
gamma: midcom_helper_imagefilter::gamma() in imagefilter.php

Gamma-Adjustment of the image.
generate_error: midcom_application::generate_error() in application.php

Generate an error page.
get: midcom_helper_configuration::get() in configuration.php

Retrieve a configuration key
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_26_request_metadata: midcom_application::get_26_request_metadata() in application.php

This is a temporary tranisition function used to get the currently known and required Request Metadata: The last modified timestamp and the permalink GUID.
get_all: midcom_helper_configuration::get_all() in configuration.php

Retrieve a copy the complete configuration array.
get_all_manifest_customdata: midcom_helper__componentloader::get_all_manifest_customdata() in _componentloader.php

This small helper builds a complete set of custom data accociated with a given component identifier. In case a given component does not have the key set and the boolean parameter is set to true, an empty array is added implicitly.
get_all_privileges: midcom_core_privilege::get_all_privileges() in privilege.php

This is a static helper function which lists all privileges assigned an object unfiltered.
get_assignee: midcom_core_privilege::get_assignee() in privilege.php

If the assignee has an object representation (at this time, only users and groups have), this call will return a reference to the assignee object held by the authentication service. See midcom_services_auth::get_assignee() for details.
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_data: midcom_helper_nav::get_breadcrumb_data() in nav.php

Construct source data for a breadcrumb line.
get_breadcrumb_line: midcom_helper_nav::get_breadcrumb_line() in nav.php

Construct a breadcrumb line.
get_class_magic_default_privileges: midcom_core_temporary_object::get_class_magic_default_privileges() in temporary_object.php

These objects have no restrictions whatsoever directly assigned to them.
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_privileges: midcom_core_privilege::get_content_privileges() in privilege.php

This is a static helper function which lists all content privileges assigned to a given object. Essentially, this will exclude all SELF style assignees.
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_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_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_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_first_login: midcom_core_user::get_first_login() in user.php

Returns the first login time of the user, if available. In contrast to get_last_login and is_online this query does not require the isonline privilege, as it is usually used to determine the "age" of a user account in a community.
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_last_login: midcom_core_user::get_last_login() in user.php

Returns the last login of the given user. You require the privilege midcom:isonline for the storage object you are going to check. The privilege is not granted by default, to allow users full control over their privacy.
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: 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_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_nav::get_leaf_uplink() in nav.php

Returns the ID of the node to which $leaf_id is accociated to, false on failure.
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_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_name_translated: midcom_core_manifest::get_name_translated() in manifest.php

Populates and translates the name of the component.
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_object: midcom_core_privilege::get_object() in privilege.php

A copy of the object referenced by the guid value of this privilege.
get_object_by_guid: midcom_helper__dbfactory::get_object_by_guid() in _dbfactory.php

This is a replacement for the original mgd_get_object_by_guid function, which takes the MidCOM DBA system into account.
get_page_prefix: midcom_application::get_page_prefix() in application.php

Return the prefix required to build relative links on the current site.
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_parent_group: midcom_core_group_midgard::get_parent_group() in group_midgard.php

Returns the parent group.
get_parent_group: midcom_core_group::get_parent_group() in group.php

Returns the parent group.
get_parent_guid: midcom_helper__dbfactory::get_parent_guid() in _dbfactory.php

This is a helper function which determines the parent GUID for an existing GUID according to the MidCOM conten tree rules.
get_per_class_privileges: midcom_core_user::get_per_class_privileges() in user.php

Returns the specific per class global privilege set assigned to this user, taking all parent groups into account. If the class specified is unknown, an empty array is returned.
get_privilege: midcom_core_privilege::get_privilege() in privilege.php

This is a static helper function which retrieves a single given privilege at a content object, identified by the combination of assingee and privilege name.
get_privileges: midcom_core_group::get_privileges() in group.php

Return a list of privileges assigned directly to the group. The default implementation queries the storage object directly using the get_privileges method of the midcom_core_baseclasses_core_dbobject class, which should work fine on all MgdSchema objects. If the storage object is null, an emptry array is returned.
get_privileges: midcom_core_user::get_privileges() in user.php

Returns the complete privilege set assigned to this user, taking all parent groups into account.
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_self_privileges: midcom_core_privilege::get_self_privileges() in privilege.php

This is a static helper function which lists all privileges assigned directly to a user or group. These are all SELF privileges.
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_topicsfirst::get_sorted_list() in topicsfirst.php
get_sorted_list: midcom_helper_itemlist_articlesfirst::get_sorted_list() in articlesfirst.php
get_status: midcom_application::get_status() in application.php

Get the current MidCOM processing state.
get_storage: midcom_core_group::get_storage() in group.php

This function will return a MidCOM DBA level storage object for the current group. Be aware, that depending on ACL information, the retrival of the user may fail.
get_storage: midcom_core_user::get_storage() in user.php

This function will return a MidCOM DBA level storage object for the current user. Be aware, that depending on ACL information, the retrival of the user may fail.
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).
group_midgard.php: group_midgard.php in group_midgard.php
group.php: group.php in group.php
group_virtual.php: group_virtual.php in group_virtual.php

h

top

$hide_invisible: midcom_core_querybuilder::$hide_invisible in querybuilder.php

Set this element to true to hide all items which are currently invisible according to the approval/scheduling settings made using Metadata. This must be set before executing the query.
header: midcom_application::header() in application.php

Sends a header out to the client.
hide_item: midcom_helper_toolbar::hide_item() in toolbar.php

Set's an item's hidden flag to true.
hide_unapproved_photos: hide_unapproved_photos() in convert_legacy_metadata.php

i

top

$i18n: midcom_application::$i18n in application.php

I18n service class
$id: midcom_core_user::$id in user.php

The identification string used to internally identify the user uniquely in the system. This is usually some kind of user:$guid string combination.
$id: midcom_core_group::$id in group.php

The identification string used to internally identify the group uniquely in the system. This is usually some kind of group:$guid string combination.
$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.
initialize: midcom_core_querybuilder::initialize() in querybuilder.php

The initialization routin executes the _on_prepare_new_querybuilder callback on the class.
initialize: midcom_application::initialize() in application.php

Main MidCOM initialization.
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_in_group: midcom_core_user::is_in_group() in user.php

Checks wether a user is a member of the given group.
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_magic_assignee: midcom_core_privilege::is_magic_assignee() in privilege.php

Checks wether the current assignee is a magic assignee or an object identifier.
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_online: midcom_core_user::is_online() in user.php

This is a shortcut for the method midcom_services_auth_sessionmgr::is_user_online().
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
imagefilter.php: imagefilter.php in imagefilter.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_all_memberships: midcom_core_user::list_all_memberships() in user.php

Retrieves a list of groups for which this user is a member, both directly and indirectly.
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_members: midcom_core_group_midgard::list_members() in group_midgard.php

Retrieves a list of users for which are a member in this group.
list_members: midcom_core_group::list_members() in group.php

Retrieves a list of users for which are a member in this group.
list_members: midcom_core_group_virtual::list_members() in group_virtual.php

Retrieves a list of users for which are a member in this group.
list_memberships: midcom_core_group_virtual::list_memberships() in group_virtual.php

This method returns a list of all virtual groups in which the MidCOM user passed is a member.
list_memberships: midcom_core_group_midgard::list_memberships() in group_midgard.php

This method returns a list of all groups in which the MidCOM user passed is a member.
list_memberships: midcom_core_user::list_memberships() in user.php

Retrieves a list of groups for which this user is an immediate member.
list_memberships: midcom_core_group::list_memberships() in group.php

This method returns a list of all groups in which the MidCOM user passed is a member.
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.
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.
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_all_manifests: midcom_helper__componentloader::load_all_manifests() in _componentloader.php

This function is called during system startup and loads all component manifests from the disk. The list of manifests to load is determined using a find shell call and is cached using the phpscripts cache module.
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_graceful: midcom_helper__componentloader::load_graceful() in _componentloader.php

This function will invoke _load directly. If the loading process is unsucessful, false is returned.
load_library: midcom_application::load_library() in application.php

Load a code library
load_manifest: midcom_helper__componentloader::load_manifest() in _componentloader.php

Load a manifest from the disk and add it to the $manifests list.
load_snippet: midcom_application::load_snippet() in application.php
log: midcom_debug::log() in debug.php

Log a message
list_helpers.php: list_helpers.php in list_helpers.php

m

top

$manifests: midcom_helper__componentloader::$manifests in _componentloader.php

This lists all available components in the systems in the form of their manifests, indexed by the component name. Whenever possible you should refer to this listing to gain information about the components available.
$metadata: midcom_application::$metadata in application.php

The metadata service.
$midgard: midcom_application::$midgard in application.php

Contains the output of get_midgard. You can directly access it here.
mgd_delete_extensions: mgd_delete_extensions() in misc.php

Delete all extensions (parameters and attachments) to a Midgard object
MGD_ERR_ACCESS_DENIED: MGD_ERR_ACCESS_DENIED in misc.php
MGD_ERR_DUPLICATE: MGD_ERR_DUPLICATE in misc.php
MGD_ERR_ERROR: MGD_ERR_ERROR in misc.php
MGD_ERR_HAS_DEPENDANTS: MGD_ERR_HAS_DEPENDANTS in misc.php
MGD_ERR_INTERNAL: MGD_ERR_INTERNAL in misc.php
MGD_ERR_INVALID_NAME: MGD_ERR_INVALID_NAME in misc.php
MGD_ERR_INVALID_OBJECT: MGD_ERR_INVALID_OBJECT in misc.php
MGD_ERR_NOT_CONNECTED: MGD_ERR_NOT_CONNECTED in misc.php
MGD_ERR_NOT_EXISTS: MGD_ERR_NOT_EXISTS in misc.php
MGD_ERR_NOT_OBJECT: MGD_ERR_NOT_OBJECT in misc.php
MGD_ERR_NO_MEM: MGD_ERR_NO_MEM in misc.php
MGD_ERR_OBJECT_NAME_EXISTS: MGD_ERR_OBJECT_NAME_EXISTS in misc.php
MGD_ERR_OBJECT_NO_PARENT: MGD_ERR_OBJECT_NO_PARENT in misc.php
MGD_ERR_OBJECT_NO_STORAGE: MGD_ERR_OBJECT_NO_STORAGE in misc.php
MGD_ERR_OK: MGD_ERR_OK in misc.php
MGD_ERR_QUOTA: MGD_ERR_QUOTA in misc.php
MGD_ERR_RANGE: MGD_ERR_RANGE in misc.php
MGD_ERR_SG_NOTFOUND: MGD_ERR_SG_NOTFOUND in misc.php
MGD_ERR_SITEGROUP_VIOLATION: MGD_ERR_SITEGROUP_VIOLATION in misc.php
mgd_fetch_to_array: mgd_fetch_to_array() in misc.php

Transforms a fetchable into an ID-array
mgd_get_createstr: mgd_get_createstr() in misc.php

Get the constructor string for an object's class.
mgd_group_id_array: mgd_group_id_array() in misc.php

Sort and group an Array of object IDs
mgd_include_snippet_php: mgd_include_snippet_php() in misc.php

PHP-level implementation of the Midgard Preparser language construct mgd_include_snippet. Same semantics, but probably a littlebit slower.
mgd_is_group_in_group_tree: mgd_is_group_in_group_tree() in misc.php

Helper function to check wether a given group is a subgroup of another one.
mgd_is_guid: mgd_is_guid() in misc.php

This funciton validates wether the argument passed is a syntactically valid GUID.
mgd_list_persons_in_group_all: mgd_list_persons_in_group_all() in misc.php

List all members in a group.
mgd_load_custom_fields_param: mgd_load_custom_fields_param() in misc.php

Load a number of variables into parameters and attach them to the Midgard object.
mgd_load_var_from_attachment: mgd_load_var_from_attachment() in misc.php

Load a variable form an attachment to a Midgard object.
mgd_memberships_to_gid: mgd_memberships_to_gid() in misc.php

Transforms a membership fetchable to an Group-ID Array
mgd_memberships_to_uid: mgd_memberships_to_uid() in misc.php

Transforms a membership fetchable to an Person-ID Array
mgd_save_custom_fields_param: mgd_save_custom_fields_param() in misc.php

Save a number of variables into parameters on an arbitary Midgard object.
mgd_save_var_as_attachment: mgd_save_var_as_attachment() in misc.php

Save a variable as attachment to an Midgard object. Type is preserved through serialization.
mgd_set_errno: mgd_set_errno() in misc.php
mgd_show_element: mgd_show_element() in misc.php
mgd_sort_id_array: mgd_sort_id_array() in misc.php

Sort an Array of object IDs
mgd_sort_object_array: mgd_sort_object_array() in misc.php

Sort an Array of objects
manifest.php: manifest.php in manifest.php
mailtemplate.php: mailtemplate.php in mailtemplate.php
metadata.php: metadata.php in metadata.php
misc.php: misc.php in misc.php
midcom.php: midcom.php in midcom.php
midcom_application: midcom_application in application.php

Main controlling instance of the MidCOM Framework
MIDCOM_CLIENT_IE: MIDCOM_CLIENT_IE in constants.php
MIDCOM_CLIENT_MAC: MIDCOM_CLIENT_MAC in constants.php
MIDCOM_CLIENT_MOZILLA: MIDCOM_CLIENT_MOZILLA in constants.php
MIDCOM_CLIENT_NETSCAPE: MIDCOM_CLIENT_NETSCAPE in constants.php
MIDCOM_CLIENT_OPERA: MIDCOM_CLIENT_OPERA in constants.php
MIDCOM_CLIENT_UNIX: MIDCOM_CLIENT_UNIX in constants.php
MIDCOM_CLIENT_WIN: MIDCOM_CLIENT_WIN in constants.php
MIDCOM_CONFIG_FILE: MIDCOM_CONFIG_FILE in midcom.php
MIDCOM_CONTEXT_ANCHORPREFIX: MIDCOM_CONTEXT_ANCHORPREFIX in constants.php
MIDCOM_CONTEXT_COMPONENT: MIDCOM_CONTEXT_COMPONENT in constants.php
MIDCOM_CONTEXT_CONTENTTOPIC: MIDCOM_CONTEXT_CONTENTTOPIC in constants.php
MIDCOM_CONTEXT_CUSTOMDATA: MIDCOM_CONTEXT_CUSTOMDATA in constants.php
MIDCOM_CONTEXT_LASTMODIFIED: MIDCOM_CONTEXT_LASTMODIFIED in constants.php
MIDCOM_CONTEXT_NAP: MIDCOM_CONTEXT_NAP in constants.php
MIDCOM_CONTEXT_OUTPUT: MIDCOM_CONTEXT_OUTPUT in constants.php
MIDCOM_CONTEXT_PAGETITLE: MIDCOM_CONTEXT_PAGETITLE in constants.php
MIDCOM_CONTEXT_PERMALINKGUID: MIDCOM_CONTEXT_PERMALINKGUID in constants.php
MIDCOM_CONTEXT_REQUESTTYPE: MIDCOM_CONTEXT_REQUESTTYPE in constants.php
MIDCOM_CONTEXT_ROOTTOPIC: MIDCOM_CONTEXT_ROOTTOPIC in constants.php
MIDCOM_CONTEXT_SUBSTYLE: MIDCOM_CONTEXT_SUBSTYLE in constants.php
midcom_core_group: midcom_core_group::midcom_core_group() in group.php

The constructor retrieves the group indentified by its name from the database and prepares the object for operation.
midcom_core_group: midcom_core_group in group.php

System group, does not directly implement anything, it serves only as a base classes for the various types of groups supported within the MidCOM framework.
midcom_core_group_midgard: midcom_core_group_midgard::midcom_core_group_midgard() in group_midgard.php

The constructor retrieves the group indentified by its name from the database and prepares the object for operation.
midcom_core_group_midgard: midcom_core_group_midgard in group_midgard.php

MidCOM group implementation supporting Midgard Groups.
midcom_core_group_virtual: midcom_core_group_virtual::midcom_core_group_virtual() in group_virtual.php

The constructor retrieves the virtual group indentified by its identifier by loading the corresponding component.
midcom_core_group_virtual: midcom_core_group_virtual in group_virtual.php

MidCOM group implementation supporting Virtual groups.
midcom_core_manifest: midcom_core_manifest::midcom_core_manifest() in manifest.php

The constructor loads the manifest indicated by the filename passed to it.
midcom_core_manifest: midcom_core_manifest in manifest.php

This class encaspulates a the information contained in a component manifest.
midcom_core_privilege: midcom_core_privilege::midcom_core_privilege() in privilege.php

The Default constructor creates an empty privilege, if you specify another privilege object in the constructor, a copy is constructed.
midcom_core_privilege: midcom_core_privilege in privilege.php

Privilege class, used to interact with the privilege system. It encaspulates the actual Database Level Object. As usual with MidCOM DBA, you must never access the DB layer object.
midcom_core_querybuilder: midcom_core_querybuilder::midcom_core_querybuilder() in querybuilder.php

The constructor wraps the class resolution into the MidCOM DBA system.
midcom_core_querybuilder: midcom_core_querybuilder in querybuilder.php

MidCOM DBA level wrapper for the Midgard Query Builder.
midcom_core_temporary_object: midcom_core_temporary_object::midcom_core_temporary_object() in temporary_object.php

The default constructor will create an empty object. Optionally, you can pass an object ID or GUID to the object which will then initialize the object with the corresponding DB instance.
midcom_core_temporary_object: midcom_core_temporary_object in temporary_object.php

MidCOM Temporary Database Object
midcom_core_user: midcom_core_user in user.php

System user, basically encaspulates a MidgardPerson. It does not provide a way to manipulate accounts, instead, this is an abstraction used in the ACL system.
midcom_core_user: midcom_core_user::midcom_core_user() in user.php

The constructor retrieves the user indentified by its name from the database and prepares the object for operation.
MIDCOM_CRON_DAY: MIDCOM_CRON_DAY in constants.php

Execute once every day.
MIDCOM_CRON_HOUR: MIDCOM_CRON_HOUR in constants.php

Execute once every hour.
MIDCOM_CRON_MINUTE: MIDCOM_CRON_MINUTE in constants.php

Execute once every minute.
MIDCOM_DATAMGR_CANCELLED: MIDCOM_DATAMGR_CANCELLED in constants.php
MIDCOM_DATAMGR_CANCELLED_NONECREATED: MIDCOM_DATAMGR_CANCELLED_NONECREATED in constants.php
MIDCOM_DATAMGR_CREATEFAILED: MIDCOM_DATAMGR_CREATEFAILED in constants.php
MIDCOM_DATAMGR_CREATING: MIDCOM_DATAMGR_CREATING in constants.php
MIDCOM_DATAMGR_EDITING: MIDCOM_DATAMGR_EDITING in constants.php
MIDCOM_DATAMGR_FAILED: MIDCOM_DATAMGR_FAILED in constants.php
MIDCOM_DATAMGR_SAVED: MIDCOM_DATAMGR_SAVED in constants.php
MIDCOM_DATAMGR_SAVE_DELAYED: MIDCOM_DATAMGR_SAVE_DELAYED in constants.php
midcom_debug: midcom_debug in debug.php

This is a debugger class.
midcom_debug: midcom_debug::midcom_debug() in debug.php

Standard constructor
MIDCOM_ERRAUTH: MIDCOM_ERRAUTH in constants.php
MIDCOM_ERRCRIT: MIDCOM_ERRCRIT in constants.php
MIDCOM_ERRFORBIDDEN: MIDCOM_ERRFORBIDDEN in constants.php
MIDCOM_ERRNOTFOUND: MIDCOM_ERRNOTFOUND in constants.php
MIDCOM_ERROK: MIDCOM_ERROK in constants.php
midcom_file_exists_incpath: midcom_file_exists_incpath() in misc.php

Check if a file exists in the include path
midcom_generate_urlname_from_string: midcom_generate_urlname_from_string() in misc.php

Helper function for generating "clean" URL names from titles, etc.
midcom_get_snippet_content: midcom_get_snippet_content() in misc.php

This helper function searche for a snippet either in the Filesystem or in the database and returns its content or code-field, respecitvly.
midcom_get_snippet_content_graceful: midcom_get_snippet_content_graceful() in misc.php

This helper function searche for a snippet either in the Filesystem or in the database and returns its content or code-field, respecitvly.
midcom_helper_configuration: midcom_helper_configuration::midcom_helper_configuration() in configuration.php

The constructor initializes the global configuration.
midcom_helper_configuration: midcom_helper_configuration in configuration.php

This class is designed to ease MidCOM Configuration management.
midcom_helper_filesize_to_string: midcom_helper_filesize_to_string() in misc.php

Helper function for pretty printing file sizes Original from http://www.theukwebdesigncompany.com/articles/php-file-manager.php
midcom_helper_find_node_by_component: midcom_helper_find_node_by_component() in misc.php

This helper function returns the first instance of a given component on the MidCOM site.
midcom_helper_get_mime_icon: midcom_helper_get_mime_icon() in misc.php

Helper function for finding MIME type image for a document
midcom_helper_imagefilter: midcom_helper_imagefilter in imagefilter.php

Image Filter Class, used to post process all images, check the documentation of the individual methods.
midcom_helper_itemlist: midcom_helper_itemlist in itemlist.php

Itemlist Interface
midcom_helper_itemlist_articlesfirst: midcom_helper_itemlist_articlesfirst in articlesfirst.php

Itemlist Subclass: Topics, then articles in component sorting order
midcom_helper_itemlist_score: midcom_helper_itemlist_score in score.php

Itemlist Interface
midcom_helper_itemlist_topicsfirst: midcom_helper_itemlist_topicsfirst in topicsfirst.php

Itemlist Subclass: Topics, then articles in component sorting order
midcom_helper_list_styles: midcom_helper_list_styles() in list_helpers.php

midcom_helper_datamanager_list_styles get an array of the styles bellow an id.
midcom_helper_mailtemplate: midcom_helper_mailtemplate in mailtemplate.php

This is a E-Mail template engine. It basically takes a template out of a mailtemplate datamanager field, fills it in with the parameters that have been set and sends it using the PEAR Mail classes.
midcom_helper_mailtemplate: midcom_helper_mailtemplate::midcom_helper_mailtemplate() in mailtemplate.php

Constructs the template engine on the base of the passed template.
midcom_helper_metadata: midcom_helper_metadata in metadata.php

This class is an interface to the metadata of MidCOM objects. It is not to be instantinated directly, as a cache is in place to avoide duplicate metadata objects for the same Midgard Object. So, basically, each of these object is a singelton.
midcom_helper_metadata: midcom_helper_metadata::midcom_helper_metadata() in metadata.php

This will construct a new metadata object for an existing content object.
midcom_helper_nav: midcom_helper_nav in nav.php

Main Navigation interface class.
midcom_helper_nav: midcom_helper_nav::midcom_helper_nav() in nav.php

Create a NAP instance for the given context. If unspecified, it uses the currently active context which should be sufficient in most cases.
midcom_helper_purge_object: midcom_helper_purge_object() in misc.php

Helper function for really removing an object
midcom_helper_toolbar: midcom_helper_toolbar in toolbar.php

This class is a generic toolbar class, that is used mainly within AIS to render all toolbars in an uniform way. It supports enabling and disabling of buttons, icons and hover-helptexts (currently rendered using TITLE tags).
midcom_helper_toolbar: midcom_helper_toolbar::midcom_helper_toolbar() in toolbar.php

Basic constructor, initializes the class and sets defaults for the CSS style if omitted. Note, that the styles can be changed after construction by updating the id_style and class_style members.
midcom_helper_urlparser: midcom_helper_urlparser in urlparser.php

This is a generic topic/article/attachment based URL parser. It gives you the basic matching algorithms you need for every more complex parser. Most of the time you will use this class as a part of the MidCOM parser system.
midcom_helper_urlparser: midcom_helper_urlparser::midcom_helper_urlparser() in urlparser.php

Initialize the classe
MIDCOM_HELPER_URLPARSER_ARTICLE: MIDCOM_HELPER_URLPARSER_ARTICLE in constants.php
MIDCOM_HELPER_URLPARSER_ATTACHMENT: MIDCOM_HELPER_URLPARSER_ATTACHMENT in constants.php
MIDCOM_HELPER_URLPARSER_KEY: MIDCOM_HELPER_URLPARSER_KEY in constants.php
MIDCOM_HELPER_URLPARSER_TOPIC: MIDCOM_HELPER_URLPARSER_TOPIC in constants.php
MIDCOM_HELPER_URLPARSER_VALUE: MIDCOM_HELPER_URLPARSER_VALUE in constants.php
midcom_helper__basicnav: midcom_helper__basicnav in _basicnav.php

This class is the basic building stone of the Navigation Access Point System of MidCOM.
midcom_helper__basicnav: midcom_helper__basicnav::midcom_helper__basicnav() in _basicnav.php

Constructor
midcom_helper__componentloader: midcom_helper__componentloader in _componentloader.php

This class is a Factory that is responsible for loading and establishing the interface to a MidCOM Component.
midcom_helper__componentloader: midcom_helper__componentloader::midcom_helper__componentloader() in _componentloader.php

The constructor will initialize the class. Nothing special is done here. The real initialization is done in initialize() so that we already have a reference to ourselves.
midcom_helper__dbfactory: midcom_helper__dbfactory::midcom_helper__dbfactory() in _dbfactory.php

Calls parent constructor only.
midcom_helper__dbfactory: midcom_helper__dbfactory in _dbfactory.php

This class contains various factory methods to retrieve objects from the database.
midcom_helper__styleloader: midcom_helper__styleloader in _styleloader.php

This class is responsible for all style management and replaces the old <[...]> syntax. It is instantiated by the MidCOM framework and accessible through the $midcom->style object.
midcom_helper__styleloader: midcom_helper__styleloader::midcom_helper__styleloader() in _styleloader.php

Simple initialization
MIDCOM_LOG_CRIT: MIDCOM_LOG_CRIT in constants.php
MIDCOM_LOG_DEBUG: MIDCOM_LOG_DEBUG in constants.php
MIDCOM_LOG_ERROR: MIDCOM_LOG_ERROR in constants.php
MIDCOM_LOG_INFO: MIDCOM_LOG_INFO in constants.php
MIDCOM_LOG_WARN: MIDCOM_LOG_WARN in constants.php
MIDCOM_METADATA_NODE: MIDCOM_METADATA_NODE in constants.php

Identifier for a node metadata for a request context.
MIDCOM_METADATA_VIEW: MIDCOM_METADATA_VIEW in constants.php

Identifier for a view metadata for a request context.
MIDCOM_META_CREATED: MIDCOM_META_CREATED in constants.php
MIDCOM_META_CREATOR: MIDCOM_META_CREATOR in constants.php
MIDCOM_META_EDITED: MIDCOM_META_EDITED in constants.php
MIDCOM_META_EDITOR: MIDCOM_META_EDITOR in constants.php
MIDCOM_NAVORDER_ARTICLESFIRST: MIDCOM_NAVORDER_ARTICLESFIRST in constants.php
MIDCOM_NAVORDER_DEFAULT: MIDCOM_NAVORDER_DEFAULT in constants.php
MIDCOM_NAVORDER_SCORE: MIDCOM_NAVORDER_SCORE in constants.php
MIDCOM_NAVORDER_TOPICSFIRST: MIDCOM_NAVORDER_TOPICSFIRST in constants.php
MIDCOM_NAV_ABSOLUTEURL: MIDCOM_NAV_ABSOLUTEURL in constants.php
MIDCOM_NAV_ACL: MIDCOM_NAV_ACL in constants.php
MIDCOM_NAV_ADMIN: MIDCOM_NAV_ADMIN in constants.php
MIDCOM_NAV_COMPONENT: MIDCOM_NAV_COMPONENT in constants.php
MIDCOM_NAV_CONFIGURATION: MIDCOM_NAV_CONFIGURATION in constants.php
MIDCOM_NAV_FULLURL: MIDCOM_NAV_FULLURL in constants.php
MIDCOM_NAV_GUID: MIDCOM_NAV_GUID in constants.php
MIDCOM_NAV_ICON: MIDCOM_NAV_ICON in constants.php
MIDCOM_NAV_ID: MIDCOM_NAV_ID in constants.php
MIDCOM_NAV_INTERNAL: MIDCOM_NAV_INTERNAL in constants.php
MIDCOM_NAV_LEAFID: MIDCOM_NAV_LEAFID in constants.php
MIDCOM_NAV_LEAVES: MIDCOM_NAV_LEAVES in constants.php
MIDCOM_NAV_NAME: MIDCOM_NAV_NAME in constants.php
MIDCOM_NAV_NODEID: MIDCOM_NAV_NODEID in constants.php
MIDCOM_NAV_NOENTRY: MIDCOM_NAV_NOENTRY in constants.php
MIDCOM_NAV_OBJECT: MIDCOM_NAV_OBJECT in constants.php
MIDCOM_NAV_PERMALINK: MIDCOM_NAV_PERMALINK in constants.php
MIDCOM_NAV_RELATIVEURL: MIDCOM_NAV_RELATIVEURL in constants.php
MIDCOM_NAV_SCORE: MIDCOM_NAV_SCORE in constants.php
MIDCOM_NAV_SITE: MIDCOM_NAV_SITE in constants.php
MIDCOM_NAV_SUBNODES: MIDCOM_NAV_SUBNODES in constants.php
MIDCOM_NAV_TOOLBAR: MIDCOM_NAV_TOOLBAR in constants.php
MIDCOM_NAV_TYPE: MIDCOM_NAV_TYPE in constants.php
MIDCOM_NAV_URL: MIDCOM_NAV_URL in constants.php
MIDCOM_NAV_VIEWERGROUPS: MIDCOM_NAV_VIEWERGROUPS in constants.php
MIDCOM_NAV_VISIBLE: MIDCOM_NAV_VISIBLE in constants.php
MIDCOM_OPERATION_ALL: MIDCOM_OPERATION_ALL in constants.php

Matches all known operations.
MIDCOM_OPERATION_DBA_ALL: MIDCOM_OPERATION_DBA_ALL in constants.php

All known DBA operations.
MIDCOM_OPERATION_DBA_CREATE: MIDCOM_OPERATION_DBA_CREATE in constants.php

DBA object creation. This excludes parameter operations.
MIDCOM_OPERATION_DBA_DELETE: MIDCOM_OPERATION_DBA_DELETE in constants.php

DBA object deletion. This excludes parameter operations.
MIDCOM_OPERATION_DBA_UPDATE: MIDCOM_OPERATION_DBA_UPDATE in constants.php

DBA object update, this includes all attachment and parameter operations.
MIDCOM_PRIVILEGE_ALLOW: MIDCOM_PRIVILEGE_ALLOW in constants.php

Allow the privilege.
MIDCOM_PRIVILEGE_ASSIGNEE: MIDCOM_PRIVILEGE_ASSIGNEE in constants.php

Privilege array assignee entry
MIDCOM_PRIVILEGE_DENY: MIDCOM_PRIVILEGE_DENY in constants.php

Deny the privilege.
MIDCOM_PRIVILEGE_INHERIT: MIDCOM_PRIVILEGE_INHERIT in constants.php

Inherit the privilege from the parent.
MIDCOM_PRIVILEGE_NAME: MIDCOM_PRIVILEGE_NAME in constants.php

Privilege array name entry
MIDCOM_PRIVILEGE_SCOPE_ANONYMOUS: MIDCOM_PRIVILEGE_SCOPE_ANONYMOUS in constants.php

Magic scope value for privileges assigned to all unauthenticated users
MIDCOM_PRIVILEGE_SCOPE_EVERYONE: MIDCOM_PRIVILEGE_SCOPE_EVERYONE in constants.php

Magic scope value for privileges assigned to EVERYONE
MIDCOM_PRIVILEGE_SCOPE_OWNER: MIDCOM_PRIVILEGE_SCOPE_OWNER in constants.php

Magic scope value for owner privileges.
MIDCOM_PRIVILEGE_SCOPE_ROOTGROUP: MIDCOM_PRIVILEGE_SCOPE_ROOTGROUP in constants.php

Starting scope value for root groups
MIDCOM_PRIVILEGE_SCOPE_USER: MIDCOM_PRIVILEGE_SCOPE_USER in constants.php

Magic scope value for user privileges.
MIDCOM_PRIVILEGE_SCOPE_USERS: MIDCOM_PRIVILEGE_SCOPE_USERS in constants.php

Magic scope value for privileges assigned to all authenticated users
MIDCOM_PRIVILEGE_SCOPE_VGROUPS: MIDCOM_PRIVILEGE_SCOPE_VGROUPS in constants.php

Default scope value for virtual groups.
MIDCOM_PRIVILEGE_VALUE: MIDCOM_PRIVILEGE_VALUE in constants.php

Privilege array value entry
midcom_probe_nemein_rcs: midcom_probe_nemein_rcs() in misc.php

Probes for the installed NemeinRCS root
MIDCOM_PROP_ACL_PRIVILEGES: MIDCOM_PROP_ACL_PRIVILEGES in constants.php
MIDCOM_PROP_DLOAD: MIDCOM_PROP_DLOAD in constants.php
MIDCOM_PROP_NAME: MIDCOM_PROP_NAME in constants.php
MIDCOM_PROP_PURECODE: MIDCOM_PROP_PURECODE in constants.php
MIDCOM_PROP_VERSION: MIDCOM_PROP_VERSION in constants.php
MIDCOM_PROP_VGROUPS: MIDCOM_PROP_VGROUPS in constants.php
MIDCOM_REQUEST_COMPONENTADM: MIDCOM_REQUEST_COMPONENTADM in constants.php
MIDCOM_REQUEST_CONTENT: MIDCOM_REQUEST_CONTENT in constants.php
MIDCOM_REQUEST_CONTENTADM: MIDCOM_REQUEST_CONTENTADM in constants.php
MIDCOM_ROOT: MIDCOM_ROOT in midcom.php
midcom_show_style: midcom_show_style() in _styleloader.php

Global shortcut.
MIDCOM_STATIC_ROOT: MIDCOM_STATIC_ROOT in midcom.php
MIDCOM_STATIC_URL: MIDCOM_STATIC_URL in midcom.php
MIDCOM_STATUS_CANHANDLE: MIDCOM_STATUS_CANHANDLE in constants.php
MIDCOM_STATUS_CLEANUP: MIDCOM_STATUS_CLEANUP in constants.php
MIDCOM_STATUS_CONTENT: MIDCOM_STATUS_CONTENT in constants.php
MIDCOM_STATUS_HANDLE: MIDCOM_STATUS_HANDLE in constants.php
MIDCOM_STATUS_PREPARE: MIDCOM_STATUS_PREPARE in constants.php
MIDCOM_TOOLBAR_ACCESSKEY: MIDCOM_TOOLBAR_ACCESSKEY in constants.php

The accesskey for this button
MIDCOM_TOOLBAR_ENABLED: MIDCOM_TOOLBAR_ENABLED in constants.php

Element Enabled state
MIDCOM_TOOLBAR_HELPTEXT: MIDCOM_TOOLBAR_HELPTEXT in constants.php

Element Helptext
MIDCOM_TOOLBAR_HIDDEN: MIDCOM_TOOLBAR_HIDDEN in constants.php

Set this to true if you just want to hide this element from the output.
MIDCOM_TOOLBAR_ICON: MIDCOM_TOOLBAR_ICON in constants.php

Element Icon (Relative URL to MIDCOM_STATIC_URL root), e.g. 'stock-icons/16x16/attach.png'.
MIDCOM_TOOLBAR_LABEL: MIDCOM_TOOLBAR_LABEL in constants.php

Element Label
MIDCOM_TOOLBAR_NODE: MIDCOM_TOOLBAR_NODE in constants.php

Identifier for a node toolbar for a request context.
MIDCOM_TOOLBAR_OBJECT: MIDCOM_TOOLBAR_OBJECT in constants.php

Identifier for a custom objcet toolbar.
MIDCOM_TOOLBAR_OPTIONS: MIDCOM_TOOLBAR_OPTIONS in constants.php

Options array.
MIDCOM_TOOLBAR_POST: MIDCOM_TOOLBAR_POST in constants.php

Use an HTTP POST form request if this is true. The default is not to do so.
MIDCOM_TOOLBAR_POST_HIDDENARGS: MIDCOM_TOOLBAR_POST_HIDDENARGS in constants.php

Optional arguments for an POST request.
MIDCOM_TOOLBAR_SUBMENU: MIDCOM_TOOLBAR_SUBMENU in constants.php

Add a subobject here if you want to have nested menus.
MIDCOM_TOOLBAR_URL: MIDCOM_TOOLBAR_URL in constants.php

Element URL
MIDCOM_TOOLBAR_VIEW: MIDCOM_TOOLBAR_VIEW in constants.php

Identifier for a view toolbar for a request context.
MIDCOM_TOOLBAR__ORIGINAL_URL: MIDCOM_TOOLBAR__ORIGINAL_URL in constants.php

Original element URL as defined by the callee.
midcom_update_nemein_rcs: midcom_update_nemein_rcs() in misc.php

MidCOM Interface against NemeinRCS.
MIDCOM_XDEBUG: MIDCOM_XDEBUG in midcom.php
move_extensions_to_object: midcom_core_temporary_object::move_extensions_to_object() in temporary_object.php

Transfers all parametersm attachments and privileges on the current object to another
move_item_down: midcom_helper_toolbar::move_item_down() in toolbar.php

Moves an item on place downwards in the list. This will only work, of course, if you are not working with the bottom element.
move_item_up: midcom_helper_toolbar::move_item_up() in toolbar.php

Moves an item on place upwards in the list. This will only work, of course, if you are not working with the top element.

n

top

$name: midcom_core_group::$name in group.php

Name of the group
$name: midcom_core_user::$name in user.php

The full name of the current user, built from the first and last name of the user record, falling back to the username if both are unset. It is to be considered read-only.
$name: midcom_core_manifest::$name in manifest.php

The name of the component.
$name: midcom_core_privilege::$name in privilege.php

The name of the privilege.
$name_translated: midcom_core_manifest::$name_translated in manifest.php

This is the translated, full component name obtained by looking up the string $name in the l10n library $name. This member is only populated on demand by the get_translated_name() function.
nav.php: nav.php in nav.php
new_query_builder: midcom_helper__dbfactory::new_query_builder() in _dbfactory.php

This function will determine the correct type of MidgardQueryBuilder that has to be created. It will also call the _on_prepare_new_query_builder event handler.

o

top

$object: midcom_helper_metadata::$object in metadata.php

Object to which we are attached to. This object can be accessed from the outside, where neccessary.
$objectguid: midcom_core_privilege::$objectguid in privilege.php

The GUID of the content object this privilege is valid for.
on_update: midcom_helper_metadata::on_update() in metadata.php

This is the update event handler for the Metadata system. It must be called whenever metadata changes to synchronize the various backwards-compatibility values in place throughout the system.

p

top

$parent_node_id: midcom_helper_itemlist::$parent_node_id in itemlist.php
$privileges: midcom_core_manifest::$privileges in manifest.php

Privileges array definition. Indexes are the full privilege names (including the component prefix), values are arrays holding the global / owner privilege default.
$purecode: midcom_core_manifest::$purecode in manifest.php

If this is true, it is a pure-code component, otherwise it is a full blown component.
privilege.php: privilege.php in privilege.php
parse: midcom_helper_mailtemplate::parse() in mailtemplate.php

Parses the template and generates the message body and subject.
path_to_prefix: midcom_helper__componentloader::path_to_prefix() in _componentloader.php

Helper, converting a component path (de.linkm.newsticker) to a class prefix (de_linkm_newsticker).
path_to_snippetpath: midcom_helper__componentloader::path_to_snippetpath() in _componentloader.php

Helper, converting a component path (de.linkm.newsticker) to a snippetpath (/de/linkm/newsticker).
pop_prefix: midcom_debug::pop_prefix() in debug.php

Restore the last debug prefix
prepend_component_styledir: midcom_helper__styleloader::prepend_component_styledir() in _styleloader.php

prepend the styledir of a component
prepend_styledir: midcom_helper__styleloader::prepend_styledir() in _styleloader.php

Function prepend styledir
println_orange: println_orange() in autoconf.php
println_red: println_red() in autoconf.php
print_dump_mem: midcom_debug::print_dump_mem() in debug.php

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

Dump stack trace, only working when XDebug is present.
print_head_elements: midcom_application::print_head_elements() in application.php

Echo the _head elements added.
print_jscripts: midcom_application::print_jscripts() in application.php

Echo the registred javascript code.
print_jsonload: midcom_application::print_jsonload() in application.php

Echo the registred javascript code.
print_r: midcom_debug::print_r() in debug.php

Dump a variable (by reference)
print_type: midcom_debug::print_type() in debug.php

Dump a variables type (by reference)
process_chain: midcom_helper_imagefilter::process_chain() in imagefilter.php

This function will process a string-based filter chain. This is a semicolon-separated list of commands, which will be evaluated using process_command each.
process_command: midcom_helper_imagefilter::process_command() in imagefilter.php

This is the main function evaluator of the filter class.
process_pending_notifies: midcom_helper__componentloader::process_pending_notifies() in _componentloader.php

This function processes all pending notifies and flushes the pending list.
push_prefix: midcom_debug::push_prefix() in debug.php

Set a new debug prefix

q

top

querybuilder.php: querybuilder.php in querybuilder.php

r

top

$rname: midcom_core_user::$rname in user.php

The full reversed name of the current user, built from the first and last name of the user record, falling back to the username if both are unset. It is to be considered read-only.
reindex.php: reindex.php in reindex.php
release_datamanager: midcom_helper_metadata::release_datamanager() in metadata.php
relocate: midcom_application::relocate() in application.php

Relocate to another URL.
remove_all_items: midcom_helper_toolbar::remove_all_items() in toolbar.php

Clears the complete toolbar.
remove_item: midcom_helper_toolbar::remove_item() in toolbar.php

Removes a toolbar item based on its index or its URL
render: midcom_helper_toolbar::render() in toolbar.php

Renders the toolbar and returns it as a string.
render_combined_toolbar: midcom_helper_nav::render_combined_toolbar() in nav.php

Shortcut function, which creates a combined leaf/node-toolbar and renders it immediately.
render_leaf_toolbar: midcom_helper_nav::render_leaf_toolbar() in nav.php

Shortcut function, which creates a leaf-toolbar and renders it immediately.
render_node_toolbar: midcom_helper_nav::render_node_toolbar() in nav.php

Shortcut function, which creates a node-toolbar and renders it immediately.
rescale: midcom_helper_imagefilter::rescale() in imagefilter.php

Image Resize: This will resize the orignal image.
reset_local: midcom_helper_configuration::reset_local() in configuration.php

Clear the local configuration data, effectively reverting to the global default.
resolve_guid: midcom_helper_nav::resolve_guid() in nav.php

This function tries to resolve a guid into an NAP object.
retrieve: midcom_helper_metadata::retrieve() in metadata.php

Returns a metadata object for a given content object.
rotate: midcom_helper_imagefilter::rotate() in imagefilter.php

Manual image rotation

s

top

$scope: midcom_core_user::$scope in user.php

The scope value, which must be set during the _load callback, indicates the "depth" of the group in the inheritance tree. This is used during privilege merging in the content privilege code, which needs a way to determine the proper ordering. All persons currently use the magic value -1.
$scope: midcom_core_group::$scope in group.php

The scope value, which must be set during the _load callback, indicates the "depth" of the group in the inheritance tree. This is used during privilege merging in the content privilege code, which needs a way to determine the proper ordering. Top level groups start with a scope of 1.
$sent: midcom_helper_mailtemplate::$sent in mailtemplate.php

Number of E-Mails sent successfully.
$skip_page_style: midcom_application::$skip_page_style in application.php

Set this variable to true during the handle phase of your component to
$style: midcom_application::$style in application.php

Helperclass to handle all style management. See class description for further information
scan_for_utility: scan_for_utility() in autoconf.php
send: midcom_helper_mailtemplate::send() in mailtemplate.php

Sends the email to both the addresses specified in the template and the addresses passed through $to. You can either pass a single address as a string or an array of addresses.
serve_attachment: midcom_application::serve_attachment() in application.php

Deliver a snippet to the client.
serve_snippet: midcom_application::serve_snippet() in application.php

This function is a copy of serve_attachment, but instead of serving attachments it can serve the code field of an arbitary snippet. There is no checking on permissions done here, the callee has to ensure this. See the URL methods servesnippet(guid) for details.
set: midcom_helper_metadata::set() in metadata.php

Directly set a metadata option.
setLogfile: midcom_debug::setLogfile() in debug.php

Set log file name
setLoglevel: midcom_debug::setLoglevel() in debug.php

Set log level
set_26_request_metadata: midcom_application::set_26_request_metadata() in application.php

This is a temporary tranisition function used to set the currently known and required Request Metadata: The last modified timestamp and the permalink GUID.
set_assignee: midcom_core_privilege::set_assignee() in privilege.php

This call sets the assignee member string to the correct value to represent the object passed, in general, this resolves users and groups to their strings and leaves magic assingees intact.
set_custom_context_data: midcom_application::set_custom_context_data() in application.php

Store arbitary, component-specific information in the component context
set_file: midcom_helper_imagefilter::set_file() in imagefilter.php

Sets the filename of the image currently being edited.
set_lang: midcom_core_querybuilder::set_lang() in querybuilder.php

Returns only objects that are availble in the specified language. This will disable the automatic fallback to the default language which would be in place otherwise.
set_limit: midcom_core_querybuilder::set_limit() in querybuilder.php

Limits the resultset to contain at most the specified number of records.
set_object: midcom_core_privilege::set_object() in privilege.php

Set a privilege to a given content object.
set_offset: midcom_core_querybuilder::set_offset() in querybuilder.php

Sets the offset of the first record to retrieve. This is a zero based index, so if you want to retrieve from the very first record, the correct offset would be zero, not one.
set_pagetitle: midcom_application::set_pagetitle() in application.php

Sets the page title for the current context.
set_parameters: midcom_helper_mailtemplate::set_parameters() in mailtemplate.php

This will set the template parameters accordingly.
show: midcom_helper__styleloader::show() in _styleloader.php

Looks for a style element matching $path (either in a user defined style or the default style snippetdir) and displays/evaluates it.
show_combined_nav: midcom_helper_nav::show_combined_nav() in nav.php

Generate a fully automated navigation.
show_item: midcom_helper_toolbar::show_item() in toolbar.php

Set's an item's hidden flag to false.
show_simple_nav: midcom_helper_nav::show_simple_nav() in nav.php

Generate a fully automated navigation.
snippetpath_to_prefix: midcom_helper__componentloader::snippetpath_to_prefix() in _componentloader.php

Helper, converting a snippetpath (/de/linkm/newsticker) to a class prefix (de_linkm_newsticker).
sort_cmp: midcom_helper_itemlist_score::sort_cmp() in score.php
store: midcom_helper_configuration::store() in configuration.php

The method store will write the parameters in $params into the local configuration.
store: midcom_core_privilege::store() in privilege.php

Store the privilege. This will validate it first and then either update an existing privilege record, or create a new one, depending on the DB state.
store_from_object: midcom_helper_configuration::store_from_object() in configuration.php

Import data from a Midgard object.
substyle_append: midcom_application::substyle_append() in application.php

Appends a substyle after the currently selected component style.
substyle_prepend: midcom_application::substyle_prepend() in application.php

Prepends a substyle before the currently selected component style.

t

top

$tmp: midcom_application::$tmp in application.php

The temporary object service.
$toolbars: midcom_application::$toolbars in application.php

The toolbars service.
topicsfirst.php: topicsfirst.php in topicsfirst.php
toolbar.php: toolbar.php in toolbar.php
trigger_watches: midcom_helper__componentloader::trigger_watches() in _componentloader.php

This is called by the framework whenever watchable events occur.

u

top

$uimessages: midcom_application::$uimessages in application.php

The UI messages service.
$username: midcom_core_user::$username in user.php

Username of the current user, it is to be considered read-only.
user.php: user.php in user.php
urlparser.php: urlparser.php in urlparser.php
unapprove: midcom_helper_metadata::unapprove() in metadata.php

Unapproves the object.
unfetch: midcom_helper_urlparser::unfetch() in urlparser.php

Undo the last fetch operation.
update_item_url: midcom_helper_toolbar::update_item_url() in toolbar.php

Updates an items URL using the same rules as in add_item.
update_password: midcom_core_user::update_password() in user.php

Updates the password to the new one. This requires update privileges on the person storage object.
update_username: midcom_core_user::update_username() in user.php

Updates the username to the new one. This requires update privileges on the person storage object.

v

top

$value: midcom_core_privilege::$value in privilege.php

The privilege value.
$version: midcom_core_manifest::$version in manifest.php

Old version number of the components, currently specified as integer. Not really used within the system, but you may (actually should) use it for your own versioning.
version.php: version.php in version.php
validate: midcom_core_privilege::validate() in privilege.php

This call validates the privilege for correctness of all set options. This includes:
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
view_current_page_url: midcom_helper_nav::view_current_page_url() in nav.php

This function provides an interface to construct links like "View this page".

w

top

$watches: midcom_core_manifest::$watches in manifest.php

A list of all watches defined by the component.