Interaktive Shell

Wenn PHP mit der Option --with-readline kompiliert wurde, bietet die CLI SAPI mit der Option -a eine interaktive Shell an. Von PHP 7.1.0 an steht die interaktive Shell auch unter Windows zu Verfügung, wenn die readline-Erweiterung aktiviert ist.

Mittels der interaktiven Shell können Sie PHP-Code eingeben und direkt ausführen lassen.

Beispiel #1 Ausführung von Code in der interaktiven Shell

$ 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 >

Die interaktive Shell bietet auch Tabulator-Autovervollständigung für Funktionen, Konstanten, Klassen, Variablen, statische Methoden und Klassenkonstanten.

Beispiel #2 Tabulator-Autovervollständigung

Wenn es mehrere mögliche Vervollständigungen gibt, wird durch zweimaliges Drücken der Tabulator-Taste eine Liste dieser Vervollständigungen angezeigt:

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

Wenn es nur eine mögliche Vervollständigung gibt, führt ein einmaliges Drücken der Tabulator-Taste zur Vervollständigung der Zeile:

php > strpt[TAB]ime(

Autovervollständigung funktioniert auch für Namen, welche bereits während dieser interaktiven Session definiert wurden:

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

Die interaktive Shell speichert den Verlauf von zuletzt eingegeben Zeilen, auf die mittels der Pfeiltasten zugegriffen werden kann. Der Verlauf wird in der Datei ~/.php_history gespeichert. Seit PHP 8.4.0 kann der Pfad zur History-Datei mit der Umgebungsvariablen PHP_HISTFILE festgelegt werden.

Die CLI SAPI bietet die php.ini-Optionen cli.pager und cli.prompt. Die Option cli.pager erlaubt einem externen Programm (wie etwa less) als Pager für die Ausgabe zu agieren, anstatt dass diese direkt ausgegeben wird. Die Option cli.prompt erlaubt das Ändern der php >-Eingabeaufforderung.

Es ist auch möglich, die php.ini-Optionen in der interaktiven Shell zu setzen, indem man eine Kurzschreibweise verwendet.

Beispiel #3 Setzen von php.ini-Optionen in der interaktiven Shell

Die Option cli.prompt:

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

Mittels Backticks kann PHP-Code in der Eingabeaufforderung ausgeführt werden:

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 >

Setzen des Pagers auf less:

php > #cli.pager=less
php > phpinfo();
(output displayed in less)
php >

Die Option cli.prompt unterstützt einige Escape-Sequenzen.
cli.prompt-Escape-Sequenzen

Sequenzen Beschreibung

\e Wird verwendet, um Farben zur Eingabeaufforderung hinzuzufügen. Ein Beispiel: \e[032m\v \e[031m\b \e[34m\> \e[0m

\v Die PHP-Version.

\b Gibt an, in welchem Block sich PHP befindet. Zum Beispiel gibt /* an, dass man sich gerade in einem mehrzeiligen Kommentar befindet. Der äußerste Block ist php.

\> Gibt das Eingabeaufforderungszeichen an. Standardmäßig ist dies >, ändert sich jedoch, wenn sich die Shell innerhalb eines nicht beendeten Blocks oder Strings befindet. Mögliche Zeichen sind: ' " { ( >

**`cli.prompt`-Escape-Sequenzen**
Sequenzen	Beschreibung
`\e`	Wird verwendet, um Farben zur Eingabeaufforderung hinzuzufügen. Ein Beispiel: `\e[032m\v \e[031m\b \e[34m\> \e[0m`
`\v`	Die PHP-Version.
`\b`	Gibt an, in welchem Block sich PHP befindet. Zum Beispiel gibt `/*` an, dass man sich gerade in einem mehrzeiligen Kommentar befindet. Der äußerste Block ist `php`.
`\>`	Gibt das Eingabeaufforderungszeichen an. Standardmäßig ist dies `>`, ändert sich jedoch, wenn sich die Shell innerhalb eines nicht beendeten Blocks oder Strings befindet. Mögliche Zeichen sind: `' " { ( >`

Hinweis:
Dateien, die mit auto_prepend_file und auto_append_file eingebunden wurden, werden in diesem Modus mit einigen Einschränkungen geparst - z. B. müssen Funktionen vor dem Aufruf definiert werden.

Interaktiver Modus

Wenn die readline-Erweiterung nicht verfügbar ist, wurde vor PHP 8.1.0 durch den Aufruf von CLI SAPI mit der Option -a in den interaktiven Modus gewechselt. In diesem Modus muss ein komplettes PHP-Skript über STDIN übergeben werden, das nach dem Beenden mit CTRL +D (POSIX) oder CTRL +Z gefolgt von ENTER (Windows) ausgewertet wird. Dies ist im Grunde dasselbe wie der Aufruf von CLI SAPI ohne die Option -a.

Seit PHP 8.1.0 schlägt der Aufruf von CLI SAPI mit der Option -a fehl, wenn die readline-Erweiterung nicht verfügbar ist.