Package
This module defines the singleton object that handles Plugins
loading, initialization and execution.
This class uses Chain of Responsibility (GOF) pattern to dispatch
handler calls to registered plugins.
| |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | ObjectMethod dispatch ($handlerName,...)Dispatch the given handler, passing on ... in the parameter vector | ||||||||||||||||||||
ObjectMethod haveHandlerFor ($handlerName) -> $boolean
| |||||||||||||||||||||
Deleted: | |||||||||||||||||||||
< < |
ObjectMethod registrationHandler ()Called by the register scriptObjectMethod beforeCommonTagsHandler ()Called at the beginning (for cache Plugins only)ObjectMethod commonTagsHandler ()Called after %INCLUDE:"..."%ObjectMethod afterCommonTagsHandler ()Called at the end (for cache Plugins only)ObjectMethod preRenderingHandler ($text,\%map)
<pre class='slobadob'> XYZ </pre>the map will contain: $removed->{'pre1'}{text}: XYZ $removed->{'pre1'}{params}: class="slobadob"Iterating over blocks for a single tag is easy. For example, to prepend a line number to every line of a pre block you might use this code: foreach my $placeholder ( keys %$map ) { if( $placeholder =~ /^pre/i ) { my $n = 1; $map->{$placeholder}{text} =~ s/^/$n++/gem; } } ObjectMethod postRenderingHandler (\$text)
ObjectMethod startRenderingHandler ()Called just before the line loop DEPRECATED Use preRenderingHandler instead. This handler correctly handles verbatim and other TWiki ML block types, and exposes them to the plugin.ObjectMethod outsidePREHandler ()Called in line loop outside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod insidePREHandler ()Called in line loop inside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod endRenderingHandler ()Called just after the line loop DEPRECATED Use postRenderingHandler instead.ObjectMethod beforeEditHandler ()Called by editObjectMethod afterEditHandler ()Called by editObjectMethod beforeSaveHandler ()Called just before the save actionObjectMethod afterSaveHandler ()Called just after the save actionObjectMethod afterRenameHandler ($oldWeb,$oldTopic,$oldAttachment,$newWeb,$newTopic,$newAttachment)Called just after the rename/move/delete action of a web, topic or attachment.
ObjectMethod mergeHandler ()Called to handle text merge.ObjectMethod beforeAttachmentSaveHandler ($attrHashRef,$topic,$web)This code provides Plugins with the opportunity to alter an uploaded attachment between the upload and save-to-store processes. It is invoked as per other Plugins.
my( $attrHashRef, $topic, $web ) = @_; $$attrHashRef{'comment'} .= " (NOTE: Extracted from blah.tar.gz)"; ObjectMethod afterAttachmentSaveHandler ($attachmentAttrHash,$topic,$web,$error)deal with an uploaded attachment between the upload and save-to-store processes. It is invoked as per other plugins.
ObjectMethod writeHeaderHandler () -> $headersDEPRECATED Use modifyHeaderHandler instead. it is a lot more flexible, and allows you to modify existing headers as well as add new ones. It also works correctly when multiple plugins want to modify headers.ObjectMethod modifyHeaderHandler (\@headers,$query)ObjectMethod completePageHandler ($text,$pageType,$contentType)ObjectMethod redirectCgiQueryHandler () -> $resultCalled by TWiki::redirectObjectMethod renderFormFieldForEditHandler ($name,$type,$size,$value,$attributes,$possibleValues) -> $htmlThis handler is called before built-in types are considered. It generates the HTML text rendering this form field, or false, if the rendering should be done by the built-in type handlers.
ObjectMethod renderWikiWordHandler () -> $resultChange how a WikiWord is rendered Originated from the TWiki:Plugins.SpacedWikiWordPlugin hack | ||||||||||||||||||||
Package
This module defines the singleton object that handles Plugins
loading, initialization and execution.
This class uses Chain of Responsibility (GOF) pattern to dispatch
handler calls to registered plugins.
| |||||||||||
Added: | |||||||||||
> > | ObjectMethod finish ()Break circular references. | ||||||||||
ObjectMethod load ($allDisabled) -> $loginNameFind all active plugins, and invoke the early initialisation. Has to be done after prefs are read. Returns the user returned by the lastinitializeUserHandler to be
called.
If allDisabled is set, no plugin handlers will be called.
ObjectMethod settings ()Push plugin settings onto preference stackObjectMethod enable ()Initialisation that is done after the user is known.ObjectMethod getPluginVersion () -> $numberReturns the $TWiki::Plugins::VERSION number if no parameter is specified, else returns the version number of a named Plugin. If the Plugin cannot be found or is not active, 0 is returned.ObjectMethod addListener ($command,$handler) | |||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
invoke($command,...) , which will be triggered
when the event is to be processed.
ObjectMethod haveHandlerFor ($handlerName) -> $boolean
ObjectMethod registrationHandler ()Called by the register scriptObjectMethod beforeCommonTagsHandler ()Called at the beginning (for cache Plugins only)ObjectMethod commonTagsHandler ()Called after %INCLUDE:"..."%ObjectMethod afterCommonTagsHandler ()Called at the end (for cache Plugins only)ObjectMethod preRenderingHandler ($text,\%map)
<pre class='slobadob'> XYZ </pre> | |||||||||||
Added: | |||||||||||
> > | |||||||||||
the map will contain: | |||||||||||
Changed: | |||||||||||
< < | |||||||||||
> > | |||||||||||
$removed->{'pre1'}{text}: XYZ $removed->{'pre1'}{params}: class="slobadob" | |||||||||||
Deleted: | |||||||||||
< < | |||||||||||
Iterating over blocks for a single tag is easy. For example, to prepend a line number to every line of a pre block you might use this code: | |||||||||||
Added: | |||||||||||
> > | |||||||||||
foreach my $placeholder ( keys %$map ) { if( $placeholder =~ /^pre/i ) { my $n = 1; $map->{$placeholder}{text} =~ s/^/$n++/gem; } } | |||||||||||
Added: | |||||||||||
> > | |||||||||||
ObjectMethod postRenderingHandler (\$text)
ObjectMethod startRenderingHandler ()Called just before the line loop DEPRECATED Use preRenderingHandler instead. This handler correctly handles verbatim and other TWiki ML block types, and exposes them to the plugin.ObjectMethod outsidePREHandler ()Called in line loop outside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod insidePREHandler ()Called in line loop inside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod endRenderingHandler ()Called just after the line loop DEPRECATED Use postRenderingHandler instead.ObjectMethod beforeEditHandler ()Called by editObjectMethod afterEditHandler ()Called by editObjectMethod beforeSaveHandler ()Called just before the save actionObjectMethod afterSaveHandler ()Called just after the save actionObjectMethod afterRenameHandler ($oldWeb,$oldTopic,$oldAttachment,$newWeb,$newTopic,$newAttachment)Called just after the rename/move/delete action of a web, topic or attachment.
ObjectMethod mergeHandler ()Called to handle text merge.ObjectMethod beforeAttachmentSaveHandler ($attrHashRef,$topic,$web)This code provides Plugins with the opportunity to alter an uploaded attachment between the upload and save-to-store processes. It is invoked as per other Plugins.
| |||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
Keys in $attrHashRef:
my( $attrHashRef, $topic, $web ) = @_; $$attrHashRef{'comment'} .= " (NOTE: Extracted from blah.tar.gz)"; ObjectMethod afterAttachmentSaveHandler ($attachmentAttrHash,$topic,$web,$error)deal with an uploaded attachment between the upload and save-to-store processes. It is invoked as per other plugins.
| |||||||||||
Changed: | |||||||||||
< < |
| ||||||||||
> > |
| ||||||||||
Keys in $attrHashRef:
ObjectMethod writeHeaderHandler () -> $headers | |||||||||||
Deleted: | |||||||||||
< < | Called by TWiki::writePageHeader. DEPRECATED do not use! | ||||||||||
DEPRECATED Use modifyHeaderHandler instead. it is a lot
more flexible, and allows you to modify existing headers
as well as add new ones. It also works correctly when
multiple plugins want to modify headers.
ObjectMethod modifyHeaderHandler (\@headers,$query) | |||||||||||
Added: | |||||||||||
> > |
ObjectMethod completePageHandler ($text,$pageType,$contentType) | ||||||||||
ObjectMethod redirectCgiQueryHandler () -> $resultCalled by TWiki::redirectObjectMethod renderFormFieldForEditHandler ($name,$type,$size,$value,$attributes,$possibleValues) -> $htmlThis handler is called before built-in types are considered. It generates the HTML text rendering this form field, or false, if the rendering should be done by the built-in type handlers.
ObjectMethod renderWikiWordHandler () -> $resultChange how a WikiWord is rendered Originated from the TWiki:Plugins.SpacedWikiWordPlugin hack |
Package
This module defines the singleton object that handles Plugins
loading, initialization and execution.
This class uses Chain of Responsibility (GOF) pattern to dispatch
handler calls to registered plugins.
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | $SESSION object in this package, or via the Func package. | ||||||||||||||||||||
> > | $SESSION object in this package, or via the Func package. | ||||||||||||||||||||
For example, the call: | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | my $pref = TWiki::getPreferencesValue('URGH'); | ||||||||||||||||||||
> > | my $pref = TWiki::getPreferencesValue('URGH'); | ||||||||||||||||||||
should be replaced with | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | my $pref = TWiki::Func::getPreferencesValue('URGH'); | ||||||||||||||||||||
> > | my $pref = TWiki::Func::getPreferencesValue('URGH'); | ||||||||||||||||||||
and the call | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | my $t = TWiki::writeWarning($message); | ||||||||||||||||||||
> > | my $t = TWiki::writeWarning($message); | ||||||||||||||||||||
should be replaced with | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | my $pref = $TWiki::Plugins::SESSION->writeWarning($message); | ||||||||||||||||||||
> > | my $pref = $TWiki::Plugins::SESSION->writeWarning($message); | ||||||||||||||||||||
Methods in other modules such as Store must be accessed through the relevant TWiki sub-object, for example | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | TWiki::Store::saveTopic(...) | ||||||||||||||||||||
> > | TWiki::Store::saveTopic(...) | ||||||||||||||||||||
should be replaced with | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | $TWiki::Plugins::SESSION->{store}->saveTopic(...) | ||||||||||||||||||||
> > | $TWiki::Plugins::SESSION->{store}->saveTopic(...) | ||||||||||||||||||||
Note that calling TWiki internal methods is very very bad practice,
and should be avoided wherever practical.
The developers of TWiki reserve the right to change internal
methods without warning, unless those methods are clearly
marked as PUBLIC. PUBLIC methods are part of the core specification
of a module and can be trusted.
PUBLIC constant $VERSION | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
This is the version number of the plugins package. Use it for checking
if you have a recent enough version.
PUBLIC $SESSION | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
This is a reference to the TWiki session object. It can be used in
plugins to get at the methods of the TWiki kernel.
You are highly recommended to only use the methods in the
Func interface, unless you have no other choice,
as kernel methods may change between TWiki releases.
ClassMethod new ($session)Construct new singleton plugins collection object. The object is a container for a list of plugins and the handlers registered by the plugins. The plugins and the handlers are carefully ordered.ObjectMethod load ($allDisabled) -> $loginNameFind all active plugins, and invoke the early initialisation. Has to be done after prefs are read. Returns the user returned by the lastinitializeUserHandler to be
called.
If allDisabled is set, no plugin handlers will be called.
| |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | ObjectMethod settings ()Push plugin settings onto preference stack | ||||||||||||||||||||
ObjectMethod enable ()Initialisation that is done after the user is known.ObjectMethod getPluginVersion () -> $numberReturns the $TWiki::Plugins::VERSION number if no parameter is specified, else returns the version number of a named Plugin. If the Plugin cannot be found or is not active, 0 is returned.ObjectMethod addListener ($command,$handler) | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
invoke($command,...) , which will be triggered
when the event is to be processed.
ObjectMethod haveHandlerFor ($handlerName) -> $boolean | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
ObjectMethod registrationHandler ()Called by the register scriptObjectMethod beforeCommonTagsHandler ()Called at the beginning (for cache Plugins only)ObjectMethod commonTagsHandler ()Called after %INCLUDE:"..."%ObjectMethod afterCommonTagsHandler ()Called at the end (for cache Plugins only) | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | ObjectMethd preRenderingHandler( $text, \%map ) | ||||||||||||||||||||
> > | ObjectMethod preRenderingHandler ($text,\%map) | ||||||||||||||||||||
<pre class='slobadob'> XYZ </pre> the map will contain: <pre> $removed->{'pre1'}{text}: XYZ $removed->{'pre1'}{params}: class="slobadob" </pre> | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
Iterating over blocks for a single tag is easy. For example, to prepend a line number to every line of a pre block you might use this code: foreach my $placeholder ( keys %$map ) { if( $placeholder =~ /^pre/i ) { my $n = 1; $map->{$placeholder}{text} =~ s/^/$n++/gem; } } | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > | |||||||||||||||||||||
ObjectMethod postRenderingHandler (\$text)
ObjectMethod startRenderingHandler ()Called just before the line loop DEPRECATED Use preRenderingHandler instead. This handler correctly handles verbatim and other TWiki ML block types, and exposes them to the plugin.ObjectMethod outsidePREHandler ()Called in line loop outside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod insidePREHandler ()Called in line loop inside of <PRE> tag DEPRECATED Use preRenderingHandler instead. This handler correctly handles pre and other TWiki ML block types, and is called only once instead of line-by-line.ObjectMethod endRenderingHandler ()Called just after the line loop DEPRECATED Use postRenderingHandler instead.ObjectMethod beforeEditHandler ()Called by editObjectMethod afterEditHandler ()Called by editObjectMethod beforeSaveHandler ()Called just before the save actionObjectMethod afterSaveHandler ()Called just after the save action | |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > |
ObjectMethod afterRenameHandler ($oldWeb,$oldTopic,$oldAttachment,$newWeb,$newTopic,$newAttachment)Called just after the rename/move/delete action of a web, topic or attachment.
| ||||||||||||||||||||
ObjectMethod mergeHandler ()Called to handle text merge.ObjectMethod beforeAttachmentSaveHandler ($attrHashRef,$topic,$web)This code provides Plugins with the opportunity to alter an uploaded attachment between the upload and save-to-store processes. It is invoked as per other Plugins.
my( $attrHashRef, $topic, $web ) = @_; $$attrHashRef{'comment'} .= " (NOTE: Extracted from blah.tar.gz)"; ObjectMethod afterAttachmentSaveHandler ($attachmentAttrHash,$topic,$web,$error)deal with an uploaded attachment between the upload and save-to-store processes. It is invoked as per other plugins.
ObjectMethod writeHeaderHandler () -> $headersCalled by TWiki::writePageHeader. DEPRECATED do not use! DEPRECATED Use modifyHeaderHandler instead. it is a lot more flexible, and allows you to modify existing headers as well as add new ones. It also works correctly when multiple plugins want to modify headers.ObjectMethod modifyHeaderHandler (\@headers,$query)ObjectMethod redirectCgiQueryHandler () -> $resultCalled by TWiki::redirectObjectMethod renderFormFieldForEditHandler ($name,$type,$size,$value,$attributes,$possibleValues) -> $htmlThis handler is called before built-in types are considered. It generates the HTML text rendering this form field, or false, if the rendering should be done by the built-in type handlers.
ObjectMethod renderWikiWordHandler () -> $resultChange how a WikiWord is rendered Originated from the TWiki:Plugins.SpacedWikiWordPlugin hack |
Package
This module defines the singleton object that handles Plugins
loading, initialization and execution.
This class uses Chain of Responsibility (GOF) pattern to dispatch
handler calls to registered plugins.
|