readline_callback_handler_install

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

readline_callback_handler_installИнициализирует callback-интерфейс readline и терминал, печатает строку приглашения и немедленно возвращает управление

Описание

readline_callback_handler_install(string $prompt, callable $callback): bool

Инициализирует callback-интерфейс readline, печатает prompt и возвращает управление. Повторный вызов этой функции без предварительного удаления старого callback-интерфейса приведёт к автоматической его перезаписи.

Функционал callback-функций особенно удобен в комбинации с stream_select(), поскольку он, в отличие от readline(), позволяет чередовать ввод-вывод и пользовательский ввод.

Список параметров

prompt

Строка приглашения.

callback

Функция передаваемая в параметр callback должна принимать один параметр - возвращённый пользовательский ввод.

Возвращаемые значения

Возвращает true в случае успешного выполнения или false в случае возникновения ошибки.

Примеры

Пример #1 Пример использования callback-интерфейса readline

<?php
function rl_callback($ret)
{
global
$c, $prompting;

echo
"Вы ввели: $ret\n";
$c++;

if (
$c > 10) {
$prompting = false;
readline_callback_handler_remove();
} else {
readline_callback_handler_install("[$c] Поговори со мной: ", 'rl_callback');
}
}

$c = 1;
$prompting = true;

readline_callback_handler_install("[$c] Введите что-нибудь: ", 'rl_callback');

while (
$prompting) {
$w = NULL;
$e = NULL;
$n = stream_select($r = array(STDIN), $w, $e, null);
if (
$n && in_array(STDIN, $r)) {
// читаем символ и вызываем callback-функцию,
// если введён символ новой строки
readline_callback_read_char();
}
}

echo
"Ввод отключён. Спасибо за внимание.\n";
?>

Смотрите также

  • readline_callback_handler_remove() - Удаляет ранее зарегистрированную callback-функцию и восстанавливает терминал
  • readline_callback_read_char() - Читает символ и информирует callback-функцию readline, что получена строка
  • stream_select() - Запускает эквивалент системного вызова select() на массивах потоков со временем ожидания в секундах и микросекундах

add a note

User Contributed Notes 1 note

up
1
thflori
5 years ago
To read byte wise and multi line you can check the line_buffer from readline_info:

<?php

function read(int $count, string $prompt = null): string
{
$previous = '';
readline_callback_handler_install($prompt ?? " \e[D", function ($str) use (&$previous) {
$previous .= $str . PHP_EOL;
});
do {
$r = array(STDIN);
$n = stream_select($r, $w, $e, null);
if (
$n && in_array(STDIN, $r)) {
readline_callback_read_char();
$str = $previous . readline_info('line_buffer');
}
} while (
mb_strlen($str) < $count); // use strlen if you need the exact byte count
readline_callback_handler_remove();

return
$str;
}
To Top