getenv
(PHP 4, PHP 5, PHP 7)
getenv — Получение значения переменной окружения
Описание
string getenv
( string
$varname
)Получает значение переменной среды.
Список всех переменных окружения можно посмотреть с помощью функции phpinfo(). Многие из этих переменных есть в документе » RFC 3875, по большей части в разделе 4.1, "Request Meta-Variables".
Список параметров
-
varname -
Имя переменной.
Возвращаемые значения
Возвращает значение переменной среды varname или FALSE,
если переменной varname не существует.
Примеры
Пример #1 Пример использования getenv()
<?php
// Пример использования getenv()
$ip = getenv('REMOTE_ADDR');
// можно еще воспользоваться суперглобальной переменной ($_SERVER or $_ENV)
$ip = $_SERVER['REMOTE_ADDR'];
?>
Смотрите также
- putenv() - Устанавливает значение переменной среды
- apache_getenv() - Возвращает переменную окружения подпроцесса сервера Apache
- Superglobals
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Изменение поведения PHP
- PHP Опции и Информация
- assert_options
- assert
- cli_get_process_title
- cli_set_process_title
- dl
- extension_loaded
- gc_collect_cycles
- gc_disable
- gc_enable
- gc_enabled
- gc_mem_caches
- get_cfg_var
- get_current_user
- get_defined_constants
- get_extension_funcs
- get_include_path
- get_included_files
- get_loaded_extensions
- get_magic_quotes_gpc
- get_magic_quotes_runtime
- get_required_files
- get_resources
- getenv
- getlastmod
- getmygid
- getmyinode
- getmypid
- getmyuid
- getopt
- getrusage
- ini_alter
- ini_get_all
- ini_get
- ini_restore
- ini_set
- magic_quotes_runtime
- main
- memory_get_peak_usage
- memory_get_usage
- php_ini_loaded_file
- php_ini_scanned_files
- php_logo_guid
- php_sapi_name
- php_uname
- phpcredits
- phpinfo
- phpversion
- putenv
- restore_include_path
- set_include_path
- set_magic_quotes_runtime
- set_time_limit
- sys_get_temp_dir
- version_compare
- zend_logo_guid
- zend_thread_id
- zend_version
Коментарии
As you know, getenv('DOCUMENT_ROOT') is useful.However, under CLI environment(I tend to do quick check
if it works or not), it doesn't work without modified php.ini
file. So I add "export DOCUMENT_ROOT=~" in my .bash_profile.
SERVER_NAME is the name defined in the apache configuration.HTTP_HOST is the host header sent by the client when using the more recent versions of the http protocol.
A function returning the remote adress of the visiting browser could look like this:
<?php
function getIPfromXForwarded() {
$ipString=@getenv("HTTP_X_FORWARDED_FOR");
$addr = explode(",",$ipString);
return $addr[sizeof($addr)-1];
}
?>
Note that some adresses are followed by a whitespace and ip2long(getIPfromXForwarded()) would not return the expected result.
Make use of trim() in your scripts, either in the function itself, or the surrounding space of the caller.
Greetings
When writing CLI applications, not that any environment variables that are set in your web server config will not be passed through. PHP will pass through system environment variables that are prefixed based off the safe_mode_allowed_env_vars directive in your php.iniThis function is useful (compared to $_SERVER, $_ENV) because it searches $varname key in those array case-insensitive manner.For example on Windows $_SERVER['Path'] is like you see Capitalized, not 'PATH' as you expected.
So just: <?php getenv('path') ?>
All of the notes and examples so far have been strictly CGI.
It should not be understated the usefulness of getenv()/putenv() in CLI as well.
You can pass a number of variables to a CLI script via environment variables, either in Unix/Linux bash/sh with the "VAR='foo'; export $VAR" paradigm, or in Windows with the "set VAR='foo'" paradigm. (Csh users, you're on your own!) getenv("VAR") will retrieve that value from the environment.
We have a system by which we include a file full of putenv() statements storing configuration values that can apply to many different CLI PHP programs. But if we want to override these values, we can use the shell's (or calling application, such as ant) environment variable setting method to do so.
This saves us from having to manage an unmanageable amount of one-off configuration changes per execution via command line arguments; instead we just set the appropriate env var first.
Beware that when using this function with PHP built-in server – i.e. php -S localhost:8000 – it will return boolean FALSE.for quick check of getenv() adding a new env variable -if you add a new env variable, make sure not only apache but xampp is also restarted.
Otherwise getenv() will return false for the newly added env variable.
As noted on httpoxy.org, getenv() can confuse you in having you believe that all variables come from a "safe" environment (not all of them do).
In particular, $_SERVER['HTTP_PROXY'] (or its equivalent getenv('HTTP_PROXY')) can be manually set in the HTTP request header, so it should not be considered safe in a CGI environment.
In short, try to avoid using getenv('HTTP_PROXY') without properly filtering it.
The example on how to fallback produces a syntax error on PHP 5.2:
-bash-3.2$ cat test.php
<?php
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>
-bash-3.2$ /web/cgi-bin/php5 test.php
Content-type: text/html
<br />
<b>Parse error</b>: syntax error, unexpected ':' in <b>/home/content/25/11223125/test.php</b> on line <b>3</b><br />
On PHP 5.2, one must write
$ip = getenv('REMOTE_ADDR', true) ? getenv('REMOTE_ADDR', true) : getenv('REMOTE_ADDR')
Contrary to what eng.mrkto.com said, getenv() isn't always case-insensitive. On Linux it is not:
<?php
var_dump(getenv('path')); // bool(false)
var_dump(getenv('Path')); // bool(false)
var_dump(getenv('PATH')); // string(13) "/usr/bin:/bin"
From PHP 7.1 => getenv() no longer requires its parameter. If the parameter is omitted, then the current environment variables will be returned as an associative array.
Source: migration71.changed-functions
It is worth noting that since getenv('MY_VARIABLE') will return false when the variable given is not set, there is no direct way to distinguish between a variable that is unset and one that is explicitly set to the value bool(false) when using getenv().This makes it somewhat tricky to have boolean environment variables default to true if unset, which you can work around either by using "falsy" values such as 0 with the strict comparison operators or by using the superglobal arrays and isset().
I did a benchmark about env.
constants :
0.00067687034606934 ms
getenv :
0.056761026382446 ms
(less is better)
https://github.com/eftec/php-benchmarks#define--const--env
And, in Windows at leat, reading the env value is considerably slow (in comparison with a constant), so PHP doesn't cache the information and asks to the OS the env value per call.
So, if you are calling once per request, then there is not a problem. However, if you are calling it many times per request, then it could affects the performance.