Apache2::Util - Perl API for Misc Apache Utility functions
use Apache2::Util (); # OS escape path $escaped_path = Apache2::Util::escape_path($path, "a 'long' file.html"); # format time as a string my $fmt = "%a, %D %H:%M:%S %Z"; $fmtdate = Apache2::Util::ht_time($r->pool, $r->request_time, $fmt, 0);
User Contributed Perl Documentation
build::sparcv9::docs::api::Apache2::Util(3)
NAME
Apache2::Util - Perl API for Misc Apache Utility functions
Synopsis
use Apache2::Util ();
# OS escape path
$escaped_path = Apache2::Util::escape_path($path, "a 'long' file.html");
# format time as a string
my $fmt = "%a, %D %H:%M:%S %Z";
$fmtdate = Apache2::Util::ht_time($r->pool, $r->request_time, $fmt, 0);
Description
Various Apache utilities that don't fit into any other group.
Functions API
"Apache2::Util" provides the following functions and/or methods:
"escape_path"
convert an OS path to a URL in an OS dependant way.
$escaped_path = Apache2::Util::escape_path($path, $p);
$escaped_path = Apache2::Util::escape_path($path, $p, $partial);
arg1: $path ( string )
The path to convert
arg2: $p ( "APR::Pool" )
The pool to allocate from
opt arg3: $partial ( boolean )
if TRUE, assume that the path will be appended to something with a
'/' in it (and thus does not prefix "./")
if FALSE it prepends "./" unless $path contains ":" optionally
followed by "/".
the default is TRUE
ret: $escaped_path ( string )
The escaped path
since: 2.0.00
"ht_time"
Convert time from an integer value into a string in a specified format
$time_str = Apache2::Util::ht_time($p);
$time_str = Apache2::Util::ht_time($p, $time);
$time_str = Apache2::Util::ht_time($p, $time, $fmt);
$time_str = Apache2::Util::ht_time($p, $time, $fmt, $gmt);
arg1: $p ( "APR::Pool object" )
The pool to allocate memory from
opt arg2: $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.
opt arg3: $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"
opt arg4: $gmt ( boolean )
The time will be not converted to GMT if FALSE is passed.
If the value is not passed TRUE (do convert) is used as a default.
ret: $time_str (string)
The string that represents the specified time
since: 2.0.00
Examples:
Use current time, the default format and convert to GMT:
$fmtdate = Apache2::Util::ht_time($r->pool);
Use my time, the default format and convert to GMT:
my $time = time+100;
$fmtdate = Apache2::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 = Apache2::Util::ht_time($r->pool, $r->request_time, $fmt, 0);
See Also
mod_perl 2.0 documentation.
Copyright
mod_perl 2.0 and its core modules are copyrighted under The Apache
Software License, Version 2.0.
Authors
The mod_perl development team and numerous contributors.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------------------------+
|Availability | web/server/apache-24/module/apache-perl |
+---------------+-----------------------------------------+
|Stability | Uncommitted |
+---------------+-----------------------------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://www.apache.org/dist/perl/mod_perl-2.0.12.tar.gz.
Further information about this software can be found on the open source
community website at https://perl.apache.org/.
perl v5.32.0 2022-01-30
build::sparcv9::docs::api::Apache2::Util(3)