install::TempContent::Objects::mod_perl-2.0.12::docs::api::Apache2::URI(3) | User Contributed Perl Documentation | install::TempContent::Objects::mod_perl-2.0.12::docs::api::Apache2::URI(3) |
Apache2::URI - Perl API for manipulating URIs
use Apache2::URI (); $hostport = $r->construct_server(); $hostport = $r->construct_server($hostname); $hostport = $r->construct_server($hostname, $port); $hostport = $r->construct_server($hostname, $port, $pool); $url = $r->construct_url(); $url = $r->construct_url($rel_uri); $url = $r->construct_url($rel_uri, $pool); $parsed_uri = $r->parse_uri($uri); $parsed_uri = $r->parsed_uri(); $url = join '%20', qw(one two three); Apache2::URI::unescape_url($url);
While "APR::URI" provides a generic API to dissect, adjust and put together any given URI string, "Apache2::URI" provides an API specific to Apache, by taking the information directly from the $r object. Therefore when manipulating the URI of the current HTTP request usually methods from both classes are used.
"Apache2::URI" provides the following functions and methods:
Construct a string made of hostname and port
$hostport = $r->construct_server(); $hostport = $r->construct_server($hostname); $hostport = $r->construct_server($hostname, $port); $hostport = $r->construct_server($hostname, $port, $pool);
If that argument is not passed, "$r->get_server_name" is used.
If that argument is not passed, "$r->get_server_port" is used.
If that argument is not passed, "$r->pool" is used.
Examples:
$r->get_server_name == "localhost"; $r->get_server_port == 8001;
The code:
$hostport = $r->construct_server();
returns a string:
localhost:8001
$hostport = $r->construct_server("my.example.com", 8888);
and it returns a string:
my.example.com:8888
Build a fully qualified URL from the uri and information in the request rec:
$url = $r->construct_url(); $url = $r->construct_url($rel_uri); $url = $r->construct_url($rel_uri, $pool);
If that argument is not passed, "$r->uri" is used.
If that argument is not passed, "$r->pool" is used.
Examples:
http://localhost.localdomain:8529/test?args
The code:
my $url = $r->construct_url;
returns the string:
http://localhost.localdomain:8529/test
notice that the query (args) component is not in the string. You need to append it manually if it's needed.
http://localhost.localdomain:8529/test?args
The code:
my $rel_uri = "/foo/bar?tar"; my $url = $r->construct_url($rel_uri);
returns the string:
http://localhost.localdomain:8529/foo/bar?tar
Break apart URI (affecting the current request's uri components)
$r->parse_uri($uri);
This method call has the following side-effects:
Get the current request's parsed uri object
my $uri = $r->parsed_uri();
Unescape URLs
Apache2::URI::unescape_url($url);
Example:
my $url = join '%20', qw(one two three); Apache2::URI::unescape_url($url);
$url now contains the string:
"one two three";
"APR::URI", mod_perl 2.0 documentation.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
2022-01-30 | perl v5.34.0 |