readline_add_history — Добавляет строку в историю команд

Назначение readline_add_history

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

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

Это процедурная функция раздела «readline». Её отличают имя readline_add_history, контракт «обязательные $prompt» и объявленный результат true; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура readline_add_history

Структурная запись: true readline_add_history(string $prompt). В ней 1 параметр: обязательные $prompt. Результат объявлен как true; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры readline_add_history

Порядок и роли аргументов по сигнатуре: 1. $prompt — string, обязателен. Для readline_add_history фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

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

1) string $prompt — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат readline_add_history

readline_add_history объявляет результат типа true. Результат readline_add_history имеет объявленный тип true. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

Убедитесь, что раздел «readline» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $prompt. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «строки и кодировки» важно явно выбрать кодировку и единицу измерения длины; негативный сценарий должен проверить пустую строку, многобайтовые символы и некорректную последовательность.

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

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

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

Сначала запишите точную сигнатуру true readline_add_history(string $prompt) и фактические типы переданных значений. Затем подтвердите загрузку расширения «readline» в той же среде, где выполняется readline_add_history. Если результат неожиданен, сравните его тип с true и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

Выбор readline_add_history оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «readline»; 2) сигнатура содержит 1 аргумент: обязательных 1, необязательных 0; 3) вызывающему коду нужен результат true и действие «изменение состояния». Для профиля «строки и кодировки» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с readline_callback_handler_install: у него другое назначение, владелец или набор входных данных.

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

Для readline_add_history базовый ориентир: добавляет строку в историю команд; обязательные $prompt; результат true. Сопоставление с опубликованными соседями: readline_callback_handler_install: инициализирует callback-интерфейс readline и терминал, печатает строку приглашения и немедленно возвращает управление; вход — обязательные $prompt, $callback; результат — true. readline_read_history: считывает историю команд из файла; вход — необязательные $filename; результат — bool. readline_write_history: записывает историю команд в файл; вход — необязательные $filename; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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