GX::Plugin

Module Version: 0.2000_02

NAME

GX::Plugin - Base class for plugins

SYNOPSIS

None.

DESCRIPTION

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

METHODS

Public Methods

application

Returns the application instance to which the plugin belongs.

$application = $plugin->application;
Returns:

required_hooks

Returns the names of the required hooks.

@hook_names = $plugin->required_hooks;
Returns:
  • @hook_names ( strings )

required_plugins

Returns the (base) class names of the required plugins.

@class_names = $plugin->required_plugins;
Returns:
  • @class_names ( strings )

setup

Sets up the plugin.

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

Internal Methods

__deploy

Internal method.

$plugin->__deploy;
Exceptions:

__register

Internal method.

$plugin_interface = $plugin->__register( $application );
Arguments:
Returns:
  • $plugin_interface ( string | GX::Plugin object )

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

Exceptions:

__setup

Internal method.

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

__start

Internal method.

$plugin->__start;
Exceptions:

__unload

Internal method.

$plugin->__unload;
Exceptions:

__unregister

Internal method.

$plugin->__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.