The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Apache::Util - Perl API for XXX

Synopsis

  use Apache::Util ();

META: to be completed

Description

META: to be completed

Functions API

Apache::Util provides the following functions and/or methods:

ht_time

Convert time from an integer value into a string in a specified format

  $time_str = Apache::Util::ht_time($p, $time, $fmt, $gmt);
arg1: $p (APR::Pool)

The pool to allocate memory from

arg2 opt: $time (number)

The time to convert (e.g., time() or $r->request_time).

If the value is not passed the current time will be used.

arg3 opt: $fmt (string)

The format to use for the conversion, using strftime(3) tokens.

If the value is not passed the default format used is:

  "%a, %d %b %Y %H:%M:%S %Z"
arg4 opt: $gmt (integer)

The time will be not converted to GMT if 0 is passed.

If the value is not passed 1 (do convert) is used as a default.

ret: $time_str (string)

The string that represents the specified time

Examples:

Use current time, the default format and convert to GMT:

  $fmtdate = Apache::Util::ht_time($r->pool);

Use my time, the default format and convert to GMT:

  my $time = time+100;
  $fmtdate = Apache::Util::ht_time($r->pool, $time);

Use the time the request has started, custom format and don't convert to GMT:

  my $fmt = "%a, %D %H:%M:%S %Z";
  $fmtdate = Apache::Util::ht_time($r->pool, $r->request_time, $fmt, 0);

escape_path

META: Autogenerated - needs to be reviewed/completed

convert an OS path to a URL in an OS dependant way.

  $path = Apache::escape_path($path, $p, $partial);
arg1: $path (string)

The path to convert

arg2: $p (APR::Pool)

The pool to allocate from

arg3: $partial (integer)

if set, assume that the path will be appended to something with a '/' in it (and thus does not prefix "./")

ret: $path (string)

The converted URL

See Also

mod_perl 2.0 documentation.

Copyright

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

Authors

The mod_perl development team and numerous contributors.