This function is a wrapper for Apache's
table_get
and
table_set
. It edits the table of notes that exists during a request. The table's purpose is to allow Apache modules to communicate.
The main use for
apache_note()
is to pass information from one module to another within the same request.
Parameters
note_name
The name of the note.
note_value
The value of the note.
Return Values
If
note_value
is omitted or
null
, it returns the current value of note
note_name
. Otherwise, it sets the value of note
note_name
to
note_value
and returns the previous value of note
note_name
. If the note cannot be retrieved,
false
is returned.
Changelog
Version
Description
8.0.0
note_value
is nullable now.
Examples
Example #1 Passing information between PHP and Perl
# Get Apache request object
my $r = Apache->request()->main();
# Get passed data
my $name = $r->notes('name');
# some processing
# Pass result back to PHP
$r->notes('resultdata', $result);
Example #2 Logging values in access.log
<?phpapache_note('sessionID',session_id());?>
# "%{sessionID}n" can be used in the LogFormat directive
See Also
virtual() - Perform an Apache sub-request
PHP / apache_request_headers — DevDocs
apache_request_headers
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
apache_request_headers
—
Fetch all HTTP request headers
Description
apache_request_headers():array
Fetches all HTTP request headers from the current request. Works in the Apache, FastCGI, CLI, and FPM webservers.
Parameters
This function has no parameters.
Return Values
An associative array of all the HTTP headers in the current request, or
false
on failure.
You can also get at the value of the common CGI
variables by reading them from the environment, which works whether or not you are using PHP as an
Apache
module. Use
phpinfo()
to see a list of all of the available environment variables.
See Also
apache_response_headers() - Fetch all HTTP response headers
apache_setenv()
can be paired up with
apache_getenv()
across separate pages or for setting variables to pass to Server Side Includes (.shtml) that have been included in PHP scripts.
See Also
apache_getenv() - Get an Apache subprocess_env variable
Fetches all HTTP headers from the current request.
This function is an alias for
apache_request_headers()
. Please read the
apache_request_headers()
documentation for more information on how this function works.
Parameters
This function has no parameters.
Return Values
An associative array of all the HTTP headers in the current request, or
false
on failure.
virtual()
is an Apache-specific function which is similar to
<!--#include virtual...-->
in
mod_include
. It performs an Apache sub-request. It is useful for including CGI scripts or
.shtml
files, or anything else that you would parse through Apache. Note that for a CGI script, the script must generate valid CGI headers. At the minimum that means it must generate a
Content-Type
header.
To run the sub-request, all buffers are terminated and flushed to the browser, pending headers are sent too.
This function is supported when PHP is installed as an Apache module webserver.
Parameters
uri
The file that the virtual command will be performed on.
Return Values
Performs the virtual command on success, or returns
false
on failure.
Examples
See
apache_note()
for an example.
Notes
Warning
The query string can be passed to the included file but
$_GET
is copied from the parent script and only
$_SERVER['QUERY_STRING']
is filled with the passed query string. The query string may only be passed when using Apache 2. The requested file will not be listed in the Apache access log.
Note
:
Environment variables set in the requested file are not visible to the calling script.
Note
:
This function may be used on PHP files. However, it is typically better to use
include
or
require
for PHP files.
