NAME

Net::SinFP3::Mode - base class for Mode plugin objects

SYNOPSIS

use base qw(Net::SinFP3::Mode);

# Your Mode plugin code

DESCRIPTION

This is the base class for all Net::SinFP3::Mode plugins.

ATTRIBUTES

global (Net::SinFP3::Global)

The global object containing global parameters and pointers to currently executing plugins.

METHODS

new (%hash)

Object constructor. You must give it the following attributes: global.

take ()

Return an array ref of allowed Next object types.

init ()

Do some initialization by writing this method.

run ()

To use when you are ready to launch the main loop.

post ()

Do some cleanup by writing this method. post is run in the middle of main Net::SinFP3 loop postlude. The exact order is:

output->post > search->post > mode->post > db->post > input->post

postSearch ()

Execute this action right after a Net::SinFP3::Search plugin run method. This can be used, for instance, to modify search results.

AUTHOR

Patrice <GomoR> Auffret

COPYRIGHT AND LICENSE

Copyright (c) 2011-2012, Patrice <GomoR> Auffret

You may distribute this module under the terms of the Artistic license. See LICENSE.Artistic file in the source distribution archive.