Zoidberg::PluginHash - Magic plugin loader
use Zoidberg::PluginHash; my %plugins; tie %plugins, q/Zoidberg::PluginHash/, $shell; $plugins{foo}->bar();
Documentation about Zoidberg's plugin mechanism will be provided in an other document. FIXME tell where exactly.
This module hides some plugin loader stuff behind a transparent tie interface. You should regard the tied hash as a simple hash with object references. You can NOT store objects in the hash, all stored values are expected to be either a filename or a hash with meta data.
tie
The $shell object is expected to be a hash containing at least the array $shell->{settings}{data_dirs} which contains the search path for plugin meta data. Config data for plugins is located in $shell->{settings}{plugin_name}. Commands and events as defined by the plugins are stored in $shell->{commands} and $shell->{events}. These two hashes are expected to be tied with class Zoidberg::DispatchTable.
$shell
$shell->{settings}{data_dirs}
$shell->{settings}{plugin_name}
$shell->{commands}
$shell->{events}
Zoidberg::PluginHash depends on Zoidberg::Utils for reading files of various content types. Also it has special bindings for initialising Zoidberg::Fish objects.
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
Copyright (c) 2011 Jaap G Karssenberg and Joel Berger. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Zoidberg, Zoidberg::Utils, Zoidberg::Fish, Zoidberg::DispatchTable
To install Zoidberg, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Zoidberg
CPAN shell
perl -MCPAN -e shell install Zoidberg
For more information on module installation, please visit the detailed CPAN module installation guide.