APACHE_NOTE(3) 1 APACHE_NOTE(3)
apache_note - Get and set apache request notes
SYNOPSIS
string apache_note (string $note_name, [string $note_value = ""])
DESCRIPTION
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(3) is to pass information from one module to another within the same request.
PARAMETERS
o $note_name
- The name of the note.
o $note_value
- The value of the note.
RETURN VALUES
If called with one argument, it returns the current value of note note_name. If called with two arguments, 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.
EXAMPLES
Example #1
Passing information between PHP and Perl
<?php
apache_note('name', 'Fredrik Ekengren');
// Call perl script
virtual("/perl/some_script.pl");
$result = apache_note("resultdata");
?>
# 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
<?php
apache_note('sessionID', session_id());
?>
# "%{sessionID}n" can be used in the LogFormat directive
SEE ALSO
virtual(3).
PHP Documentation Group APACHE_NOTE(3)
