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::ImagePlugin::Core - Core class for the image service. A singleton instance is created by Foswiki::Plugins::ImagePlugin::getCore()
• Foswiki::Plugins::ImagePlugin::Filter - This class implements ways to manipulate images using filers, i.e. it tries to mimik commonly known instagram filters
• Foswiki::Plugins::ImagePlugin::IMAGE - This is the perl stub for the image plugin.
• Foswiki::Plugins::ImagePlugin::IMAGETOOLTIP - This is the perl stub for the jquery.imagetooltip plugin.

internal package Foswiki::Plugins::ImagePlugin

base class to hook into the foswiki core

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

initialize the plugin, automatically called during the core initialization process

ClassMethod getCore() → $core

returns a singleton Foswiki::Plugins::ImagePlugin::Core

ClassMethod finishPlugin()

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

ClassMethod ObjectMethod afterRenameHandler()

ClassMethod afterSaveHandler()

ClassMethod commonTagsHandler()

ClassMethod takeOutBlocks($text, $tag, $map) → $processedText

compatibility wrapper

ClassMethod putBackBlocks($text, $tag, $map) → $processedText

compatibility wrapper

ClassMethod renderLocalImage($web, $topic, $text) → $result

handles local images, called by commonTagsHandler()

ObjectMethod renderExternalImage(web, $topic, $prefix, $url) → $result

handles external images, called by commonTagsHandler()

ClassMethod getPubUrl()

compatibility wrapper, returns the absolute pub url