internal package Foswiki::Plugins::TimeTablePlugin

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:

Child packagesChild packages

• Foswiki::Plugins::TimeTablePlugin::TimeTable

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

• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query
• $user - the login name of the user
• $installWeb - the name of the web the plugin is installed in

REQUIRED

Called to initialise the plugin. If everything is OK, should return a non-zero value. On non-fatal failure, should write a message using Foswiki::Func::writeWarning and return 0. In this case

Plugin	Errors
TWikiCompatibilityPlugin	none
SpreadSheetPlugin	none
SlideShowPlugin	none
AttachContentPlugin	none
AutoTemplatePlugin	none
AutoViewTemplatePlugin	none
BookmakerPlugin	none
BreadCrumbsPlugin	none
CalDAVPlugin	none
CalendarPlugin	none
ChecklistPlugin	none
ClassificationPlugin	none
CommentPlugin	none
CompareRevisionsAddonPlugin	none
ConfigurePlugin	none
ControlWikiWordPlugin	none
DBCachePlugin	none
System.DBIPlugin	none
DiffPlugin	none
DigestPlugin	none
DocumentViewerPlugin	none
EditRowPlugin	none
FilesysVirtualPlugin	none
FilterPlugin	none
FlexFormPlugin	none
FlexWebListPlugin	none
FormPlugin	none
FreeMindPlugin	none
FullCalendarPlugin	none
GenPDFAddOnPlugin	none
GenPDFWebkitPlugin	none
GraphvizPlugin	none
GridLayoutPlugin	none
HistoryPlugin	none
HolidaylistPlugin	none
HomePagePlugin	none
ICalPlugin	none
ImageGalleryPlugin	none
ImagePlugin	none
JEditableContribPlugin	none
JQDataTablesPlugin	none
JQFullCalendarPlugin	none
JQGridPlugin	none
JQueryPlugin	none
LatexModePlugin	none
LdapNgPlugin	none
LikePlugin	none
ListyPlugin	none
MailerContribPlugin	none
MathModePlugin	none
MediaElementPlugin	none
MetaCommentPlugin	none
MetaDataPlugin	none
MimeIconPlugin	none
MoreFormfieldsPlugin	none
MultiLingualPlugin	none
NatEditPlugin	none
NatSkinPlugin	none
OEmbedPlugin	none
ObjectPlugin	none
PageOptimizerPlugin	none
PdfPlugin	none
PerlPlugin	none
PreferencesPlugin	none
PublishPlugin	none
RedDotPlugin	none
RenderListPlugin	none
RenderPlugin	none
SecurityHeadersPlugin	none
SendEmailPlugin	none
SmiliesPlugin	none
SolrPlugin	none
SubscribePlugin	none
TablePlugin	none
TagCloudPlugin	none
TimeTablePlugin	none
TinyMCEPlugin	none
TopicInteractionPlugin	none
TopicTitlePlugin	none
TreeBrowserPlugin	none
TreePlugin	none
TwistyPlugin	none
UpdatesPlugin	none
UploadPlugin	none
VotePlugin	none
WebLinkPlugin	none
WorkflowPlugin	none
WysiwygPlugin	none

Handler	Plugins
afterAttachmentSaveHandler	DBCachePlugin This handler is deprecated - please check for updated versions of the plugins that use it!
afterUploadHandler	DBCachePlugin MoreFormfieldsPlugin SolrPlugin TopicInteractionPlugin
afterCommonTagsHandler	JQGridPlugin LatexModePlugin TablePlugin
afterEditHandler	MoreFormfieldsPlugin WysiwygPlugin
afterRenameHandler	ClassificationPlugin DBCachePlugin FlexWebListPlugin ImagePlugin LikePlugin MoreFormfieldsPlugin SolrPlugin TopicTitlePlugin
afterSaveHandler	AttachContentPlugin ClassificationPlugin DBCachePlugin FlexWebListPlugin GraphvizPlugin ICalPlugin MoreFormfieldsPlugin SolrPlugin TreePlugin
beforeAttachmentSaveHandler	WorkflowPlugin This handler is deprecated - please check for updated versions of the plugins that use it!
beforeCommonTagsHandler	AttachContentPlugin PreferencesPlugin WysiwygPlugin
beforeEditHandler	MoreFormfieldsPlugin NatEditPlugin TinyMCEPlugin WorkflowPlugin WysiwygPlugin
beforeMergeHandler	WysiwygPlugin
beforeSaveHandler	ClassificationPlugin ImagePlugin MetaDataPlugin MoreFormfieldsPlugin MultiLingualPlugin ObjectPlugin TopicTitlePlugin WorkflowPlugin WysiwygPlugin
beforeUploadHandler	TopicInteractionPlugin
commonTagsHandler	SpreadSheetPlugin SlideShowPlugin ChecklistPlugin CompareRevisionsAddonPlugin DiffPlugin EditRowPlugin FilterPlugin GraphvizPlugin ImagePlugin LatexModePlugin MathModePlugin ObjectPlugin TimeTablePlugin
completePageHandler	FlexFormPlugin GenPDFWebkitPlugin NatSkinPlugin PageOptimizerPlugin PdfPlugin
earlyInitPlugin	TWikiCompatibilityPlugin MetaDataPlugin
endRenderingHandler	ChecklistPlugin NatSkinPlugin This handler is deprecated - please check for updated versions of the plugins that use it!
finishPlugin	AutoTemplatePlugin BreadCrumbsPlugin ClassificationPlugin DBCachePlugin DBIPlugin DiffPlugin FlexFormPlugin FlexWebListPlugin GraphvizPlugin GridLayoutPlugin ImageGalleryPlugin ImagePlugin JQDataTablesPlugin JQueryPlugin LdapNgPlugin LikePlugin ListyPlugin MetaDataPlugin MimeIconPlugin MoreFormfieldsPlugin MultiLingualPlugin NatSkinPlugin PageOptimizerPlugin RenderPlugin SecurityHeadersPlugin SolrPlugin TopicInteractionPlugin TopicTitlePlugin UpdatesPlugin WebLinkPlugin
initPlugin	TWikiCompatibilityPlugin SpreadSheetPlugin SlideShowPlugin AttachContentPlugin AutoTemplatePlugin AutoViewTemplatePlugin BookmakerPlugin BreadCrumbsPlugin CalDAVPlugin CalendarPlugin ChecklistPlugin ClassificationPlugin CommentPlugin CompareRevisionsAddonPlugin ConfigurePlugin ControlWikiWordPlugin DBCachePlugin DBIPlugin DiffPlugin DigestPlugin DocumentViewerPlugin EditRowPlugin FilesysVirtualPlugin FilterPlugin FlexFormPlugin FlexWebListPlugin FormPlugin FreeMindPlugin FullCalendarPlugin GenPDFAddOnPlugin GenPDFWebkitPlugin GraphvizPlugin GridLayoutPlugin HistoryPlugin HolidaylistPlugin HomePagePlugin ICalPlugin ImageGalleryPlugin ImagePlugin JEditableContribPlugin JQDataTablesPlugin JQFullCalendarPlugin JQGridPlugin JQueryPlugin LatexModePlugin LdapNgPlugin LikePlugin ListyPlugin MailerContribPlugin MathModePlugin MediaElementPlugin MetaCommentPlugin MetaDataPlugin MimeIconPlugin MoreFormfieldsPlugin MultiLingualPlugin NatEditPlugin NatSkinPlugin OEmbedPlugin ObjectPlugin PageOptimizerPlugin PdfPlugin PerlPlugin PreferencesPlugin PublishPlugin RedDotPlugin RenderListPlugin RenderPlugin SecurityHeadersPlugin SendEmailPlugin SmiliesPlugin SolrPlugin SubscribePlugin TablePlugin TagCloudPlugin TimeTablePlugin TinyMCEPlugin TopicInteractionPlugin TopicTitlePlugin TreeBrowserPlugin TreePlugin TwistyPlugin UpdatesPlugin UploadPlugin VotePlugin WebLinkPlugin WorkflowPlugin WysiwygPlugin
initializeUserHandler	HomePagePlugin
modifyHeaderHandler	GenPDFWebkitPlugin RenderPlugin SecurityHeadersPlugin WysiwygPlugin
postRenderingHandler	BookmakerPlugin ChecklistPlugin EditRowPlugin MathModePlugin PreferencesPlugin WysiwygPlugin
preRenderingHandler	ControlWikiWordPlugin PageOptimizerPlugin RenderListPlugin SmiliesPlugin TablePlugin TreeBrowserPlugin
renderWikiWordHandler	TWikiCompatibilityPlugin TopicTitlePlugin

88 plugins

will indicate which plugins failed.

In the case of a catastrophic failure that will prevent the whole installation from working safely, this handler may use 'die', which will be trapped and reported in the browser.

You may also call Foswiki::Func::registerTagHandler here to register a function to handle tags that have standard Foswiki syntax - for example, =%MYTAG{"my param" myarg="My Arg"}%. You can also override internal Foswiki tag handling functions this way, though this practice is unsupported and highly dangerous!

initializeUserHandler( $loginName, $url, $pathInfo )

• $loginName - login name recovered from $ENV{REMOTE_USER}
• $url - request url
• $pathInfo - pathinfo from the CGI query

Allows a plugin to set the username, for example based on cookies.

Return the user name, or guest if not logged in.

This handler is called very early, immediately after earlyInitPlugin.

Since: Foswiki::Plugins::VERSION = '1.010'

registrationHandler($web, $wikiName, $loginName )

• $web - the name of the web in the current CGI query
• $wikiName - users wiki name
• $loginName - users login name

Called when a new user registers with this System.

Since: Foswiki::Plugins::VERSION = '1.010'

commonTagsHandler($text, $topic, $web )

• $text - text to be processed
• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query

This handler is called by the code that expands %TAGS% syntax in the topic body and in form fields. It may be called many times while a topic is being rendered.

Plugins that want to implement their own %TAGS% with non-trivial additional syntax should implement this function. Internal Foswiki tags (and any tags declared using Foswiki::Func::registerTagHandler) are expanded before, and then again after, this function is called to ensure all %TAGS% are expanded.

For tags with trivial syntax it is far more efficient to use Foswiki::Func::registerTagHandler (see initPlugin).

NOTE: when this handler is called, <verbatim> blocks have been removed from the text (though all other HTML such as <pre> blocks is still present).

NOTE: meta-data is not embedded in the text passed to this handler.

beforeCommonTagsHandler($text, $topic, $web )

• $text - text to be processed
• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query

This handler is called before Foswiki does any expansion of it's own internal tags. It is designed for use by cache plugins. Note that when this handler is called, <verbatim> blocks are still present in the text.

NOTE: This handler is called once for each call to commonTagsHandler i.e. it may be called many times during the rendering of a topic.

NOTE: meta-data is not embedded in the text passed to this handler.

afterCommonTagsHandler($text, $topic, $web )

• $text - text to be processed
• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query

This handler is after Foswiki has completed expansion of %TAGS%. It is designed for use by cache plugins. Note that when this handler is called, <verbatim> blocks are present in the text.

NOTE: This handler is called once for each call to commonTagsHandler i.e. it may be called many times during the rendering of a topic.

NOTE: meta-data is not embedded in the text passed to this handler.

preRenderingHandler( $text, \%map )

• $text - text, with the head, verbatim and pre blocks replaced with placeholders
• \%removed - reference to a hash that maps the placeholders to the removed blocks.

Handler called immediately before Foswiki syntax structures (such as lists) are processed, but after all variables have been expanded. Use this handler to process special syntax only recognised by your plugin.

Placeholders are text strings constructed using the tag name and a sequence number e.g. 'pre1', "verbatim6", "head1" etc. Placeholders are inserted into the text inside <!--!marker!-→ characters so the text will contain <!--!pre1!-→ for placeholder pre1.

Each removed block is represented by the block text and the parameters passed to the tag (usually empty) e.g. for

<pre class='slobadob'>
XYZ
</pre>
the map will contain:
<pre>
$removed->{'pre1'}{text}:   XYZ
$removed->{'pre1'}{params}: class="slobadob"
</pre>
Iterating over blocks for a single tag is easy. For example, to prepend a line number to every line of every pre block you might use this code:
<verbatim>
foreach my $placeholder ( keys %$map ) {
    if( $placeholder =~ /^pre/i ) {
       my $n = 1;
       $map->{$placeholder}{text} =~ s/^/$n++/gem;
    }
}
</verbatim>

__NOTE__: This handler is called once for each rendered block of text i.e. it may be called several times during the rendering of a topic.

__NOTE:__ meta-data is _not_ embedded in the text passed to this
handler.

Since Foswiki::Plugins::VERSION = '1.026'

=cut

sub DISABLE_preRenderingHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    #my( $text, $pMap ) = @_;
}

=pod

---++ postRenderingHandler( $text )
   * =$text= - the text that has just been rendered. May be modified in place.

__NOTE__: This handler is called once for each rendered block of text i.e. it may be called several times during the rendering of a topic.

__NOTE:__ meta-data is _not_ embedded in the text passed to this
handler.

Since Foswiki::Plugins::VERSION = '1.026'

=cut

sub DISABLE_postRenderingHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    #my $text = shift;
}

=pod

---++ beforeEditHandler($text, $topic, $web )
   * =$text= - text that will be edited
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
This handler is called by the edit script just before presenting the edit text
in the edit box. It is called once when the =edit= script is run.

__NOTE__: meta-data may be embedded in the text passed to this handler (using %META: tags)

__Since:__ Foswiki::Plugins::VERSION = '1.010'

=cut

sub DISABLE_beforeEditHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ### my ( $text, $topic, $web ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::beforeEditHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ afterEditHandler($text, $topic, $web )
   * =$text= - text that is being previewed
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
This handler is called by the preview script just before presenting the text.
It is called once when the =preview= script is run.

__NOTE:__ this handler is _not_ called unless the text is previewed.

__NOTE:__ meta-data is _not_ embedded in the text passed to this
handler.

__Since:__ Foswiki::Plugins::VERSION = '1.010'

=cut

sub DISABLE_afterEditHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ### my ( $text, $topic, $web ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::afterEditHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ beforeSaveHandler($text, $topic, $web, $meta )
   * =$text= - text _with embedded meta-data tags_
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
   * =$meta= - the metadata of the topic being saved, represented by a Foswiki::Meta object.

This handler is called each time a topic is saved.

__NOTE:__ meta-data is embedded in $text (using %META: tags)

__Since:__ Foswiki::Plugins::VERSION = '1.010'

=cut

sub DISABLE_beforeSaveHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ### my ( $text, $topic, $web ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::beforeSaveHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ afterSaveHandler($text, $topic, $web, $error, $meta )
   * =$text= - the text of the topic _excluding meta-data tags_
     (see beforeSaveHandler)
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
   * =$error= - any error string returned by the save.
   * =$meta= - the metadata of the saved topic, represented by a Foswiki::Meta object 

This handler is called each time a topic is saved.

__NOTE:__ meta-data is embedded in $text (using %META: tags)

__Since:__ Foswiki::Plugins::VERSION = '1.020'

=cut

sub DISABLE_afterSaveHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ### my ( $text, $topic, $web, $error, $meta ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::afterSaveHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ beforeAttachmentSaveHandler(\%attrHash, $topic, $web )
   * =\%attrHash= - reference to hash of attachment attribute values
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
This handler is called once when an attachment is uploaded.

The attributes hash
will include at least the following attributes:
   * =attachment= => the attachment name
   * =comment= - the comment
   * =user= - the user's Web.<nop>WikiName

__Since:__ Foswiki::Plugins::VERSION = '1.023'

=cut

sub DISABLE_beforeAttachmentSaveHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ###   my( $attrHashRef, $topic, $web ) = @_;
    Foswiki::Func::writeDebug( "- ${pluginName}::beforeAttachmentSaveHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error )
   * =\%attrHash= - reference to hash of attachment attribute values
   * =$topic= - the name of the topic in the current CGI query
   * =$web= - the name of the web in the current CGI query
   * =$error= - any error string generated during the save process
This handler is called just after the save action. The attributes hash
will include at least the following attributes:
   * =attachment= => the attachment name
   * =comment= - the comment
   * =user= - the user's Web.<nop>WikiName

__Since:__ Foswiki::Plugins::VERSION = '1.023'

=cut

sub DISABLE_afterAttachmentSaveHandler {
    # do not uncomment, use $_[0], $_[1]... instead
    ###   my( $attrHashRef, $topic, $web ) = @_;
    Foswiki::Func::writeDebug( "- ${pluginName}::afterAttachmentSaveHandler( $_[2].$_[1] )" ) if $debug;
}

=pod

---++ mergeHandler( $diff, $old, $new, \%info ) -> $text
Try to resolve a difference encountered during merge. The =differences= array is an array of hash references, where each hash contains the following fields:
   * =$diff= => one of the characters '+', '-', 'c' or ' '.
      * '+' - =new= contains text inserted in the new version
      * '-' - =old= contains text deleted from the old version
      * 'c' - =old= contains text from the old version, and =new= text from the version being saved
      * ' ' - =new= contains text common to both versions, or the change only involved whitespace
   * =$old= => text from version currently saved
   * =$new= => text from version being saved
   * =\%info= is a reference to the form field description { name, title, type, size, value, tooltip, attributes, referenced }. It must _not_ be wrtten to. This parameter will be undef when merging the body text of the topic.

Plugins should try to resolve differences and return the merged text. For example, a radio button field where we have ={ diff=>'c', old=>'Leafy', new=>'Barky' }= might be resolved as ='Treelike'=. If the plugin cannot resolve a difference it should return undef.

The merge handler will be called several times during a save; once for each difference that needs resolution.

If any merges are left unresolved after all plugins have been given a chance to intercede, the following algorithm is used to decide how to merge the data:
   1 =new= is taken for all =radio=, =checkbox= and =select= fields to resolve 'c' conflicts
   1 '+' and '-' text is always included in the the body text and text fields
   1 <del>conflict</del> <ins>markers</ins> are used to mark 'c' merges in text fields

The merge handler is called whenever a topic is saved, and a merge is required to resolve concurrent edits on a topic.

=cut

sub DISABLE_mergeHandler {
}

=pod

---++ modifyHeaderHandler( \%headers, $query )
   * =\%headers= - reference to a hash of existing header values
   * =$query= - reference to CGI query object
Lets the plugin modify the HTTP headers that will be emitted when a
page is written to the browser. \%headers= will contain the headers
proposed by the core, plus any modifications made by other plugins that also
implement this method that come earlier in the plugins list.
<verbatim>
$headers->{expires} = '+1h';
</verbatim>

Note that this is the HTTP header which is _not_ the same as the HTML
&lt;HEAD&gt; tag. The contents of the &lt;HEAD&gt; tag may be manipulated
using the =Foswiki::Func::addToHEAD= method.

__Since:__ Foswiki::Plugins::VERSION 1.026

=cut

sub DISABLE_modifyHeaderHandler {
    my ( $headers, $query ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::modifyHeaderHandler()" ) if $debug;
}

=pod

---++ redirectCgiQueryHandler($query, $url )
   * =$query= - the CGI query
   * =$url= - the URL to redirect to

This handler can be used to replace Foswiki's internal redirect function.

If this handler is defined in more than one plugin, only the handler
in the earliest plugin in the INSTALLEDPLUGINS list will be called. All
the others will be ignored.

__Since:__ Foswiki::Plugins::VERSION = '1.010'

=cut

sub DISABLE_redirectCgiQueryHandler {
    # do not uncomment, use $_[0], $_[1] instead
    ### my ( $query, $url ) = @_;

    Foswiki::Func::writeDebug( "- ${pluginName}::redirectCgiQueryHandler( query, $_[1] )" ) if $debug;
}

=pod

---++ renderFormFieldForEditHandler($name, $type, $size, $value, $attributes, $possibleValues) -> $html

This 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.
   * =$name= - name of form field
   * =$type= - type of form field
   * =$size= - size of form field
   * =$value= - value held in the form field
   * =$attributes= - attributes of form field 
   * =$possibleValues= - the values defined as options for form field, if any. May be a scalar (one legal value) or a ref to an array (several legal values)
Return HTML text that renders this field. If false, form rendering continues by considering the built-in types.

=cut

sub DISABLE_renderFormFieldForEditHandler {
}

=pod

---++ restExample($session) -> $text

This is an example of a sub to be called by the =rest= script. The parameter is:
   * =$session= - The Foswiki object associated to this session.

Additional parameters can be recovered via de query object in the $session.

For more information, check Foswiki:System.CommandAndCGIScripts#rest

=cut

sub restExample {
   #my ($session) = @_;
   return "This is an example of a REST invocation\n\n";
}

1;