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::ClassificationPlugin::Access
• Foswiki::Plugins::ClassificationPlugin::Category
• Foswiki::Plugins::ClassificationPlugin::Core - core class of which a singleton instance is allocated via Foswiki::Plugins::ClassificationPlugin::getCore()
• Foswiki::Plugins::ClassificationPlugin::Hierarchy - a hierarchy is the container for all categories in a web. each web is associated with exactly one hierarchy object. A hierachy is stored persistently on disk and is loaded into memory. it is only reloaded if it changed on disk by another process
• Foswiki::Plugins::ClassificationPlugin::JSTreeConnector
• Foswiki::Plugins::ClassificationPlugin::Services

internal package Foswiki::Plugins::ClassificationPlugin

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::ClassificationPlugin::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()

getServices() → $services

returns a singleton Foswiki::Plugins::ClassificationPlugin::Services object for this plugin;

getJsTreeConnector() → $jsTreeConnector

returns a singleton Foswiki::Plugins::ClassificationPlugin::JSTreeConnector object for this plugin

beforeSaveHandler()

called before a topic is saved

afterSaveHandler()

called after a topic is saved

afterRenameHandler()

called after a topic or attachment has been renamed

getHierarchy($web) → $hierarchy

gets a hierarchy object for a web

getHierarchyFromTopic($web, $topic) → $hierarchy

gets a hierarchy object for a web

getHierarchyFromText($text) → $hierarchy

returns a hierarchy object for a given bullet list

subscriptionMatches($topics, $db, $depth) → $boolean

This is our impl of Foswiki::Contrib::MailerContrib::Subscription::matches() to implement subscription to a category: notify about changes of any topic covered by a category the user is subscribed to

restUpdateCache()

REST handler to create and update the hierarchy cache