Docs For Class no_odindata_quickform

Description

Base class to encaspulate a admin request to the component, instantinated by the MidCOM component interface.

This is largly equivalent to the regular request base class midcom_baseclasses_components_request with the exception, that helper handlers exist for configuration management.

Three additional member variables are defined during startup, making the topic, leaf and metadata AIS toolbars available to the user.

Custom Handler: Datamanger driven component configuration

It defines a handler that can be used for Datamanager driven configuration. It requires a few configuration directives: 'schemadb' must hold a valid path to a schema database containing the actual configuration schema. The key 'schema' may contain the name of the schema to use, it defaults to 'config' if omitted. Finally, 'disable_return_to_topic', if set to true, will hide the automatically added "Return to topic" toolbar item. This is useful for components which have only an configuration interface but nothing more, it defaults to false.

It uses the MidCOM l10n string 'return to topic' as title for the leaf-toolbar-item added during the handle phase.

The handler will load the datamanager library during the handle phase, just in case you have not yet loaded it.

Important Note: The schema you supply for configuration is always treated as having a zero lock timeout, this parameter is enforced after initializing the datamanager. It is important, as the config handler stays in the edit loop indefinitly.

Full configuration example:

 <?php
  $this->_request_switch[] = Array
  (S
      'handler' => 'config_dm',
      'fixed_args' => Array('config'),
      'schemadb' => 'file:/de/linkm/taviewer/config/schemadb_config.inc',
      'schema' => 'config',
      'disable_return_to_topic' => false
  );
 ?>

Located in /no/odindata/quickform/admin.php (line 3)

midcom_baseclasses_components_request
   |
   --midcom_baseclasses_components_request_admin
      |
      --no_odindata_quickform_admin

Method Summary

no_odindata_quickform_admin no_odindata_quickform_admin (mixed $topic, mixed $config)

void get_metadata ()

void _load_schema_database ()

void _on_initialize ()

void _prepare_topic_toolbar ()

Variables

Inherited Variables

Inherited from midcom_baseclasses_components_request_admin

midcom_baseclasses_components_request_admin::$_local_toolbar
midcom_baseclasses_components_request_admin::$_meta_toolbar
midcom_baseclasses_components_request_admin::$_topic_toolbar

Inherited from midcom_baseclasses_components_request

midcom_baseclasses_components_request::$errcode
midcom_baseclasses_components_request::$errstr
midcom_baseclasses_components_request::$_component
midcom_baseclasses_components_request::$_component_data
midcom_baseclasses_components_request::$_config
midcom_baseclasses_components_request::$_handler
midcom_baseclasses_components_request::$_i18n
midcom_baseclasses_components_request::$_l10n
midcom_baseclasses_components_request::$_l10n_midcom
midcom_baseclasses_components_request::$_request_data
midcom_baseclasses_components_request::$_request_switch
midcom_baseclasses_components_request::$_topic

Methods

Constructor no_odindata_quickform_admin (line 26)

no_odindata_quickform_admin no_odindata_quickform_admin (mixed $topic, mixed $config)

get_metadata (line 130)

void get_metadata ()

Redefinition of:

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

_load_schema_database (line 66)

Internal helper, loads the configured schema database into the class.

It is not yet evaluated by a datamanager, only the file is loaded.

access: private
see: $_schemadb_index
see: $_schemadb

void _load_schema_database ()

_on_initialize (line 30)

void _on_initialize ()

Redefinition of:

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

_prepare_topic_toolbar (line 109)

This function adds all of the standard items (configuration and create links) to the topic toolbar.

access: private

void _prepare_topic_toolbar ()

Inherited Methods

Inherited From midcom_baseclasses_components_request_admin

midcom_baseclasses_components_request_admin::midcom_baseclasses_components_request_admin()
midcom_baseclasses_components_request_admin::_handler_config_dm()
midcom_baseclasses_components_request_admin::_handler_config_dm_prepare()
midcom_baseclasses_components_request_admin::_on_handler_config_dm_prepared()
midcom_baseclasses_components_request_admin::_on_handler_config_dm_preparing()
midcom_baseclasses_components_request_admin::_on_handler_config_dm_saved()
midcom_baseclasses_components_request_admin::_show_config_dm()

Inherited From midcom_baseclasses_components_request

midcom_baseclasses_components_request::midcom_baseclasses_components_request()
midcom_baseclasses_components_request::can_handle()
midcom_baseclasses_components_request::get_metadata()
midcom_baseclasses_components_request::handle()
midcom_baseclasses_components_request::initialize()
midcom_baseclasses_components_request::show()
midcom_baseclasses_components_request::_on_get_metadata()
midcom_baseclasses_components_request::_on_handle()
midcom_baseclasses_components_request::_on_initialize()
midcom_baseclasses_components_request::_on_show()
midcom_baseclasses_components_request::_prepare_handler()
midcom_baseclasses_components_request::_prepare_request_switch()