1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
package HTTP::Exception::3XX;
use strict;
use base 'HTTP::Exception::Base';
our $VERSION = '0.04001';
$VERSION = eval $VERSION; # numify for warning-free dev releases
sub is_info () { '' }
sub is_success () { '' }
sub is_redirect () { 1 }
sub is_error () { '' }
sub is_client_error () { '' }
sub is_server_error () { '' }
sub location {
$_[0]->{location} = $_[1] if (@_ > 1);
return $_[0]->{location};
}
sub Fields {
my $self = shift;
my @fields = $self->SUPER::Fields();
# TODO: default-value or required, maybe alter new
push @fields, qw(location); # additional Fields
return @fields;
}
1;
=head1 NAME
HTTP::Exception::3XX - Base Class for 3XX (redirect) Exceptions
=head1 VERSION
0.04001
=head1 SYNOPSIS
use HTTP::Exception;
# all are exactly the same
HTTP::Exception->throw(301, location => 'google.com');
HTTP::Exception::301->throw(location => 'google.com');
HTTP::Exception::MOVED_PERMANENTLY->throw(location => 'google.com');
# and in your favourite Webframework
eval { ... }
if (my $e = HTTP::Exception::301->caught) {
my $self->req->redirect($e->location);
}
=head1 DESCRIPTION
This package is the base class for all 3XX (redirect) Exceptions.
This makes adding features for a range of exceptions easier.
DON'T USE THIS PACKAGE DIRECTLY. 'use HTTP::Exception' does this for you.
=head1 ADDITIONAL FIELDS
Fields, that 3XX-Exceptions provide over HTTP::Exceptions.
=head2 location
Indicates, where the browser is beeing redirected to.
=head1 AUTHOR
Thomas Mueller, C<< <tmueller at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-http-exception at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTTP-Exception>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc HTTP::Exception::Base
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTTP-Exception>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/HTTP-Exception>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/HTTP-Exception>
=item * Search CPAN
L<https://metacpan.org/release/HTTP-Exception>
=back
=head1 LICENSE AND COPYRIGHT
Copyright 2010 Thomas Mueller.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
|
