sha1_file

rtrim

Last updated: Fri, 22 Aug 2008

setlocale

(PHP 4, PHP 5)

setlocale — Define informações locais

Descrição

string setlocale ( mixed $category , string $locale [, string $... ] )

string setlocale ( mixed $category , array $locale )

Category é uma constante (ou string) especificando a categoria de funções afetadas pela definição local: setting:

LC_ALL para tudo abaixo
LC_COLLATE para comparação de strings, veja strcoll()
LC_CTYPE para classificação de caracteres e conversão, por exemplo strtoupper()
LC_MONETARY para localeconv()
LC_NUMERIC para o separador decimal (Veja também localeconv())
LC_TIME para formatação de data e hora com strftime()

Se locale for uma string vazia "", o nome do local será obtido apartir de variaveis de ambiente com os mesmos nomes das categorias acima ou apartir de "LANG".

Se locale for NULL ou "0", a definição de local não é modificada, apenas retorna a definição atual.

Se locale for uma matriz ou conter parâmetros adicionais, então cada elemento da matriz é tentado como um local até obter sucesso. Isto é útil se um lugar é conhecido por nomes diferentes em sistemas diferentes ou para prover um outro local se um estiver indisponível.

Nota: Passar varios lugares não esta disponível antes do PHP 4.3.0

setlocale() retorna o novo local ou FALSE se a funcionalidade de locais não estiver implementada em sua plataforma, o local não existir ou a categoria for invalida. Uma categoria invalida também gera uma mensagem de aviso. Nomes de categoria/local podem ser encontrados em » RFC 1766 e » ISO 639.

Nota: O valor de retorno de setlocale() depende do sistema no qual o PHP esta sendo executado. Ele retorna exatamente o que a função setlocale do sistema retorna.

Dica

Usuários do windows encontraram informações úteis sobre as strings de locale no site MSDN da Microsoft. Strings das línguas suportadas podem ser encontradas » aqui as strings de pais/região suportados » aqui. Sistemas windows suportam códigos de três letras para pais/região especificados por ISO 3166-Alpha-3, que pode ser encontrada em » Unicode website .

Exemplo #1 Exemplos setlocale()


<?php
/* Define o local para Holandês(usar pt_BR para o Português(Brasil) ) */
setlocale (LC_ALL, 'nl_NL');

/* Mostra: vrijdag 22 december 1978 */
echo strftime ("%A %e %B %Y", mktime (0, 0, 0, 12, 22, 1978));

/* Tenta diferentes nomes de local para o Alemão apartir do PHP 4.3.0 */
$loc_de = setlocale (LC_ALL, 'de_DE@euro', 'de_DE', 'de', 'ge');
echo "Preferred locale for german on this system is '$loc_de'";
?>

Exemplo #2 Exemplos para windows desetlocale()


<?php
/* Define o local para Holandês(usar ptb para o Português(Brasil) ) */
setlocale (LC_ALL, 'nld_nld');

/* Mostra: vrijdag 22 december 1978 */
echo strftime ("%A %d %B %Y", mktime (0, 0, 0, 12, 22, 1978));

/* Tenta diferentes nomes de local para o Alemão apartir do PHP 4.3.0 */
$loc_de = setlocale (LC_ALL, 'de_DE@euro', 'de_DE', 'deu_deu');
echo "Preferred locale for german on this system is '$loc_de'";
?>

sha1_file

rtrim

Last updated: Fri, 22 Aug 2008

add a note User Contributed Notes
setlocale

buana95 at yahoo dot com
21-Aug-2008 02:30


This will works for Indonesian on all platform (Windows, Linux and others Nix server):



<?php

echo '<pre>' . "\n";



//Add english as default (if all Indonesian not available)



setlocale(LC_ALL, 'id_ID.UTF8', 'id_ID.UTF-8', 'id_ID.8859-1', 'id_ID', 'IND.UTF8', 'IND.UTF-8', 'IND.8859-1', 'IND', 'Indonesian.UTF8', 'Indonesian.UTF-8', 'Indonesian.8859-1', 'Indonesian', 'Indonesia', 'id', 'ID', 'en_US.UTF8', 'en_US.UTF-8', 'en_US.8859-1', 'en_US', 'American', 'ENG', 'English');



//will output something like: Minggu, 17 Agustus 2008

echo strftime("%A, %d %B %Y") . "\n";



echo '</pre>' . "\n";

?>

Arjon
28-Jul-2008 01:12


Please take heed and read the warning above if you are running on a XAMPP or any other Windows apache server! It just took me far too long to figure this out; and all the while there was a warning right on the page.



If you're experiencing shifting locale settings (check with setlocale(LC_ALL,0), returning the current locale stuff) and you're running a windows server, then it's not just you! Again, I urge everyone to read the red, but oh so easy not to read, warning message on this page.

michal dot kocarek at brainbox dot cz
27-Jul-2008 12:33


Note about using UTF-8 locale charset on Windows systems:





According to MSDN, Windows setlocale()'s implementation does not support UTF-8 encoding.





Citation from "MSDN setlocale, _wsetlocale" page (http://msdn.microsoft.com/en-us/library/x99tb11d.aspx):


The set of available languages, country/region codes, and code pages includes all those supported by the Win32 NLS API except code pages that require more than two bytes per character, such as UTF-7 and UTF-8. If you provide a code page like UTF-7 or UTF-8, setlocale will fail, returning NULL.





So basically, code like


<?php setlocale(LC_ALL, 'Czech_Czech Republic.65001'); // 65001 is UTF-8 codepage ?>


does not work on Windows at all.





(written in time of PHP 5.2.4)

de ronino at kde (reverse it)
25-Jun-2008 06:43


I experienced the behavior stated in the above Warning box: Running PHP5 on a multithreaded Apache made the current locale change sometimes all of a sudden within a script, so strftime() output wasn't in the required format.



I recompiled Apache with the prefork MPM and now it works like a charm. Took me a long time to find out the reason as I overlooked the warning box searching for either a bug report or a programming error of mine...

jonas at jonashaag dot de
27-May-2008 04:11


On Ubuntu, you have to take p.e. "de_DE.utf8", all available languages you can get with:

    locale -a

Georg
04-Apr-2008 06:31


To set locale to 'de_DE' on my Debian 4 machine I had to:

- uncomment 'de_DE' in file /etc/locale.gen and afterwards

- run locale-gen from the shell

bryn AT lunarvis DOT com
21-Jan-2008 11:04


Posting this in the hope it might be useful to others, as I could find very little info anywhere. If you want to use a Welsh locale and have the suitable language support installed, you pass 'cym' (abbreviated form of Cymraeg) to setlocale:



<?php

setlocale(LC_TIME, 'cym');

$welsh= gmstrftime("%A, %B %Y - %H:%M",time());

echo $welsh;

?>



The above certainly applies to Windows systems, but should also apply to Unix if the required support is installed.



Cheers,



Bryn.

ostapk
27-Dec-2007 08:39


There is a new PECL extension under development called intl (it will be available in PHP5.3). Meanwhile all who rely on the setlocale() and friends should be aware about the limitations of them as covered in this post on the onPHP5.com blog: http://www.onphp5.com/article/22

Periklis
13-Sep-2007 06:33


In *some* Windows systems, setting LC_TIME only will not work, you must either set LC_ALL or both LC_CTYPE and LC_TIME. BUT if you have already set LC_TIME using setlocale earlier in the script, dates will not be affected! For example:

<?php

setlocale(LC_TIME, 'greek');

setlocale(LC_CTYPE, 'greek');

?>

will not work, while 

<?php

setlocale(LC_CTYPE, 'greek');

setlocale(LC_TIME, 'greek');

?>

will do the job.

mvanbaak
09-May-2007 09:03


To complement Sven K's tip about debian:



You can also install the package locales-all

That one holds all the locales there are in compiled form.

szepeshazi at gmail dot com
19-Feb-2007 12:11


For those of you who are unfortunate enough (like me) to work in Windows environment, and try to set the locale to a language _and_ to UTF-8 charset, and were unable to do it, here is a workaround.



For example to output the date in hungarian with UTF-8 charset, this will work:



    $dateString = "%B %d., %A";

    setlocale(LC_ALL,'hungarian');

    $res=strftime($dateString);

    echo(iconv('ISO-8859-1', 'UTF-8', $res));



If anybody knows how to set the locale on Windows to the equivalent of "hu_HU.UTF-8" on unix, please do tell me.

lifeless
20-Nov-2006 02:40


if your server is an ubuntu (debian like)

you need to install the locales you want (default is english and your language) go to aptitude and install -language-pack-*-base it will resolve dependencies and will try to install a suggested package, remove it if you don't care and proceed.

Clayton Smith
26-Sep-2006 03:15


If you already have all the locales installed and "locale -a" is only showing a few languages, then edit /etc/locale.gen and add a line, e.g., es_MX ISO-8859-1.  After you add the line, run the command locale-gen for it to generate the locales based on those settings.

Sven K
07-Jun-2006 07:08


If your system doesn't show any installed locales by "locale -a", try installing them by "dpkg-reconfigure locales" (on debian).

08-Mar-2006 05:17


The example from bruno dot cenou at revues dot org below shows the possibility, but I want to spell it out: you can add charset info to setlocale.



Example:



Into my utf-8-encoded page I want to insert the name of the current month, which happens to be March, in German "März" - with umlaut. If you use



   setlocale(LC_TIME, 'de_DE');

   echo strftime("%B");



this will return "M&auml;rz", but that html-entity will look like this on a utf-8 page: "M?rz". Not what I want.



But if you use



   setlocale(LC_TIME, 'de_DE.UTF8');  // note the charset info !

   echo strftime("%B");



this returns "M√§rz", which, on utf-8, looks like it should: "März".

bruno dot cenou at revues dot org
20-Feb-2006 11:31


A little function to test available locales on a sytem :



<?php

function list_system_locales(){

    ob_start();

    system('locale -a'); 

    $str = ob_get_contents();

    ob_end_clean();

    return split("\\n", trim($str));

}



$locale = "fr_FR.UTF8";

$locales = list_system_locales();



if(in_array($locale, $locales)){

        echo "yes yes yes....";

}else{

        echo "no no no.......";

}



?>

Edwin Martin
20-Feb-2006 09:29


Debian users: Addition to Gabor Deri's note: if setlocale doesn't work in your locale and you're on Debian, and Gabor Deri's note doesn't work, you have to install the locales package.



As root, type: "apt-get install locales" and it will be installed.

glenn at europlan dot no
30-Nov-2005 04:55


In most Unix/Linux system, you could use:



locale -a



This will list all available locales on the server.

birkholz at web dot de
15-Aug-2005 12:42


When i tried to get the current locale (e.g. after i set the lang to german with setlocale(LC_ALL, 'de_DE'); ), the following did not work on my suse linux 9.0-box:

$currentLocale = setlocale(LC_ALL, NULL);

This code did a reset to the server-setting.



$currentLocale = setlocale(LC_ALL, 0); works perfectly for me, but the manual says NULL and 0 are equal in this case, but NULL seems to act like "".

pigmeu at pigmeu dot net
18-Oct-2004 05:42


!!WARNING!!



The "locale" always depend on the server configuration.



i.e.:

When trying to use "pt_BR" on some servers you will ALWAYS get false. Even with other languages.



The locale string need to be supported by the server. Sometimes there are diferents charsets for a language, like "pt_BR.utf-8" and "pt_BR.iso-8859-1", but there is no support for a _standard_ "pt_BR".



This problem occours in Windows platform too. Here you need to call "portuguese" or "spanish" or "german" or...



Maybe the only way to try to get success calling the function setlocale() is:

setlocale(LC_ALL, "pt_BR", "pt_BR.iso-8859-1", "pt_BR.utf-8", "portuguese", ...);



But NEVER trust on that when making functions like date conversions or number formating. The best way to make sure you are doing the right thing, is using the default "en_US" or "en_UK", by not calling the setlocale() function. Or, make sure that your server support the lang you want to use, with some tests.



Remember that: Using the default locale setings is the best way to "talk" with other applications, like dbs or rpc servers, too.



[]s



Pigmeu

dv at josheli dot com
12-Aug-2004 08:04


On Novell Netware, the language codes require hyphens, not underscores, and using anything other than LC_ALL doesn't work directly.



So... (from their support list)....



You have to set TIME, NUMERIC etc. info in two steps as given below rather than one. This is due to the limitation of setlocale function of LibC.

<?php

   setlocale(LC_ALL, 'es-ES');

   $loc = setlocale(LC_TIME, NULL);

   echo strftime("%A %e %B %Y", mktime(0, 0, 0, 12, 22, 1978));

  // jeuves 22 diciembre 1978

?>

This should work.



or of course, reset LC_ALL...

<?php

setlocale(LC_ALL, 'es-ES');

echo strftime("%A %e %B %Y", mktime(0, 0, 0, 12, 22, 1978));

setlocale(LC_ALL, '');

// jeuves 22 diciembre 1978

?>

bogdan at iHost dot ro
02-Mar-2004 07:53


On some systems (at least FreeBSD 4.x) the format for a `locale' is, for example, ro_RO.ISO8859-2. If you use ro_RO instead setlocale will return FALSE. Just browse in /usr/share/locale and see what is the name of the directory holding your `locale' and use that name in your scripts:



<?php

  clearstatcache();

  $pos = strrpos ($_SERVER["PHP_SELF"], "/");

  $fisier = substr ($_SERVER["PHP_SELF"], $pos + 1);

  $result = filemtime ($fisier);

  $local = setlocale (LC_TIME, 'ro_RO.ISO8859-2');

  if ($local == "ro_RO.ISO8859-2") {

    $modtime = strftime '%e&nbsp;%B&nbsp;%Y&nbsp;%H:%M', $result);

  } else {

    $modtime = strftime ('%d.%m.%Y&nbsp;%H:%M', $result);

  }

  printf ("Ultima&nbsp;actualizare: %s\\n", $modtime);

?>

mk at totu dot com
26-Jan-2004 09:59


Be carefull - setting a locale which uses commas instead of dots in numbers may cause a mysql db not to understand the query:


<?php


setlocale(LC_ALL,"pl");


$price = 1234 / 100; // now the price looks like 12,34


$query = mysql_query("SELECT Id FROM table WHERE price='".$price."'");


?>


Even if there is a price 12.34 - nothing will be found

r dot nospam dot velseboer at quicknet dot nospam dot nl
08-Sep-2002 11:02


be careful with the LC_ALL setting, as it may introduce some unwanted conversions. For example, I used 



setlocale (LC_ALL, "Dutch");



to get my weekdays in dutch on the page. From that moment on (as I found out many hours later) my floating point values from MYSQL where interpreted as integers because the Dutch locale wants a comma (,) instead of a point (.) before the decimals. I tried printf, number_format, floatval.... all to no avail. 1.50 was always printed as 1.00 :(



When I set my locale to :



 setlocale (LC_TIME, "Dutch");



my weekdays are good now and my floating point values too. 



I hope I can save some people the trouble of figuring this out by themselves.



Rob

jorg-spamm at omnimedia dot no
03-Jul-2002 03:23


I needed to compile and install some extra locales to get this to work on RH7.3. Probably just me not doing a proper installation, but this is what it took to fix it:



localedef -ci no_NO -f ISO_8859-1 no_NO

elindset at hoved dot net
12-May-2002 06:59


In FreeBSD I had to use no_NO.ISO8859-1 instead of just no_NO..



<?PHP

    setlocale (LC_ALL, 'no_NO.ISO8859-1');

    echo strftime ("%A %e %B %Y", time());

?>

misc dot anders at feder dot dk
19-Jun-2001 10:13


Under FreeBSD, locale definitions are stored in the /usr/share/locale/ directory. Danish time formats and weekdays, for instance, are stored in /usr/share/locale/da_DK.ISO_8859-1/LC_TIME.

noog at libero dot it
23-Nov-2000 08:13


On windows:


Control Panel->International Settings


You can set your locale and customize it


And locale-related PHP functions work perfectly

Morgan Christiansson <mog at linux dot nu>
29-Mar-2000 05:56


check /usr/share/locale/ if you want more info about the locale available with your *NIX box





there is also a file called /usr/share/locale/locale.alias with a list of aliases


such as swedish for sv_SE





so on all boxes i have accounts on (rh 6.0 and slack 3.4) you can just use setlocale("LC_ALL","swedish"); or other prefered language in plain english.





However, the weekdays were in all lowercase :(





Note: export LC_ALL=swedish made a lot of programs swedish for me, it's also possible to make them russian or japanese :)

Lucas Thompson <lucas at slf dot cx>
31-Jan-2000 07:57


The Open Group has an excellent document available on the setlocale() library function, most of which applies to the PHP function of the same name.





http://www.opengroup.org/onlinepubs/7908799/xbd/locale.html





WARNING: This document might be a little too complex for people who came from HTML to PHP.





If you migrated from the world of C programming you'll be a locale master after reading this document.

add a note

sha1_file

rtrim

Last updated: Fri, 22 Aug 2008