GX::Component

Module Version: 0.2000_02

NAME

GX::Component - Base class for components

SYNOPSIS

None.

DESCRIPTION

This module provides the GX::Component class which is the base class for all components. The GX::Component class itself inherits from GX::Class.

METHODS

Public Methods

application

Returns the application instance to which the component belongs.

$application = $component->application;
Returns:

setup

Sets up the component.

$component->setup( %options );
Arguments:
  • %options ( named list )
Exceptions:

Internal Methods

__deploy

Internal method.

$component->__deploy;
Exceptions:

__register

Internal method.

$component_interface = $component->__register( $application );
Arguments:
Returns:
  • $component_interface ( string | GX::Component object )

    The component interface, which can be, depending on the implementation, an instance of the component class or the component class name.

Exceptions:

__setup

Internal method.

$component->__setup( $options );
Arguments:
  • $options ( HASH reference )
Exceptions:

__start

Internal method.

$component->__start;
Exceptions:

__unload

Internal method.

$component->__unload;
Exceptions:

__unregister

Internal method.

$component->__unregister;
Exceptions:

AUTHOR

Jörg A. Uzarek <uzarek@runlevelnull.de>

COPYRIGHT AND LICENSE

Copyright © 2009-2011 Jörg A. Uzarek.

This module is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3 as published by the Free Software Foundation.