接続に関する TTY 名を返す

# pg_tty

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

pg_tty — 接続に関する TTY 名を返す

### 説明

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

pg_tty() は、指定した PostgreSQL `connection` インスタンスで、 サーバー側のデバッグ出力が送られる tty 名を返します。

> 注意:

> pg_tty() は現在は使用されません。今はサーバーが TTY 設定を気にする必要がないからです。しかし、過去との互換性を 保持するためにこの関数は残されています。

### パラメータ

`connection`

  PgSql\Connection クラスのインスタンス。 `connection` が `null`, の場合、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect() または pg_pconnect() によって確立された直近の接続です。

  警告

  PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

### 戻り値

`connection` のデバッグ TTY を文字列で返します。

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。
8.0.0 | `connection` は、nullable になりました。

### 例

例1 pg_tty() の例

    <?php
    $pgsql_conn = pg_connect("dbname=mark host=localhost");

    if ($pgsql_conn) {
       print "Server debug TTY is: " . pg_tty($pgsql_conn) . "<br/>\n";
    } else {
       print pg_last_error($pgsql_conn);
       exit;
    }
    ?>

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open