pg_client_encoding

(PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8)

pg_client_encoding — Obtém a codificação do cliente

Descrição

pg_client_encoding(?PgSql\Connection $connection = null): string

PostgreSQL suporta conversão automática de conjuntos de caracteres entre servidor e cliente para determinados conjuntos de caracteres. pg_client_encoding() retorna a codificação do cliente como uma string. A string retornada será um dos identificadores de codificação padrão do PostgreSQL.

Note:

Esta função requer PostgreSQL 7.0 ou superior. Se a libpq for compilada sem suporte à codificação multibyte, pg_client_encoding() sempre retornará SQL_ASCII. A codificação suportada depende da versão do PostgreSQL. Consulte as codificações suportadas na documentação do PostgreSQL.

A função costumava ser chamada de pg_clientencoding().

Parâmetros

connection

Uma instância de PgSql\Connection. Quando o parâmetro connection for null, a conexão padrão será usada. A conexão padrão é a última conexão feita por pg_connect() ou pg_pconnect().

Warning

A partir do PHP 8.1.0, usar a conexão padrão tornou-se defasado.

Valor Retornado

A codificação do cliente.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro connection agora espera uma instância de PgSql\Connection; anteriormente, um resource era esperado.
8.0.0 connection agora é anulável.

Exemplos

Example #1 Exemplo de pg_client_encoding()

<?php
// Suponha que $conn seja uma conexão com um banco de dados ISO-8859-1
$encoding = pg_client_encoding($conn);

echo "A codificação do cliente é: ", $encoding, "\n";
?>

O exemplo acima produzirá:

A codificação do cliente é: ISO-8859-1

Veja Também