Trabalhando de acordo com a Localidade em PHP

Introdução

Muitas aplicações web possuem uma área de abrangência bastante restrita, normalmente aos usuários de uma entidade ou pessoas de um país. Porém, também existem aplicações mais globais, usadas por pessoas de diferentes países e que possuem notações próprias para trabalhar com palavras e números.

A questão da internacionalização de uma aplicação envolve várias tarefas, como a tradução dos termos utilizados, possíveis reformulações de layout, e a aplicação de regras relacionadas à localidade. Neste artigo vamos tratar especificamente desta última, que são as regras relacionadas à localidade.

A função setlocale

A função setlocale é responsável por especificar o tipo de localidade desejada para realizar operações de uma categoria. O primeiro parâmetro representa a categoria de operações, e deve valer uma das constantes abaixo:

• LC_COLLATE - para especificar as regras da localidade para comparação de textos.
• LC_CTYPE - para especificar as regras da localidade para classificação/conversão de caracteres.
• LC_MONETARY - para especificar a notação monetária de uma localidade.
• LC_NUMERIC - para especificar a notação numérica de uma localidade.
• LC_TIME - para especificar a notação de data/tempo de uma localidade.
• LC_MESSAGES - para especificar o idioma das mensagens de log.
• LC_ALL - para especificar a localidade para todas as categorias.

O segundo parâmetro deve ser uma string, com o nome da localidade de acordo com o sistema operacional. Isso porque a função setlocale utiliza as definições de localidade definidas no servidor, inclusive seu nome.

Por exemplo, no Linux, podemos instalar as definições de localidade para português do Brasil e modificar as regras de localidade com a string "pt_BR", enquanto, no Windows, a string pode ser "Portuguese_Brazil". O charset também é importante, já que algumas operações dependem dele.

Podemos passar um terceiro, quarto, quinto parâmetro, etc. para a função setlocale, especificando várias localidades possíveis. A primeira a ser encontrada pelo servidor é utilizada. Veja o exemplo:

setlocale(LC_ALL, 'pt_BR.UTF-8', 'Portuguese_Brazil.1252');

Para sabermos qual a localidade que está sendo usada no momento, basta passarmos como segundo parâmetro o valor "0", na forma de string, conforme o exemplo:

$localidade_atual_numeric = setlocale(LC_NUMERIC, '0');

E, finalmente, podemos passar o valor "C" como segundo parâmetro para especificar a localidade default do PHP, que usa a notação americana para várias coisas, mas, mesmo assim, possui diferenças em relação à localidade "en_US".

Para obter as características de uma localidade, basta definirmos a localidade desejada e chamar a função localeconv, que retorna array associativo com os símbolos e algumas regras usadas pela localidade.

---

Comparando textos

Para compararmos textos de acordo com a localidade, utilizamos a categoria LC_COLLATE. Ao definirmos uma localidade nesta categoria, podemos usar a função strcoll para comparar duas strings, para saber qual deve vir antes que a outra quando forem ordenadas, por exemplo. O funcionamento de strcoll é parecido com strcmp, porém, ela leva em consideração a localidade para determinar o resultado (comparando letra a letra), enquanto strcmp compara o valor binário de cada byte da string, da esquerda para direita.

Para entender exatamente o que ocorre, vejamos o teste a seguir (considerando que estamos usando a codificação UTF-8):

// Comparação binária
$comparacao1 = strcmp('índio', 'laranja');

// Comparação de acordo com a localidade
setlocale(LC_COLLATE, 'pt_BR.UTF-8');
$comparacao2 = strcoll('índio', 'laranja');

A variável $comparacao1 obteve o valor "87", indicando que "índio" deve vir após "laranja", se colocados em ordem. Já a variável $comparacao2 obteve o valor "-3", indicando que "índio" deve vir antes de "laranja", se colocados em ordem. O valor de $comparacao2 é mais adequado para o português, já que a letra "i" vem antes da letra "l", mesmo que ela tenha acento.

Para entender como é feita a comparação byte a byte, precisamos quebrar as strings "índio" e "laranja" em bytes, segundo a codificação UTF-8:

Bytes da palavra "índio" em UTF-8

Letra	í		n	d	i	o
Bytes	11000011	10101101	01101110	01100100	01101001	01101111
Bytes Decimal	195	173	110	100	105	111

Bytes da palavra "laranja" em UTF-8

Letra	l	a	r	a	n	j	a
Bytes	01101100	01100001	01110010	01100001	01101110	01101010	01100001
Bytes Decimal	108	97	114	97	110	106	97

Observando as tabelas, basta comparar o primeiro byte de uma string com o primeiro byte da outra string, ou seja, 195 e 108. Como o 195 é maior que 108, então a função strcmp retornou um valor maior que zero, ou seja, a primeira string é posterior à primeira string. Ou seja, a ordem fica condicionada ao algorítimo de codificação dos caracteres que, no caso, foi o UTF-8

Já a função strcoll considera a letra "í" com acento e a letra "i" sem acento como sendo uma letra da mesma "família". Embora se compararmos estas duas letras, a "í" com acento virá após a "i" sem acento, porém, a "í" com acento virá antes da letra "l", que está mais a frente no alfabeto.

Agora que entendemos bem a diferença entre as duas funções, podemos utilizá-la num caso mais prático, como a ordenação de um array com strings codificadas em UTF-8, levando em consideração as regras de comparação de uma localidade:

<?php

$array = array(
    'índio',
    'aluguel',
    'laranja',
    'carro'
);

setlocale(LC_COLLATE, 'pt_BR.UTF-8');
usort($array, 'strcoll');

Ao chamarmos a função usort, podemos passar um callback informando a função que usaremos para comparar dois elementos do array durante a ordenação. Como definimos uma localidade e depois chamamos a função usort passando o callback "strcoll", então o array será ordenado de acordo com a localidade, resultando em: aluguel, carro, índio, laranja.

---

Classificação/conversão de Caracteres

Cada localidade possui a classificação de seus símbolos e algumas correlações entre eles. Por exemplo, a letra "a" minúscula está na categoria de "letra" e está relacionada à letra "A" maiúscula. Em português, usamos acentuação em algumas letras e esta correlação também se aplica. Por exemplo, a letra "é" minúscula e acentuada está relacionada à letra "É" maiúscula e acentuada. Em outras localidades, este correlação pode variar.

Neste caso, a categoria LC_CTYPE afeta a classificação de caracteres e funções que dependem da tabela de correlação entre elas. Ou seja, as funções da extensão ctype, e algumas funções como strtoupper, strtolower, ucfirst, ucwords, escapeshellarg, etc. Veja o exemplo:

setlocale(LC_CTYPE, 'pt_BR.ISO-8859-1');
$alpha = ctype_alpha('ã');           // Recebe valor "true"
$maiuscula = strtoupper('avião');    // Recebe valor "AVIÃO"

Infelizmente, a linguagem PHP ainda não trabalha nativamente com unicode para algumas funções. Existe a esperança de que o PHP 6 isso se resolva, mas, enquanto isso, é necessário usar recursos específicos para algumas operações. Por exemplo, para converter uma string UTF-8 para maiúscula, pode-se usar a extensão Multibyte, conforme exemplo:.

$maiuscula = mb_strtoupper('avião', 'UTF-8');

---

Formatação de números

Para formatação de números de acordo com a localidade, especificamos a localidade para a categoria LC_NUMERIC. Com isso, serão usados os símbolos adequados para separador de casas decimais e separador de milhar. Em português do Brasil, o separador de casas decimais é a vírgula, enquanto o separador de milhar é o ponto final. Veja o exemplo:

$float = 1500.87;

setlocale(LC_NUMERIC, 'pt_BR.UTF-8');
echo $float;     // Imprime 1.500,87

Observação: em alguns servidores, a definição de localidade pode não usar o ponto final como separador de milhar.

Cuidado: note que, ao definir a localidade, você precisa tomar cuidado ao imprimir números. Lembre-se que eles serão impressos na notação da localidade. Para garantir que um número seja impresso na notação do PHP, você pode voltar a localidade para "C", temporariamente:

$float = 1500.87;

$locale_antigo = setlocale(LC_NUMERIC, '0');
setlocale(LC_NUMERIC, 'C');

echo $float;     // Imprime 1500.87

setlocale(LC_NUMERIC, $locale_antigo);

---

Formatação Monetária

De forma similar à definição da notação numérica com LC_NUMERIC, existe a categoria LC_MONETARY para definir a notação monetária de alguma localidade. Por exemplo, no Brasil, utilizamos a notação "R$ x.xxxx,xx". Definindo a localidade nesta categoria, modificamos o comportamento da função money_format:

$float = 1500.87;

setlocale(LC_MONETARY, 'pt_BR.UTF-8');

echo money_format('%n', $float);   // Imprime: R$ 1.500,87
echo money_format('%i', $float);   // Imprime: BRL 1.500,87

Observação: a função money_format não está definida em todos os sistemas. Veja uma solução alternativa para money_format.

---

Formatação de Data

Algumas flags usadas pela função strftime dependem da localidade. Por exemplo, a flat "%A" representa o nome do dia da semana. Se definirmos a localidade para a categoria LC_TIME, obtemos o nome correto para as datas, conforme o exemplo:

$time = mktime(0, 0, 0, 9, 26, 2012);

setlocale(LC_TIME, 'pt_BR.UTF-8');
echo strftime('%A, %d de %B de %Y', $time); // Imprime: quarta, 26 de setembro de 2012

---

Considerações Finais

Tornar a aplicação adequada à localidade a aproxima da realidade do usuário, sendo mais amigável e usual. Porém, alguns cuidados devem ser tomados, como visto no artigo Transformação de Dados.