|
|
Apache Virtual Path
|
|
|
|
_SERVER(3) 1 _SERVER(3) $_SERVER - Server and execution environment information $_SERVER is an array containing information such as headers, paths, and script locations. The entries in this array are created by the web server. There is no guarantee that every web server will provide any of these; servers may omit some, or provide others not listed here. That said, a large number of these variables are accounted for in the CGI/1.1 specification, so you should be able to expect those. Note Prior to PHP 5.4.0, $HTTP_SERVER_VARS contained the same initial information, but was not a superglobal. (Note that $HTTP_SERVER_VARS and $_SERVER were different variables and that PHP handled them as such.) You may or may not find any of the following elements in $_SERVER. Note that few, if any, of these will be available (or indeed have any meaning) if running PHP on the command line. o '$PHP_SELF' - The filename of the currently executing script, relative to the document root. For instance, $_SERVER['PHP_SELF'] in a script at the address http://example.com/foo/bar.php would be /foo/bar.php. The __FILE__ constant contains the full path and filename of the current (i.e. included) file. If PHP is running as a command-line processor this variable contains the script name since PHP 4.3.0. Previously it was not available. o 'argv' - Array of arguments passed to the script. When the script is run on the command line, this gives C-style access to the command line parameters. When called via the GET method, this will contain the query string. o 'argc' - Contains the number of command line parameters passed to the script (if run on the command line). o '$GATEWAY_INTERFACE' - What revision of the CGI specification the server is using; i.e. ' CGI/1.1'. o '$SERVER_ADDR' - The IP address of the server under which the current script is executing. o '$SERVER_NAME' - The name of the server host under which the current script is executing. If the script is running on a virtual host, this will be the value defined for that virtual host. o '$SERVER_SOFTWARE' - Server identification string, given in the headers when responding to requests. o '$SERVER_PROTOCOL' - Name and revision of the information protocol via which the page was requested; i.e. ' HTTP/1.0'; o '$REQUEST_METHOD' - Which request method was used to access the page; i.e. ' GET', ' HEAD', ' POST', ' PUT'. Note PHP script is terminated after sending headers (it means after producing any output without output buffering) if the request method was HEAD. o '$REQUEST_TIME' - The timestamp of the start of the request. Available since PHP 5.1.0. o '$REQUEST_TIME_FLOAT' - The timestamp of the start of the request, with microsecond precision. Available since PHP 5.4.0. o '$QUERY_STRING' - The query string, if any, via which the page was accessed. o '$DOCUMENT_ROOT' - The document root directory under which the current script is executing, as defined in the server's configuration file. o '$HTTP_ACCEPT' - Contents of the Accept: header from the current request, if there is one. o '$HTTP_ACCEPT_CHARSET' - Contents of the Accept-Charset: header from the current request, if there is one. Example: ' iso-8859-1,*,utf-8'. o '$HTTP_ACCEPT_ENCODING' - Contents of the Accept-Encoding: header from the current request, if there is one. Example: ' gzip'. o '$HTTP_ACCEPT_LANGUAGE' - Contents of the Accept-Language: header from the current request, if there is one. Example: ' en'. o '$HTTP_CONNECTION' - Contents of the Connection: header from the current request, if there is one. Example: ' Keep-Alive'. o '$HTTP_HOST' - Contents of the Host: header from the current request, if there is one. o '$HTTP_REFERER' - The address of the page (if any) which referred the user agent to the current page. This is set by the user agent. Not all user agents will set this, and some provide the ability to modify $HTTP_REFERER as a feature. In short, it cannot really be trusted. o '$HTTP_USER_AGENT' - Contents of the User-Agent: header from the current request, if there is one. This is a string denoting the user agent being which is accessing the page. A typical example is: Mozilla/4.5 [en] (X11; U; Linux 2.2.9 i586). Among other things, you can use this value with get_browser(3) to tailor your page's output to the capabilities of the user agent. o '$HTTPS' - Set to a non-empty value if the script was queried through the HTTPS protocol. Note Note that when using ISAPI with IIS, the value will be off if the request was not made through the HTTPS protocol. o '$REMOTE_ADDR' - The IP address from which the user is viewing the current page. o '$REMOTE_HOST' - The Host name from which the user is viewing the current page. The reverse dns lookup is based off the $REMOTE_ADDR of the user. Note Your web server must be configured to create this variable. For example in Apache you'll need HostnameLookups On inside httpd.conf for it to exist. See also gethostbyaddr(3). o '$REMOTE_PORT' - The port being used on the user's machine to communicate with the web server. o '$REMOTE_USER' - The authenticated user. o '$REDIRECT_REMOTE_USER' - The authenticated user if the request is internally redirected. o '$SCRIPT_FILENAME' - The absolute pathname of the currently executing script. Note If a script is executed with the CLI, as a relative path, such as file.php or ../file.php, $_SERVER['SCRIPT_FILENAME'] will contain the relative path specified by the user. o '$SERVER_ADMIN' - The value given to the SERVER_ADMIN (for Apache) directive in the web server configuration file. If the script is running on a virtual host, this will be the value defined for that virtual host. o '$SERVER_PORT' - The port on the server machine being used by the web server for communication. For default setups, this will be ' 80'; using SSL, for instance, will change this to whatever your defined secure HTTP port is. Note Under the Apache 2, you must set UseCanonicalName = On, as well as UseCanonicalPhysicalPort = On in order to get the physi- cal (real) port, otherwise, this value can be spoofed and it may or may not return the physical port value. It is not safe to rely on this value in security-dependent contexts. o '$SERVER_SIGNATURE' - String containing the server version and virtual host name which are added to server-generated pages, if enabled. o '$PATH_TRANSLATED' - Filesystem- (not document root-) based path to the current script, after the server has done any virtual-to-real mapping. 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. o '$SCRIPT_NAME' - Contains the current script's path. This is useful for pages which need to point to themselves. The __FILE__ constant contains the full path and filename of the current (i.e. included) file. o '$REQUEST_URI' - The URI which was given in order to access this page; for instance, ' /index.html'. o '$PHP_AUTH_DIGEST' - When doing Digest HTTP authentication this variable is set to the 'Authorization' header sent by the client (which you should then use to make the appropriate validation). o '$PHP_AUTH_USER' - When doing HTTP authentication this variable is set to the username provided by the user. o '$PHP_AUTH_PW' - When doing HTTP authentication this variable is set to the password provided by the user. o '$AUTH_TYPE' - When doing HTTP authenticated this variable is set to the authentication type. o '$PATH_INFO' - Contains any client-provided pathname information trailing the actual script filename but preceding the query string, if avail- able. For instance, if the current script was accessed via the URL http://www.example.com/php/path_info.php/some/stuff?foo=bar, then $_SERVER['PATH_INFO'] would contain /some/stuff. o '$ORIG_PATH_INFO' - Original version of '$PATH_INFO' before processed by PHP. +--------+---------------------------------------------------+ |Version | | | | | | | Description | | | | +--------+---------------------------------------------------+ | 5.4.0 | | | | | | | $HTTP_SERVER_VARS isn't available anymore due to | | | the removal of long arrays registering. | | | | | 5.3.0 | | | | | | | Directive register_long_arrays which caused | | | $HTTP_SERVER_VARS to be available has been depre- | | | cated. | | | | | 4.1.0 | | | | | | | Introduced $_SERVER that deprecated | | | $HTTP_SERVER_VARS. | | | | +--------+---------------------------------------------------+ Example #1 $_SERVER example <?php echo $_SERVER['SERVER_NAME']; ?> The above example will output something similar to: www.example.com Note This is a 'superglobal', or automatic global, variable. This simply means that it is available in all scopes throughout a script. There is no need to do global $variable; to access it within functions or methods. The filter extension. PHP Documentation Group _SERVER(3)
