PHP 8.4.2 Released!

posix_isatty

(PHP 4, PHP 5, PHP 7, PHP 8)

posix_isattyDétermine si un pointeur de fichier est un terminal interactif

Description

posix_isatty(resource|int $file_descriptor): bool

Détermine si le pointeur de fichier file_descriptor se réfère à un type de terminal de périphérique valide.

Liste de paramètres

file_descriptor

Le descripteur de fichier, qui doit être soit une ressource de fichier, soit un entier. Un entier est supposé être un descripteur de fichier qui peut être passé directement à l'appel système sous-jacent.

Valeurs de retour

Retourne true si file_descriptor est un pointeur de fichier connecté à un terminal, false sinon.

Historique

Version Description
8.4.0 Définit errno (numéro d'erreur) à EBADF lorsque le descripteur de fichier/flux passé est invalide.
8.3.0 Des erreurs de type E_WARNING sont désormais générées pour les coercitions d'entiers suivant les sémantiques habituelles de coercition de type PHP.

Voir aussi

add a note

User Contributed Notes 2 notes

up
2
hfuecks at phppatterns dot com
20 years ago
Can be useful to determine whether output is being piped elsewhere, for PHP shell scripts, for example;

#!/usr/local/bin/php
<?php
if ( !posix_isatty(STDOUT) ) {
fwrite(STDOUT, "Invalid TTY\n");
exit(
2);
}
fwrite(STDOUT, "Enter you name\n");
$name = fgets(STDIN);
fwrite(STDOUT,"Hello $name\n");
exit(
0);
?>

If this script is like:

script.php > outfile

outfile will contain "Invalid TTY"
up
1
KEINOS
3 years ago
It's quite complicated to understand its movements. But it determines if the file_descriptor is open AND connected to a terminal.

Thus, while receiving data from the STDIN, for example, it will return false.

This move is useful to optionally pipe STDIN to a PHP script, to avoid hanging when nothing is from STDIN.

<?php

// Simply echoes the contents from STDIN if any
// and "no stdin" if not.
echo (posix_isatty(STDIN)) ? 'no stdin' . PHP_EOL : file_get_contents('php://stdin');
?>
To Top