MidCOM PHP Superglobal

From OpenPSA Wiki

The $_MIDCOM superglobal is where MidCOM stores the midcom_application object, the main controlling instance of the MidCOM framework. $_MIDCOM is usually a link to $GLOBALS['midcom'], so the same functionality is available there. See also Midgard PHP Superglobal.

Modifying Style Elements often involves the use of the $_MIDCOM object. For example, get_context_data is used to transport information from Component backend functions to the presentation layer (i.e. the Style Elements).

In OpenPSA 9 and Midgard 2, the use of the $_MIDCOM superglobal is deprecated. Developers should access the functionality with the midcom::get() method instead:

//old syntax:
$_MIDCOM->componentloader->load('org.openpsa.documents');
//new syntax:
midcom::get('componentloader')->load('org.openpsa.documents');

[edit] Structure

• $_MIDCOM - This is a midcom_application objects, with all the respective attributes and methods (see midcom_application for a complete listing).
  • $_MIDCOM->auth - Access point to midcom.services.auth.
    • $_MIDCOM->auth->admin - true when the currently logged in User has admin privileges
    • $_MIDCOM->auth->user - A midcom_core_user object of the currently logged in User
    • $_MIDCOM->auth->sessionmgr
  • $_MIDCOM->cache
  • $_MIDCOM->componentloader - midcom_helper__componentloader object. Can be used to load MidCOM Components
    • $_MIDCOM->componentloader->manifests - An array of available manifests for MidCOM Components.
  • $_MIDCOM->dbclassloader - Access point to the MidCOM Service midcom_services_dbclassloader
  • $_MIDCOM->dbfactory - Access point to midcom_helper__dbfactory
  • $_MIDCOM->i18n - midcom_services_i18n object
  • $_MIDCOM->indexer - midcom_services_indexer object
  • $_MIDCOM->midgard
  • $_MIDCOM->metadata - midcom_services_metadata object
  • $_MIDCOM->permalinks - midcom_services_permalinks interface
  • $_MIDCOM->metadata - midcom_services_metadata object
  • $_MIDCOM->rcs - midcom_services_rcs object
  • $_MIDCOM->serviceloader - midcom_helper_serviceloader object
  • $_MIDCOM->session - midcom_service__sessioning object
  • $_MIDCOM->style - midcom_helper__styleloader object
  • $_MIDCOM->toolbars - Access point to the MidCOM Toolbars service
  • $_MIDCOM->tmp - midcom_services_tmp object
  • $_MIDCOM->uimessages - midcom_services_uimessages object