Class midcom_helper_helloworld_viewer

Description

MidCOM Hello World site interface class.

Use this as an example to write new components.

...

Located in /midcom/helper/helloworld/viewer.php (line 20)

midcom_baseclasses_components_request
   |
   --midcom_helper_helloworld_viewer
Method Summary
 midcom_helper_helloworld_viewer midcom_helper_helloworld_viewer (mixed $topic, mixed $config)
 bool _handler_welcome (mixed $handler_id, Array $args, mixed &$data)
 void _show_welcome (mixed $handler_id, mixed &$data)
Variables
Methods
Constructor midcom_helper_helloworld_viewer (line 27)

Constructor.

Nothing fancy, defines the request switch.

midcom_helper_helloworld_viewer midcom_helper_helloworld_viewer (mixed $topic, mixed $config)
_handler_welcome (line 54)

Welcome page handler, does nothing, as we only have to display a hello world style element in _show_welcome.

It is executed during the code-init phase of the Midgard request, so stuff like HTTP redirects are still possible here.

  • return: Indicating success.
bool _handler_welcome (mixed $handler_id, Array $args, mixed &$data)
  • mixed $handler_id: The ID of the handler.
  • Array $args: The argument list.
  • mixed $data: The local request data.
_show_welcome (line 66)

Search form show handler, displays the search form, including some hints about how to write queries.

void _show_welcome (mixed $handler_id, mixed &$data)
  • mixed $handler_id: The ID of the handler.
  • mixed $data: The local request data.

Inherited Methods

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()

Documentation generated on Mon, 21 Nov 2005 18:23:00 +0100 by phpDocumentor 1.3.0RC3