Chapter 49. Zend_Translate

Table of Contents

49.1. Introduction
49.1.1. Starting multi-lingual
49.2. Adapters for Zend_Translate
49.2.1. How to decide which translation adapter to use
49.2.1.1. Zend_Translate_Adapter_Array
49.2.1.2. Zend_Translate_Adapter_Csv
49.2.1.3. Zend_Translate_Adapter_Gettext
49.2.1.4. Zend_Translate_Adapter_Ini
49.2.1.5. Zend_Translate_Adapter_Tbx
49.2.1.6. Zend_Translate_Adapter_Tmx
49.2.1.7. Zend_Translate_Adapter_Qt
49.2.1.8. Zend_Translate_Adapter_Xliff
49.2.1.9. Zend_Translate_Adapter_XmlTm
49.2.2. Integrate self written Adapters
49.2.3. Speedup all Adapters
49.3. Using Translation Adapters
49.3.1. Translation Source Structures
49.3.2. Creating Array source files
49.3.3. Creating Gettext source files
49.3.4. Creating TMX source files
49.3.5. Creating CSV source files
49.3.6. Creating INI source files
49.3.7. Options for adapters
49.3.8. Handling languages
49.3.8.1. Automatical handling of languages
49.3.9. Automatic source detection
49.3.9.1. Language through naming directories
49.3.9.2. Language through filenames
49.3.9.2.1. Complete filename
49.3.9.2.2. Extension of the file
49.3.9.2.3. Filename tokens
49.3.10. Checking for translations
49.3.11. How to log not found translations
49.3.12. Accessing source data
49.4. Migrating from previous versions
49.4.1. Migrating from 1.6 to 1.7 or newer
49.4.1.1. Setting languages

49.1. Introduction

Zend_Translate is Zend Framework's solution for multilingual applications.

In multilingual applications, the content must be translated into several languages and display content depending on the user's language. PHP offers already several ways to handle such problems, however the PHP solution has some problems:

  • Inconsistent API: There is no single API for the different source formats. The usage of gettext for example is very complicated.

  • PHP supports only gettext and native array: PHP itself offers only support for array or gettext. All other source formats have to be coded manually, because there is no native support.

  • No detection of the default language: The default language of the user cannot be detected without deeper knowledge of the backgrounds for the different web browsers.

  • Gettext is not thread-safe: PHP's gettext library is not thread safe, and it should not be used in a multithreaded environment. This is due to problems with gettext itself, not PHP, but it is an existing problem.

Zend_Translate does not have the above problems. This is why we recommend using Zend_Translate instead of PHP's native functions. The benefits of Zend_Translate are:

  • Supports multiple source formats: Zend_Translate supports several source formats, including those supported by PHP, and other formats including TMX and CSV files.

  • Thread-safe gettext: The gettext reader of Zend_Translate is thread-safe. There are no problems using it in multi-threaded environments.

  • Easy and generic API: The API of Zend_Translate is very simple and requires only a handful of functions. So it's easy to learn and easy to maintain. All source formats are handled the same way, so if the format of your source files change from Gettext to TMX, you only need to change one line of code to specify the storage adapter.

  • Detection of the user's standard language: The preferred language of the user accessing the site can be detected and used by Zend_Translate.

  • Automatic source detection: Zend_Translate is capable of detecting and integrating multiple source files and additionally detect the locale to be used depending on directory or filenames.

49.1.1. Starting multi-lingual

So let's get started with multi-lingual business. What we want to do is translate our string output so the view produces the translated output. Otherwise we would have to write one view for each language, and no one would like to do this. Generally, multi-lingual sites are very simple in their design. There are only four steps you would have to do:

  1. Decide which adapter you want to use;

  2. Create your view and integrate Zend_Translate in your code;

  3. Create the source file from your code;

  4. Translate your source file to the desired language.

The following sections guide you through all four steps. Read through the next few pages to create your own multi-lingual web application.