getopt — Получает параметры из списка аргументов командной строки

Назначение getopt

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

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

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

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

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

Сигнатура getopt

Структурная запись: array|false getopt(string $short_options, array $long_options = [], int $rest_index = null). В ней 3 параметра: обязательные $short_options; необязательные $long_options, $rest_index. Результат объявлен как array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры getopt

Порядок и роли аргументов по сигнатуре: 1. $short_options — string, обязателен; 2. $long_options — array, необязателен, default []; 3. $rest_index — int, необязателен, default null.

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

1) string $short_options — обязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию. 2) array $long_options — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию. 3) int $rest_index — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры.

Результат getopt

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

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

Убедитесь, что раздел «Информация о PHP» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $short_options. Затем отдельно добавьте необязательные параметры array $long_options=[], int $rest_index=null, чтобы увидеть влияние значений по умолчанию. Для профиля «строки и кодировки» важно явно выбрать кодировку и единицу измерения длины; негативный сценарий должен проверить пустую строку, многобайтовые символы и некорректную последовательность.

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

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

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

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

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

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

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

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

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

Для getopt базовый ориентир: получает параметры из списка аргументов командной строки; обязательные $short_options; необязательные $long_options, $rest_index; результат array|false. Сопоставление с опубликованными соседями: ini_get_all: получает все параметры конфигурации; вход — необязательные $extension, $details; результат — array|false. getrusage: получает информацию об использовании текущего ресурса; вход — необязательные $mode; результат — array|false. get_extension_funcs: возвращает массив имён функций модуля; вход — обязательные $extension; результат — array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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