ZF2 translator is not working in controller?

Question

I am trying to translate in the controller by ServiceLocator, but this is not translating and I have tried many sulotions in stackoverflow but with out success. My system uses multiple languages and my goal is to use transtor in view, controller, form and filter. Tranlator in my view is working. Any sugestion and help will be appreciated.

Not working in controller:

$this->getServiceLocator()->get('translator')->translate('my text',$myLocale);

My Application mudole.config.php:

'service_manager' => array(
     'abstract_factories' => array(
         'Zend\Cache\Service\StorageCacheAbstractServiceFactory',
         'Zend\Log\LoggerAbstractServiceFactory',
     ),
     'factories' => array(
         'translator' => 'Zend\I18n\Translator\TranslatorServiceFactory',
     ),
 ),
 'translator' => array(
     'locale' => 'en_US',// 'locale' => 'dk_DK',
     'translation_file_patterns' => array(
         array(

             'type'     => 'gettext',
             'base_dir' => __DIR__ . '/../language',
             'pattern'  => '%s.mo',
         ),
     ),
 ),

I changed the local in mudole.config.php to another language but still not translating.

Answer 1

You can use my ZfTranslate controller plugin.

installation

composer require mikica/zf2-translate-plugin

You need to register new module. Add in file config/application.config.php:

'modules' => array(
    '...',
    'ZfTranslate'
),

Usage in controller

<?php
$this->translate('translate word');
$this->translate('translate word', 'locale');

Answer 2

It seems that the locale is sets not directly in the translating text, but by $this->getServiceLocator()->get('translator')->setLocale($locale), and now it is translating my text.

My Application mudole.config.php:

   'service_manager' => array(
         'factories' => array(
             'translator' => 'Zend\I18n\Translator\TranslatorServiceFactory',
         ),
     ),
     'translator' => array(
         'locale' => 'en_US',
         'translation_file_patterns' => array(
             array(
                 'type'     => 'gettext',
                 'base_dir' => __DIR__ . '/../language',
                 'pattern'  => '%s.mo',
             ),
         ),
     ),

And in the controller:

$this->getServiceLocator()->get('translator')->setLocale($locale);
echo $c=$this->getServiceLocator()->get('translator')->translate('Book'); // Print(Danish): Bog

Answer 3

AlexP answer is the best way to do it.

But remains a question, why your way doesn't work?

It should work. But it doesn't because you are in different namespaces, so you are using distinct domains among the files. You doing something like that:

namespace MyModule\Controller;

class MyController {

   public function someAction() {
       $this->getServiceLocator()->get('translator')->translate('my text',__NAMESPACE__,$myLocale);
   }

}

While at your `module.config.php', you probably using this namespace:

namespace MyModule;

return array(
    //...
   'translator' => array(
       //...
    ),
);

Note that in the example of the controller __NAMESPACE__ is equals MyModule\Controller. While at the config file the __NAMESPACE__ is equals MyModule. You need to fix it, passing the same value in both cases.

In other words, there are several approachs to solve this, like AlexP's, for instance. But, any one of them need to have the domain of translator (the value of the 'text_domain' key) when you configure it equals the domain parameter (second paramater) of the translate method when you call it.

The faster solution is changing the $domain parameter to string at the controller file:

$this->getServiceLocator()->get('translator')->translate('my text','MyModule',$myLocale);

Another solution should be creating a constant and using it at the files (controllers, views and config).

Answer 4

View Helper/Forms

ZF2 ships with the view helper Zend\I18n\View\Helper\Translate; this is why you can already use the method $this->translate($text) in the view.

However all view helper classes that extend from Zend\I18n\View\Helper\AbstractTranslatorHelper (which includes all form view helpers) are also 'translation capable'.

You would need to pass in the translator using $viewHelper->setTranslator($translator) and enabling translation via $viewHelper->setTranslatorEnabled(true).

Controller Plugin

Unfortunately there is no default plugin (that I could find) to handle translators in controllers; I guess you could argue that text content shouldn't be in the controller anyway.

You could easily create one such as the example below. The key is to pass your new translator service as a dependency via a factory.

namespace MyModule\Controller\Plugin;

use Zend\Mvc\Controller\AbstractPlugin;
use Zend\I18n\Translator\Translator as TranslatorService;

class Translator extends AbstractPlugin
{
    protected $translatorService;

    public function __construct(TranslatorService $translatorService)
    {
        $this->translatorService = $translatorService;
    }

    public function invoke($text = null, array $options = [])
    {
        if (null == $text) {
            return $this;
        }
        return $this->translate($text, $options);
    }

    public function translate($text, array $options = [])
    {
        return $this->translatorService->translate($text);
    }

}

And create the factory class.

namespace MyModule\Controller\Plugin;

use MyModule\Controller\Plugin\Translator;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\ServiceManager\FactoryInterface;

class TranslatorFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $controllerPluginManager)
    {
        $serviceManager = $controllerPluginManager->getServiceLocator();

        return new Translator($serviceManager->get('translator'));
    }
}

Register the service in module.config.php.

return [
    'controller_plugins' => [
         'factories' => [
             'translate' => 'MyModule\\Controller\\Plugin\\TranslateFactory',
         ]
    ],
];

Then you can just call it within a controller class.

// Directly
$this->translate($text, $options); 

// Or fetch the plugin first
$this->translate()->translate($text, $options);