mod_perl logo perl icon
previous page: Apache2::SubRequest - Perl API for Apache subrequestspage up: mod_perl 2.0 APInext page: Apache2::Util - Perl API for Misc Apache Utility functions

Apache2::URI - Perl API for manipulating URIs






Practical mod_perl

Practical mod_perl

By Stas Bekman, Eric Cholet
The mod_perl Developer's Cookbook

The mod_perl Developer's Cookbook

By Geoffrey Young, Paul Lindner, Randy Kobes
mod_perl Pocket Reference

mod_perl Pocket Reference

By Andrew Ford
Writing Apache Modules with Perl and C

Writing Apache Modules with Perl and C

By Lincoln Stein, Doug MacEachern
Embedding Perl in HTML with Mason

Embedding Perl in HTML with Mason

By Dave Rolsky, Ken Williams
mod_perl2 User's Guide

mod_perl2 User's Guide

By Stas Bekman, Jim Brandt


Table of Contents

Synopsis

  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);


TOP

Description

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.



TOP

API

Apache2::URI provides the following functions and methods:



TOP

construct_server

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);

Examples:



TOP

construct_url

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);

Examples:



TOP

parse_uri

Break apart URI (affecting the current request's uri components)

  $r->parse_uri($uri);

This method call has the following side-effects:

  1. sets $r->args to the rest after '?' if such exists in the passed $uri, otherwise sets it to undef.

  2. sets $r->uri to the passed $uri without the $r->args part.

  3. sets $r->hostname (if not set already) using the (scheme://host:port) parts of the passed $uri.



TOP

parsed_uri

Get the current request's parsed uri object

  my $uri = $r->parsed_uri();


TOP

unescape_url

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";


TOP

See Also

APR::URI, mod_perl 2.0 documentation.



TOP

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.



TOP

Authors

The mod_perl development team and numerous contributors.






TOP
previous page: Apache2::SubRequest - Perl API for Apache subrequestspage up: mod_perl 2.0 APInext page: Apache2::Util - Perl API for Misc Apache Utility functions