Apache-specific Functions

Introduction

These functions are only available when running PHP as an Apache module.

Note:

As of PHP 4.3.2, PATH_TRANSLATED is no longer set implicitly under the Apache 2 SAPI in contrast to the situation in Apache 1, where it's set to the same value as the SCRIPT_FILENAME server variable when it's not populated by Apache. This change was made to comply with the CGI specification that PATH_TRANSLATED should only exist if PATH_INFO is defined.

Apache 2 users may use AcceptPathInfo = On inside httpd.conf to define PATH_INFO.

Installation

For PHP installation on Apache see the installation chapter.

Runtime Configuration

The behaviour of the Apache PHP module is affected by settings in php.ini. Configuration settings from php.ini may be overridden by php_flag settings in the server configuration file or local .htaccess files.

Example 200. Turning off PHP parsing for a directory using `.htaccess`

copy to clipboard

php_flag engine off

Table 17. Apache configuration options

Name	Default	Changeable	Changelog
engine	"1"	PHP_INI_ALL	Available since PHP 4.0.5.
child_terminate	"0"	PHP_INI_ALL	Available since PHP 4.0.5.
last_modified	"0"	PHP_INI_ALL	Available since PHP 4.0.5.
xbithack	"0"	PHP_INI_ALL	Available since PHP 4.0.5.

For further details and definitions of the PHP_INI_* constants, see the Appendix I, php.ini directives.

Here's a short explanation of the configuration directives.

engine boolean: Turns PHP parsing on or off. This directive is really only useful in the Apache module version of PHP. It is used by sites that would like to turn PHP parsing on and off on a per-directory or per-virtual server basis. By putting engine off in the appropriate places in the httpd.conf file, PHP can be enabled or disabled.
child_terminate boolean: Specify whether PHP scripts may request child process termination on end of request, see also apache_child_terminate().
last_modified boolean: Send PHP scripts modification date as Last-Modified: header for this request.
xbithack boolean: Parse files with executable bit set as PHP regardless of their file ending.

Resource Types

This extension has no resource types defined.

Predefined Constants

This extension has no constants defined.

Table of Contents

apache_child_terminate — Terminate apache process after this request
apache_get_modules — Get a list of loaded Apache modules
apache_get_version — Fetch Apache version
apache_getenv — Get an Apache subprocess_env variable
apache_lookup_uri — Perform a partial request for the specified URI and return all info about it
apache_note — Get and set apache request notes
apache_request_headers — Fetch all HTTP request headers
apache_reset_timeout — Reset the Apache write timer
apache_response_headers — Fetch all HTTP response headers
apache_setenv — Set an Apache subprocess_env variable
ascii2ebcdic — Translate string from ASCII to EBCDIC
ebcdic2ascii — Translate string from EBCDIC to ASCII
getallheaders — Fetch all HTTP request headers
virtual — Perform an Apache sub-request

Code Examples / Notes » ref.apache

My Apache server has a problem when someone enters a URI like: "http://my_server.nl/index.php/". (Note the extra slash.) The server executes the index.php script anyway, which causes the browser directory and the current directory used in the script to be different. And therefore my relative links don't work, and my stylesheet is not loaded. A quick test ("http://www.php.net/manual/en/index.php/") reveals that also this site has this glitch. When a client requests a directory without the last slash ("http://www.php.net/manual") the server sends a HTTP 301 (Moved Permanently) response with a redirect to the correct URI ("http://www.php.net/manual/"), and my idea was to do the same when the user adds a slash too much: <?php $req = $_SERVER['REQUEST_URI']; // Remove rubbish. $newReq = ereg_replace ('index.php[^?]*', 'index.php', $req); if (strlen($newReq) < strlen($req)) { header ('Location: '.$newReq); header ('HTTP/1.0 301 Moved Permanently'); die; // Don't send any more output. } unset($req); unset($newReq); ... (rest of the script) ... ?> Replace every occurence of 'index.php' with your filename and you're done. Hope it helps. :-) (Note: I'm not using fragments in my URI's (like 'index.php#bottom'), and this code may not do what you want if you are using them.)

Important info for Apache2 users that have several virtual hosts. It seems php_flag directive has a different behaviour under Apache 2 (from what it is under 1.3) when used inside <VirtualHost> block. If you override global php.ini settings with php_flag for one of your virtual host - then your other non-customized virtual hosts may use this overrided settings as well. php_flag records are messed up among different virtual hosts under single Apache 2 server. It may result from Apache 2 multi-thread nature. Here is an example: Suppose you have two Virtual hosts: V1 and V2. For V1 in Apache configuration you use php_flag magic_quotes_gpc 1 V2 is supposed to use global php.ini settings, so you didn't put any php_flag records into Apache conf for V2 (this worked under Apache 1.3). And your default php.ini settings are: php_flag magic_quotes_gpc 0 When you run your server you'll notice that magic quotes is (sometimes) set to On at V2! The value turns On at V2 when there have been a previous request to V1. To solve the problem either move php_flag into .htaccess located inside customized virtual host directory OR put php_flag with default settings into all your <VirtualHost> blocks that are not customized. So for V2 put: php_flag magic_quotes_gpc 0 It is critical to be very carefull with php_flag engine 0. My configuration is: PHP 4.3.4, Apache 2.0.50, Linux RedHat 9