PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins
Child packages:

More ...Less ...

• Foswiki::Plugins::QMPlugin::Base - abstract base class for nodes, edges and roles
• Foswiki::Plugins::QMPlugin::Command - implements a command that is executed while traversing a net
• Foswiki::Plugins::QMPlugin::Core - core class for this plugin
• Foswiki::Plugins::QMPlugin::Edge - implements an Edge in a workflow Net
• Foswiki::Plugins::QMPlugin::Group
• Foswiki::Plugins::QMPlugin::Handler
• Foswiki::Plugins::QMPlugin::JQuery - jQuery plugin to load the plugin's css and javascript assets
• Foswiki::Plugins::QMPlugin::Net - implements a workflow network
• Foswiki::Plugins::QMPlugin::Node - implements a Node in a workflow Net
• Foswiki::Plugins::QMPlugin::Review - a Review is part of a State and records the review in progress
• Foswiki::Plugins::QMPlugin::Role - implements a role concept for workflows
• Foswiki::Plugins::QMPlugin::State - implements a state that a network is in
• Foswiki::Plugins::QMPlugin::TopicIterator - iterate over topics with a qmstate
• Foswiki::Plugins::QMPlugin::User - thin wrapper for user information, something the foswiki core does not offer
• Foswiki::Plugins::QMPlugin::Utils - This package exports a few operations on topics and attachments to ease copying, moving and trashing them with ease. All functions operate on Foswiki::Meta objects.

internal package Foswiki::Plugins::QMPlugin

base class to hook into the foswiki core

initPlugin($topic, $web, $user) → $boolean

initialize the plugin, automatically called during the core initialization process

finishPlugin

finish the plugin and the core if it has been used, automatically called during the core initialization process

getCore() → $core

returns a singleton Foswiki::Plugins::QMPlugin::Core object for this plugin; a new core is allocated during each session request; once a core has been created it is destroyed during finishPlugin()

beforeSaveHandler($text, $topic, $web, $meta )

make sure the saved topic has got the right access control settings

afterSaveHandler($text, $topic, $web, $error, $meta )

make sure the saved topic has got the right access control settings

registerCommandHandler($id, $type, $handler)

register a function that can be refered to by the given id. there are two types of handler:

• beforeSave: function is called before a state is saved
• afterSave: function is called after a state is saved