View/Helper/Translate.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_View
- Subpackage
- Helper
- Version
- $Id$
\Zend_View_Helper_Translate
Package: Zend_View\Helper
Returns
Translation view helper
- Parent(s)
- \Zend_View_Helper_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(\Zend_Translate | \Zend_Translate_Adapter $translate = null) : voidConstructor for manually handling
Parameters
| Name | Type | Description |
|---|---|---|
| $translate | \Zend_Translate | \Zend_Translate_Adapter | Instance of Zend_Translate |
getLocale() : string | \Zend_LocaleReturns the set locale for translations
Returns
Throws
| Type | Description |
|---|---|
| string | \Zend_Locale |
| Exception | Description |
|---|---|
| \Zend_View_Exception | When no Zend_Translate instance was set |
getTranslator() : \Zend_Translate_Adapter | nullRetrieve translation object
Returns
| Type | Description |
|---|---|
| \Zend_Translate_Adapter | null |
setLocale(string | \Zend_Locale $locale = null) : \Zend_View_Helper_TranslateSet's an new locale for all further translations
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $locale | string | \Zend_Locale | New locale to set |
| Type | Description |
|---|---|
| \Zend_View_Helper_Translate |
| Exception | Description |
|---|---|
| \Zend_View_Exception | When no Zend_Translate instance was set |
setTranslator(\Zend_Translate | \Zend_Translate_Adapter $translate) : \Zend_View_Helper_TranslateSets a translation Adapter for translation
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $translate | \Zend_Translate | \Zend_Translate_Adapter | Instance of Zend_Translate |
| Type | Description |
|---|---|
| \Zend_View_Helper_Translate |
| Exception | Description |
|---|---|
| \Zend_View_Exception | When no or a false instance was set |
translate(string $messageid = null) : string | \Zend_View_Helper_TranslateTranslate a message You can give multiple params or an array of params.
If you want to output another locale just set it as last single parameter
Example 1: translate('%1\$s + %2\$s', $value1, $value2, $locale);
Example 2: translate('%1\$s + %2\$s', array($value1, $value2), $locale);
Parameters| Name | Type | Description |
|---|---|---|
| $messageid | string | Id of the message to be translated |
| Type | Description |
|---|---|
| string | \Zend_View_Helper_Translate | Translated message |