.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "SVN::Web::X 3pm"
.TH SVN::Web::X 3pm "2016-11-12" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SVN::Web::X \- exceptions for SVN::Web
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use SVN::Web::X;
\&
\& ...
\&
\& SVN::Web::X\->throw(error => \*(Aq(error message %1)\*(Aq,
\& vars => [$var_to_interpolate]);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
SVN::Web::X implements exceptions for SVN::Web. Derived from
Exception::Class, It provides a simple mechanism for throwing
exceptions, catching them, and ensuring that friendly, localised error
messages are generated and sent to the user's browser.
.SH "USAGE IN SVN::Web ACTIONS"
.IX Header "USAGE IN SVN::Web ACTIONS"
If an SVN::Web action that you are writing needs to stop processing
and raise an error, throw an SVN::Web::X exception.
.PP
\&\f(CW\*(C`throw()\*(C'\fR takes a hash with two mandatory keys.
.ie n .IP """error""" 4
.el .IP "\f(CWerror\fR" 4
.IX Item "error"
A string describing the error. This string should be short, and key
to a longer internationalised message.
.Sp
This string may contain placeholders; \f(CW%1\fR, \f(CW%2\fR, \f(CW%3\fR, and so on. These
will be replaced by the values of the variables passed in the \f(CW\*(C`vars\*(C'\fR
key.
.Sp
By convention this string should be enclosed in parentheses, \f(CW\*(C`(\*(C'\fR and
\&\f(CW\*(C`)\*(C'\fR. This helps make them stand out in the interface, if localised
versions of the error message have not yet been written.
.ie n .IP """vars""" 4
.el .IP "\f(CWvars\fR" 4
.IX Item "vars"
An array reference. The first entry in the array will replace the \f(CW%1\fR
placeholder in \f(CW\*(C`error\*(C'\fR, the second entry will replace the \f(CW%2\fR placeholder,
and so on.
.Sp
If there are no placeholders then pass a reference to an empty array.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.SS "A simple exception, with no placeholders."
.IX Subsection "A simple exception, with no placeholders."
In the action:
.PP
.Vb 8
\& sub run {
\& ...
\& if(! frob_repo()) {
\& SVN::Web::X\->throw(error => \*(Aq(frob failed)\*(Aq,
\& vars => []);
\& }
\& ...
\& }
.Ve
.PP
In the \fIen.po\fR file for the localised text.
.PP
.Vb 3
\& msgid "(frob failed)"
\& msgstr "There was a problem trying to frob the repository. This "
\& "probably indicates a permissions problem."
.Ve
.SS "An exception with placeholders"
.IX Subsection "An exception with placeholders"
In the action:
.PP
.Vb 5
\& sub run {
\& ...
\& # $path is a repo path, $rev is a repo revision
\& my $root = $fs\->revision_root($rev);
\& my $kind = $root\->check_path($path);
\&
\& if($kind == $SVN::Node::none) {
\& SVN::Web::X\->throw(error => \*(Aq(path %1 does not exist in rev %2)\*(Aq,
\& vars => [$path, $rev]);
\& }
\& }
.Ve
.PP
In the \fIen.po\fR file for the localised text.
.PP
.Vb 6
\& msgid "(path %1 does not exist in rev %2)"
\& msgstr "The path %1 could not be found in the repository "
\& "at revision %2. This may be a typo in the path or the revision "
\& "number. SVN::Web should never normally generate a link like this. "
\& "If you followed a link from SVN::Web (rather than from an e\-mail,
\& "or similar) please report this as a bug."
.Ve
.PP
As you can see, the localised text can be much friendlier and more
informative to the user than the error message.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2003\-2004 by Chia-liang Kao \f(CW\*(C`\*(C'\fR.
.PP
Copyright 2005\-2007 by Nik Clayton \f(CW\*(C`\*(C'\fR.
.PP
Copyright 2012 by Dean Hamstead \f(CW\*(C`\*(C'\fR.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
See