Jon Portnoy > Bot-Cobalt-0.016000 > Bot::Cobalt::Conf::File::Plugins

Download:
Bot-Cobalt-0.016000.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.016000   Source   Latest Release: Bot-Cobalt-0.016002

NAME ^

Bot::Cobalt::Conf::File::Plugins - Bot::Cobalt plugins config

SYNOPSIS ^

  my $plugins_cfg = Bot::Cobalt::Conf::File::Plugins->new(
    etcdir => $path_to_etcdir,

    path => $path_to_plugins_cf,    
  );

  ## Retrieve array reference of plugin aliases seen:
  my $plugins_arr = $plugins_cfg->list_plugins;

  ## Retrieve Bot::Cobalt::Conf::File::PerPlugin object:
  my $this_plugin_cf = $plugins_cfg->plugin( $alias );

DESCRIPTION ^

This is the Bot::Cobalt::Conf::File subclass for "plugins.conf" -- its primary purpose is to handle Bot::Cobalt::Conf::File::PerPlugin instances, retrievable via "plugin".

The constructor requires a etcdir to be used as a relative base path for plugin-specific configuration files.

(This is a core configuration class; there is generally no need for plugin authors to use these objects directly.)

clear_plugin

Takes a plugin alias. Removes the configuration object for the specified plugin.

install_plugin

Takes a plugin alias and a Bot::Cobalt::Conf::File::PerPlugin or subclass thereof. Installs the new object under the specified alias.

list_plugins

Returns an array reference of currently tracked plugin aliases.

load_plugin

Takes a plugin alias. Loads or re-instances the Bot::Cobalt::Conf::File::PerPlugin object for the specified plugin.

plugin

Takes a plugin alias. Returns the Bot::Cobalt::Conf::File::PerPlugin object for the specified plugin (or boolean false).

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>

syntax highlighting: