Welcome to Knowledge Base!

KB at your finger tips

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

Categories
All

Web-PHP

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.

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.

See Also

  • apache_response_headers() - Fetch all HTTP response headers

PHP / apache_response_headers — DevDocs

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
)

See Also

  • apache_request_headers() - Fetch all HTTP request headers
  • headers_sent() - Checks if or where headers have been sent
  • headers_list() - Returns a list of response headers sent (or ready to send)
Read article

PHP / apache_setenv — DevDocs

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.

See Also

  • apache_getenv() - Get an Apache subprocess_env variable
Read article

PHP / getallheaders — DevDocs

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";
}

?>

See Also

  • apache_response_headers() - Fetch all HTTP response headers
Read article

PHP / virtual — DevDocs

virtual

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

virtual Perform an Apache sub-request

Description

virtual(string $uri): bool

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.

See Also

  • apache_note() - Get and set apache request notes
Read article

PHP / apcu_add — DevDocs

apcu_add

(PECL apcu >= 4.0.0)

apcu_add Cache a new variable in the data store

Description

apcu_add(string $key, mixed $var, int $ttl = 0): bool
apcu_add(array $values, mixed $unused = NULL, int $ttl = 0): array

Caches a variable in the data store, only if it's not already stored.

Note : Unlike many other mechanisms in PHP, variables stored using apcu_add() will persist between requests (until the value is removed from the cache).

Parameters

key

Store the variable using this name. key s are cache-unique, so attempting to use apcu_add() to store data with a key that already exists will not overwrite the existing data, and will instead return false . (This is the only difference between apcu_add() and apcu_store() .)

var

The variable to store

ttl

Time To Live; store var in the cache for ttl seconds. After the ttl has passed, the stored variable will be expunged from the cache (on the next request). If no ttl is supplied (or if the ttl is 0 ), the value will persist until it is removed from the cache manually, or otherwise fails to exist in the cache (clear, restart, etc.).

values

Names in key, variables in value.

Return Values

Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second syntax returns array with error keys.

Examples

Example #1 A apcu_add() example

<?php
$bar = 'BAR';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
$bar = 'NEVER GETS SET';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
?>

The above example will output:

string(3) "BAR"
string(3) "BAR"

See Also

  • apcu_store() - Cache a variable in the data store
  • apcu_fetch() - Fetch a stored variable from the cache
  • apcu_delete() - Removes a stored variable from the cache
Read article