Shell Interactivo

El CLI SAPI proporciona un shell interactivo al usar la opción -a si PHP se ha compilado con la opción --with-readline. Desde PHP 7.1.0, el shell interactivo también está disponible en Windows, si la extensión readline está activada.

Al usar el shell interactivo, tiene la posibilidad de escribir código PHP y que se ejecute directamente.

Ejemplo #1 Ejecución de código usando el shell interactivo

$ php -a
Interactive shell

php > echo 5+8;
13
php > function addTwo($n)
php > {
php { return $n + 2;
php { }
php > var_dump(addtwo(2));
int(4)
php >

El shell interactivo también proporciona autocompletado de funciones, constantes, nombres de clases, variables, llamadas a métodos estáticos y constantes de clases utilizando la tecla de tabulación. Desde PHP 8.4.0, la ruta hacia el archivo de historial puede establecerse utilizando la variable de entorno PHP_HISTFILE.

Ejemplo #2 Autocompletado usando la tecla de tabulación

Presionar dos veces la tecla de tabulación cuando hay varias posibles completaciones mostrará una lista de estas completaciones:

php > strp[TAB][TAB]
strpbrk   strpos    strptime
php > strp

Cuando solo hay una posible completación, presionar la tecla de tabulación una vez completará el resto en la misma línea:

php > strpt[TAB]ime(

La completación también funcionará para los nombres que se han definido durante la sesión actual del shell interactivo:

php > $fooThisIsAReallyLongVariableName = 42;
php > $foo[TAB]ThisIsAReallyLongVariableName

El shell interactivo almacena su historial y puede acceder a él utilizando las teclas arriba y abajo. El historial se guarda en el archivo ~/.php_history.

El CLI SAPI proporciona 2 directivas del php.ini: cli.pager y cli.prompt. La directiva cli.pager permite la definición de un programa externo (como less) a utilizar como pager para la salida en lugar de mostrarla directamente en la pantalla. La directiva cli.prompt permite la modificación del prompt php >.

También es posible definir directivas del php.ini en un shell interactivo utilizando notaciones abreviadas.

Ejemplo #3 Definición de directivas del php.ini en un shell interactivo

La definición de la directiva cli.prompt:

php > #cli.prompt=hello world :>
hello world :>

Utilizando comillas invertidas, es posible ejecutar código PHP en el prompt:

php > #cli.prompt=`echo date('H:i:s');` php >
15:49:35 php > echo 'hi';
hi
15:49:43 php > sleep(2);
15:49:45 php >

Definición del pager a less:

php > #cli.pager=less
php > phpinfo();
(salida mostrada con less)
php >

La directiva cli.prompt soporta algunas secuencias de escape:
Secuencias de escape de cli.prompt

Secuencia: Descripción:

\e utilizado para agregar colores al prompt. Ejemplo: \e[032m\v \e[031m\b \e[34m\> \e[0m

\v La versión de PHP.

\b Indica en qué bloque de PHP nos encontramos. Por ejemplo, /* permite indicar que estamos en un comentario multilínea. El ámbito externo se representa por php.

\> Indica el carácter utilizado para el prompt. Por defecto, será >, pero puede cambiarse cuando el shell se encuentra en un bloque indeterminado o en una cadena de caracteres. Los caracteres posibles son: ' " { ( >

**Secuencias de escape de `cli.prompt`**
Secuencia:	Descripción:
`\e`	utilizado para agregar colores al prompt. Ejemplo: `\e[032m\v \e[031m\b \e[34m\> \e[0m`
`\v`	La versión de PHP.
`\b`	Indica en qué bloque de PHP nos encontramos. Por ejemplo, `/*` permite indicar que estamos en un comentario multilínea. El ámbito externo se representa por `php`.
`\>`	Indica el carácter utilizado para el prompt. Por defecto, será `>`, pero puede cambiarse cuando el shell se encuentra en un bloque indeterminado o en una cadena de caracteres. Los caracteres posibles son: `' " { ( >`

Nota:
Los archivos incluidos a través de auto_prepend_file y auto_append_file se analizan en este modo, pero con algunas restricciones; es decir, las funciones deben haber sido definidas antes de la llamada.

Modo interactivo

Si la extensión readline no está disponible, anterior a PHP 8.1.0, invocar el CLI SAPI con la opción -a proporciona el modo interactivo. En este modo, se supone que se da un script PHP completo a través de STDIN, y después de la interrupción con CTRL +D (POSIX) o CTRL +Z seguido de ENTER (Windows), este script será evaluado. Esto es básicamente idéntico a invocar el CLI SAPI sin la opción -a.

A partir de PHP 8.1.0, invocar el CLI SAPI con la opción -a falla si la extensión readline no está disponible.