Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_View_Helper_Translate Class Reference

Public Member Functions

 __construct ($translate=null)
 Constructor for manually handling.
 
 translate ($messageid=null)
 Translate a message You can give multiple params or an array of params.
 
 setTranslator ($translate)
 Sets a translation Adapter for translation.
 
 getTranslator ()
 Retrieve translation object.
 
 setLocale ($locale=null)
 Set's an new locale for all further translations.
 
 getLocale ()
 Returns the set locale for translations.
 
- Public Member Functions inherited from Zend_View_Helper_Abstract
 setView (Zend_View_Interface $view)
 Set the View object.
 
 direct ()
 Strategy pattern: currently unutilized.
 

Protected Attributes

 $_translator
 

Additional Inherited Members

- Public Attributes inherited from Zend_View_Helper_Abstract
 $view = null
 

Constructor & Destructor Documentation

__construct (   $translate = null)

Constructor for manually handling.

Parameters
Zend_Translate | Zend_Translate_Adapter$translateInstance of Zend_Translate

Member Function Documentation

getLocale ( )

Returns the set locale for translations.

Exceptions
Zend_View_ExceptionWhen no Zend_Translate instance was set
Returns
string|Zend_Locale
getTranslator ( )

Retrieve translation object.

Returns
Zend_Translate_Adapter|null
setLocale (   $locale = null)

Set's an new locale for all further translations.

Parameters
string | Zend_Locale$localeNew locale to set
Exceptions
Zend_View_ExceptionWhen no Zend_Translate instance was set
Returns
Zend_View_Helper_Translate
setTranslator (   $translate)

Sets a translation Adapter for translation.

Parameters
Zend_Translate | Zend_Translate_Adapter$translateInstance of Zend_Translate
Exceptions
Zend_View_ExceptionWhen no or a false instance was set
Returns
Zend_View_Helper_Translate
translate (   $messageid = null)

Translate 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
string$messageidId of the message to be translated
Returns
string|Zend_View_Helper_Translate Translated message

Member Data Documentation

$_translator
protected