apache2::connectionutil(3) [mojave man page]

install::TempContent::Objects::mod_perl-2.0.9::docs::apiUseraCinstall::TempContent::Objects::mod_perl-2.0.9::docs::api::Apache2::ConnectionUtil(3)

NAME

       Apache2::ConnectionUtil - Perl API for Apache connection utils

Synopsis
	  use Apache2::Connection     ();
	  use Apache2::ConnectionUtil ();
	  use Apache2::RequestRec     ();

	  # grab the connection object;
	  my $c = $r->connection;

	  # share perl objects like $r->pnotes
	  $old_val = $c->pnotes($key => $value);

Description
       "Apache2::ConnectionUtil" provides the Apache connection record object utilities API.

API

       "Apache2::ConnectionUtil" provides the following functions and/or methods:

   "pnotes"
       Share Perl variables between requests over the lifetime of the connection.

	  $old_val  = $c->pnotes($key => $val);
	  $val	    = $c->pnotes($key);
	  $hash_ref = $c->pnotes();

       obj: $c ( "Apache2::Connection object" )
       opt arg1: $key ( string )
	   A key value

       opt arg2: $val ( SCALAR )
	   Any scalar value (e.g. a reference to an array)

       ret: (3 different possible values)
	   if both, $key and $val are passed the previous value for $key is returned if such existed, otherwise undef is returned.

	   if only $key is passed, the current value for the given key is returned.

	   if no arguments are passed, a hash reference is returned, which can then be directly accessed without going through the "pnotes()"
	   interface.

       since: 2.0.3

       See ("Apache2::RequestUtil::pnotes") for the details of the "pnotes" method usage.  The usage is identical except for a few differences.
       First is the use of $c instead of $r as the invocant.  The second is that the the data persists for the lifetime of the connection instead
       of the lifetime of the request.	If the connection is lost, so is the data stored in "pnotes".

See Also
       Apache2::Connection.

       Apache2::RequestUtil::pnotes.

       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.

perl v5.18.2						      install::TempContent::Objects::mod_perl-2.0.9::docs::api::Apache2::ConnectionUtil(3)

install::TempContent::Objects::mod_perl-2.0.9::docs::apiUseraContributedinstall::TempContent::Objects::mod_perl-2.0.9::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.

perl v5.18.2							    2015install::TempContent::Objects::mod_perl-2.0.9::docs::api::Apache2::Util(3)