[midcom.baseclasses] element index

Package indexes

All elements

_

top

$_acl_privileges: midcom_baseclasses_components_interface::$_acl_privileges in interface.php
$_ais_class_suffix: midcom_baseclasses_components_interface::$_ais_class_suffix in interface.php

This is the class suffix used when constructing the AIS handler class.
$_anchor_prefix: midcom_admin_content_topic_plugin::$_anchor_prefix in _topic_plugin.php
$_autoload_class_definitions: midcom_baseclasses_components_interface::$_autoload_class_definitions in interface.php
$_autoload_files: midcom_baseclasses_components_interface::$_autoload_files in interface.php

A list of files, relative to the components root directory, that should be loaded during initialization.
$_autoload_libraries: midcom_baseclasses_components_interface::$_autoload_libraries in interface.php

A list of libraries which should by loaded during initialization.
$_component: midcom_baseclasses_components_navigation::$_component in navigation.php

Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
$_component: midcom_baseclasses_components_cron_handler::$_component in cron_handler.php

The name of the component to which this handler is accociated.
$_component: midcom_baseclasses_components_handler::$_component in handler.php

Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
$_component: midcom_baseclasses_components_interface::$_component in interface.php

The name of the component, e.g. de.linkm.taviewer
$_component: midcom_baseclasses_components_purecode::$_component in purecode.php

Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
$_component: midcom_baseclasses_components_request::$_component in request.php

Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
$_component_data: midcom_baseclasses_components_handler::$_component_data in handler.php

Component data storage area.
$_component_data: midcom_baseclasses_components_request::$_component_data in request.php

Component data storage area.
$_component_data: midcom_baseclasses_components_navigation::$_component_data in navigation.php

Component data storage area.
$_component_data: midcom_baseclasses_components_cron_handler::$_component_data in cron_handler.php

The systemwide component data store.
$_component_data: midcom_baseclasses_components_purecode::$_component_data in purecode.php

Component data storage area.
$_component_interface: midcom_baseclasses_components_cron_handler::$_component_interface in cron_handler.php

This is a reference to the Component Interface class. It is loaded during class instantination and only available for baseclass driven component interfaces, not for legacy classes.
$_component_path: midcom_baseclasses_components_interface::$_component_path in interface.php

The full path to the components' root directory. Used for loading files.
$_config: midcom_baseclasses_components_request::$_config in request.php

The current configuration.
$_config: midcom_baseclasses_components_handler::$_config in handler.php

The current configuration.
$_config: midcom_baseclasses_components_cron_handler::$_config in cron_handler.php

The systemwide component configuration, obtained from the component during class initialization.
$_config: midcom_baseclasses_components_purecode::$_config in purecode.php

The current configuration, possibly modified by the _load_topic_configuration helper.
$_config: midcom_baseclasses_components_navigation::$_config in navigation.php

The current configuration.
$_config_snippet_name: midcom_baseclasses_components_interface::$_config_snippet_name in interface.php

This is used during initialization when loading the default configurations from the filesystem ($prefix/config/$name.inc) and the snippetdirs ($GLOBALS['midcom_config']['midcom_sgconfig_basedir']/$component/$name).
$_context_data: midcom_baseclasses_components_interface::$_context_data in interface.php

This variable holds the context-specific data during processing.
$_count_mode: org_openpsa_qbpager::$_count_mode in pager.php
$_current_page: org_openpsa_qbpager::$_current_page in pager.php
$_data: midcom_baseclasses_components_interface::$_data in interface.php

The component-specific data storage, hold in the global Array $midcom_component_data, which is indexed by the component name.
$_handler: midcom_baseclasses_components_request::$_handler in request.php

This is a reference to the handler which declared to be able to handle the request. The array will contain the original index of the handler in the 'id' member for backtracking purposes. The variable argument list will be placed into 'args' for performance reasons.
$_handler_config: midcom_baseclasses_components_cron_handler::$_handler_config in cron_handler.php

The local handler configuration as written in the Component Manifest.
$_i18n: midcom_baseclasses_components_handler::$_i18n in handler.php

A handle to the i18n service.
$_i18n: midcom_baseclasses_components_navigation::$_i18n in navigation.php

A handle to the i18n service.
$_i18n: midcom_baseclasses_components_purecode::$_i18n in purecode.php

A handle to the i18n service.
$_i18n: midcom_baseclasses_components_request::$_i18n in request.php

A handle to the i18n service.
$_l10n: midcom_baseclasses_components_request::$_l10n in request.php

The components' L10n string database
$_l10n: midcom_baseclasses_components_purecode::$_l10n in purecode.php

The components' L10n string database
$_l10n: midcom_baseclasses_components_handler::$_l10n in handler.php

The components' L10n string database
$_l10n: midcom_baseclasses_components_navigation::$_l10n in navigation.php

The components' L10n string database
$_l10n_midcom: midcom_baseclasses_components_request::$_l10n_midcom in request.php

The global MidCOM string database
$_l10n_midcom: midcom_baseclasses_components_navigation::$_l10n_midcom in navigation.php

The global MidCOM string database
$_l10n_midcom: midcom_baseclasses_components_purecode::$_l10n_midcom in purecode.php

The global MidCOM string database
$_l10n_midcom: midcom_baseclasses_components_handler::$_l10n_midcom in handler.php

The global MidCOM string database
$_limit: org_openpsa_qbpager::$_limit in pager.php
$_local_toolbar: midcom_baseclasses_components_request_admin::$_local_toolbar in request_admin.php

The toolbar local to the current request
$_manifest: midcom_baseclasses_components_interface::$_manifest in interface.php

The component manifest instance accociated with this component. Read-Only and automatically populated during initialization.
$_master: midcom_baseclasses_components_handler::$_master in handler.php

A reference to the request class that has invoked this handler instance.
$_meta_toolbar: midcom_baseclasses_components_request_admin::$_meta_toolbar in request_admin.php

The Metadata toolbar. You should normally have no need to modify it.
$_midcom_qb: org_openpsa_qbpager::$_midcom_qb in pager.php
$_nap_class_suffix: midcom_baseclasses_components_interface::$_nap_class_suffix in interface.php

This is the class suffix used when constructing the NAP handler class.
$_nap_instance: midcom_baseclasses_components_interface::$_nap_instance in interface.php

The NAP interface instance from the component, initialized on demand.
$_newtopic: midcom_admin_content_topic_plugin::$_newtopic in _topic_plugin.php
$_node_toolbar: midcom_baseclasses_components_handler::$_node_toolbar in handler.php

The node toolbar for the current request context. Not available during the can_handle phase.
$_node_toolbar: midcom_baseclasses_components_request::$_node_toolbar in request.php

The node toolbar for the current request context. Not available during the can_handle phase.
$_offset: org_openpsa_qbpager::$_offset in pager.php
$_onsite_toolbar_css: midcom_baseclasses_components_request::$_onsite_toolbar_css in request.php

The url to the css file to be added when onsite toolbars are shown.
$_open_handle: midcom_baseclasses_database_attachment::$_open_handle in attachment.php

Internal tracking state variable, holds the file handle of any open attachment.
$_pager_id: org_openpsa_qbpager::$_pager_id in pager.php
$_plugin_namespace_config: midcom_baseclasses_components_request::$_plugin_namespace_config in request.php

This variable keeps track of the registered plugin namespaces. It maps namespace identifiers against plugin config lists. This is used during can_handle startup to determine whether the request has to be relayed to a plugin.
$_prefix: org_openpsa_qbpager::$_prefix in pager.php
$_processing_msg: midcom_admin_content_topic_plugin::$_processing_msg in _topic_plugin.php
$_purecode: midcom_baseclasses_components_interface::$_purecode in interface.php
$_request_data: org_openpsa_qbpager::$_request_data in pager.php
$_request_data: midcom_baseclasses_components_request::$_request_data in request.php

Request specific data storage area. Registered in the component context as ''.
$_request_data: midcom_baseclasses_components_handler::$_request_data in handler.php

Request specific data storage area. Registered in the component context as ''.
$_request_switch: midcom_baseclasses_components_request::$_request_switch in request.php

Request execution switch configuration.
$_site_class_suffix: midcom_baseclasses_components_interface::$_site_class_suffix in interface.php

This is the class suffix used when constructing the on-site handler class.
$_topic: midcom_baseclasses_components_request::$_topic in request.php

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

The topic for which we are handling a requiest.
$_topic: midcom_baseclasses_components_handler::$_topic in handler.php

The topic for which we are handling a requiest.
$_topic_toolbar: midcom_baseclasses_components_request_admin::$_topic_toolbar in request_admin.php

The toolbar of the topic.
$_version: midcom_baseclasses_components_interface::$_version in interface.php
$_view_toolbar: midcom_baseclasses_components_handler::$_view_toolbar in handler.php

The view toolbar for the current request context. Not available during the can_handle phase.
$_view_toolbar: midcom_baseclasses_components_request::$_view_toolbar in request.php

The view toolbar for the current request context. Not available during the can_handle phase.
_bind_to_request_data: midcom_baseclasses_components_purecode::_bind_to_request_data() in purecode.php

Binds the object to the current request data. This populates the members _request_data, _config, _topic, _l10n and _l10n_midcom accordingly.
_check_author: midcom_baseclasses_database_article::_check_author() in article.php

Internal helper function, invoked during create and update which validates the author field to be correct.
_check_name: midcom_baseclasses_database_article::_check_name() in article.php

Check that article by same name doesn't exist in the topic in Classic Midgard API fashion.
_check_nap_instance: midcom_baseclasses_components_interface::_check_nap_instance() in interface.php

Checks, wether an instance of the NAP interface class has already been created and creates it if not.
_check_page_vars: org_openpsa_qbpager::_check_page_vars() in pager.php

Check $_REQUEST for variables and sets internal status accordingly
_clear_object: midcom_baseclasses_core_dbobject::_clear_object() in dbobject.php

Internal helper function, which clears all variables of an object with the exception of the __ prefixed internal ones. This is used to reset an object after a failed permission check for example.
_create_attachment_location: midcom_baseclasses_database_attachment::_create_attachment_location() in attachment.php

Internal helper, computes an MD5 string which is used as an attachment location.
_create_parameter_object: midcom_baseclasses_core_dbobject::_create_parameter_object() in dbobject.php

Internal helper, which creates a new parameter object. ACL checks have to be done by the callee.
_delete_privileges: midcom_baseclasses_core_dbobject::_delete_privileges() in dbobject.php

Internal helper function, called upon successful delete. It will unconditionally drop all privileges assigned to the given object.
_delete_topic_update_index: midcom_admin_content_topic_plugin::_delete_topic_update_index() in _topic_plugin.php
_encode_req_feat: org_openpsa_smslib_clickatell::_encode_req_feat() in clickatell.php

Encodes the features list to decimal value used by the server
_get_content_error: org_openpsa_smslib_clickatell::_get_content_error() in clickatell.php

Look for error messages in content and decode them, returns false on no errors found, true on errors found.
_get_http_error: org_openpsa_smslib_clickatell::_get_http_error() in clickatell.php

Server HTTP level error decode
_get_parameter_object: midcom_baseclasses_core_dbobject::_get_parameter_object() in dbobject.php

Internal helper function that retrieves a parameter object for a given domain/name pair.
_get_remote_error: org_openpsa_smslib_messto::_get_remote_error() in messto.php
_get_remote_error: org_openpsa_smslib_tambur::_get_remote_error() in tambur.php
_handler_approval: midcom_admin_content_topic_plugin::_handler_approval() in _topic_plugin.php
_handler_configdm: midcom_core_handler_configdm::_handler_configdm() in configdm.php

Datamanager configuration handler interface.
_handler_configdm_prepare: midcom_core_handler_configdm::_handler_configdm_prepare() in configdm.php

Helper function that prepares a datamanager instance for the configdm handler.
_handler_config_dm: midcom_baseclasses_components_request_admin::_handler_config_dm() in request_admin.php

Datamanager configuration handler interface.
_handler_config_dm_prepare: midcom_baseclasses_components_request_admin::_handler_config_dm_prepare() in request_admin.php

Helper function that prepares a datamanager instance for the config_dm handler.
_handler_create: midcom_admin_content_topic_plugin::_handler_create() in _topic_plugin.php
_handler_delete: midcom_admin_content_topic_plugin::_handler_delete() in _topic_plugin.php
_handler_edit: midcom_admin_content_topic_plugin::_handler_edit() in _topic_plugin.php
_handler_metadata: midcom_admin_content_topic_plugin::_handler_metadata() in _topic_plugin.php
_handler_welcome_deprecated: midcom_baseclasses_components_request_admin::_handler_welcome_deprecated() in request_admin.php

Fallback handler, shown in case no handler has been defined anymore by deprecated AIS classes. Displays a simple welcome page.
_list_parameters_all: midcom_baseclasses_core_dbobject::_list_parameters_all() in dbobject.php

List all parameters of an object.
_list_parameters_domain: midcom_baseclasses_core_dbobject::_list_parameters_domain() in dbobject.php

List the parameters of a single domain of an object.
_load_configuration: midcom_baseclasses_components_interface::_load_configuration() in interface.php

Loads the configuration file specified by the component configuration
_load_plugin: midcom_baseclasses_components_request::_load_plugin() in request.php

This helper loads the specified namespace/plugin combo.
_load_plugin_class: midcom_baseclasses_components_request::_load_plugin_class() in request.php

Loads the file/snippet neccessary for a given plugin, according to its configuration.
_load_topic_configuration: midcom_baseclasses_components_purecode::_load_topic_configuration() in purecode.php

This is an internal helper which you can use to merge a topic configuration set for your component into your local configuration store. Call this without an argument to reset to the global defaults.
_on_can_handle: midcom_baseclasses_components_request::_on_can_handle() in request.php

Component specific initialization code for the can_handle phase.
_on_check_document_permissions: midcom_baseclasses_components_interface::_on_check_document_permissions() in interface.php

Verif an indexer document's permissions. This is used for custom, advanced access control within a components domain.
_on_created: org_openpsa_documents_directory::_on_created() in directory_midcomdba.php
_on_created: midcom_baseclasses_database_attachment::_on_created() in attachment.php

Created callback, triggers watches on the parent(!) object.
_on_created: midcom_baseclasses_database_person::_on_created() in person.php

Updates all computed members and adds a midgard:owner privilege for the person itself on the record.
_on_creating: midcom_baseclasses_database_attachment::_on_creating() in attachment.php

Simple creation event handler which fills out the location field if it is still empty with a location generated by _create_attachemtn_location().
_on_creating: midcom_baseclasses_database_article::_on_creating() in article.php

Pre-Creation hook, which validates the $author field for correctness.
_on_deleted: midcom_baseclasses_database_event::_on_deleted() in event.php

Deletes event membership records accociated with this event.
_on_deleted: midcom_baseclasses_database_attachment::_on_deleted() in attachment.php

Deleted callback, triggers watches on the parent(!) object.
_on_deleted: midcom_baseclasses_database_person::_on_deleted() in person.php

Deletes all group and event memberships of the original person record. SUDO privileges are used at this point, since only memberships are accociated to the groups, not persons and event memberships belong to the event, again not to the person.
_on_execute: midcom_baseclasses_components_cron_handler::_on_execute() in cron_handler.php

This is the actual handler operation, it is called only after successful operation.
_on_get_metadata: midcom_baseclasses_components_request::_on_get_metadata() in request.php

Returns a metadata object for the currently selected object, or null if no Metadata is available. The default implementation defaults to the topics' metadata object.
_on_handle: midcom_baseclasses_components_request::_on_handle() in request.php

Component specific initialization code for the handle phase. AIS, for example, uses this to preapre the toolbar arrays. The name of the request handler is passed as an argumet to the event handler.
_on_handler_configdm_prepared: midcom_core_handler_configdm::_on_handler_configdm_prepared() in configdm.php

Event handler, called after the configuration datamanager instance has been created but not yet initialized. Use this hook to modify the schema where neccessary.
_on_handler_configdm_preparing: midcom_core_handler_configdm::_on_handler_configdm_preparing() in configdm.php

Event handler, called before the configuration datamanger is created. Use this to prepare anything that is required to start up the Datamanager.
_on_handler_configdm_saved: midcom_core_handler_configdm::_on_handler_configdm_saved() in configdm.php

Event handler, called when the configuration system has successfully stored new configuration settings.
_on_handler_config_dm_prepared: midcom_baseclasses_components_request_admin::_on_handler_config_dm_prepared() in request_admin.php

Event handler, called after the configuration datamanager instance has been created but not yet initialized. Use this hook to modify the schema where neccessary.
_on_handler_config_dm_preparing: midcom_baseclasses_components_request_admin::_on_handler_config_dm_preparing() in request_admin.php

Event handler, called before the configuration datamanger is created. Use this to prepare anything that is required to start up the Datamanager.
_on_handler_config_dm_saved: midcom_baseclasses_components_request_admin::_on_handler_config_dm_saved() in request_admin.php

Event handler, called when the configuration system has successfully stored new configuration settings.
_on_initialize: midcom_baseclasses_components_handler::_on_initialize() in handler.php

Initialization event handler, called at the end of the initialization process.
_on_initialize: midcom_baseclasses_components_interface::_on_initialize() in interface.php

This is an event handler, called after the basic component initialization has been done just before the initialize call will return to MidCOM.
_on_initialize: midcom_admin_content_topic_plugin::_on_initialize() in _topic_plugin.php
_on_initialize: midcom_baseclasses_components_request::_on_initialize() in request.php

Initialization event handler, called at the end of the initialization process immediately before the request handler configuration is read.
_on_initialize: midcom_baseclasses_components_cron_handler::_on_initialize() in cron_handler.php

This callback is executed immediately after object constuction. You can initialize your class here.
_on_loaded: midcom_baseclasses_database_person::_on_loaded() in person.php

Updates all computed members.
_on_reindex: midcom_baseclasses_components_interface::_on_reindex() in interface.php

Reindex the given topic. The complete configuration set is already available in $config. The original index records are already deleted, so you do not need to bother about this.
_on_resolve_permalink: midcom_baseclasses_components_interface::_on_resolve_permalink() in interface.php

This interface function is used to check wether a component can handle a given GUID or not on site only. A topic is provided which limits the "scope" of the search accordingly. It can be safely assumed that the topic given is a valid topic in the MidCOM content tree (it is checked through NAP).
_on_retrieve_vgroup_members: midcom_baseclasses_components_interface::_on_retrieve_vgroup_members() in interface.php

Retrieve all members of a given virtual group. This information may be cached by the framework.
_on_set_object: midcom_baseclasses_components_navigation::_on_set_object() in navigation.php

Event handler called after a new topic has been set. The configuration is already loaded at this point.
_on_show: midcom_baseclasses_components_request::_on_show() in request.php

Generic output initialization code. The return value lets you control wether the output method accociated with the handler declaration is called, return false to override this automatism, true, the default, will call the output handler normally.
_on_updated: org_openpsa_documents_directory::_on_updated() in directory_midcomdba.php
_on_updated: midcom_baseclasses_database_attachment::_on_updated() in attachment.php

Updated callback, triggers watches on the parent(!) object.
_on_updated: midcom_baseclasses_database_person::_on_updated() in person.php

Updates all computed members.
_on_updating: midcom_baseclasses_database_article::_on_updating() in article.php

Pre-Update hook, which validates the $author field for correctness.
_on_watched_dba_create: midcom_baseclasses_components_interface::_on_watched_dba_create() in interface.php

This function is triggered at the end of the request for each watched create operation that has been done during the request.
_on_watched_dba_delete: midcom_baseclasses_components_interface::_on_watched_dba_delete() in interface.php

This function is triggered at the end of the request for each watched delete operation that has been done during the request.
_on_watched_dba_update: midcom_baseclasses_components_interface::_on_watched_dba_update() in interface.php

This function is triggered at the end of the request for each watched update operation that has been done during the request.
_on_watched_operation: midcom_baseclasses_components_interface::_on_watched_operation() in interface.php

This function is triggered at the end of the request for each watched operation that has been done during the request.
_prepare_handler: midcom_baseclasses_components_request::_prepare_handler() in request.php

Helper function, which prepares the handler callback for execution.
_prepare_plugin: midcom_baseclasses_components_request::_prepare_plugin() in request.php

Prepares the actual plugin by adding all neccessary information to the request switch.
_prepare_request_switch: midcom_baseclasses_components_request::_prepare_request_switch() in request.php

This private helper post-processes the initial information as set by the constructor.
_process_create_form: midcom_admin_content_topic_plugin::_process_create_form() in _topic_plugin.php
_process_delete_form: midcom_admin_content_topic_plugin::_process_delete_form() in _topic_plugin.php
_process_edit_form: midcom_admin_content_topic_plugin::_process_edit_form() in _topic_plugin.php
_qb_limits: org_openpsa_qbpager::_qb_limits() in pager.php

sets LIMIT and OFFSET for requested page
_register_core_plugin_namespaces: midcom_baseclasses_components_request::_register_core_plugin_namespaces() in request.php

This helper function registers the plugin namespaces provided from the MidCOM core.
_rewrite_timestamps_to_isodate: midcom_baseclasses_core_dbobject::_rewrite_timestamps_to_isodate() in dbobject.php

This function prepares the previously converted UNIX timestamps again for saving by converting them back to ISO 8859-1 Format.
_rewrite_timestamps_to_unixdate: midcom_baseclasses_core_dbobject::_rewrite_timestamps_to_unixdate() in dbobject.php

This function parses the loaded object and detects all meta timestamps of the original Midgard object which were in Unix Timestamp format before that and are in ISO format now.
_sanity_check: org_openpsa_smslib_messto::_sanity_check() in messto.php
_sanity_check: org_openpsa_smslib_tambur::_sanity_check() in tambur.php
_sanity_check: org_openpsa_smslib_clickatell::_sanity_check() in clickatell.php
_sanity_check: org_openpsa_qbpager::_sanity_check() in pager.php

Makes sure we have some absolutely required things properly set
_set_creator: midcom_baseclasses_core_dbobject::_set_creator() in dbobject.php

This is an internal helper which updates the created/creator timestamp on a record if the corresponding fields exists.
_set_owner_privileges: midcom_baseclasses_core_dbobject::_set_owner_privileges() in dbobject.php

This is an internal helper adds full privileges to the owner of the object.
_set_revisor: midcom_baseclasses_core_dbobject::_set_revisor() in dbobject.php

This is an internal helper which updates the revised/revisor timestamp on a record if the corresponding fields exists.
_show_configdm: midcom_core_handler_configdm::_show_configdm() in configdm.php

Simple display handler for the configdm handler, it uses the MidCOM L10n string 'component configuration' as heading, and immediately displays the form afterwards.
_show_config_dm: midcom_baseclasses_components_request_admin::_show_config_dm() in request_admin.php

Simple display handler for the config_dm handler, it uses the MidCOM L10n string 'component configuration' as heading, and immediately displays the form afterwards.
_show_create: midcom_admin_content_topic_plugin::_show_create() in _topic_plugin.php
_show_delete: midcom_admin_content_topic_plugin::_show_delete() in _topic_plugin.php
_show_edit: midcom_admin_content_topic_plugin::_show_edit() in _topic_plugin.php
_show_metadata: midcom_admin_content_topic_plugin::_show_metadata() in _topic_plugin.php
_show_welcome_deprecated: midcom_baseclasses_components_request_admin::_show_welcome_deprecated() in request_admin.php

Fallback handler, shown in case no handler has been defined anymore by deprecated AIS classes. Displays a simple welcome page noting that everything is done directly on-site now.
_update_computed_members: midcom_baseclasses_database_person::_update_computed_members() in person.php

Synchronizes the $name, $rname, $emaillink and $homepagelink members with the members they are based on.
_verify_handler_class: midcom_baseclasses_components_request::_verify_handler_class() in request.php

This is an helper function used during handler startup. It ensures that handler class is loaded. It has auto-class-loading support, which allows the component author to have the handler classes only loaded on demand (see class introduction).

a

top

$api_id: org_openpsa_smslib_clickatell::$api_id in clickatell.php
add_constraint: org_openpsa_qbpager::add_constraint() in pager.php
add_order: org_openpsa_qbpager::add_order() in pager.php
article.php: article.php in article.php
attachment.php: attachment.php in attachment.php

b

top

begin_group: org_openpsa_qbpager::begin_group() in pager.php

c

top

$client_id: org_openpsa_smslib::$client_id in factory.php
$count: org_openpsa_qbpager::$count in pager.php
can_handle: midcom_baseclasses_components_request::can_handle() in request.php

CAN_HANDLE Phase interface, checks against all registered handlers if a vaild one can be found. You should not need to override this, instead, use the HANDLE Phase for further checks.
can_handle: midcom_baseclasses_components_interface::can_handle() in interface.php

Relays the can_handle call to the component, instantinating a new AIS or Site class respecitvly. It will execute can_handle of that class, retruning its result to MidCOM.
check_document_permissions: midcom_baseclasses_components_interface::check_document_permissions() in interface.php

Verif an indexer document's permissions.
close: midcom_baseclasses_database_attachment::close() in attachment.php

This function closes the open write handle obtained by the open() call again.
configure: midcom_baseclasses_components_interface::configure() in interface.php

Configures the component for usage. The configuration is merged, and, if neccessary, an existing handler object is purged.
copy_from_file: midcom_baseclasses_database_attachment::copy_from_file() in attachment.php

Updates the contents of the attachments with the contents of the file specified.
copy_from_handle: midcom_baseclasses_database_attachment::copy_from_handle() in attachment.php

Updates the contents of the attachments with the contents of the resource identified by the filehandle passed.
count: org_openpsa_qbpager::count() in pager.php
count_pages: org_openpsa_qbpager::count_pages() in pager.php

Returns number of total pages for query
count_unchecked: org_openpsa_qbpager::count_unchecked() in pager.php
count_unchecked: org_openpsa_qbpager_direct::count_unchecked() in pager_direct.php

Wraps to count since midgard QB does not support said method yet
create: midcom_baseclasses_core_dbobject::create() in dbobject.php

Execute a DB create of the object passed. This will call the corresponding event handlers. Calling sequence with method signatures:
createattachment: midcom_baseclasses_core_dbobject::createattachment() in dbobject.php

Legacy Midgard Compatibility function.
create_attachment: midcom_baseclasses_core_dbobject::create_attachment() in dbobject.php

Creates a new attachment at the current object and returns it for usage.
create_new_privilege_object: midcom_baseclasses_core_dbobject::create_new_privilege_object() in dbobject.php

This helper function will create a new privilege object for the object in question.
cron_handler.php: cron_handler.php in cron_handler.php

d

top

$display_pages: org_openpsa_qbpager::$display_pages in pager.php
delete: midcom_baseclasses_core_dbobject::delete() in dbobject.php

Execute a DB delete of the object passed. This will call the corresponding event handlers. Calling sequence with method signatures:
delete_attachment: midcom_baseclasses_core_dbobject::delete_attachment() in dbobject.php

Delete an attachment on an arbitary object by its name.
delete_parameter: midcom_baseclasses_core_dbobject::delete_parameter() in dbobject.php

Delete a parameter of a given object to the value specified.
dbobject.php: dbobject.php in dbobject.php

e

top

$emaillink: midcom_baseclasses_database_person::$emaillink in person.php

Read-Only variable, consisting of ta complete mailto A HREF tag to the set email addres.
$errcode: midcom_baseclasses_components_handler::$errcode in handler.php

The last error code of the component. Set this when the request handling fails.
$errcode: org_openpsa_smslib::$errcode in factory.php
$errcode: midcom_baseclasses_components_request::$errcode in request.php

The last error code of the component. Set this when the request handling fails.
$errstr: midcom_baseclasses_components_handler::$errstr in handler.php

The last error message of the component. Set this when the request handling fails.
$errstr: org_openpsa_smslib::$errstr in factory.php
$errstr: midcom_baseclasses_components_request::$errstr in request.php

The last error message of the component. Set this when the request handling fails.
end_group: org_openpsa_qbpager::end_group() in pager.php
errcode: midcom_baseclasses_components_interface::errcode() in interface.php

Returns the last error code of the component.
errstr: midcom_baseclasses_components_interface::errstr() in interface.php

Returns the last error message of the component.
execute: org_openpsa_qbpager::execute() in pager.php
execute: org_openpsa_qbpager_direct::execute() in pager_direct.php
execute: midcom_baseclasses_components_cron_handler::execute() in cron_handler.php

Execute the handler, this calls the corresponding event handler.
execute_unchecked: org_openpsa_qbpager::execute_unchecked() in pager.php
execute_unchecked: org_openpsa_qbpager_direct::execute_unchecked() in pager_direct.php

Wraps to count since midgard QB does not support said method yet
element.php: element.php in element.php
eventmember.php: eventmember.php in eventmember.php
event.php: event.php in event.php

f

top

$features: org_openpsa_smslib_clickatell::$features in clickatell.php
factory: org_openpsa_smslib::factory() in factory.php

g

top

get_attachment: midcom_baseclasses_core_dbobject::get_attachment() in dbobject.php

Retrieves an attac hment on an arbitary object by its name.
get_attachment_qb: midcom_baseclasses_core_dbobject::get_attachment_qb() in dbobject.php

Returns a prepared query builder that is already limited to the attachments of the given object.
get_author: midcom_baseclasses_database_article::get_author() in article.php

Returns the User-Object representing the author of the record. This is the object behind the $author member of this object.
get_balance: org_openpsa_smslib_clickatell::get_balance() in clickatell.php

Returns (bool)false on error or whatever the GW returns Non-numeric balance should be supposed infinite.
get_balance: org_openpsa_smslib_tambur::get_balance() in tambur.php

Returns either (int)balance on success or (bool)false on error
get_by_guid: midcom_baseclasses_core_dbobject::get_by_guid() in dbobject.php

This call wraps the original get_by_guid call to provide access control.
get_by_id: midcom_baseclasses_core_dbobject::get_by_id() in dbobject.php

This call wraps the original get_by_id call to provide access control.
get_by_path: midcom_baseclasses_core_dbobject::get_by_path() in dbobject.php

This call wraps the original get_by_guid call to provide access control.
get_config_for_topic: midcom_baseclasses_components_interface::get_config_for_topic() in interface.php

This is a small helper function which gets the full configuration set active for a given topic. If no topic is passed, the systemwide default configuration is returned.
get_current_leaf: midcom_baseclasses_components_interface::get_current_leaf() in interface.php

Returns the currently selected leaf of the request.
get_leaves: midcom_baseclasses_components_interface::get_leaves() in interface.php

Relays the get_leaves call to the NAP instance.
get_leaves: midcom_baseclasses_components_navigation::get_leaves() in navigation.php

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

Returns the metadata of the currently selected object. It uses a callback to determine a metadata object which contains the neccessary information.
get_metadata: midcom_baseclasses_core_dbobject::get_metadata() in dbobject.php

This helper will return a reference to the metadata class accociated with the given object instance.
get_node: midcom_baseclasses_components_interface::get_node() in interface.php

Relays the get_node call to the NAP instance.
get_node: midcom_baseclasses_components_navigation::get_node() in navigation.php

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

Return a parameter from the database.
get_parent: midcom_baseclasses_core_dbobject::get_parent() in dbobject.php

Returns the the parent object. Tries to utilize the Memcache data, loading the actual information only if it is not cached.
get_parent_guid: midcom_baseclasses_core_dbobject::get_parent_guid() in dbobject.php

Returns the GUID of the parent object. Tries to utilize the Memcache data, loading the actual information only if it is not cached.
get_parent_guid_uncached: midcom_baseclasses_database_style::get_parent_guid_uncached() in style.php

Returns the Parent of the Snippet.
get_parent_guid_uncached: midcom_baseclasses_database_topic::get_parent_guid_uncached() in topic.php

Returns the Parent of the Topic, which is always another topic.
get_parent_guid_uncached: midcom_baseclasses_database_snippetdir::get_parent_guid_uncached() in snippetdir.php

Returns the Parent of the Snippet.
get_parent_guid_uncached: midcom_baseclasses_database_snippet::get_parent_guid_uncached() in snippet.php

Returns the Parent of the Snippet.
get_parent_guid_uncached: midcom_baseclasses_database_pageelement::get_parent_guid_uncached() in pageelement.php

Returns the Parent of the Page.
get_parent_guid_uncached: midcom_baseclasses_database_page::get_parent_guid_uncached() in page.php

Returns the Parent of the Page.
get_parent_guid_uncached: midcom_baseclasses_database_eventmember::get_parent_guid_uncached() in eventmember.php

Returns the Parent of the Eventmmeber. This is the event it is assinged to.
get_parent_guid_uncached: midcom_baseclasses_database_attachment::get_parent_guid_uncached() in attachment.php

Returns the Parent of the Attachment, which is identified by the table/id combination in the attachment record. The table in question is used to identify the object to use. If multiple objects are registered for a given table, the first matching class returned by the dbfactory is used (which is usually rather arbitary).
get_parent_guid_uncached: midcom_baseclasses_database_article::get_parent_guid_uncached() in article.php

Returns the Parent of the Article. This can either be another article if we have an reply article, or a topic otherwise.
get_parent_guid_uncached: midcom_baseclasses_database_member::get_parent_guid_uncached() in member.php

Returns the group the membership record is accociated with. This allows group owners to manage their members.
get_parent_guid_uncached: midcom_baseclasses_database_element::get_parent_guid_uncached() in element.php

Returns the Parent of the Element. This is the style the element is assinged to.
get_parent_guid_uncached: midcom_baseclasses_database_group::get_parent_guid_uncached() in group.php

Gets the parent object of the current one.
get_parent_guid_uncached: midcom_baseclasses_database_event::get_parent_guid_uncached() in event.php

Returns the Parent of the Event. This can either be another event if we have an reply event, or a topic otherwise.
get_plugin_handlers: midcom_admin_content_topic_plugin::get_plugin_handlers() in _topic_plugin.php
get_privilege: midcom_baseclasses_core_dbobject::get_privilege() in dbobject.php

Looks up a privilege by its parameters.
get_privileges: midcom_baseclasses_core_dbobject::get_privileges() in dbobject.php

Read all privilege records from the object in question and return them accordingly.
group.php: group.php in group.php

h

top

$homepagelink: midcom_baseclasses_database_person::$homepagelink in person.php

Read-Only variable, consisting of a complete A HREF tag to homepage if set.
handle: midcom_baseclasses_components_request::handle() in request.php

This method handles the request using the handler determined by the can_handle check.
handle: midcom_baseclasses_components_interface::handle() in interface.php

Relays the handle call to the component.
handler.php: handler.php in handler.php
host.php: host.php in host.php

i

top

initialize: midcom_baseclasses_components_interface::initialize() in interface.php

Initializes the component. It will first load all dependent libraries and then include the snippets referenced by the component. The components local data storage area is initialized and referenced into the global storage area.
initialize: midcom_baseclasses_components_navigation::initialize() in navigation.php

Initialize the NAP class, sets all state variables.
initialize: midcom_baseclasses_components_request::initialize() in request.php

Initializes the request handler class, called by the component interface after instantination. Required to allow safe $this references during startup.
initialize: midcom_baseclasses_components_request_admin::initialize() in request_admin.php

Override initialization to add a default handler in case no admin handlers are defined. This is a transitional measure to have on-site-components not block AIS usage.
initialize: midcom_baseclasses_components_cron_handler::initialize() in cron_handler.php

This initializes the cron job. Before calling the on_initialize callback, it prepares the instance with various configuration variables and helper references.
initialize: midcom_baseclasses_components_handler::initialize() in handler.php

Initializes the request handler class, called by the component interface after instantination. Required to allow safe $this references during startup.
is_internal: midcom_baseclasses_components_interface::is_internal() in interface.php

Relays the is_internal check for the current object.
is_object_visible_onsite: midcom_baseclasses_core_dbobject::is_object_visible_onsite() in dbobject.php

This is a metadata helper that maps to the metadata onsite visibility check function, making checks against visibility far easier.
is_owner: midcom_baseclasses_core_dbobject::is_owner() in dbobject.php

Checks, wether the person given to the function is an owner (read: has write access) to the object in question.
interface.php: interface.php in interface.php

l

top

$location: org_openpsa_smslib::$location in factory.php
listattachments: midcom_baseclasses_core_dbobject::listattachments() in dbobject.php

Legacy Midgard Compatibility Method
list_attachments: midcom_baseclasses_core_dbobject::list_attachments() in dbobject.php

Returns a complete list of attachments for the current object. If there are no attachments, an empty array is returned.
list_parameters: midcom_baseclasses_core_dbobject::list_parameters() in dbobject.php

List the parameters of an object. This will either list the parameters of a single domain or the complete set of parameters, depending on the value of $domain.
load: midcom_baseclasses_core_dbobject::load() in dbobject.php

Loads the object identified by the ID from the database. After a successful load by either get_by_id or get_by_guid methods or the copy constructor run, the _on_loaded event handler is called. Thus, you have this calling sequence:

m

top

member.php: member.php in member.php
midcom_admin_content_topic_plugin: midcom_admin_content_topic_plugin::midcom_admin_content_topic_plugin() in _topic_plugin.php
midcom_admin_content_topic_plugin: midcom_admin_content_topic_plugin in _topic_plugin.php

Execution handler subclass, to be used with the request switch in midcom_baseclasses_components_request.
midcom_baseclasses_components_cron_handler: midcom_baseclasses_components_cron_handler::midcom_baseclasses_components_cron_handler() in cron_handler.php

Empty constuctor yet, just calls the base class.
midcom_baseclasses_components_cron_handler: midcom_baseclasses_components_cron_handler in cron_handler.php

This is the base class used for all jobs run by MidCOM CRON.
midcom_baseclasses_components_handler: midcom_baseclasses_components_handler::midcom_baseclasses_components_handler() in handler.php

Main constructor does not do much yet, it shouldn't be overridden though, use the _on_initilize event handler instead.
midcom_baseclasses_components_handler: midcom_baseclasses_components_handler in handler.php

Execution handler subclass, to be used with the request switch in midcom_baseclasses_components_request.
midcom_baseclasses_components_interface: midcom_baseclasses_components_interface in interface.php

Baseclass to use for the component interface in MIDCOM.
midcom_baseclasses_components_interface: midcom_baseclasses_components_interface::midcom_baseclasses_components_interface() in interface.php

Initialize the class, nothing to do yet.
midcom_baseclasses_components_navigation: midcom_baseclasses_components_navigation::midcom_baseclasses_components_navigation() in navigation.php

Create the navigation instance, the constructor doesn't do anything yet, startup is handled by initialize().
midcom_baseclasses_components_navigation: midcom_baseclasses_components_navigation in navigation.php

Base class to encaspulate a NAP interface. Does all the neccessary work for setting the object to the right topic. you just have to fill the gaps for getting the leaves and node data.
midcom_baseclasses_components_purecode: midcom_baseclasses_components_purecode::midcom_baseclasses_components_purecode() in purecode.php

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.
midcom_baseclasses_components_purecode: midcom_baseclasses_components_purecode in purecode.php

Base class used for writing pure code components, retrieves a few common variables from the components current environment.
midcom_baseclasses_components_request: midcom_baseclasses_components_request::midcom_baseclasses_components_request() in request.php

Initializes the class, only basic variable assignement. Your own constructor should call this function first.
midcom_baseclasses_components_request: midcom_baseclasses_components_request in request.php

Base class to encaspulate a request to the component, instantinated by the MidCOM component interface.
midcom_baseclasses_components_request_admin: midcom_baseclasses_components_request_admin in request_admin.php

Base class to encaspulate a admin request to the component, instantinated by the MidCOM component interface.
midcom_baseclasses_components_request_admin: midcom_baseclasses_components_request_admin::midcom_baseclasses_components_request_admin() in request_admin.php

Initialize the toolbar references after constructing the base class.
midcom_baseclasses_core_dbobject: midcom_baseclasses_core_dbobject in dbobject.php

This class only contains static functions which are there to hook into the classes you derive from the MidgardSchema DB types like (New)MidgardArticle.
midcom_baseclasses_core_object: midcom_baseclasses_core_object in object.php

This is the base class for all objects within the MidCOM core. Usually you should not need to inherit from this class directly, as all baseclasses made available for usage are somehow derived from this class.
midcom_baseclasses_core_object: midcom_baseclasses_core_object::midcom_baseclasses_core_object() in object.php
midcom_baseclasses_database_article: midcom_baseclasses_database_article in article.php

MidCOM level replacement for the Midgard Article record with framework support.
midcom_baseclasses_database_article: midcom_baseclasses_database_article::midcom_baseclasses_database_article() in article.php
midcom_baseclasses_database_attachment: midcom_baseclasses_database_attachment in attachment.php

MidCOM level replacement for the Midgard Attachment record with framework support.
midcom_baseclasses_database_attachment: midcom_baseclasses_database_attachment::midcom_baseclasses_database_attachment() in attachment.php
midcom_baseclasses_database_element: midcom_baseclasses_database_element in element.php

MidCOM level replacement for the Midgard Style Element record with framework support.
midcom_baseclasses_database_element: midcom_baseclasses_database_element::midcom_baseclasses_database_element() in element.php
midcom_baseclasses_database_event: midcom_baseclasses_database_event::midcom_baseclasses_database_event() in event.php
midcom_baseclasses_database_event: midcom_baseclasses_database_event in event.php

MidCOM level replacement for the Midgard Event record with framework support.
midcom_baseclasses_database_eventmember: midcom_baseclasses_database_eventmember::midcom_baseclasses_database_eventmember() in eventmember.php
midcom_baseclasses_database_eventmember: midcom_baseclasses_database_eventmember in eventmember.php

MidCOM level replacement for the Midgard Eventmember record with framework support.
midcom_baseclasses_database_group: midcom_baseclasses_database_group in group.php

MidCOM level replacement for the Midgard Group record with framework support.
midcom_baseclasses_database_group: midcom_baseclasses_database_group::midcom_baseclasses_database_group() in group.php
midcom_baseclasses_database_host: midcom_baseclasses_database_host in host.php

MidCOM level replacement for the Midgard Host record with framework support.
midcom_baseclasses_database_host: midcom_baseclasses_database_host::midcom_baseclasses_database_host() in host.php
midcom_baseclasses_database_member: midcom_baseclasses_database_member::midcom_baseclasses_database_member() in member.php
midcom_baseclasses_database_member: midcom_baseclasses_database_member in member.php

MidCOM level replacement for the Midgard Membership record with framework support.
midcom_baseclasses_database_page: midcom_baseclasses_database_page in page.php

MidCOM level replacement for the Midgard Page record with framework support.
midcom_baseclasses_database_page: midcom_baseclasses_database_page::midcom_baseclasses_database_page() in page.php
midcom_baseclasses_database_pageelement: midcom_baseclasses_database_pageelement in pageelement.php

MidCOM level replacement for the Midgard PageElement record with framework support.
midcom_baseclasses_database_pageelement: midcom_baseclasses_database_pageelement::midcom_baseclasses_database_pageelement() in pageelement.php
midcom_baseclasses_database_person: midcom_baseclasses_database_person in person.php

MidCOM level replacement for the Midgard Person record with framework support.
midcom_baseclasses_database_person: midcom_baseclasses_database_person::midcom_baseclasses_database_person() in person.php
midcom_baseclasses_database_snippet: midcom_baseclasses_database_snippet::midcom_baseclasses_database_snippet() in snippet.php
midcom_baseclasses_database_snippet: midcom_baseclasses_database_snippet in snippet.php

MidCOM level replacement for the Midgard Snippet record with framework support.
midcom_baseclasses_database_snippetdir: midcom_baseclasses_database_snippetdir::midcom_baseclasses_database_snippetdir() in snippetdir.php
midcom_baseclasses_database_snippetdir: midcom_baseclasses_database_snippetdir in snippetdir.php

MidCOM level replacement for the Midgard SnippetDir record with framework support.
midcom_baseclasses_database_style: midcom_baseclasses_database_style in style.php

MidCOM level replacement for the Midgard Style record with framework support.
midcom_baseclasses_database_style: midcom_baseclasses_database_style::midcom_baseclasses_database_style() in style.php
midcom_baseclasses_database_topic: midcom_baseclasses_database_topic in topic.php

MidCOM level replacement for the Midgard Topic record with framework support.
midcom_baseclasses_database_topic: midcom_baseclasses_database_topic::midcom_baseclasses_database_topic() in topic.php
midcom_core_handler_configdm: midcom_core_handler_configdm in configdm.php

Handler for Datamanger driven component configuration
midcom_core_handler_configdm: midcom_core_handler_configdm::midcom_core_handler_configdm() in configdm.php
msg_to_latin1: org_openpsa_smslib::msg_to_latin1() in factory.php

n

top

$name: midcom_baseclasses_database_person::$name in person.php

Read-Only variable, consisting of "$firstname $lastname".
navigation.php: navigation.php in navigation.php
net_nemein_ping_pinger: net_nemein_ping_pinger::net_nemein_ping_pinger() in main.php

Initializes the class and stores the selected person to be shown The argument should be a MidgardPerson object. In the future DM Array format will also be supported.
net_nemein_ping_pinger: net_nemein_ping_pinger in main.php

Base class used for writing pure code components, retrieves a few common variables from the components current environment.

o

top

object.php: object.php in object.php
open: midcom_baseclasses_database_attachment::open() in attachment.php

Opens the attachment for file IO, the semantics match the original
open_attachment: midcom_baseclasses_core_dbobject::open_attachment() in dbobject.php

Opens an attachment for File IO operations.
org_openpsa_documents_directory: org_openpsa_documents_directory::org_openpsa_documents_directory() in directory_midcomdba.php
org_openpsa_documents_directory: org_openpsa_documents_directory in directory_midcomdba.php

Wrapper for midcom_baseclasses_database_topic
org_openpsa_qbpager: org_openpsa_qbpager in pager.php

Pages QB resultsets
org_openpsa_qbpager: org_openpsa_qbpager::org_openpsa_qbpager() in pager.php
org_openpsa_qbpager_direct: org_openpsa_qbpager_direct::org_openpsa_qbpager_direct() in pager_direct.php
org_openpsa_qbpager_direct: org_openpsa_qbpager_direct in pager_direct.php

Pages QB resultsets (uses midgard QB directly)
org_openpsa_smslib: org_openpsa_smslib::org_openpsa_smslib() in factory.php
org_openpsa_smslib: org_openpsa_smslib in factory.php

Loader for the supported SMS interfaces
org_openpsa_smslib_clickatell: org_openpsa_smslib_clickatell in clickatell.php

Intarface to Clickatell API
org_openpsa_smslib_clickatell: org_openpsa_smslib_clickatell::org_openpsa_smslib_clickatell() in clickatell.php
org_openpsa_smslib_email2sms: org_openpsa_smslib_email2sms in email2sms.php

Generic email -> SMS gateway backend
org_openpsa_smslib_email2sms: org_openpsa_smslib_email2sms::org_openpsa_smslib_email2sms() in email2sms.php
org_openpsa_smslib_messto: org_openpsa_smslib_messto in messto.php

Intarface to messto API for sending SMS, MMS, Wap-push etc
org_openpsa_smslib_messto: org_openpsa_smslib_messto::org_openpsa_smslib_messto() in messto.php
org_openpsa_smslib_tambur: org_openpsa_smslib_tambur::org_openpsa_smslib_tambur() in tambur.php
org_openpsa_smslib_tambur: org_openpsa_smslib_tambur in tambur.php

Intarface to Tambur API for sending SMS, MMS, Wap-push etc

p

top

$password: org_openpsa_smslib::$password in factory.php
purecode.php: purecode.php in purecode.php
pageelement.php: pageelement.php in pageelement.php
page.php: page.php in page.php
person.php: person.php in person.php
ping: net_nemein_ping_pinger::ping() in main.php
ping_object: net_nemein_ping_pinger::ping_object() in main.php
print_error: midcom_baseclasses_components_cron_handler::print_error() in cron_handler.php

This helper function echoes the error message to the client, automatically appending the classname to the prefix. If you want to log the error, you have to take care of this yourself.

r

top

$results_per_page: org_openpsa_qbpager::$results_per_page in pager.php
$rname: midcom_baseclasses_database_person::$rname in person.php

Read-Only variable, consisting of "$lastname, $firstname".
request_admin.php: request_admin.php in request_admin.php
request.php: request.php in request.php
read_array_from_file: midcom_baseclasses_components_interface::read_array_from_file() in interface.php

This helper function reads a file from disk and evaluates its content as array.
read_array_from_snippet: midcom_baseclasses_components_interface::read_array_from_snippet() in interface.php

This helper function reads a snippet and evaluates its content as array.
refresh: midcom_baseclasses_core_dbobject::refresh() in dbobject.php

This is a simple wrapper with (currently) no additional functionality over get_by_id that resynchronizes the object state with the database.
register_plugin_namespace: midcom_baseclasses_components_request::register_plugin_namespace() in request.php

This function creates a new plugin namespace and maps the configuration to it.
reindex: midcom_baseclasses_components_interface::reindex() in interface.php

This new interface function will initiate a reindex run for the given component and topic. See the _on_reindex() event handler for details.
resolve_permalink: midcom_baseclasses_components_interface::resolve_permalink() in interface.php

This interface function is used to check wether a component can handle a given GUID or not on site only. A topic is provided which limits the "scope" of the search accordingly. It can be safely assumed that the topic given is a valid topic in the MidCOM content tree (it is checked through NAP).
retrieve_vgroup_members: midcom_baseclasses_components_interface::retrieve_vgroup_members() in interface.php

Retrieve all members of a given virtual group. This information may be cached by the framework.

s

top

snippetdir.php: snippetdir.php in snippetdir.php
snippet.php: snippet.php in snippet.php
style.php: style.php in style.php
send_mms: org_openpsa_smslib::send_mms() in factory.php
send_sms: org_openpsa_smslib_messto::send_sms() in messto.php

Method sends any SMS deliverable data, handles encoding so when sending logos etc, provide msg and udh as binary.
send_sms: org_openpsa_smslib_clickatell::send_sms() in clickatell.php

Method sends any SMS deliverable data, handles encoding so when sending logos etc, provide msg and udh as binary.
send_sms: org_openpsa_smslib_tambur::send_sms() in tambur.php

Method sends any SMS deliverable data, handles encoding so when sending logos etc, provide msg and udh as binary.
send_sms: org_openpsa_smslib::send_sms() in factory.php
set_lang: org_openpsa_qbpager::set_lang() in pager.php
set_limit: org_openpsa_qbpager::set_limit() in pager.php
set_object: midcom_baseclasses_components_navigation::set_object() in navigation.php

Set a new content object. This updates the local configuration copy with the topic in question. It calls the event handler _on_set_object after initializing everything in case you need to do some custom initializations as well.
set_object: midcom_baseclasses_components_interface::set_object() in interface.php

Releays the set_object call to the nap instance. Checks if the NAP instance has already been created beforehand.
set_offset: org_openpsa_qbpager::set_offset() in pager.php
set_parameter: midcom_baseclasses_core_dbobject::set_parameter() in dbobject.php

Set a parameter of a given object to the value specified.
set_privilege: midcom_baseclasses_core_dbobject::set_privilege() in dbobject.php

Set a privilege on an object.
show: midcom_baseclasses_components_request::show() in request.php

Display the content, it uses the handler as determined by can_handle.
show_content: midcom_baseclasses_components_interface::show_content() in interface.php

Relays the show content call to the component, invoking output.
show_pages: org_openpsa_qbpager::show_pages() in pager.php

Displays page selector
stat: midcom_baseclasses_database_attachment::stat() in attachment.php

Simple wrapper for mgd_stat_attachment.

t

top

topic.php: topic.php in topic.php
trigger_watch: midcom_baseclasses_components_interface::trigger_watch() in interface.php

This function delegates all watched operations, in two phases. First, the general _on_watched_operation handler is called, to allow for handling generic operations. After that, the individual watches are called, to allow for more specific processing.

u

top

$uri: org_openpsa_smslib_clickatell::$uri in clickatell.php
$uri: org_openpsa_smslib_messto::$uri in messto.php
$uri: org_openpsa_smslib_tambur::$uri in tambur.php
$user: org_openpsa_smslib::$user in factory.php
unset_all_privileges: midcom_baseclasses_core_dbobject::unset_all_privileges() in dbobject.php

Unsets all privilege on an object .
unset_privilege: midcom_baseclasses_core_dbobject::unset_privilege() in dbobject.php

Unset a privilege on an object (e.g. set it to INHERIT).
update: midcom_baseclasses_core_dbobject::update() in dbobject.php

Execute a DB update of the object passed. This will call the corresponding event handlers. Calling sequence with method signatures: