readline_callback_handler_install

PHP 5 >= 5.1.0, PHP 7, PHP 8
readline_callback_handler_install - Initializes the readline callback interface and terminal, prints the prompt and returns immediately
Manual
Code Examples

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

Sets up a readline callback interface then prints prompt and immediately returns. Calling this function twice without removing the previous callback interface will automatically and conveniently overwrite the old interface.

The callback feature is useful when combined with stream_select as it allows interleaving of IO and user input, unlike readline.

Parameters

prompt

The prompt message.

callback

The callback function takes one parameter; the user input returned.

Return Values

Returns true on success or false on failure.

Related Functions

  • readline_callback_handler_remove - Removes a previously installed callback handler and restores terminal settings
  • readline_callback_read_char - Reads a character and informs the readline callback interface when a line is received
  • stream_select - Runs the equivalent of the select() system call on the given arrays of streams with a timeout specified by seconds and microseconds

Example of readline_callback_handler_install

Show all examples for readline_callback_handler_install

Edit/Test in Sandbox
PHP Version:


Function readline_callback_handler_install:

GNU Readline Functions

Most used PHP functions