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