getenv — Получает значение одной или всех переменных окружения

Назначение getenv

getenv: Получает значение одной или всех переменных окружения. Справочная сущность относится к разделу «Информация о PHP». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается getenv

Это процедурная функция раздела «Информация о PHP». Её отличают имя getenv, контракт «необязательные $name, $local_only» и объявленный результат string|array|false; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление getenv

Смысловое направление getenv — «получение данных». В прикладном коде различайте отсутствие данных, пустое значение и технический отказ источника. Контрольный набор для этой операции: проверьте пустой источник, один результат и недоступное окружение. Такой акцент отделяет getenv от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура getenv

Структурная запись: string|array|false getenv(string|null $name = null, bool $local_only = false). В ней 2 параметра: необязательные $name, $local_only. Результат объявлен как string|array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры getenv

Порядок и роли аргументов по сигнатуре: 1. $name — string|null, необязателен, default null; 2. $local_only — bool, необязателен, default false.

Контроль входных данных для getenv

1) string|null $name — необязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) bool $local_only — необязательный: передайте true и false явно, не полагаясь на нестрогое приведение скалярных значений.

Результат getenv

getenv объявляет результат типа string|array|false. Контракт getenv допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

Проверочный сценарий для getenv

Убедитесь, что раздел «Информация о PHP» доступен в целевой сборке PHP. Сначала выполните контрольный вызов без аргументов. Затем отдельно добавьте необязательные параметры string|null $name=null, bool $local_only=false, чтобы увидеть влияние значений по умолчанию. Для профиля «контракт PHP» важно зафиксировать предусловия вызова и не подавлять диагностические сообщения; негативный сценарий должен проверить штатный результат, граничный вход и документированный отказ.

Интеграция getenv в проект

Проверку доступности getenv и преобразование входных значений разместите у границы модуля «Информация о PHP». Для профиля «контракт PHP» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция getenv не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика getenv

Сначала запишите точную сигнатуру string|array|false getenv(string|null $name = null, bool $local_only = false) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Информация о PHP» в той же среде, где выполняется getenv. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для getenv предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

Границы применения

Для категории «контракт PHP» применяйте отдельный негативный тест: проверить штатный результат, граничный вход и документированный отказ. В production-коде важно зафиксировать предусловия вызова и не подавлять диагностические сообщения. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать getenv

Выбор getenv оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «Информация о PHP»; 2) сигнатура содержит 2 аргумента: обязательных 0, необязательных 2; 3) вызывающему коду нужен результат string|array|false и действие «получение данных». Для профиля «контракт PHP» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с putenv: у него другое назначение, владелец или набор входных данных.

Сравнение getenv с соседними API

Для getenv базовый ориентир: получает значение одной или всех переменных окружения; необязательные $name, $local_only; результат string|array|false. Сопоставление с опубликованными соседями: putenv: устанавливает значение переменной среды; вход — обязательные $assignment; результат — bool. apache_getenv: возвращает переменную окружения подпроцесса сервера apache; вход — обязательные $variable; необязательные $walk_to_top; результат — string|false. get_cfg_var: извлекает значение параметра конфигурации php; вход — обязательные $option; результат — string|array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 8.0.0, 7.1.0, 7.0.9. getenv сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для getenv.

Связанные материалы