• Home
• Contao
• Environment

PHP Class Contao\Environment

The class returns the environment variables (which are stored in the PHP $_SERVER array) independent of the operating system. Usage: echo Environment::get('scriptName'); echo Environment::get('requestUri'); Show file Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property	Type	Description
$arrCache	array	Cache
$objInstance	Environment	Object instance (Singleton)
$strSapi	string	The SAPI name

Public Methods

Method	Description
__clone ( )	Prevent cloning of the object (Singleton)
__get ( string $strKey ) : string	Return an environment variable
__set ( string $strKey, mixed $varValue )	Set an environment variable
get ( string $strKey ) : mixed	Return an environment variable
getInstance ( ) : Environment	Return the object instance (Singleton)
reset ( )	Reset the internal cache
set ( string $strKey, mixed $varValue )	Set an environment variable

Protected Methods

Method	Description
__construct ( )	Prevent direct instantiation (Singleton)
agent ( ) : object	Return the operating system and the browser name and version
base ( ) : string	Return the URL and path that can be used in a tag
documentRoot ( ) : string	Return the document root (e.g. /home/www/user/)
encodeRequestString ( string $strRequest ) : string	Encode a request string preserving certain reserved characters
host ( ) : string	Return the host name
httpAcceptEncoding ( ) : array	Return accepted encoding types as array
httpAcceptLanguage ( ) : array	Return the first eight accepted languages as array
httpHost ( ) : string	Return the HTTP Host
httpUserAgent ( ) : string	Return the user agent as string
httpXForwardedHost ( ) : string	Return the HTTP X-Forwarded-Host
indexFreeRequest ( ) : string	Return the request string without the index.php fragment
ip ( ) : string	Return the real REMOTE_ADDR even if a proxy server is used
isAjaxRequest ( ) : boolean	Return true on Ajax requests
path ( ) : string	Return the relative path to the base directory (e.g. /path)
phpSelf ( ) : string	Alias for scriptName()
queryString ( ) : string	Return the query string (e.g. id=2)
relativeRequest ( ) : string	Return the request string without the script name (e.g. en/news.html)
request ( ) : string	Return the relativ path to the script and include the request (e.g. index.php?id=2)
requestUri ( ) : string	Return the request URI [path]?[query] (e.g. /contao/index.php?id=2)
script ( ) : string	Return the relativ path to the script (e.g. index.php)
scriptFilename ( ) : string	Return the absolute path to the script (e.g. /home/www/html/website/index.php)
scriptName ( ) : string	Return the relative path to the script (e.g. /website/index.php)
server ( ) : string	Return the SERVER_ADDR
ssl ( ) : boolean	Return true if the current page was requested via an SSL connection
uri ( ) : string	Return the current URL with path or query string
url ( ) : string	Return the current URL without path or query string

Method Details

Property Details