Tags:
tag this topic
create new tag
view all tags
---+ Package =TWiki::OopsException= Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser to a url based on the =oops= script. =oops= requires the name of an oops template file from the =templates= directory. This file will be expanded and the parameter values passed to the exception instantiated. The result will be shown in the browser. Plugins may throw TWiki::OopsException. For example: <verbatim> use Error; ... throw TWiki::OopsException( 'bathplugin', def => 'toestuck', web => $web, topic => $topic, params => [ 'bigtoe', 'hot tap' ] ); </verbatim> %TOC% ---++ ClassMethod *new* <tt>($template,...)</tt> * =template= is the name of an oops template. e.g. 'bathplugin' refers to =templates/oopsbathplugin.tmpl= The remaining parameters are interpreted as key-value pairs. The following keys are used: * =web= will be used as the web for the oops * =topic= will be used as the topic for the oops * =def= - is the (optional) name of a TMPL:DEF within the template * =keep= - if set, the exception handler should try its damnedest to retain parameter values from the query. * =params= is a reference to an array of parameters. These will be substituted for !%PARAM1%, !%PARAM2% ... !%PARAMn% in the template. For an example of how to use the =def= parameter, see the =oopsattention= template. NOTE: parameter values are automatically and unconditionally entity-encoded ---++ ObjectMethod *stringify* <tt>([$session]) -> $string</tt> Generates a string representation for the object. if a session is passed in, and the exception specifies a def, then that def is expanded. This is to allow internal expansion of oops exceptions for example when performing bulk operations, and also for debugging. ---++ ObjectMethod *redirect* <tt>($twiki)</tt> Generate a redirect to an 'oops' script for this exception. If the 'keep' parameter is set in the exception, it saves parameter values into the query as well. This is needed if the query string might get lost during a passthrough, due to a POST being redirected to a GET.
E
dit
|
A
ttach
|
Watch
|
P
rint version
|
H
istory
: r4
<
r3
<
r2
<
r1
|
B
acklinks
|
V
iew topic
|
Ra
w
edit
|
M
ore topic actions
Topic revision: r4 - 2013-10-14
-
TWikiContributor
Home
Site map
Main web
MedicaidBilling web
Sandbox web
TWiki web
TWiki Web
User registration
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
View
Raw View
Print version
Find backlinks
History
More topic actions
Edit
Raw edit
Attach file or image
Edit topic preference settings
Set new parent
More topic actions
User Reference
ATasteOfTWiki
TextFormattingRules
TWikiVariables
FormattedSearch
QuerySearch
TWikiDocGraphics
TWikiSkinBrowser
InstalledPlugins
Admin Maintenance
Reference Manual
InterWikis
ManagingUsers
ManagingWebs
TWikiSiteTools
TWikiPreferences
WebPreferences
Categories
Admin Documentation
Admin Tools
Developer Doc
User Documentation
User Tools
Account
Log In
E
dit
A
ttach
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback
Note:
Please contribute updates to this topic on TWiki.org at
TWiki:TWiki.TWikiOopsExceptionDotPm
.