Class midcom_baseclasses_components_purecode

Description
Description | Descendents | Vars (details) | Methods (details)

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

Note, that the request data, for ease of use, already contains references to the L10n Databases of the Component and MidCOM itself located in this class. They are stored as 'l10n' and 'l10n_midcom'. Also availbale as 'config' is the current component configuration.

Located in /midcom.core/midcom/baseclasses/components/purecode.php (line 24) 

PEAR
   |
   --midcom_baseclasses_core_object
      |
      --midcom_baseclasses_components_purecode
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class midcom_admin_aegir_module Created on Sep 3, 2005
class midcom_admin_core_config Created on Sep 3, 2005
class midcom_helper_datamanager2_controller Datamanger 2 Data Manager controller base class.
class midcom_helper_datamanager2_csv Datamanager 2 CSV Export helper class.
class midcom_helper_datamanager2_datamanager Datamanger 2 Data Manager core class.
class midcom_helper_datamanager2_formmanager Datamanger 2 Form Manager core class.
class midcom_helper_datamanager2_schema Datamanger 2 Schema class.
class midcom_helper_datamanager2_storage Datamanger 2 Data storage base class.
class midcom_helper_datamanager2_type Datamanger 2 Data Type base class.
class midcom_helper_datamanager2_widget Datamanger 2 Widget base class.
class net_nehmer_account_callbacks_validation Form Validation helper methods.
class net_nehmer_account_remote Account Management remote interface class
class net_nehmer_branchenbuch_callbacks_categorylister Branchenbuch Schema helper class.
class net_nehmer_branchenbuch_callbacks_searchbase Branchenbuch custom search callback interface
class net_nehmer_branchenbuch_schemamgr Branchenbuch Schema helper class.
class net_nehmer_buddylist_callbacks_categorylister Marketplace Schema callback, post-processes the available categories and makes them accessible. This callback can only be used from within the marketplace component, since it relies on its component context ot be correctly initialized.
class net_nehmer_jobmarket_callbacks_configlists Job Market Schema callback, takes the configuration of the current request context and works with the arrays in there. Cannot work outside the component scope.
class net_nehmer_mail_callbacks_mailboxowners On-Site Mail System Owner Listing Callback.
class net_nehmer_markdown_markdown Markdown interface class
class net_nehmer_marketplace_callbacks_categorylister Marketplace Schema callback, post-processes the available categories and makes them accessible. This callback can only be used from within the marketplace component, since it relies on its component context ot be correctly initialized.
class net_nehmer_publications_callbacks_categorylister Publications Schema callback, retrieves a category listing from the database and makes it availalble in a way compatible for the select DM2 type.
class net_nehmer_publications_query Publications query, wraps the QB and provides additional features that are required to transform a query to the M:N mapping table into a set of publication objects. Current features:
class net_nemein_opendeploydumper
class net_nemein_payment_factory Payment handler factory class.
class net_nemein_payment_handler Payment handler base class.
class net_nemein_ping_pinger Base class used for writing pure code components, retrieves a few common variables from the components current environment.
class net_nemein_registrations_aqcallback Event registration system: Additional Questions Schema selection dropdown
class net_nemein_repeathandler_calculator Calendar repeating event handler
class net_nemein_repeathandler Calendar repeating event handler
class net_nemein_wiki_notes Wiki note helper class to be used by other components
class org_openpsa_calendarwidget Class for rendering calendar widgets
class org_openpsa_contactwidget Class for rendering person records
class org_openpsa_helpers_ajax Class for sending Ajax replies to clients. Preferably used together with the Ajax JavaScript utilities provided in /midcom-static/org.openpsa.helpers/ajaxutils.js
class org_openpsa_helpers_uimessages Class for sending messages to the OpenPsa user interface. The messages are added to a stack and are displayed together with Ajax status messages in the #org_openpsa_messagearea element of the document.
class org_openpsa_mail Class for handling email encode/decode and sending
class org_openpsa_notifications Class for notifying users of different events
class org_openpsa_notifications_notifier Class for sending notices. All component-specific notification senders should inherit from here.
class org_openpsa_qbpager Pages QB resultsets
class org_openpsa_relatedto_handler Class for handling "related to" information
class org_openpsa_relatedto_suspect Class for findinf suspected "related to" links
class org_openpsa_smslib Loader for the supported SMS interfaces
class org_routamc_positioning_importer Position importing factory class. All importers inherit from this.
class org_routamc_positioning_object Positioning for a given Midgard object
class org_routamc_positioning_person Positioning for a given person
class org_routamc_positioning_utils Position handling utils, use static methods
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
string $_component
Array $_component_data
midcom_helper_configuration $_config
midcom_helper_services_i18n $_i18n
midcom_services__i18n_l10n $_l10n
midcom_services__i18n_l10n $_l10n_midcom
Method Summary
Description | Descendants | Vars (details) | Methods (details)
midcom_baseclasses_components_purecode midcom_baseclasses_components_purecode ()
void _bind_to_request_data ()
void _load_topic_configuration ([midcom_db_topic $topic = null])
Variables
Description | Descendents | Vars (details) | Methods (details)
string $_component = '' (line 79)

Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

This variable must be set before the basecalsses' constructor is called.

  • access: protected
Array $_component_data = null (line 69)

Component data storage area.

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

  • access: protected
midcom_helper_configuration $_config = null (line 41)

The current configuration, possibly modified by the _load_topic_configuration helper.

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

  • access: protected
Redefined in descendants as:
midcom_helper_services_i18n $_i18n = null (line 48)

A handle to the i18n service.

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

  • access: protected
midcom_services__i18n_l10n $_l10n = null (line 55)

The components' L10n string database

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

  • access: protected
midcom_services__i18n_l10n $_l10n_midcom = null (line 62)

The global MidCOM string database

Request state variable.

To initialize this variable you must call _bind_to_request_data(), otherwise it will be null.

  • access: protected
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor midcom_baseclasses_components_purecode (line 87)

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.

midcom_baseclasses_components_purecode midcom_baseclasses_components_purecode ()
_bind_to_request_data (line 120)

Binds the object to the current request data. This populates the members _request_data, _config, _topic, _l10n and _l10n_midcom accordingly.

  • access: protected
void _bind_to_request_data ()
_load_topic_configuration (line 105)

This is an internal helper which you can use to merge a topic configuration set for your component into your local configuration store. Call this without an argument to reset to the global defaults.

  • access: protected
void _load_topic_configuration ([midcom_db_topic $topic = null])
  • midcom_db_topic $topic: The topic from which to load the configuration. Omit this (or call it with null) to load the global default configuration.

Inherited Methods

Inherited From midcom_baseclasses_core_object

midcom_baseclasses_core_object::midcom_baseclasses_core_object()

Documentation generated on Tue, 15 Aug 2006 12:52:45 +0300 by phpDocumentor 1.3.0RC3