[midcom.services] element index

Package indexes

All elements

_

top

$_allowed_types: midcom_services_uimessages::$_allowed_types in uimessages.php

List of allowed message types
$_attachment: midcom_services_indexer_document_attachment::$_attachment in attachment.php
$_auth_backend: midcom_services_auth::$_auth_backend in auth.php

A reference to the authentication backend we should use by default.
$_auth_frontend: midcom_services_auth::$_auth_frontend in auth.php

A reference to the authentication frontend we should use by default.
$_auto_serialize: midcom_services_cache_backend::$_auto_serialize in backend.php

Set this to true if you plan to store PHP data structures rather then strings, the interface will automatically serialize/unserialize the data you store/retrieve from the database.
$_backend: midcom_services_indexer::$_backend in indexer.php

The backend indexer implementation
$_backend: midcom_services_cache_module_memcache::$_backend in memcache.php

The configuration to use to start up the backend drivers. Initialized during startup from the MidCOM configuration key cache_module_nap_backend.
$_backends: midcom_services_cache_module::$_backends in module.php

A list of all backends created by _create_backend(). They will be automatically shut down when the module shuts down. They are indexed by their name.
$_backend_config: midcom_services_cache_module_nap::$_backend_config in nap.php

The configuration to use to start up the backend drivers. Initialized during startup from the MidCOM configuration key cache_module_nap_backend.
$_cache: midcom_services_cache_module_memcache::$_cache in memcache.php

The cache backend instance to use.
$_cache: midcom_services_cache_backend_memcached::$_cache in memcached.php

The Memcache interface object.
$_cache_dir: midcom_services_cache_module_phpscripts::$_cache_dir in phpscripts.php

The base directory in which we may add script files.
$_cache_dir: midcom_services_cache_backend::$_cache_dir in backend.php

The base directory in which we may add files and directories within our namespace.
$_centralized_mode: midcom_services_toolbars::$_centralized_mode in toolbars.php

Whether we're in centralized mode, i.e. centralized toolbar has been shown
$_charset: midcom_services__i18n_l10n::$_charset in _i18n_l10n.php

Current character set
$_class_definition: midcom_services_dbclassloader::$_class_definition in dbclassloader.php

Temporary variable during class cosntruction, stores the class definition that is currently processed.
$_class_definition_filename: midcom_services_dbclassloader::$_class_definition_filename in dbclassloader.php

The filename of the class definition currently being read.
$_class_string: midcom_services_dbclassloader::$_class_string in dbclassloader.php

Temporary variable during class construction, stores the constructed code.
$_component_sudo: midcom_services_auth::$_component_sudo in auth.php

This flag indicates if sudo mode is active during execution. This will only be the case if the sudo system actually grants this privileges, and only until components release the rights again. This does override the full access control system at this time and essentially give you full admin privileges (though this might change in the future).
$_config: midcom_services_cache_module::$_config in module.php

Current configuration.
$_config: midcom_services_cache_backend::$_config in backend.php

Configuration key array. This is populated during initialize().
$_content_type: midcom_services_cache_module_content::$_content_type in content.php

The MIME content-type of the current request. It defaults to text/html, but must be set correctly, so that the client gets the correct type delivered upon cache deliveries.
$_cookie_data: midcom_services_i18n::$_cookie_data in i18n.php

Stores the acciociative array stored in the cookie "midcom_services_i18n" which contains the keys "language" and "charset" or null if the cookie was not set.
$_cookie_id: midcom_services_auth_backend_simple::$_cookie_id in simple.php

The auto-generated cookie ID for which this login session is valid. This consists of a static string with the host GUID concatenated to it.
$_current_charset: midcom_services_i18n::$_current_charset in i18n.php

Current character set
$_current_content_language: midcom_services_i18n::$_current_content_language in i18n.php

Current language for content. May be different than the UI language
$_current_data: midcom_services_indexer_XMLComm_ResponseReader::$_current_data in XMLCommClient.php

Current Data collected by the CDATA handler, will be processed by the end-element handlers.
$_current_document: midcom_services_indexer_XMLComm_ResponseReader::$_current_document in XMLCommClient.php

The current document, before being added to the resultset.
$_current_document_id: midcom_services_indexer_XMLComm_ResponseReader::$_current_document_id in XMLCommClient.php

The RI of the document currently being parsed.
$_current_field: midcom_services_indexer_XMLComm_ResponseReader::$_current_field in XMLCommClient.php

The name of the current field, which is collected in _current_data at this time.
$_current_id: midcom_services_indexer_XMLComm_ResponseReader::$_current_id in XMLCommClient.php

The current request ID.
$_current_language: midcom_services_i18n::$_current_language in i18n.php

Current language.
$_cvs_revision: midcom_services_dbclassloader::$_cvs_revision in dbclassloader.php

Internal version number, this is added to the generated classes for informational purposes only (right now).
$_datamanager: midcom_services_indexer_document_datamanager2::$_datamanager in datamanager2.php

The datamanager instance of the document we need to index.
$_datamanager: midcom_services_indexer_document_datamanager::$_datamanager in datamanager.php

The datamanager instance of the document we need to index.
$_data_cache: midcom_services_cache_module_content::$_data_cache in content.php

An cache backend used to store the actual cached pages.
$_data_groups: midcom_services_cache_module_memcache::$_data_groups in memcache.php

List of known data groups. See the class introduction for details.
$_default_magic_class_privileges: midcom_services_auth::$_default_magic_class_privileges in auth.php

This listing contains all magic privileges assigned to the existing classes. It is a multi-level array, example entry:
$_default_privileges: midcom_services_auth::$_default_privileges in auth.php

Internal listing of all default privileges currently registered in the system. This is a privilege name/value map.
$_dirname: midcom_services_cache_backend_flatfile::$_dirname in flatfile.php

The full directory filename.
$_disabled: midcom_services_indexer::$_disabled in indexer.php

Flag for disabled indexing, set by the constructor.
$_domain: midcom_service_session::$_domain in session.php

The domain we're working in.
$_enable_centralized: midcom_services_toolbars::$_enable_centralized in toolbars.php

midcom.services.toolbars has two modes, it can either display one centralized toolbar for authenticated users, or the node and view toolbars separately for others. This property controls whether centralized mode is enabled.
$_end: midcom_services_indexer_filter_date::$_end in date.php

End timestamp, may be 0
$_expires: midcom_services_cache_module_content::$_expires in content.php

Page expiration in seconds. If NULL (unset), the page does not expire.
$_fallback_language: midcom_services_i18n::$_fallback_language in i18n.php

Fallback language, in case the selected language is not available.
$_fallback_language: midcom_services__i18n_l10n::$_fallback_language in _i18n_l10n.php

Fallback language, in case the selected language is not available.
$_field: midcom_services_indexer_filter::$_field in filter.php

The name of the field that should be restricted.
$_fields: midcom_services_indexer_document::$_fields in document.php

An acciociative array containing all fields of the current document.
$_filename: midcom_services_cache_backend_dba::$_filename in dba.php

The full database filename.
$_group_cache: midcom_services_auth::$_group_cache in auth.php

Internal cache of all loaded groups, indexed by their identifiers.
$_guid_backend_map: midcom_services_cache_module_nap::$_guid_backend_map in nap.php

This array maps GUIDs to backend instances. This is required as AIS sites use the backend instance related to the live site. See _check_for_topic() for details.
$_handle: midcom_services_cache_backend_dba::$_handle in dba.php

The current handle, controlled by _open() and _close().
$_handler: midcom_services_cache_backend_dba::$_handler in dba.php

The handler to use
$_host: midcom_services_cache_backend_memcached::$_host in memcached.php

The IP to connect to.
$_http_charset: midcom_services_i18n::$_http_charset in i18n.php

Preferred charsets extracted out of the HTTP content negotiation. Array keys are the charsets, the value is their q-index.
$_http_lang: midcom_services_i18n::$_http_lang in i18n.php

Preferred languages extracted out of the HTTP content negotiation. Array keys are the languages, the value is their q-index.
$_i18n: midcom_services_indexer_document::$_i18n in document.php

A reference to the i18n service, used for charset conversion.
$_index_name: midcom_services_indexer_XMLComm_RequestWriter::$_index_name in XMLCommClient.php

The index name to use
$_internal_sudo: midcom_services_auth::$_internal_sudo in auth.php

This is an internal flag used to override all regular permission checks with a sort-of
$_jobs: midcom_services_cron::$_jobs in cron.php

The list of jobs to run. See the class introduction for a more precise definition of these keys.
$_language: midcom_services__i18n_l10n::$_language in _i18n_l10n.php

Current language.
$_language_db: midcom_services_i18n::$_language_db in i18n.php

The language database, loaded from /lib/midcom/services/_i18n_language-db.dat
$_language_db: midcom_services__i18n_l10n::$_language_db in _i18n_l10n.php

A copy of the language DB from i18n.
$_last_modified: midcom_services_cache_module_content::$_last_modified in content.php

The time of the last modification, set during auto-header-completion.
$_latest_message_id: midcom_services_uimessages::$_latest_message_id in uimessages.php

ID of the latest UI message added so we can auto-increment
$_library: midcom_services__i18n_l10n::$_library in _i18n_l10n.php

The name of the locale library we use, this is usually a component's name.
$_library_filename: midcom_services__i18n_l10n::$_library_filename in _i18n_l10n.php

The full path basename to the active library files. The individual files are ending with .$lang.txt.
$_live_mode: midcom_services_cache_module_content::$_live_mode in content.php

This flag is true if the live mode has been activiated. This prevents the cache processing at the end of the request.
$_loaded_classes: midcom_services_dbclassloader::$_loaded_classes in dbclassloader.php

List of all classes which have been loaded. This list only contains the class definitions that have been used to construct the actual helper classes.
$_loaded_sessions: midcom_services_auth_sessionmgr::$_loaded_sessions in sessionmgr.php

A list of loaded login sessions, indexed by their session identifier.
$_localedb: midcom_services__i18n_l10n::$_localedb in _i18n_l10n.php

The language database, loaded from /lib/midcom/services/_i18n_language-db.dat
$_messages_from_session: midcom_services_uimessages::$_messages_from_session in uimessages.php

List of messages retrieved from session to avoid storing them again
$_message_stack: midcom_services_uimessages::$_message_stack in uimessages.php

The current message stack
$_metadata: midcom_services_metadata::$_metadata in metadata.php

The metadata currently available. This array is indexed by context id; each value consists of an flat array of two metadata objects, the first object being the Node metadata, the second View metadata. The metadata objects are created on-demand.
$_metadata: midcom_services_indexer_document_midcom::$_metadata in midcom.php

The metadata instance attached to the object to be indexed.
$_meta_cache: midcom_services_cache_module_content::$_meta_cache in content.php

This is true, if the pages produced by the cache should not be
$_mgdschema_class_handler: midcom_services_dbclassloader::$_mgdschema_class_handler in dbclassloader.php

A mapping storing which component handles which class. This is used to ensure that all MidCOM DBA main classes are loaded when casting MgdSchema objects to DBA objects.
$_midcom_jobs: midcom_services_cron::$_midcom_jobs in cron.php

Jobs specific to the MidCOM core not covered by any component. (Services use this facility for example.)
$_modules: midcom_services_cache::$_modules in cache.php

List of all loaded modules, indexed by their class name.
$_multilang: midcom_services_cache_module_content::$_multilang in content.php

True, if the cache should honor the language settings.
$_name: midcom_services_cache_backend::$_name in backend.php

The backend instance name. This variable my not be written to after the instance has been created.
$_no_cache: midcom_services_cache_module_content::$_no_cache in content.php

Flag, indicating wether the current page may be cached. If false, the usual no-cache headers will be generated.
$_obj_l10n: midcom_services_i18n::$_obj_l10n in i18n.php

Cache of all instantinated localization classes. They are delivered by reference to all clients.
$_obrunning: midcom_services_cache_module_content::$_obrunning in content.php

Internal flag indicating wether the output buffering is active.
$_open_for_reading: midcom_services_cache_backend::$_open_for_reading in backend.php

True, if the database has been opened for reading previously. This is also true, if we are in read-write mode, naturally.
$_open_for_writing: midcom_services_cache_backend::$_open_for_writing in backend.php

True, if the database has been opened for writing previously.
$_owner_default_privileges: midcom_services_auth::$_owner_default_privileges in auth.php

Internal listing of all default owner privileges currently registered in the system.
$_page_classes: midcom_services_metadata::$_page_classes in metadata.php

Class of the current page per each context.
$_port: midcom_services_cache_backend_memcached::$_port in memcached.php

The Port to connect to.
$_privileges_cache: midcom_services_auth::$_privileges_cache in auth.php

Internal cache of the effective privileges of users on content objects, this is an accociative array using a combination of the user identifier and the objects' guid as index. The privileges for the anonymous user use the magic EVERYONE as user identifier.
$_recurrence: midcom_services_cron::$_recurrence in cron.php

The recurrence rule to use, one of the MIDCOM_CRON_* constants.
$_request: midcom_services_indexer_backend_xmlshell::$_request in xmlshell.php

The request to execute.
$_request: midcom_services_indexer_XMLComm_RequestWriter::$_request in XMLCommClient.php

The current request content. This does not include the XML header and the enclosing request tag. This will be added upon retrieval of this string.
$_request: midcom_services_indexer_backend_xmltcp::$_request in xmltcp.php

The request to execute.
$_response: midcom_services_indexer_backend_xmltcp::$_response in xmltcp.php

The response received.
$_response: midcom_services_indexer_backend_xmlshell::$_response in xmlshell.php

The response received.
$_schema: midcom_services_indexer_document_datamanager2::$_schema in datamanager2.php

The schema in use. This is referenced into the datamanager2 instance.
$_schema: midcom_services_indexer_document_datamanager::$_schema in datamanager.php

The schema in use.
$_sent_headers: midcom_services_cache_module_content::$_sent_headers in content.php

An array storing all HTTP headers registered through register_sent_header().
$_sessioning: midcom_service_session::$_sessioning in session.php

Sessioning singelton.
$_source: midcom_services_indexer_document_attachment::$_source in attachment.php
$_start: midcom_services_indexer_filter_date::$_start in date.php

Start timestamp, may be 0
$_stringdb: midcom_services__i18n_l10n::$_stringdb in _i18n_l10n.php

The string database, a reference into the global cache.
$_tmp_object_class_loaded: midcom_services_tmp::$_tmp_object_class_loaded in tmp.php

Internal status variable, set to true if the temporary object class has already been loaded.
$_toolbars: midcom_services_toolbars::$_toolbars in toolbars.php

The toolbars currently available. This array is indexed by context id; each value consists of an flat array of two toolbars, the first object being the Node toolbar, the second View toolbar. The toolbars are created on-demand.
$_uncached: midcom_services_cache_module_content::$_uncached in content.php

Set this to true, if you want to inhibit storage of the generated pages in the cache database. All other headers will be created as usual though, so 304 processing will kick in for example.
$_unload_queue: midcom_services_cache::$_unload_queue in cache.php

List of all modules in the order they need to be unloaded. This is a FILO queue, the module loaded first is unloaded last.
$_user_cache: midcom_services_auth::$_user_cache in auth.php

Internal cache of all loaded users, indexed by their identifiers.
$_version: midcom_services__i18n_l10n::$_version in _i18n_l10n.php

The current L10n DB file format number (corresponds to the MidCOM versions).
$_vgroups: midcom_services_auth::$_vgroups in auth.php

Internal listing of all known virtual groups, populated from the MidCOM Virtual Groups registry. It indexes virtual group identifiers suitable for get_group with their clear-text names.
_i18n_l10n.php: _i18n_l10n.php in _i18n_l10n.php
_sessioning.php: _sessioning.php in _sessioning.php
_add_as_date_field: midcom_services_indexer_document_datamanager::_add_as_date_field() in datamanager.php

This function tries to convert the field $name into a date representation. Unixdate fields are used directly (localtime is used, not GMT), other fields will be parsed with strtodate.
_add_as_date_field: midcom_services_indexer_document_datamanager2::_add_as_date_field() in datamanager2.php

This function tries to convert the field $name into a date representation. Unixdate fields are used directly (localtime is used, not GMT), other fields will be parsed with strtodate.
_add_field: midcom_services_indexer_document::_add_field() in document.php

Internal helper which actually stores a field.
_can_do_internal_sudo: midcom_services_auth::_can_do_internal_sudo() in auth.php

This internal helper checks if a privilege is available during internal sudo mode, as outlined in the corresponding variable.
_check_cache_dir: midcom_services_cache_backend::_check_cache_dir() in backend.php

This helper will ensure that the cache base directory is created and usable by checking it is actually a directory. If it does not exist, it will be created automatically. Errors will be handled by calling generate_error.
_check_for_active_login_session: midcom_services_auth::_check_for_active_login_session() in auth.php

Internal startup helper, checks the currently running authentication backend for a running login session.
_check_for_language: midcom_services__i18n_l10n::_check_for_language() in _i18n_l10n.php

Checks, wether the referenced language is already loaded. If not, it is automatically made available. Any errors will trigger generate_error.
_check_for_new_login_session: midcom_services_auth::_check_for_new_login_session() in auth.php

Internal startup helper, checks if the current authentication fronted has new credencials ready. If yes, it processes the login accordingly.
_check_for_topic: midcom_services_cache_module_nap::_check_for_topic() in nap.php

Internal helper, which ensures that the cache databases for root topic guid passed to the function are loaded.
_check_hit: midcom_services_cache_module_content::_check_hit() in content.php

This function holds the cache hit check meachnism. It seraches the requested URL in the cache database. If found, it checks, wether the cache page has expired. If not, the cached page is delivered to the client and processing ends. In all other cases this method simply returns.
_check_not_modified: midcom_services_cache_module_content::_check_not_modified() in content.php

Checks, wether the browser supplied if-modified-since or if-none-match headers match the passed etag/last modified timestamp. If yes, a 304 not modified header is emitted and true is returned. Otherwise the function will return false without modifications to the current runtime state.
_clean_content_control_chars: midcom_services_indexer_XMLComm_RequestWriter::_clean_content_control_chars() in XMLCommClient.php

Removes all control characters except LF from the content, as this might throw the indexer off-track (valid XML and the like).
_close: midcom_services_cache_backend::_close() in backend.php

Close the database that has been opened previosly with _open().
_close: midcom_services_cache_backend_dba::_close() in dba.php
_close: midcom_services_cache_backend_memcached::_close() in memcached.php

This method is unused as we use persistant connections, letting memcached take care about synchronization.
_complete_fields: midcom_services_indexer_document_datamanager2::_complete_fields() in datamanager2.php

Completes all fields which are not yet complete:
_complete_sent_headers: midcom_services_cache_module_content::_complete_sent_headers() in content.php

This little helper ensures that the headers Accept-Ranges, Content-Length and Last-Modified are present. The lastmod timestamp is taken out of the component context information if it is populated correctly there; if not, the system time is used instead.
_create_backend: midcom_services_cache_module::_create_backend() in module.php

Creates an instance of the handler described by the configuration passed to the function. The backend instance returned should be assigned by reference, to avoid handle duplication or the like.
_create_class_definition_filename: midcom_services_dbclassloader::_create_class_definition_filename() in dbclassloader.php

Little helper which converts a component / filename combination into a fully qualified path/filename. The filename is assigned to the $_class_definition_filename member variable of this class.
_create_metadata: midcom_services_metadata::_create_metadata() in metadata.php

Creates the node and view metadata for a given context ID.
_create_toolbars: midcom_services_toolbars::_create_toolbars() in toolbars.php

Creates the node and view toolbars for a given context ID.
_delete_cookie: midcom_services_auth_backend_simple::_delete_cookie() in simple.php

Deletes the cookie according to the session configuration as outlined in the class introduction.
_determine_recurrence: midcom_services_cron::_determine_recurrence() in cron.php

Determine the recurrence rule:
_do_midgard_auth: midcom_services_auth_sessionmgr::_do_midgard_auth() in sessionmgr.php

Internal helper, which does the actual Midgard authentication.
_encode_argument: midcom_services_indexer_XMLComm_RequestWriter::_encode_argument() in XMLCommClient.php

Encodes an argument masking both single and double quotes.
_encode_cdata: midcom_services_indexer_XMLComm_RequestWriter::_encode_cdata() in XMLCommClient.php

Encodes a string using CDATA encoding.
_exec: midcom_services_indexer_backend_xmltcp::_exec() in xmltcp.php

This private helper will create a socket connection to the indexer daemon and execute the query.
_exec: midcom_services_indexer_backend_xmlshell::_exec() in xmlshell.php

This private helper will launch the Indexer interface and run the request in the $xml parameter, which must be a request writer object.
_execute_job: midcom_services_cron::_execute_job() in cron.php

Executes the given job.
_exists: midcom_services_cache_backend::_exists() in backend.php

Checks, wether the given key exists in the Database.
_exists: midcom_services_cache_backend_memcached::_exists() in memcached.php

Exists maps to the getter function, as memcached does not support exists checks.
_exists: midcom_services_cache_backend_dba::_exists() in dba.php
_finish_caching: midcom_services_cache_module_content::_finish_caching() in content.php

This helper will be called during module shutdown, it completes the output caching, post-processes it and updates the cache databases accordingly.
_format_filesize: midcom_services_cache_module_content::_format_filesize() in content.php

Wrapper for number_format(number, 0, "", "."), used in the cache_stats call.
_generate_class: midcom_services_dbclassloader::_generate_class() in dbclassloader.php

Generates a complete class out of the definition passed to the method.
_get: midcom_services_cache_backend::_get() in backend.php

Get the data accociated with the given key.
_get: midcom_services_cache_backend_dba::_get() in dba.php
_get: midcom_services_cache_backend_memcached::_get() in memcached.php
_get_attachment_content: midcom_services_indexer_document_attachment::_get_attachment_content() in attachment.php

Returns the first four megabytes of the File referenced by $handle.
_get_helper: midcom_service__sessioning::_get_helper() in _sessioning.php

This is a small, internal helper function, which will load, unserialize and return a given key's value. It is shared by get and remove.
_get_text_representation: midcom_services_indexer_document_datamanager::_get_text_representation() in datamanager.php

Returns a textual representation of the corresponding field.
_index_cast_to_document: midcom_services_indexer::_index_cast_to_document() in indexer.php

Automatic helper which transforms a reference-passed object into an indexable document.
_initialize_centralized_toolbar: midcom_services_toolbars::_initialize_centralized_toolbar() in toolbars.php

Initialize centralized toolbar if required
_initialize_user_from_midgard: midcom_services_auth::_initialize_user_from_midgard() in auth.php

Internal startup helper, synchronizes the authenticated user with the Midgard Authentication for startup. This will be overridden by MidCOM Auth, but is there for compatibility reasons.
_load_all_languages: midcom_services__i18n_l10n::_load_all_languages() in _i18n_l10n.php

This tries to load the language files for all languages defined in the i18n's language database.
_load_class_magic_privileges: midcom_services_auth::_load_class_magic_privileges() in auth.php

This helper function loads and prepares the list of class magic privileges for usage. It will assign them to the $_*_default_class_privileges members.
_load_jobs: midcom_services_cron::_load_jobs() in cron.php

This helepr function loads and validates all registered jobs. After this call, all required handler classes will be available.
_load_l10n_db: midcom_services_i18n::_load_l10n_db() in i18n.php

Load the specified l10n library. If loading the library failed, generate_error is called, otherwise the l10n db cache is populated accordingly.
_load_language: midcom_services__i18n_l10n::_load_language() in _i18n_l10n.php

Load a language database
_load_language_db: midcom_services_i18n::_load_language_db() in i18n.php

Loads the language database.
_load_tmp_object_class: midcom_services_tmp::_load_tmp_object_class() in tmp.php

Internal helper function, ensures that the temporary object class is loaded.
_obfuscate_password: midcom_services_auth_sessionmgr::_obfuscate_password() in sessionmgr.php

This function obfuscates a password in some way so that accidential
_on_execute: midcom_cron_tmpservice::_on_execute() in tmpservice.php
_on_initialize: midcom_services_cache_module_nap::_on_initialize() in nap.php

Initialization event handler.
_on_initialize: midcom_services_cache_module::_on_initialize() in module.php

Startup handler, called during service start up at the start of the request.
_on_initialize: midcom_services_cache_module_phpscripts::_on_initialize() in phpscripts.php

Initializes the cache module, verifying the existance of the script cache directory.
_on_initialize: midcom_services_cache_module_content::_on_initialize() in content.php

This function is responsible for initializing the cache.
_on_initialize: midcom_cron_tmpservice::_on_initialize() in tmpservice.php
_on_initialize: midcom_services_cache_backend_dba::_on_initialize() in dba.php

This handler completes the configuration.
_on_initialize: midcom_services_cache_backend_flatfile::_on_initialize() in flatfile.php

This handler completes the configuration.
_on_initialize: midcom_services_cache_backend::_on_initialize() in backend.php

Backend initialization
_on_initialize: midcom_services_cache_backend_memcached::_on_initialize() in memcached.php

This handler completes the configuration.
_on_initialize: midcom_services_cache_module_memcache::_on_initialize() in memcache.php

Initialization event handler.
_on_login_session_created: midcom_services_auth_backend::_on_login_session_created() in backend.php

This event handler is called immediately after the successful creation of a new login session. The authentication driver has to ensure that the login identifier stays available during subsequent requests.
_on_login_session_created: midcom_services_auth_backend_simple::_on_login_session_created() in simple.php
_on_login_session_deleted: midcom_services_auth_backend::_on_login_session_deleted() in backend.php

This event handler is called immediately after the successful deletion of a login session. Use this to drop any session identifier store you might have created during _on_login_session_created.
_on_shutdown: midcom_services_cache_backend::_on_shutdown() in backend.php

Backend shutdown
_on_shutdown: midcom_services_cache_module::_on_shutdown() in module.php

Shutdown hanlder, called during midcom_application::finish(). Note, that for example the page cache will not use this cleanup handler, as it produces a complete html page based on a previous request.
_on_shutdown: midcom_services_cache_module_content::_on_shutdown() in content.php

The shutdown event handler will finish the caching sequence by storing the cached data, if required.
_open: midcom_services_cache_backend_memcached::_open() in memcached.php

This method is unused as we use persistant connections, letting memcached take care about synchronization.
_open: midcom_services_cache_backend::_open() in backend.php

Open the database for usage. If $write is set to true, it must be opened in read/write access, otherwise read-only access is sufficient.
_open: midcom_services_cache_backend_dba::_open() in dba.php

Internal helper, which opens a handle to the DBA file in either read-only or read/write mode. The handle has to be closed by the _close() function.
_prepare_authentication_drivers: midcom_services_auth::_prepare_authentication_drivers() in auth.php

Internal startup helper, loads all configured authentication drivers.
_process_attachment: midcom_services_indexer_document_attachment::_process_attachment() in attachment.php
_process_auto_field: midcom_services_indexer_document_datamanager::_process_auto_field() in datamanager.php

This helper will process the given field using the guidelines given in the class documentation.
_process_auto_field: midcom_services_indexer_document_datamanager2::_process_auto_field() in datamanager2.php

This helper will process the given field using the guidelines given in the class documentation.
_process_class_definition_list: midcom_services_dbclassloader::_process_class_definition_list() in dbclassloader.php

Process an entire array of class definitions, collect the generated listings and return a complete PHP file string for all classes in the list.
_process_datamanager: midcom_services_indexer_document_datamanager2::_process_datamanager() in datamanager2.php

Processes the information contained in the datamanager instance.
_process_datamanager: midcom_services_indexer_document_datamanager::_process_datamanager() in datamanager.php

Processes the information contained in the datamanager instance.
_process_metadata: midcom_services_indexer_document_midcom::_process_metadata() in midcom.php

Processes the information contained in the metadata instance.
_process_mime_binary: midcom_services_indexer_document_attachment::_process_mime_binary() in attachment.php

Any binary file will have its name in the abstract unless no title is defined, in which case the documents title already contains the file's name.
_process_mime_html: midcom_services_indexer_document_attachment::_process_mime_html() in attachment.php

Processes HTML-style attachments (should therefore work with XML too), strips tags and resolves entities.
_process_mime_pdf: midcom_services_indexer_document_attachment::_process_mime_pdf() in attachment.php

Convert a PDF attachment to plain text and index it.
_process_mime_plaintext: midcom_services_indexer_document_attachment::_process_mime_plaintext() in attachment.php

Simple plain-text driver, just copies the attachment.
_process_mime_richtext: midcom_services_indexer_document_attachment::_process_mime_richtext() in attachment.php

Convert an RTF attachment to plain text and index it.
_process_mime_word: midcom_services_indexer_document_attachment::_process_mime_word() in attachment.php

Convert a Word attachment to plain text and index it.
_process_nap: midcom_services_indexer_document_datamanager::_process_nap() in datamanager.php

If neccessary, process the available NAP information to fill in the title field.
_process_topic: midcom_services_indexer_document_attachment::_process_topic() in attachment.php

Tries to determine the topic GUID and component using NAPs reverse-lookup capabilities.
_process_topic: midcom_services_indexer_document_midcom::_process_topic() in midcom.php

Tries to determine the topic GUID and component, we use NAPs reverse-lookup capabilities.
_put: midcom_services_cache_backend_memcached::_put() in memcached.php
_put: midcom_services_cache_backend::_put() in backend.php

Store the given key/value pair, any existing entry with the same key has to be silently overwritten.
_put: midcom_services_cache_backend_dba::_put() in dba.php
_read_class_definition_file: midcom_services_dbclassloader::_read_class_definition_file() in dbclassloader.php

This helper function loads a class definition file from the disk and returns its contents. The source must be stored in the $_class_definition_filename member.
_read_cookie: midcom_services_i18n::_read_cookie() in i18n.php

This method tries to pull the users prefered lanugauce and character set out of a cookie named "midcom_services_i18n".
_read_http_negotiation: midcom_services_i18n::_read_http_negotiation() in i18n.php

This method pulls available language and content type data out of the HTTP Headers delivered by the browser and populates the member variables $_http_lang and $_http_content_type. q-parameters for priorization are supported.
_register_core_privileges: midcom_services_auth::_register_core_privileges() in auth.php

This internal helper will initialize the default priviliges array with all core privileges currently defined.
_register_job: midcom_services_cron::_register_job() in cron.php

This function adds a validated job to the run queue.
_register_loaded_classes: midcom_services_dbclassloader::_register_loaded_classes() in dbclassloader.php

Simple helper that adds a list of classes to the loaded classes listing.
_remove: midcom_services_cache_backend_memcached::_remove() in memcached.php
_remove: midcom_services_cache_backend::_remove() in backend.php

Delete the data with the given key from the database.
_remove: midcom_services_cache_backend_dba::_remove() in dba.php
_remove_all: midcom_services_cache_backend_dba::_remove_all() in dba.php
_remove_all: midcom_services_cache_backend::_remove_all() in backend.php

Drops the entire database, preferrably with some kind of truncate operation.
_remove_all: midcom_services_cache_backend_memcached::_remove_all() in memcached.php
_render_toolbar: midcom_services_toolbars::_render_toolbar() in toolbars.php

Renders the specified toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the _show_toolbar method.
_resolve_permalink_in_topic: midcom_services_permalinks::_resolve_permalink_in_topic() in permalinks.php
_set_cookie: midcom_services_auth_backend_simple::_set_cookie() in simple.php

Sets the cookie according to the session configuration as outlined in the class introduction.
_set_startup_langs: midcom_services_i18n::_set_startup_langs() in i18n.php

Scans the HTTP negotiation and the cookie data and tries to set a suitable default language. Cookies have priority here.
_set_type: midcom_services_indexer_document::_set_type() in document.php

Sets the type of the object, reflecting the inheritance hierarchy.
_start_caching: midcom_services_cache_module_content::_start_caching() in content.php

This function will start the output cache. Call this before any output is made. MidCOM's startup sequence will automatically do this.
_synchronize_midgard_language: midcom_services_i18n::_synchronize_midgard_language() in i18n.php

Set the Midgard Language to the one defined in the language database.
_sync_user_with_backend: midcom_services_auth::_sync_user_with_backend() in auth.php

Internal helper, synchronizes the main service class with the authentication state of the authentication backend.
_unobfuscate_password: midcom_services_auth_sessionmgr::_unobfuscate_password() in sessionmgr.php

Reverses password obfuscation.
_update_user_password: midcom_services_auth_sessionmgr::_update_user_password() in sessionmgr.php

This function is called by the framework whenever a users' password is updated. It will synchronize all active login sessions of that user to the new password.
_update_user_username: midcom_services_auth_sessionmgr::_update_user_username() in sessionmgr.php

This function is called by the framework whenever a users' username is updated. It will synchronize all active login sessions of that user to the new username.
_validate_class_definition_list: midcom_services_dbclassloader::_validate_class_definition_list() in dbclassloader.php

This helper function validates a class definition list for correctness. Any error will be logged and false is returned..
_validate_handler: midcom_services_cron::_validate_handler() in cron.php

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

This function checks a jobs definition for validity.
_write_attachment_tmpfile: midcom_services_indexer_document_attachment::_write_attachment_tmpfile() in attachment.php

Creates a temporary copy of the attachment, the callee must delete it manually after completing procesing.
_write_class: midcom_services_dbclassloader::_write_class() in dbclassloader.php

Writes the actual class definition, uses some helpers for this.
_write_class_definition_registration: midcom_services_dbclassloader::_write_class_definition_registration() in dbclassloader.php

Generates a small block at the end of the script which registeres the original definitions with ourselves, so that we don't have to eval this all the time.
_write_constructor: midcom_services_dbclassloader::_write_constructor() in dbclassloader.php

Helper, writes the constructor to the class.
_write_event_handlers: midcom_services_dbclassloader::_write_event_handlers() in dbclassloader.php

Helper, writes the event handlers to the class.
_write_exec_handlers: midcom_services_dbclassloader::_write_exec_handlers() in dbclassloader.php

Helper, writes the exec handlers to the class.
_write_footer: midcom_services_dbclassloader::_write_footer() in dbclassloader.php

Writes the footer to the class, currently empty.
_write_header: midcom_services_dbclassloader::_write_header() in dbclassloader.php

Writes the header to the class, this includes a dump of the definition used and the generation timestamp.
_write_main_api: midcom_services_dbclassloader::_write_main_api() in dbclassloader.php

Helper, writes the main API to the class.
_write_meta_members: midcom_services_dbclassloader::_write_meta_members() in dbclassloader.php

This helper adds all definition properties as __$key__ = '$value' members.

a

top

$abstract: midcom_services_indexer_document::$abstract in document.php

The abstract of the document
$admin: midcom_services_auth::$admin in auth.php

Admin user level state. This is true if the currently authenticated user is an Midgard Administrator, false otherwise.
$author: midcom_services_indexer_document::$author in document.php

The author of the document
$auth_credencials_found: midcom_services_auth::$auth_credencials_found in auth.php

Flag, which is set to true if the system encountered any new login credencials during startup. If this is true, but no user is authenticated, login did fail.
access_denied: midcom_services_auth::access_denied() in auth.php

This is called by $_MIDCOM->generate_error(MIDCOM_ERRFORBIDDEN, ...) if and only if the headers have not yet been sent. It will display the error message and appends the login form below it.
access_denied: midcom_services_auth_frontend::access_denied() in frontend.php

??? IS THIS NEEDED ???
add: midcom_services_cache_module_phpscripts::add() in phpscripts.php

This call adds a script to the code file cache. Any existing file will be truncated before the new file is written.
add: midcom_services_uimessages::add() in uimessages.php

Add a message to be shown to the user.
add_date: midcom_services_indexer_document::add_date() in document.php

Add a date field. A timestamp is expected, which is automatically converted to a suiteable ISO timestamp before storage.
add_date_pair: midcom_services_indexer_document::add_date_pair() in document.php

This is a small helper which will create a normal date field and a unindexed _TS-postfixed timestamp field at the same time.
add_delete: midcom_services_indexer_XMLComm_RequestWriter::add_delete() in XMLCommClient.php

Adds a delete request.
add_deleteall: midcom_services_indexer_XMLComm_RequestWriter::add_deleteall() in XMLCommClient.php

Adds a drop index request.
add_index: midcom_services_indexer_XMLComm_RequestWriter::add_index() in XMLCommClient.php

Index one or more documents.
add_keyword: midcom_services_indexer_document::add_keyword() in document.php

Add a keyword field.
add_query: midcom_services_indexer_XMLComm_RequestWriter::add_query() in XMLCommClient.php

Add a query to the request.
add_result: midcom_services_indexer_document::add_result() in document.php

Add a search result field, this should normally not be done manually, the indexer will call this function when creating a document out of a search result.
add_text: midcom_services_indexer_document::add_text() in document.php

Add a text field.
add_topic_management_commands: midcom_services_toolbars::add_topic_management_commands() in toolbars.php

Adds the topic management commands to the specified toolbar.
add_unindexed: midcom_services_indexer_document::add_unindexed() in document.php

Add a unindexed field.
add_unstored: midcom_services_indexer_document::add_unstored() in document.php

Add a unstored field.
authenticate: midcom_services_auth_backend::authenticate() in backend.php

This function checks the given username / password pair is valid and sets the $user member accordingly. The default implementation checks against mgd_auth_midgard and retrieves the user using $_MIDGARD.
authenticate_session: midcom_services_auth_sessionmgr::authenticate_session() in sessionmgr.php

This function authenticates a given session, which must have been loaded previously with load_login_session (this is mandatory).
auth.php: auth.php in auth.php
attachment.php: attachment.php in attachment.php

b

top

bind_metadata_to_object: midcom_services_metadata::bind_metadata_to_object() in metadata.php
bind_to: midcom_services_metadata::bind_to() in metadata.php

Binds view metadata to a DBA content object
bind_toolbar_to_object: midcom_services_toolbars::bind_toolbar_to_object() in toolbars.php

Binds the a toolbar to a DBA object. This will append a number of globally available toolbar options. For example, expect Metadata- and Version Control-related options to be added.
backend.php: backend.php in backend.php
backend.php: backend.php in backend.php
backend.php: backend.php in backend.php

c

top

$component: midcom_services_indexer_document::$component in document.php

The name of the component responsible for the document. May be empty for non-midgard resources.
$content: midcom_services_indexer_document::$content in document.php

The content of the document
$created: midcom_services_indexer_document::$created in document.php

The time of document creation, this is an UNIX timestamp.
$creator: midcom_services_indexer_document::$creator in document.php

The MidgardPerson who created the object.
$current_session_id: midcom_services_auth_sessionmgr::$current_session_id in sessionmgr.php

Once a session has been authenticated, this variable holds the ID of the current login session.
can_do: midcom_services_auth::can_do() in auth.php

Checks wether a user has a certain privilege on the given content object.
can_user_do: midcom_services_auth::can_user_do() in auth.php

Checks, wether the given user have the privilege assigned to him in general.
cdataHandler: midcom_services_indexer_XMLComm_ResponseReader::cdataHandler() in XMLCommClient.php

The character data collector.
close: midcom_services_cache_backend::close() in backend.php

Close the database that has been opened previosly with open(). If the database is already closed, the request is ignored silently.
content_type: midcom_services_cache_module_content::content_type() in content.php

Sets the content type for the current page. The required HTTP Headers for are automatically generated, so, to the contratry of expires, you just have to set this header accordingly.
convert_from_utf8: midcom_services_i18n::convert_from_utf8() in i18n.php

This function will convert a string assumed to be in UTF-8 to the currently active charset.
convert_to_current_charset: midcom_services_i18n::convert_to_current_charset() in i18n.php

Converts the given string to the current site charset. The charset should be specified explicitly, as autodetection is very very error prone (though sometimes you don't have a choice).
convert_to_utf8: midcom_services_i18n::convert_to_utf8() in i18n.php

This function will convert a string assumed to be in the currently active charset to UTF8.
create: midcom_services__i18n_l10n::create() in _i18n_l10n.php

Creates a new entry in the localization library. For the string $string in the language $language the translation $translation will be added. The function assumes that $translation is in UTF-8. It will create a language subdir if neccessary. Returns true on success, false on failure.
create_identifier: midcom_services_cache_module_phpscripts::create_identifier() in phpscripts.php

This function creates a filename out of the given namespace and local identifier pair.
create_login_session: midcom_services_auth_backend::create_login_session() in backend.php

This function stores a login session using the given credencials through the
create_login_session: midcom_services_auth_sessionmgr::create_login_session() in sessionmgr.php

Creates a login session using the given arguments. Returns a session identifier.
create_object: midcom_services_tmp::create_object() in tmp.php

This class creates a new temporary object for use with the application.
create_permalink: midcom_services_permalinks::create_permalink() in permalinks.php

This small helper should be used to create Permalink URLs from GUIDs. It always points to the live site (given correct system configuration).
content.php: content.php in content.php
cache.php: cache.php in cache.php
cron.php: cron.php in cron.php

d

top

$document_url: midcom_services_indexer_document::$document_url in document.php

The fully qualified URL to the document, this should be a PermaLink.
datamanager2_get_text_representation: midcom_services_indexer_document::datamanager2_get_text_representation() in document.php

Returns a textual representation of the specified datamanager2 field.
datamanager_get_text_representation: midcom_services_indexer_document::datamanager_get_text_representation() in document.php

Returns a textual representation of the specified datamanager field.
delete: midcom_services_indexer_backend_xmlshell::delete() in xmlshell.php

Removes the document with the given resource identifier from the index.
delete: midcom_services_indexer::delete() in indexer.php

Removes the document with the given resource identifier from the index.
delete: midcom_services_indexer_backend_xmltcp::delete() in xmltcp.php

Removes the document with the given resource identifier from the index.
delete: midcom_services__i18n_l10n::delete() in _i18n_l10n.php

Deletes a string from the database. If the string is not present, it will fail silently.
delete: midcom_services_indexer_backend::delete() in backend.php

Removes the document with the given resource identifier from the index.
delete_all: midcom_services_indexer::delete_all() in indexer.php

Clear the index completly.
delete_all: midcom_services_indexer_backend::delete_all() in backend.php

Clear the index completly.
delete_all: midcom_services_indexer_backend_xmlshell::delete_all() in xmlshell.php

Clear the index completly.
delete_all: midcom_services_indexer_backend_xmltcp::delete_all() in xmltcp.php

Clear the index completly.
delete_session: midcom_services_auth_sessionmgr::delete_session() in sessionmgr.php

Call this function to drop a session which has been previously loaded successfully.
delete_virtual_group: midcom_services_auth::delete_virtual_group() in auth.php

Delete a registered virtual group in the system. This requires the privilege midcom:vgroup_delete assigned to the user (there is no content object checked).
drop_login_session: midcom_services_auth::drop_login_session() in auth.php

This is a limited version of logout: It will just drop the current login session, but keep the request running. This means, that the current request will stay authenticated, but any subsequent requests not.
drop_sudo: midcom_services_auth::drop_sudo() in auth.php

Drops previously aquired superuser privileges.
dump: midcom_services_indexer_document::dump() in document.php

Debugging helper, which will dump the documents contents to the log file using the indicated log level. It will check the log-level explicitly for performance reasons.
dba.php: dba.php in dba.php
dbclassloader.php: dbclassloader.php in dbclassloader.php
datamanager2.php: datamanager2.php in datamanager2.php
datamanager.php: datamanager.php in datamanager.php
document.php: document.php in document.php
date.php: date.php in date.php

e

top

$edited: midcom_services_indexer_document::$edited in document.php

The time of the last document modification, this is an UNIX timestamp.
$editor: midcom_services_indexer_document::$editor in document.php

The MidgardPerson who modified the object the last time.
enabled: midcom_services_indexer::enabled() in indexer.php

Simple helper, returns true if the indexer service is online, false if it is disabled.
enable_live_mode: midcom_services_cache_module_content::enable_live_mode() in content.php

Use this funciton to put the cache into a "live mode". This will disable the cache during runtime, correctly flushing the output buffer and sending cache control headers. You will not be able to send any additional headers after executing this call therefore you should adjust the headers in advance.
execute: midcom_services_cron::execute() in cron.php

This is the main cron handler function.
exists: midcom_service_session::exists() in session.php

Checks, if the specified key has been added to the session store.
exists: midcom_service__sessioning::exists() in _sessioning.php

Checks, if the specified key has been added to the session store.
exists: midcom_services_cache_module_memcache::exists() in memcache.php

Checks for the existance of a key in the cache.
exists: midcom_services_cache_backend_flatfile::exists() in flatfile.php
exists: midcom_services_cache_backend::exists() in backend.php

Checks, wether the given key exists in the Database. If the data store has not yet been opened for reading, it will be opened automatically prior to the call, and closed automatically again afterwards.
expires: midcom_services_cache_module_content::expires() in content.php

Sets the expiration time of the current page (Unix (GMT) Timestamp).

f

top

fields_to_members: midcom_services_indexer_document::fields_to_members() in document.php

This function should be called after retrieving a document from the index. It will populate all relevant members with the according values.
flush: midcom_services__i18n_l10n::flush() in _i18n_l10n.php

This will flush the complete string table to the filesystem.
form.php: form.php in form.php
frontend.php: frontend.php in frontend.php
flatfile.php: flatfile.php in flatfile.php
filter.php: filter.php in filter.php

g

top

$GLOBALS["midcom_services_i18n__l10n_localedb"]: $GLOBALS["midcom_services_i18n__l10n_localedb"] in _i18n_l10n.php

Global string table cache, it stores the string tables loaded during runtime.
$GLOBALS['midcom_cache']: $GLOBALS['midcom_cache'] in cache.php

Global instance of the Caching service. This is also available as $midcom->cache.
get: midcom_services_cache_backend::get() in backend.php

Get the data accociated with the given key. If the data store has not yet been opened for reading, it will be opened automatically prior to the call, and closed automatically again afterwards.
get: midcom_services_cache_backend_flatfile::get() in flatfile.php
get: midcom_services_cache_module_memcache::get() in memcache.php

Looks up a value in the cache and returns it. Not existant keys are caught in this call as well, so you do not need to call exists first.
get: midcom_service_session::get() in session.php

Returns a value from the session.
get: midcom_services__i18n_l10n::get() in _i18n_l10n.php

Retrieves a localized string from the database using $language as
get: midcom_service__sessioning::get() in _sessioning.php

Returns a value from the session.
get_all_string_ids: midcom_services__i18n_l10n::get_all_string_ids() in _i18n_l10n.php

Scans the current library and delivers all string ids that are in use.
get_all_vgroups: midcom_services_auth::get_all_vgroups() in auth.php

Returns a listing of all known(!) virtual groups.
get_assignee: midcom_services_auth::get_assignee() in auth.php

Factory Method: Resolves any assignee identifier known by the system into an appropriate user/group object.
get_classes_for_table: midcom_services_dbclassloader::get_classes_for_table() in dbclassloader.php

Returns a list of loaded classes that operate on the given table name. The
get_current_charset: midcom_services_i18n::get_current_charset() in i18n.php

Returns the current character set
get_current_language: midcom_services_i18n::get_current_language() in i18n.php

Returns the current language code
get_default_privileges: midcom_services_auth::get_default_privileges() in auth.php

Returns the system-wide basic privilege set.
get_end: midcom_services_indexer_filter_date::get_end() in date.php

Returns the end of the filter range, may be 0.
get_fallback_language: midcom_services_i18n::get_fallback_language() in i18n.php

Returns the current fallback language code
get_field: midcom_services_indexer_filter::get_field() in filter.php

Returns the name of the field.
get_field: midcom_services_indexer_document::get_field() in document.php

Returns the contents of the field name or false on failure.
get_field_record: midcom_services_indexer_document::get_field_record() in document.php

Returns the complete internal field record, including type and UTF-8 encoded content.
get_group: midcom_services_auth::get_group() in auth.php

Returns a midcom_core_group instance. Valid arguments are either a valid group identiefier (group:... or vgroup:...), any valid identifier for the midcom_core_group constructor or a valid object of that type.
get_l10n: midcom_services_i18n::get_l10n() in i18n.php

Returns an l10n class instance (see the snippet documentation at /midcom/services/_i18n_l10n for details) which can be used to access the localization data of the current component. Using the special name "midcom" you will get the midcom core l10n library.
get_language_db: midcom_services_i18n::get_language_db() in i18n.php

Returns the language database.
get_midcom_class_name_for_legacy_midgard_object: midcom_services_dbclassloader::get_midcom_class_name_for_legacy_midgard_object() in dbclassloader.php

Get a MidCOM DB class name for a legacy Midgard Object.
get_midcom_class_name_for_mgdschema_object: midcom_services_dbclassloader::get_midcom_class_name_for_mgdschema_object() in dbclassloader.php

Get a MidCOM DB class name for a MgdSchema Object.
get_midgard_group_by_name: midcom_services_auth::get_midgard_group_by_name() in auth.php

This is a wrapper for get_group, which allows Midgard Group retrieval by its name.
get_nap_cache: midcom_services_cache_module_nap::get_nap_cache() in nap.php

Returns the NAP cache accociated with the topic tree identified by the parameter $root_topic_guid. The constructed cache database name will be "NAP_{$root_topic_guid}".
get_node_metadata: midcom_services_metadata::get_node_metadata() in metadata.php

Returns a reference to the node metadata of the specified context. The metadata will be created if this is the first request.
get_node_toolbar: midcom_services_toolbars::get_node_toolbar() in toolbars.php

Returns a reference to the node toolbar of the specified context. The toolbars will be created if this is the first request.
get_online_users: midcom_services_auth_sessionmgr::get_online_users() in sessionmgr.php

Extended check for online users. Returns an array of guid=>midcom_core_user pairs of the users which are currently online. This takes privileges into account and will thus only list users which the current user has the privililege to observe.
get_online_users_count: midcom_services_auth_sessionmgr::get_online_users_count() in sessionmgr.php

Returns the total number of users online. This does not adhere the isonline check, as there is no information about which users are online.
get_owner_default_privileges: midcom_services_auth::get_owner_default_privileges() in auth.php

Returns the system-wide basic owner privilege set.
get_page_class: midcom_services_metadata::get_page_class() in metadata.php

Gets the class of the current page of a context
get_privileges: midcom_services_auth::get_privileges() in auth.php

Returns a full listing of all currently known privileges for a certain object/user combination.
get_start: midcom_services_indexer_filter_date::get_start() in date.php

Returns the start of the filter range, may be 0.
get_string: midcom_services_i18n::get_string() in i18n.php

Returns a translated string using the l10n database specified in the function arguments.
get_user: midcom_services_auth::get_user() in auth.php

Factory Method: Loads a user from the database and returns an object instance.
get_user_by_name: midcom_services_auth::get_user_by_name() in auth.php

This is a wrapper for get_user, which allows user retrieval by its name.
get_view_metadata: midcom_services_metadata::get_view_metadata() in metadata.php

Returns a reference to the view metadata of the specified context. The metadata will be created if this is the first request.
get_view_toolbar: midcom_services_toolbars::get_view_toolbar() in toolbars.php

Returns a reference to the view toolbar of the specified context. The toolbars will be created if this is the first request.
get_xml: midcom_services_indexer_XMLComm_RequestWriter::get_xml() in XMLCommClient.php

Surrounds the request data with an xml header and the request tags and returns the result.

h

top

html2text: midcom_services_indexer_document::html2text() in document.php

This is a small helper that converts HTML to plain text (relativly simple):
html_entity_decode: midcom_services_i18n::html_entity_decode() in i18n.php

Charset-aware replacement of html_entity_decode. Uses Iconv to modify the HTML_ENTITIES translation tables.

i

top

$indexed: midcom_services_indexer_document::$indexed in document.php

The timestamp of indexing.
iconv: midcom_services_i18n::iconv() in i18n.php

This is a calling wrapper to the iconv library. See the PHP iconv() function for the exact parameter definitons.
index: midcom_services_indexer_backend_xmltcp::index() in xmltcp.php

Adds a document to the index.
index: midcom_services_indexer_backend_xmlshell::index() in xmlshell.php

Adds a document to the index.
index: midcom_services_indexer_backend::index() in backend.php

Adds a document to the index.
index: midcom_services_indexer::index() in indexer.php

Adds a document to the index.
initialize: midcom_services_auth::initialize() in auth.php

Initialize the service:
initialize: midcom_services_cache::initialize() in cache.php

Cache service startup. It initializes all cache modules configured in the global configuration as outlined in the class introduction.
initialize: midcom_services_uimessages::initialize() in uimessages.php

Initialize the message stack on service start-up. Reads older unshown messages from user session.
initialize: midcom_services_cache_module::initialize() in module.php

Initialize the module. This will initialize the class configuration and call the corresponding event handler.
initialize: midcom_services_cache_backend::initialize() in backend.php

Initializes the backend by acquiring all neccessary information required for runtime.
invalidate: midcom_services_cache_module_memcache::invalidate() in memcache.php

Invalidates the GUID for all known data groups.
invalidate: midcom_services_cache_module_phpscripts::invalidate() in phpscripts.php

The GUID invalidation wrapper is empty, as cached script files are not bound to any GUID.
invalidate: midcom_services_cache::invalidate() in cache.php

Invalidates all cache records accociated with a given content object.
invalidate: midcom_services_cache_module::invalidate() in module.php

Invalidate all cache objects related to the given GUID.
invalidate: midcom_services_cache_module_content::invalidate() in content.php

This function currently maps to invalidate_all unconditionally, as there is no leaf-level invalidation of content cache objects yet.
invalidate: midcom_services_cache_module_nap::invalidate() in nap.php

Invalidates all cache objects related to the GUID specified. This function is aware for NAP / Metadata caches. It will invalidate the node/leaf record pair upon each invalidation.
invalidate_all: midcom_services_cache_module_phpscripts::invalidate_all() in phpscripts.php

The invalidate_all call will just remove all .php files from the defined cache directory.
invalidate_all: midcom_services_cache::invalidate_all() in cache.php

Invalidate all caches completly.
invalidate_all: midcom_services_cache_module::invalidate_all() in module.php

Invalidate the cache completly, dropping all entries. The default implementation will drop all entries from all registered cache backends using midcom_services_cache_backend::remove_all(). Override this function, if this behavoir doesn't suit your needs.
is_a: midcom_services_indexer_document::is_a() in document.php

Checks wether the given document is an instance of given document type.
is_group_member: midcom_services_auth::is_group_member() in auth.php

Check, wether a user is member of a given group. By default, the query is run against the currently authenticated user.
is_legacy_midgard_object: midcom_services_dbclassloader::is_legacy_midgard_object() in dbclassloader.php

Simple helper to check wether we are dealing with a legacy midgard object or a subclass thereof.
is_mgdschema_object: midcom_services_dbclassloader::is_mgdschema_object() in dbclassloader.php

Simple helper to check wether we are dealing with a MgdSchema object or a subclass thereof.
is_midcom_db_object: midcom_services_dbclassloader::is_midcom_db_object() in dbclassloader.php

Simple helper to check wether we are dealing with a MidCOM Database object or a subclass thereof.
is_user_online: midcom_services_auth_sessionmgr::is_user_online() in sessionmgr.php

Checks the online state of a given user. You require the privilege midcom:isonline for the user you are going to check. The privilege is not granted by default, to allow users full control over their privacy.
is_valid_user: midcom_services_auth::is_valid_user() in auth.php

Returns true if there is an authenticated user, false otherwise.
i18n.php: i18n.php in i18n.php
indexer.php: indexer.php in indexer.php

l

top

list_fields: midcom_services_indexer_document::list_fields() in document.php

Returns a list of all defined fields.
load: midcom_services_cache_module_phpscripts::load() in phpscripts.php

Checks the cache entry against the passed last modification timestamp. If it is still valid, the corresponding file is loaded by using require_once(). Otherwise, the cache copy is deleted and false will be returned, you have to create the cache entry using the add() call then.
load_classes: midcom_services_dbclassloader::load_classes() in dbclassloader.php

this is the main class loader function. It takes a component/filename pair as arguments, the first specifying the place to look for the latter.
load_login_session: midcom_services_auth_sessionmgr::load_login_session() in sessionmgr.php

Checks the system for a valid login session matching the passed arguments.
load_mgdschema_class_handler: midcom_services_dbclassloader::load_mgdschema_class_handler() in dbclassloader.php

This function is required by the DBA interface layer and should normally not be used outside of it.
load_module: midcom_services_cache::load_module() in cache.php

This helper function will load the specified cache module (if not already loaded), add it to the _modules array and assign it to a member variable named after the module.
logout: midcom_services_auth::logout() in auth.php

This call tells the backend to clear any authentication state, then relocates the user to the sites' root URL, so that a new, unauthenticated request is started there.
logout: midcom_services_auth_backend::logout() in backend.php

The logout function should delete the currently active login session, which has been loaded by a previous call to read_login_session.
lookup_parent_guid: midcom_services_cache_module_memcache::lookup_parent_guid() in memcache.php

This is a little helper that tries to look up a parent GUID in the memory cache's PARENT data group. If it is not found, false is returned.

m

top

members_to_fields: midcom_services_indexer_document::members_to_fields() in document.php

This will translate all member variables into appropriate field records, the backend should call this immediately before indexing.
memcached.php: memcached.php in memcached.php
memcache.php: memcache.php in memcache.php
module.php: module.php in module.php
midcom.php: midcom.php in midcom.php
metadata.php: metadata.php in metadata.php
midcom_cron_tmpservice: midcom_cron_tmpservice in tmpservice.php
midcom_services_auth: midcom_services_auth::midcom_services_auth() in auth.php

Simple constructor, calls base class and initializes the data members where applicable.
midcom_services_auth: midcom_services_auth in auth.php

Main Authentication/Authorization service class, it provides means to authenticate users and to check for permissions.
midcom_services_auth_backend: midcom_services_auth_backend::midcom_services_auth_backend() in backend.php

The constructor should do only basic initialization.
midcom_services_auth_backend: midcom_services_auth_backend in backend.php

Authentication backend, responsible for validating user/password pairs and mapping them to a given user as well as the "sessioning" part, e.g. the transition of the authentication credencials over several requests.
midcom_services_auth_backend_simple: midcom_services_auth_backend_simple in simple.php

The simple auth backend uses cookies to store a session identifier which consists of the midgard person GUID.
midcom_services_auth_backend_simple: midcom_services_auth_backend_simple::midcom_services_auth_backend_simple() in simple.php

Read the configuration
midcom_services_auth_frontend: midcom_services_auth_frontend in frontend.php

Authentication frontend, responsible for rendering the login screen, reading the credencials and displaying access denied information.
midcom_services_auth_frontend: midcom_services_auth_frontend::midcom_services_auth_frontend() in frontend.php

The constructor should do only basic initialization.
midcom_services_auth_frontend_form: midcom_services_auth_frontend_form in form.php

Form-based authentication frontend. This one is rather simple, it just renders a two-field (username/password) form which is targeted at the current URL.
midcom_services_auth_frontend_form: midcom_services_auth_frontend_form::midcom_services_auth_frontend_form() in form.php

Nothing to do here.
midcom_services_auth_sessionmgr: midcom_services_auth_sessionmgr in sessionmgr.php

This class is responsible for managing login session, mainly concentrating on DB I/O.
midcom_services_auth_sessionmgr: midcom_services_auth_sessionmgr::midcom_services_auth_sessionmgr() in sessionmgr.php

Simple, currently empty default constructor.
midcom_services_cache: midcom_services_cache::midcom_services_cache() in cache.php
midcom_services_cache: midcom_services_cache in cache.php

This class is the central access point for all registered caching services. Currently this includes the NAP, Metadata and Page cache databases.
midcom_services_cache_backend: midcom_services_cache_backend in backend.php

This is the base class of the MidCOM Cache backend infrastructure. It provides a general interface for the caching services by encaspulating the calls specific to the data storage interface.
midcom_services_cache_backend: midcom_services_cache_backend::midcom_services_cache_backend() in backend.php

The constructor just initializes the empty object. The actual initialization is done by the initialize() event which does the actual configuration.
midcom_services_cache_backend_dba: midcom_services_cache_backend_dba::midcom_services_cache_backend_dba() in dba.php

The constructor is empty yet.
midcom_services_cache_backend_dba: midcom_services_cache_backend_dba in dba.php

DBA-Style flat file database caching backend.
midcom_services_cache_backend_flatfile: midcom_services_cache_backend_flatfile in flatfile.php

Simple flat file database backend. Creates a file per key.
midcom_services_cache_backend_flatfile: midcom_services_cache_backend_flatfile::midcom_services_cache_backend_flatfile() in flatfile.php

The constructor is empty yet.
midcom_services_cache_backend_memcached: midcom_services_cache_backend_memcached::midcom_services_cache_backend_memcached() in memcached.php

The constructor is empty yet.
midcom_services_cache_backend_memcached: midcom_services_cache_backend_memcached in memcached.php

Memcached caching backend.
midcom_services_cache_module: midcom_services_cache_module::midcom_services_cache_module() in module.php

Class initialization, nothing to do yet.
midcom_services_cache_module: midcom_services_cache_module in module.php

This is the base class for the MidCOM cache modules. It provides a basic infrastructure for building your own caching service, providing hooks for initialization and shutdown.
midcom_services_cache_module_content: midcom_services_cache_module_content in content.php

This is the Output Caching Engine of MidCOM. It will intercept page output, map it using the currently used URL and use the cached output on subsequent requests.
midcom_services_cache_module_content: midcom_services_cache_module_content::midcom_services_cache_module_content() in content.php

Module constructor, relay to base class.
midcom_services_cache_module_memcache: midcom_services_cache_module_memcache::midcom_services_cache_module_memcache() in memcache.php

Module constructor, relay to base class.
midcom_services_cache_module_memcache: midcom_services_cache_module_memcache in memcache.php

The Memory caching system is geared to hold needed information available quickly.
midcom_services_cache_module_nap: midcom_services_cache_module_nap::midcom_services_cache_module_nap() in nap.php

Module constructor, relay to base class.
midcom_services_cache_module_nap: midcom_services_cache_module_nap in nap.php

This is the NAP/Metadata caching module. It provides the basic management functionality for the various backend databasese which will be created based on the root topic of the NAP trees (thus the cache can be shared between AIS and on-site pages).
midcom_services_cache_module_phpscripts: midcom_services_cache_module_phpscripts in phpscripts.php

This cache module is desiged to cache files generated by various MidCOM code generation system. This includes:
midcom_services_cache_startup: midcom_services_cache_startup() in cache.php

Helper function, starts up the caching system, assigns it to the global variable $GLOBALS['midcom_cache'].
midcom_services_cron: midcom_services_cron in cron.php

This is the handling class of the cron service. When executed, it checks all component manifests for cron jobs and runs them sequentially. The components are processed in the order they are returned by the component loader, the jobs of a single component are run in the order they are listed in the configuration array.
midcom_services_cron: midcom_services_cron::midcom_services_cron() in cron.php

Empty constuctor yet.
midcom_services_dbclassloader: midcom_services_dbclassloader::midcom_services_dbclassloader() in dbclassloader.php

Initializies the class for usage.
midcom_services_dbclassloader: midcom_services_dbclassloader in dbclassloader.php

This class acts as an automated way of generating MidCOM level wrapper classes for MgdSchema based database objects.
midcom_services_i18n: midcom_services_i18n::midcom_services_i18n() in i18n.php

This method initializes the available i18n framework by determining
midcom_services_i18n: midcom_services_i18n in i18n.php

This is a basic Midcom Service which provides an interfaces to the various I18n facilities of Midcom.
midcom_services_indexer: midcom_services_indexer::midcom_services_indexer() in indexer.php

Initialization
midcom_services_indexer: midcom_services_indexer in indexer.php

This class is the main access points into the MidCOM Indexer subsystem.
midcom_services_indexer_backend: midcom_services_indexer_backend::midcom_services_indexer_backend() in backend.php
midcom_services_indexer_backend: midcom_services_indexer_backend in backend.php

This class provides an abstract base class for all indexer backends.
midcom_services_indexer_backend_xmlshell: midcom_services_indexer_backend_xmlshell::midcom_services_indexer_backend_xmlshell() in xmlshell.php

Constructor is empty at this time.
midcom_services_indexer_backend_xmlshell: midcom_services_indexer_backend_xmlshell in xmlshell.php

XMLComm implementation using a shell interface.
midcom_services_indexer_backend_xmltcp: midcom_services_indexer_backend_xmltcp::midcom_services_indexer_backend_xmltcp() in xmltcp.php

Constructor is empty at this time.
midcom_services_indexer_backend_xmltcp: midcom_services_indexer_backend_xmltcp in xmltcp.php

XMLComm implementation using a TCP/IP interface.
midcom_services_indexer_document: midcom_services_indexer_document in document.php

This class encaspulates a single indexer document. It is used for both indexing and retrieval.
midcom_services_indexer_document: midcom_services_indexer_document::midcom_services_indexer_document() in document.php

Initialize the object, nothing fancy here.
midcom_services_indexer_document_attachment: midcom_services_indexer_document_attachment in attachment.php

This is a class geared at indexing attachments. It requires you to "assingn" the attachment to a topic, which is used as TOPIC_URL for permission purposes. In addition you may set another MidgardObject as source object, it's GUID is stored in the __SOURCE field of the index.
midcom_services_indexer_document_attachment: midcom_services_indexer_document_attachment::midcom_services_indexer_document_attachment() in attachment.php

Create a new attachment document
midcom_services_indexer_document_datamanager: midcom_services_indexer_document_datamanager::midcom_services_indexer_document_datamanager() in datamanager.php

The constructor initializes the memebervariables and invokes _process_datamanager, which will read and process the information out of that instance.
midcom_services_indexer_document_datamanager: midcom_services_indexer_document_datamanager in datamanager.php

This class is geared to ease indexing of datamanager driven documents. The user invoking the indexing must have full read permissions to the object otherwise the NAP or Metadata objects can probably not be loaded successfully.
midcom_services_indexer_document_datamanager2: midcom_services_indexer_document_datamanager2 in datamanager2.php

This class is geared to ease indexing of datamanager2 driven documents. The user invoking the indexing must have full read permissions to the object otherwise the NAP or Metadata objects can probably not be loaded successfully.
midcom_services_indexer_document_datamanager2: midcom_services_indexer_document_datamanager2::midcom_services_indexer_document_datamanager2() in datamanager2.php

The constructor initializes the memebervariables and invokes _process_datamanager, which will read and process the information out of that instance.
midcom_services_indexer_document_midcom: midcom_services_indexer_document_midcom::midcom_services_indexer_document_midcom() in midcom.php

The constructor initializes the content object, loads the metadata object and populates the metadata fields accordingly.
midcom_services_indexer_document_midcom: midcom_services_indexer_document_midcom in midcom.php

This is a base class which is targeted at MidCOM content object indexing. It should be used whenever MidCOM documents are indexed, either directly or as a base class.
midcom_services_indexer_filter: midcom_services_indexer_filter in filter.php

This class provides an abstract base class for all indexer query filters.
midcom_services_indexer_filter: midcom_services_indexer_filter::midcom_services_indexer_filter() in filter.php

Initialize the class.
midcom_services_indexer_filter_date: midcom_services_indexer_filter_date::midcom_services_indexer_filter_date() in date.php

Create a new date filter.
midcom_services_indexer_filter_date: midcom_services_indexer_filter_date in date.php

This class provides an abstract base class for all indexer query filters.
midcom_services_indexer_XMLComm_RequestWriter: midcom_services_indexer_XMLComm_RequestWriter in XMLCommClient.php

This class provides an interface to the MRFC 14 XML driven indexer backends.
midcom_services_indexer_XMLComm_RequestWriter: midcom_services_indexer_XMLComm_RequestWriter::midcom_services_indexer_XMLComm_RequestWriter() in XMLCommClient.php

Initialize an XMLComm Request Writer.
midcom_services_indexer_XMLComm_ResponseReader: midcom_services_indexer_XMLComm_ResponseReader in XMLCommClient.php

This class provides an interface to the MRFC 14 XML driven indexer backends.
midcom_services_indexer_XMLComm_ResponseReader: midcom_services_indexer_XMLComm_ResponseReader::midcom_services_indexer_XMLComm_ResponseReader() in XMLCommClient.php

Initialize the XML Parser.
midcom_services_metadata: midcom_services_metadata::midcom_services_metadata() in metadata.php

Simple constructor, calls base class.
midcom_services_metadata: midcom_services_metadata in metadata.php

Metadata service.
midcom_services_permalinks: midcom_services_permalinks::midcom_services_permalinks() in permalinks.php

Empty default constructor. Calls parent.
midcom_services_permalinks: midcom_services_permalinks in permalinks.php

Permalink management service.
midcom_services_tmp: midcom_services_tmp in tmp.php

Temporary data management service.
midcom_services_tmp: midcom_services_tmp::midcom_services_tmp() in tmp.php

Simple constructor, calls base class.
midcom_services_toolbars: midcom_services_toolbars in toolbars.php

On-site toolbar service.
midcom_services_toolbars: midcom_services_toolbars::midcom_services_toolbars() in toolbars.php

Simple constructor, calls base class.
midcom_services_uimessages: midcom_services_uimessages in uimessages.php

User interface messaging service
midcom_services_uimessages: midcom_services_uimessages::midcom_services_uimessages() in uimessages.php

Simple constructor, calls base class.
midcom_services__i18n_l10n: midcom_services__i18n_l10n in _i18n_l10n.php

This is the L10n main interface class, used by the components. It allows you to get entries from the l10n string tables in the current language with an automatic conversion to the destination character set.
midcom_services__i18n_l10n: midcom_services__i18n_l10n::midcom_services__i18n_l10n() in _i18n_l10n.php

The constructor loads the translation library indicated by the snippetdir path $library and initializes the system completly. The output character set will be initizialized to the language's default.
midcom_service_session: midcom_service_session::midcom_service_session() in session.php

Constructs a session object.
midcom_service_session: midcom_service_session in session.php

Provides sessioning for components.
midcom_service__sessioning: midcom_service__sessioning::midcom_service__sessioning() in _sessioning.php

The constructor will initialize the sessioning, set the output nocacheable and initialize the session data. This might involve creating an empty session array.
midcom_service__sessioning: midcom_service__sessioning in _sessioning.php

Base singelton class of the MidCOM sessioning service.

n

top

nap.php: nap.php in nap.php
new_document: midcom_services_indexer::new_document() in indexer.php

This function tries to instantinate the most specific document class for the object given in the parameter.
no_cache: midcom_services_cache_module_content::no_cache() in content.php

Call this, if the currently processed output must not be cached for any reason. Dynamic pages with sensitive content are a candidate for this function.
numeric_entity_decode: midcom_services_i18n::numeric_entity_decode() in i18n.php

This little helper converts a single numeric HTML entity into its current native equivalent.

o

top

on_login_session_deleted: midcom_services_auth_backend_simple::on_login_session_deleted() in simple.php
open: midcom_services_cache_backend::open() in backend.php

Open the database for usage. If $write is set to true, it must be opened in read/write access, otherwise read-only access is sufficient.

p

top

phpscripts.php: phpscripts.php in phpscripts.php
permalinks.php: permalinks.php in permalinks.php
parse: midcom_services_indexer_XMLComm_ResponseReader::parse() in XMLCommClient.php

This function will parse the given string. Any error from Expat will trigger generate_error.
populate_meta_head: midcom_services_metadata::populate_meta_head() in metadata.php

Populates appropriate metadata into XHTML documents based on metadata information available to MidCOM for the request.
print_statistics: midcom_services_cache_module_content::print_statistics() in content.php

Cache statistic dump to stdout.
privilege_exists: midcom_services_auth::privilege_exists() in auth.php

This is a simple helper function which validates whether a given privilege exists by its name. Essentially this checks if a corresponding default privilege has been registered in the system.
put: midcom_services_cache_module_memcache::put() in memcache.php

Sets a fiven key in the cache. If the data group is unknown, a Warning-Level error is logged and putting is denied.
put: midcom_services_cache_backend::put() in backend.php

Store the given key/value pair, any existing entry with the same key has to be silently overwritten. If the data store has not yet been opened for writing, it will be opened automatically prior to the call, and closed automatically again afterwards.
put: midcom_services_cache_backend_flatfile::put() in flatfile.php

q

top

query: midcom_services_indexer_backend_xmltcp::query() in xmltcp.php

Query the index and, if set, restrict the query by a given filter.
query: midcom_services_indexer_backend_xmlshell::query() in xmlshell.php

Query the index and, if set, restrict the query by a given filter.
query: midcom_services_indexer::query() in indexer.php

Query the index and, if set, restrict the query by a given filter.
query: midcom_services_indexer_backend::query() in backend.php

Query the index and, if set, restrict the query by a given filter.

r

top

$resultsets: midcom_services_indexer_XMLComm_ResponseReader::$resultsets in XMLCommClient.php

An array of resultsets. An resultset is an array of documents.
$RI: midcom_services_indexer_document::$RI in document.php

The Resource Identifier of this document. Must be UTF-8 on assignement already.
read_authentication_data: midcom_services_auth_frontend::read_authentication_data() in frontend.php

This call should process the current authentication credentials and return the username / password pair that should be tried to authentication or null for anonymous access.
read_authentication_data: midcom_services_auth_frontend_form::read_authentication_data() in form.php

This call checks wether the two form fields we have created are present, if yes it reads and returns their values.
read_login_session: midcom_services_auth_backend::read_login_session() in backend.php

This function, always called first in the order of execution, should check wether we have a usable login session. It has to use the login session management system To load a login session. At the end of the successful execution of this function, you have to populate the $session_id and $user members accordingly.
read_login_session: midcom_services_auth_backend_simple::read_login_session() in simple.php
register_default_privileges: midcom_services_auth::register_default_privileges() in auth.php

Merges a new set of default privileges into the current set.
register_sent_header: midcom_services_cache_module_content::register_sent_header() in content.php

This method stores a sent header into the cache database, so that it will be resent when the cache page is delivered. midcom_application::header() will automatically call this function, you need to do this only if you use the PHP header function.
register_virtual_group: midcom_services_auth::register_virtual_group() in auth.php

Register a virtual group in the system. This requires the privilege midcom:vgroup_register assigned to the user (there is no content object checked).
remove: midcom_service_session::remove() in session.php

Removes the value accociated with the specified key. Returns null if the key is non-existant or the value of the key just removed otherwise. Note, that this is not neccessarily a valid non-existance check, as the sessioning system does allow null values. Use the exists function if unsure.
remove: midcom_services_cache_backend_flatfile::remove() in flatfile.php
remove: midcom_service__sessioning::remove() in _sessioning.php

Removes the value accociated with the specified key. Returns null if the key is non-existant or the value of the key just removed otherwise. Note, that this is not neccessarily a valid non-existance check, as the sessioning system does allow null values. Use the exists function if unsure.
remove: midcom_services_cache_backend::remove() in backend.php

Delete the data with the given key from the database. Deleting non existant keys should fail silently. If the data store has not yet been opened for writing, it will be opened automatically prior to the call, and closed automatically again afterwards.
remove_all: midcom_services_cache_backend_flatfile::remove_all() in flatfile.php
remove_all: midcom_services_cache_backend::remove_all() in backend.php

Drops the entire database and creates an empty one.
remove_field: midcom_services_indexer_document::remove_field() in document.php

Remove a field from the list. Nonexistent fields are ignored silently.
render_node_toolbar: midcom_services_toolbars::render_node_toolbar() in toolbars.php

Renders the node toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
render_view_toolbar: midcom_services_toolbars::render_view_toolbar() in toolbars.php

Renders the view toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
request_object: midcom_services_tmp::request_object() in tmp.php

Loads the temporary object identified by the argument from the DB, verifies ownership (using the midgard:owner privilege) and returns the instance.
request_sudo: midcom_services_auth::request_sudo() in auth.php

Request superuser privileges for the domain passed.
require_admin_user: midcom_services_auth::require_admin_user() in auth.php

Validates that we currently have admin level privileges, which can either come from the current user, or from the sudo service.
require_do: midcom_services_auth::require_do() in auth.php

Validates that the current user has the given privilege granted on the content object passed to the function.
require_group_member: midcom_services_auth::require_group_member() in auth.php

Validates that the current user is a member of the given group.
require_user_do: midcom_services_auth::require_user_do() in auth.php

Validates, wether the given user have the privilege assigned to him in general.
require_valid_user: midcom_services_auth::require_valid_user() in auth.php

Validates that there is an authenticated user.
resolve_permalink: midcom_services_permalinks::resolve_permalink() in permalinks.php

This function resolves any GUID into a fully qualified URL which can be reolocated to. It operates in multiple phases:

s

top

$score: midcom_services_indexer_document::$score in document.php

This is the score of this document. Only populated on resultset documents, of course.
$security: midcom_services_indexer_document::$security in document.php

Security mechainsm used to determine the availability of a search result.
$sessionmgr: midcom_services_auth::$sessionmgr in auth.php

This is a reference to the login session management system.
$session_id: midcom_services_auth_backend::$session_id in backend.php

The ID of the session we are currently using, usable as an authentication token in the login session manager.
$source: midcom_services_indexer_document::$source in document.php

An additional tag indicating the source of the document for use by the component doing the indexing. This value is not indexed and should not be used by anybody except the component doing the indexing.
simple.php: simple.php in simple.php
sessionmgr.php: sessionmgr.php in sessionmgr.php
session.php: session.php in session.php
set: midcom_service__sessioning::set() in _sessioning.php

This will store the value to the specified key.
set: midcom_service_session::set() in session.php

This will store the value to the specified key.
set_charset: midcom_services__i18n_l10n::set_charset() in _i18n_l10n.php

Set output character set.
set_charset: midcom_services_i18n::set_charset() in i18n.php

Set output character set.
set_fallback_language: midcom_services__i18n_l10n::set_fallback_language() in _i18n_l10n.php

Set the fallback language.
set_fallback_language: midcom_services_i18n::set_fallback_language() in i18n.php

Set the fallback language.
set_language: midcom_services__i18n_l10n::set_language() in _i18n_l10n.php

Set output language.
set_language: midcom_services_i18n::set_language() in i18n.php

Set output language.
set_page_class: midcom_services_metadata::set_page_class() in metadata.php

Sets the class of the current page for a context
show: midcom_services_uimessages::show() in uimessages.php

Show the message stack via javascript calls
show: midcom_services__i18n_l10n::show() in _i18n_l10n.php

This is a shortcut for "echo $this->get(...);", useful in style code.
show: midcom_services_toolbars::show() in toolbars.php

Displays the combined MidCOM toolbar system
show_authentication_form: midcom_services_auth_frontend_form::show_authentication_form() in form.php

This call renders a simple form without any formatting (that is to be done by the callee) that asks the user for his username and password.
show_authentication_form: midcom_services_auth_frontend::show_authentication_form() in frontend.php

This call should show the authentication form (or whatever means of input you use). This content you print is assumed to work within an HTML DIV element, so you should usually stick to a simple form, which should also by styleable using CSS alone.
show_login_form: midcom_services_auth::show_login_form() in auth.php

This function should be used to render the main login form. This does only include the form, no heading or whatsoever.
show_login_page: midcom_services_auth::show_login_page() in auth.php

This will show a complete login page unconditionally and exit afterwards.
show_node_toolbar: midcom_services_toolbars::show_node_toolbar() in toolbars.php

Displays the node toolbar for the indicated context. If the toolbar is undefined, an empty string is returned.
show_string: midcom_services_i18n::show_string() in i18n.php

This is a shortcut for echo $this->get_string(...);. To keep the naming stable with the actual l10n class, this is not called echo_string (Zend won't allow $l10n->echo().)
show_view_toolbar: midcom_services_toolbars::show_view_toolbar() in toolbars.php

Displays the view toolbar for the indicated context. If the toolbar is undefined, an empty string is returned.
shutdown: midcom_services_cache_module::shutdown() in module.php

Shuts the module down. This will fist call the corresponding event handler, and will close all registered backends afterwards.
shutdown: midcom_services_cache_backend::shutdown() in backend.php

Shutdown the backend. This calls the corresponding event.
shutdown: midcom_services_cache::shutdown() in cache.php

Shuts all cache modules down. The content module is explicitly stopped as the last module for clear content cache handling (it might exit()).
store: midcom_services_uimessages::store() in uimessages.php

Store unshown UI messages from the stack to user session.
string_available: midcom_services__i18n_l10n::string_available() in _i18n_l10n.php

Checks wether the given string is available in either the current or the fallback language. Use this to determine if an actually processed result is returned by get. This is helpful especially if you want to "catch" cases where an string might translate to itself in some languages.
string_exists: midcom_services__i18n_l10n::string_exists() in _i18n_l10n.php

Checks if a localized string for $string exists. If $language is unset, the current language is used.

t

top

$title: midcom_services_indexer_document::$title in document.php

The title of the document
$topic_guid: midcom_services_indexer_document::$topic_guid in document.php

The GUID of the topic the document is assigned to. May be empty for non-midgard resources.
$topic_url: midcom_services_indexer_document::$topic_url in document.php

The full path to the topic that houses the document. For external resources, this should be either a MidCOM topic, to which this resource is accociated or some "directory" after which you could filter. You may also leave it empty prohibiting it to appear on any topic-specific search.
$type: midcom_services_indexer_filter::$type in filter.php

This variable is set by the subclass constructors and indicates the type of the filter.
$type: midcom_services_indexer_document::$type in document.php

The type of the document, set by subclasses and added to the index automatically.
tmpservice.php: tmpservice.php in tmpservice.php
tmp.php: tmp.php in tmp.php
toolbars.php: toolbars.php in toolbars.php

u

top

$user: midcom_services_auth::$user in auth.php

The currently authenticated user or null in case of anonymous access.
$user: midcom_services_auth_backend::$user in backend.php

This variable holds the user that has been successfully authenticated by the class, it is considered to be read-only.
uimessages.php: uimessages.php in uimessages.php
uncached: midcom_services_cache_module_content::uncached() in content.php

Call this, if the currently processed output must not be cached for any reason. Dynamic pages or form processing results are the usual candidates for this mode.
update: midcom_services__i18n_l10n::update() in _i18n_l10n.php

Updates a string in the database. If it does not exist, it will be created automatically.
update_parent_guid: midcom_services_cache_module_memcache::update_parent_guid() in memcache.php

This is a little helper that tries to look up a parent GUID in the memory cache's PARENT data group. If it is not found, false is returned.

w

top

$warnings: midcom_services_indexer_XMLComm_ResponseReader::$warnings in XMLCommClient.php

An array of warnings that have been found.

x

top

XMLCommClient.php: XMLCommClient.php in XMLCommClient.php
xmlshell.php: xmlshell.php in xmlshell.php
xmltcp.php: xmltcp.php in xmltcp.php
xmltag_document: midcom_services_indexer_XMLComm_ResponseReader::xmltag_document() in XMLCommClient.php

Start a new document.
xmltag_document_: midcom_services_indexer_XMLComm_ResponseReader::xmltag_document_() in XMLCommClient.php

The document is complete.
xmltag_error: midcom_services_indexer_XMLComm_ResponseReader::xmltag_error() in XMLCommClient.php

Start an error record.
xmltag_error_: midcom_services_indexer_XMLComm_ResponseReader::xmltag_error_() in XMLCommClient.php

The error is complete.
xmltag_field: midcom_services_indexer_XMLComm_ResponseReader::xmltag_field() in XMLCommClient.php

Start a new document field.
xmltag_field_: midcom_services_indexer_XMLComm_ResponseReader::xmltag_field_() in XMLCommClient.php

The field is complete.
xmltag_resultset: midcom_services_indexer_XMLComm_ResponseReader::xmltag_resultset() in XMLCommClient.php

Start a new resultset.
xmltag_resultset_: midcom_services_indexer_XMLComm_ResponseReader::xmltag_resultset_() in XMLCommClient.php

The resultset is complete.
xmltag_warning: midcom_services_indexer_XMLComm_ResponseReader::xmltag_warning() in XMLCommClient.php

Start a new warning record.
xmltag_warning_: midcom_services_indexer_XMLComm_ResponseReader::xmltag_warning_() in XMLCommClient.php

The warning is complete.