fixed bug 22899 + broken link in manual contents, removed some warnings, fixed DFV...

[maypole.git] / lib / Apache / MVC.pm

diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm
index d5909bf897daabe7fafc60ad3daab36ae555b5d4..831527639e58336d5cb0afb8af647cbeaf1fb5eb 100644 (file)
--- a/lib/Apache/MVC.pm
+++ b/lib/Apache/MVC.pm
@@ -163,6 +163,24 @@ sub parse_args {
 
 =item redirect_request
 
+Sets output headers to redirect based on the arguments provided
+
+Accepts either a single argument of the full url to redirect to, or a hash of
+named parameters :
+
+$r->redirect_request('http://www.example.com/path');
+
+or
+
+$r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
+
+The named parameters are protocol, domain, path, status and url
+
+Only 1 named parameter is required but other than url, they can be combined as
+required and current values (from the request) will be used in place of any
+missing arguments. The url argument must be a full url including protocol and
+can only be combined with status.
+
 =cut
 
 sub redirect_request