pg_tty — Funktion · PHP-Referenz

Signatur

pg_tty(PgSql\Connection $connection = ?): string

Beschreibung

pg_tty() gibt den TTY-Namen zurück, der beim Aufbau der PostgreSQL-Verbindung als Ziel für serverseitige Debug-Ausgaben festgelegt wurde. Dieser Wert entspricht dem tty-Parameter aus dem Verbindungs-String und wurde in älteren PostgreSQL-Versionen dazu verwendet, Debug-Meldungen direkt auf ein Terminal umzuleiten.

In modernen PostgreSQL-Versionen wird der TTY-Parameter vollständig ignoriert und hat keine praktische Auswirkung mehr. Die Funktion ist daher vor allem aus historischen Gründen noch in PHP enthalten und gibt in der Regel einen leeren String zurück.

Wird kein $connection-Parameter übergeben, verwendet PHP die zuletzt geöffnete PostgreSQL-Verbindung. In PHP 8.1 wurde die Verwendung der Standard-Verbindung ohne expliziten Parameter als veraltet markiert.

Parameter

Name	Typ	Default	Beschreibung
$connection	PgSql\Connection		Eine PostgreSQL-Verbindungsinstanz (`PgSql\Connection`), wie sie von `pg_connect()` oder `pg_pconnect()` zurückgegeben wird. Wird der Parameter weggelassen, wird die zuletzt geöffnete Verbindung verwendet (ab PHP 8.1 veraltet).

Rückgabewert

Typ

string

Beschreibung

Gibt den TTY-Namen als String zurück, der beim Verbindungsaufbau angegeben wurde. In der Praxis ist dies bei modernen PostgreSQL-Versionen stets ein leerer String.

Beispiele

TTY-Name einer Verbindung ausgeben

<?php
$conn = pg_connect('host=localhost dbname=testdb user=postgres password=geheim');

if ($conn === false) {
    die('Verbindung fehlgeschlagen');
}

$tty = pg_tty($conn);

echo 'TTY der Verbindung: ' . (empty($tty) ? '(leer)' : $tty) . PHP_EOL;

pg_close($conn);

TTY der Verbindung: (leer)

Verbindungsinformationen zusammen ausgeben

<?php
$conn = pg_connect('host=localhost dbname=testdb user=postgres password=geheim');

if ($conn === false) {
    die('Verbindung fehlgeschlagen');
}

echo 'Host:     ' . pg_host($conn) . PHP_EOL;
echo 'Port:     ' . pg_port($conn) . PHP_EOL;
echo 'Datenbank:' . pg_dbname($conn) . PHP_EOL;
echo 'TTY:      ' . pg_tty($conn) . PHP_EOL;

pg_close($conn);

Host: localhost Port: 5432 Datenbank:testdb TTY:

// Wichtig · Fallstricke

Veraltet: Ab PostgreSQL 7.4 wird der tty-Verbindungsparameter nicht mehr ausgewertet. pg_tty() gibt daher stets einen leeren String zurück und ist für neue Anwendungen ohne praktischen Nutzen.

Ab PHP 8.1 ist die Verwendung von pg_tty() ohne expliziten $connection-Parameter als veraltet (deprecated) eingestuft. Es sollte stets eine explizite Verbindungsinstanz übergeben werden.

Siehe auch

pg_connect pg_host pg_port pg_dbname pg_options