Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Gettext Functions : gettext

gettext

Lookup a message in the current domain (PHP 4, PHP 5, PECL axis2:0.1.0-0.1.1)
string gettext ( string message )

Example 777. gettext()-check

<?php
// Set language to German
setlocale(LC_ALL, 'de_DE');

// Specify location of translation tables
bindtextdomain("myPHPApp", "./locale");

// Choose domain
textdomain("myPHPApp");

// Translation is looking for in ./locale/de_DE/LC_MESSAGES/myPHPApp.mo now

// Print a test message
echo gettext("Welcome to My PHP Application");

// Or use the alias _() for gettext()
echo _("Have a nice day");
?>

Code Examples / Notes » gettext

jespersanospam

There's a good tutorial to the GetText tools used with PHP at http://zez.org/article/articleview/42
The only modification I needed to do was to use the correct ISO-language/country-codes (don't know the ISO number) and call setlocale.
helloworld.php:
putenv("LC_ALL=da_DK"); // For danish/Denmark
setlocale(LC_ALL, "");
// ./locale/da/LC_MESSAGES holds the helloworld.mo file
bindtextdomain("helloworld", "./locale");
textdomain("helloworld");
print(gettext("Hello world!"));
I had a lot of trouble getting this to work on Red Hat (Yellow Dog) Linux though.


florent

Take care when extracting the strings from the source files : if your source files are not encoded in ascii, then xgettext must be used with the --from-code option, and the generated .po file is *always* UTF-8 (even if you used a different --from-code charset).
The usage of gettext will not work later on strings which include non ascii caracters. For make it working, you have to translate the .po file to your proper charset with msgconv.
Example :
my source files are encoded in iso-8859-1
$ xgettext --from-code=iso-8859-1 -n *.php -o myapp.po
==> myapp.po is in UTF-8 (and generated .mo files will not work with gettext).
I have to convert it to iso-8859-1 before translating :
$ msgconv --to-code=iso-8859-1 myapp.po -o myapp.po
...and now translate the file.


daevid

It appears that this version of gettext() is lame and doesn't support [_1] and [_2] ... modifier/parameters.
Here is a little hack around this:
<?php
function translate($string)
{
$arg = array();
for($i = 1 ; $i < func_num_args(); $i++)
$arg[] = func_get_arg($i);

return vsprintf(gettext($string), $arg);
}
$foo = 'Foo';
print translate("Found %1\$s Devices on Range %2\$s", "20", $foo)."

\n";
?>
To clarify, you'd put this string in your .po file:
"Found %1\$s Devices on Range %2\$s"


nemo

If you have problem to get this working, like everybody,
try it with the long version of the language parameter:
putenv ("LANG=de_DE");


adino

If you 're experiencing problems like gettext() is not working and you're getting translated text only occassionaly use: unset LANG before starting apache.
Next thing is that you have to restart apache after you 've changed .mo files because they're treated something like shared libraries.
I've only tested this with Linux (Sourcemage Linux distro, Mandrake) but it might be true for others as well.


vinaykuruvila

If like me, you are stuck with making a lot of code localizable, you have to go through all your php files and wrap all srings in _("string"). Here's an elisp function which can help you out.
This function enables you to highlight some text in an emacs buffer and make it a localizable string using the keyboard shortcut C-l (Ctrl and l). If the first character highlighted is " or ', then it assumes the text is in php-context and changes it to: _(HIGHLIGHTED_TEXT). Otherwise it assumes the text is in html-context and changes it to <?=_('HIGHLIGHTED_TEXT')?>
The shortcut C-k can be used for translating parts of php strings which contain html tabs. We dont want to translate the entire string including the tabs, so we highlight just the substring that needs to be translated and use C-k.
To use it, do either of:
Copy and paste the following code into your .emacs file. This would permanently associate the keyboard shortcut C-l with this function.
Save the code in a new file ending with the .el extension. Evaluate it using M-x eval-buffer. This makes the C-l keyboard shortcut only last for the current Emacs session.
Code
;author: Vinay Kuruvila March 01 2006
;updated to handle php strings containing html tabs
;makes the text starting at left and ending at right in the
;current buffer a localizable string, assuming that the
;string is within php context
(defun make-localizable-string-in-php-context(left right)
(goto-char left)
(insert "_(")
(goto-char (+ right 2))
(insert ")")
)
;makes the text starting at left and ending at right in the
;current buffer a localizable string, assuming that the
;string is within html context
(defun make-localizable-string-in-html-context(left right)
(goto-char left)
(insert "<?= _('")
(goto-char (+ right 7))
(insert "')?>")
)
;makes the highlighted text a localizable string
;uses php-context localization if the first char highlighted
;is " or '
;otherwise uses html-context localization
(defun make-localizable-string()
(interactive)
;find the positions of the left and right ends of
;the highlighted text
(if (> (point) (mark))
(progn
(setq right (point))
(setq left (mark))
)
(progn
(setq right (mark))
(setq left (point))
)
)
;determine php-context or html-context and dispatch
(if (or (char-equal (char-after left) ?\") (char-equal (char-after left) ?'))
(make-localizable-string-in-php-context left right)
(make-localizable-string-in-html-context left right)
)
(deactivate-mark)
)
;to handle php strings which contain html tabs
;we dont want to translate the html tabs
(defun make-localizable-string-within-php-string ()
(interactive)
;find the positions of the left and right ends of
;the highlighted text
(if (> (point) (mark))
(progn
(setq right (point))
(setq left (mark))
)
(progn
(setq right (mark))
(setq left (point))
)
)
(goto-char left)
(insert "\". _(\"")
(goto-char (+ right 6))
(insert "\").\"")
(deactivate-mark)
)
;assigns a keyboard shortcut
(global-set-key "\C-l" 'make-localizable-string)
(global-set-key "\C-k" 'make-localizable-string-within-php-string)


daemonraco

I had a problem like "adino at adino dot sk" said, so I did the unsetting of LANG ($ unset LANG), but it was not sufficient, I had to unset the environment variable LANGUAGE too.
I tried to do this using "sudo", but it didn't works, so I had to change to root using "su"
If you need to know, I use Musix (a sub-distro of Devia).
I hope this will help you, Seeya! ^__^'


smerf a druid d if d uj d edu d pl

Gettext translations are cached. If you change *.mo files your page may not be translated as expected. Here's simple workaround which does not require restarting webserver (I know, this is just a dirty hack):
<?php
function initialize_i18n($locale) {
   putenv('LANG='.$locale);
   setlocale(LC_ALL,"");
   setlocale(LC_MESSAGES,$locale);
   setlocale(LC_CTYPE,$locale);
   $domains = glob($locales_root.'/'.$locale.'/LC_MESSAGES/messages-*.mo');
   $current = basename($domains[0],'.mo');
   $timestamp = preg_replace('{messages-}i','',$current);
   bindtextdomain($current,$locales_root);
   textdomain($current);
   }
?>
to make this work you have to put your locale inside file messages-[unix_time].mo and use this name (without .mo) as your domain to fool caching mechanism (domain names differ)
msgfmt messages.po -o messages-`date +%s`.mo
for me this works fine (although this is not very elegant solution)


iguy

Depending on the implementation of gettext used you might have to call the setlocale(LC_ALL, "") command.  
So your example code would be
<?php
// Set language to German
putenv ("LANG=de");
// set the locale into the instance of gettext
setlocale(LC_ALL, "");
// Specify location of translation tables
bindtextdomain ("myPHPApp", "./locale");
// Choose domain
textdomain ("myPHPApp");
// Print a test message
print (gettext ("Welcome to My PHP Application"));
?>
NOTE:  If setlocale returns NULL the LANG specified is invalid and "not supported".


suchy d ivan a gmail.com

Default behavior is name .mo file equally in every language version:
===
locale_dir
--- en_US
------ LC_MESSAGES
--------- lang.mo
--- sk_SK
------ LC_MESSAGES
--------- lang.mo
===
I think, better form is:
===
locale_dir
--- en_US
------ LC_MESSAGES
--------- en.mo
--- sk_SK
------ LC_MESSAGES
--------- sk.mo
===
Then the following code works very well (surprisingly on win32 too), and you don't need restart apache and do other confusing things:
$gettext_domain = 'sk'; // change by language
setlocale(LC_ALL, 'sk_SK.UTF-8'); // change by language, directory name sk_SK, not sk_SK.UTF-8
bindtextdomain($gettext_domain, "lang");
textdomain($gettext_domain);
bind_textdomain_codeset($gettext_domain, 'UTF-8');
Have nice day :-)


hardy

After many hours of tests/debug I found this behaviour in Red Hat 7.3 (I don't  test with other versions/distros)
The i18n settings doesn't work if not exits the right country code under  
/usr/lib/locale/. On my original instalation I just haved /usr/lib/locale/en* files, so after reinstall the glibc-common package the example showed here it works !.
* To force reinstall of the package
    rpm -i --force glibc-common-2.2.5-34.i386.rpm
* The working example $HOME/i18n.php
----begin----
#!/usr/bin/php
<?php
// Current locale settings
echo "Current i18n:".setlocale(LC_ALL, 0)."\n\n";
// i18n support information here
$language = 'es_ES';
$newLocale=setlocale (LC_ALL, $language);
echo "After i18n:$newLocale\n\n";
// Set the text domain as 'messages'
$domain = 'messages';
bindtextdomain($domain, "./locale");
textdomain($domain);
echo gettext("The string must be here\n");
?>
----end----
* My $HOME/locale/es_ES/LC_MESSAGES/messages.po
----begin----
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2003-03-18 10:52+0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=ISO-8859-1\n"
"Content-Transfer-Encoding: 8bit\n"
#: i18n.php:16
msgid "The string must be here\n"
msgstr "La cadena debe ir aquí\n"
----end----
I hope this helps to you
Thanks
Hardy Beltran Monasterios


Change Language


Follow Navioo On Twitter
bind_textdomain_codeset
bindtextdomain
dcgettext
dcngettext
dgettext
dngettext
gettext
ngettext
textdomain
eXTReMe Tracker