TigerZF
🌐English

Chapter 74. Zend_Translate

Table of Contents

74.1. Introduction
74.1.1. Starting multi-lingual
74.2. Adapters for Zend_Translate
74.2.1. How to decide which translation adapter to use
74.2.1.1. Zend_Translate_Adapter_Array
74.2.1.2. Zend_Translate_Adapter_Csv
74.2.1.3. Zend_Translate_Adapter_Gettext
74.2.1.4. Zend_Translate_Adapter_Ini
74.2.1.5. Zend_Translate_Adapter_Tbx
74.2.1.6. Zend_Translate_Adapter_Tmx
74.2.1.7. Zend_Translate_Adapter_Qt
74.2.1.8. Zend_Translate_Adapter_Xliff
74.2.1.9. Zend_Translate_Adapter_XmlTm
74.2.2. Integrate self written Adapters
74.2.3. Speedup all Adapters
74.3. Using Translation Adapters
74.3.1. Translation Source Structures
74.4. Creating source files
74.4.1. Creating Array source files
74.4.2. Creating Gettext source files
74.4.3. Creating TMX source files
74.4.4. Creating CSV source files
74.4.5. Creating INI source files
74.5. Additional features for translation
74.5.1. Options for adapters
74.5.2. Handling languages
74.5.2.1. Automatical handling of languages
74.5.2.2. Using a country as language
74.5.3. Automatic source detection
74.5.3.1. Language through naming directories
74.5.3.2. Language through filenames
74.5.3.2.1. Complete filename
74.5.3.2.2. Extension of the file
74.5.3.2.3. Filename tokens
74.5.3.3. Ignoring special files and directories
74.5.3.3.1. Ignore a special directory or file
74.5.3.3.2. Ignore several directories or files
74.5.3.3.3. Ignore specific names
74.5.4. Routing for translations
74.5.5. Combining multiple translation sources
74.5.6. Checking for translations
74.5.7. How to log not found translations
74.5.8. Accessing source data
74.6. Plural notations for Translation
74.6.1. Traditional plural translations
74.6.2. Modern plural translations
74.6.3. Plural source files
74.6.3.1. Array source with plural definitions
74.6.3.2. Csv source with plural definitions
74.6.3.3. Gettext source with plural definitions
74.6.4. Custom plural rules

74.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.

74.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.