KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

apache_child_terminate

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

apache_child_terminate — Terminate apache process after this request

Description

apache_child_terminate(): void

apache_child_terminate() will register the Apache process executing the current PHP request for termination once execution of PHP code is completed. It may be used to terminate a process after a script with high memory consumption has been run as memory will usually only be freed internally but not given back to the operating system.

Works in the Apache, and FastCGI webservers.

Parameters

This function has no parameters.

Return Values

No value is returned.

Notes

Note: This function is not implemented on Windows platforms.

apache_get_modules

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

apache_get_modules — Get a list of loaded Apache modules

Description

apache_get_modules(): array

Get a list of loaded Apache modules.

Parameters

This function has no parameters.

Return Values

An array of loaded Apache modules.

Examples

Example #1 apache_get_modules() example

<?php
print_r(apache_get_modules());
?>

The above example will output something similar to:

Array
(
    [0] => core
    [1] => http_core
    [2] => mod_so
    [3] => sapi_apache2
    [4] => mod_mime
    [5] => mod_rewrite
)

Read article

PHP / apache_get_version — DevDocs

apache_get_version

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

apache_get_version — Fetch Apache version

Description

apache_get_version(): string|false

Fetch the Apache version.

Parameters

This function has no parameters.

Return Values

Returns the Apache version on success or false on failure.

Examples

Example #1 apache_get_version() example

<?php
$version = apache_get_version();
echo "$version\n";
?>

The above example will output something similar to:

Apache/1.3.29 (Unix) PHP/4.3.4

apache_getenv

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

apache_getenv — Get an Apache subprocess_env variable

Description

apache_getenv(string $variable, bool $walk_to_top = false): string|false

Retrieve an Apache environment variable specified by variable.

Parameters

variable: The Apache environment variable
walk_to_top: Whether to get the top-level variable available to all Apache layers.

Return Values

The value of the Apache environment variable on success, or false on failure

Examples

Example #1 apache_getenv() example

The example above shows how to retrieve the value of the Apache environment variable SERVER_ADDR.

<?php
$ret = apache_getenv("SERVER_ADDR");
echo $ret;
?>

The above example will output something similar to:

42.24.42.240

apache_lookup_uri

(PHP 4, PHP 5, PHP 7, PHP 8)

apache_lookup_uri — Perform a partial request for the specified URI and return all info about it

Description

apache_lookup_uri(string $filename): object|false

This performs a partial request for a URI. It goes just far enough to obtain all the important information about the given resource.

This function is supported when PHP is installed as an Apache module webserver.

Parameters

filename: The filename (URI) that's being requested.

Return Values

An object of related URI information. The properties of this object are:

status
the_request
status_line
method
content_type
handler
uri
filename
path_info
args
boundary
no_cache
no_local_copy
allowed
send_bodyct
bytes_sent
byterange
clength
unparsed_uri
mtime
request_time

Returns false on failure.

Examples

Example #1 apache_lookup_uri() example

<?php
$info = apache_lookup_uri('index.php?var=value');
print_r($info);

if (file_exists($info->filename)) {
    echo 'file exists!';
}
?>

The above example will output something similar to:

stdClass Object
(
    [status] => 200
    [the_request] => GET /dir/file.php HTTP/1.1
    [method] => GET
    [mtime] => 0
    [clength] => 0
    [chunked] => 0
    [content_type] => application/x-httpd-php
    [no_cache] => 0
    [no_local_copy] => 1
    [unparsed_uri] => /dir/index.php?var=value
    [uri] => /dir/index.php
    [filename] => /home/htdocs/dir/index.php
    [args] => var=value
    [allowed] => 0
    [sent_bodyct] => 0
    [bytes_sent] => 0
    [request_time] => 1074282764
)
file exists!

Read article

PHP / apache_note — DevDocs

apache_note

(PHP 4, PHP 5, PHP 7, PHP 8)

apache_note — Get and set apache request notes

Description

apache_note(string $note_name, ?string $note_value = null): string|false

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

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

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.

Changelog

Version	Description
7.3.0	This function became available in the FPM SAPI.

Examples

Example #1 apache_request_headers() example

<?php
$headers = apache_request_headers();

foreach ($headers as $header => $value) {
    echo "$header: $value <br />\n";
}
?>

The above example will output something similar to:

Accept: */*
Accept-Language: en-us
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0
Host: www.example.com
Connection: Keep-Alive

Notes

Note:

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.

apache_response_headers

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

apache_response_headers — Fetch all HTTP response headers

Description

apache_response_headers(): array|false

Fetch all HTTP response headers. Works in the Apache, FastCGI, CLI, and FPM webservers.

Parameters

This function has no parameters.

Return Values

An array of all Apache response headers on success or false on failure.

Examples

Example #1 apache_response_headers() example

<?php
print_r(apache_response_headers());
?>

The above example will output something similar to:

Array
(
    [Accept-Ranges] => bytes
    [X-Powered-By] => PHP/4.3.8
)

apache_setenv

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

apache_setenv — Set an Apache subprocess_env variable

Description

apache_setenv(string $variable, string $value, bool $walk_to_top = false): bool

apache_setenv() sets the value of the Apache environment variable specified by variable.

Note:

When setting an Apache environment variable, the corresponding $_SERVER variable is not changed.

Parameters

variable: The environment variable that's being set.
value: The new variable value.
walk_to_top: Whether to set the top-level variable available to all Apache layers.

Return Values

Returns true on success or false on failure.

Examples

Example #1 Setting an Apache environment variable using apache_setenv()

<?php
apache_setenv("EXAMPLE_VAR", "Example Value");
?>

Notes

Note:

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.

getallheaders

(PHP 4, PHP 5, PHP 7, PHP 8)

getallheaders — Fetch all HTTP request headers

Description

getallheaders(): array

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.

Changelog

Version	Description
7.3.0	This function became available in the FPM SAPI.

Examples

Example #1 getallheaders() example

<?php

foreach (getallheaders() as $name => $value) {
    echo "$name: $value\n";
}

?>

Welcome to Knowledge Base!

KB at your finger tips

apache_child_terminate

Description

Parameters

Return Values

Notes

See Also

apache_get_modules

Description

Parameters

Return Values

Examples

apache_get_version

Description

Parameters

Return Values

Examples

See Also

apache_getenv

Description

Parameters

Return Values

Examples

See Also

apache_lookup_uri

Description

Parameters

Return Values

Examples

apache_note

Description

Parameters

Return Values

Changelog

Examples

See Also

apache_request_headers

Description

Parameters

Return Values

Changelog

Examples

Notes

See Also

apache_response_headers

Description

Parameters

Return Values

Examples

See Also

apache_setenv

Description

Parameters

Return Values

Examples

Notes

See Also

getallheaders

Description

Parameters

Return Values

Changelog

Examples

See Also

Interested? Signup now!

Interested?
Signup now!