Translating navigation breadcrumbs

Question

I'm trying to translate the breadcrumbs sitting in the module/Application/config/module.config.php configuration file like:

'navigation' => array(
    'default' => array(
        array(
            'label' => \Application\Util\Translator::translate('Home'),
            'route' => 'home',
            'resource' => 'route/home',
            'pages' => array(
            ),
        ),

The breadcrumb Home should display as Accueil in french.

The translator works just fine for the rest of the application. But none of the breadcrumbs are translated. The language resource file has been verified and poedit-ed again and again.

In the very same configuration file, is the translator

configuration:
    'service_manager' => array(
        'factories' => array(
            'account_navigation' => 'Application\Navigation\Service\AccountNavigationFactory',
            'navigation' => 'Zend\Navigation\Service\DefaultNavigationFactory',
            'translator' => 'Zend\I18n\Translator\TranslatorServiceFactory',
            'Application\Collector\RouteCollector'  => 'Application\Service\RouteCollectorServiceFactory',
        ),
    ),
    'translator' => array(
        'locale' => 'fr_FR',  // langue par défaut
        'translation_file_patterns' => array(
            array(
                'type'     => 'gettext',
                'base_dir' => __DIR__ . '/../language',
                'pattern'  => '%s.mo',
            ),
        ),
        'translation_files' => array(
            array(
                'type'     => 'phpArray',
                'filename' => __DIR__ . '/../../../vendor/zendframework/zendframework/resources/languages/fr/Zend_Validate.php',
                'locale'   => 'fr_FR'
            ),
            array(
                'type'     => 'gettext',
                'filename' => __DIR__ . '/../../../vendor/zf-commons/zfc-user/src/ZfcUser/language/fr_FR.mo',
                'locale'   => 'fr_FR'
            ),
            array(
                'type'     => 'phpArray',
                'filename' => __DIR__ . '/../language/fr_FR.php',
                'locale'   => 'fr_FR'
            )
        )
    ),

My application bootstrap looks like:

class Module
{

    public function onBootstrap(MvcEvent $e)
    {
        $eventManager = $e->getApplication()->getEventManager();
        $moduleRouteListener = new ModuleRouteListener();

        $sm = $e->getParam('application')->getServiceManager();

        // Add ACL information to the Navigation view helper
        $authorize = $sm->get('BjyAuthorize\Service\Authorize');
        $acl = $authorize->getAcl();
        $role = $authorize->getIdentity();
        \Zend\View\Helper\Navigation::setDefaultAcl($acl);
        \Zend\View\Helper\Navigation::setDefaultRole($role);

        $id = $sm->get('zfcuser_auth_service')->getIdentity();
        if (! is_null($id)) {
            $em = $sm->get('Doctrine\ORM\EntityManager');
            $usr = $em->find('Application\Entity\User', $id->getId());

            $blameableListener = new \Gedmo\Blameable\BlameableListener();
            $blameableListener->setUserValue($usr);
            $em->getEventManager()->addEventSubscriber($blameableListener);
        } else {
            // redirection
            if (isset($_SERVER['SERVER_NAME']) && preg_match('/monxxxxx/', $_SERVER['SERVER_NAME'])) {
                $strategy = new RedirectionStrategy();
                $strategy->setRedirectRoute('driver/login');
                $eventManager->attach($strategy);
            }
        }
        if ($sm->has('MvcTranslator')) {
            \Zend\Validator\AbstractValidator::setDefaultTranslator($sm->get('MvcTranslator'));
        }

        Locale::setDefault('fr_FR');

        // custom layout
        $e->getApplication()->getEventManager()->getSharedManager()->attach('Zend\Mvc\Controller\AbstractController', 'dispatch', function($e) {
            $route = $e->getRouteMatch();
            $controller = $e->getTarget();
            // change layout for login
            if($route->getParam('controller') == 'zfcuser' && $route->getParam('action') == 'login'){
                $controller->layout('layout/login');
            }
        }, 100);

        // Log the exceptions
        $application   = $e->getApplication();
        $sm = $application->getServiceManager();
        $sharedManager = $application->getEventManager()->getSharedManager();
        $sharedManager->attach('Zend\Mvc\Application', 'dispatch.error',
          function($e) use ($sm) {
            if ($e->getParam('exception') && strpos($e->getParam('exception'), 'are not authorized') === false) {  
              $sm->get('Zend\Log\Logger')->crit($e->getParam('exception'));

              $toEmail = "xxxxx@xxxxx.com";
              $toName = "Service IT";
              $subject = "Exception error";
              $body = $e->getParam('exception');
              \Application\Util\Common::sendMail($toEmail, $toName, $subject, $body);
            }
          }
        );
    }

    public function getConfig()
    {
        return include __DIR__ . '/config/module.config.php';
    }

    public function getAutoloaderConfig()
    {
        return array(
            'Zend\Loader\StandardAutoloader' => array(
                'namespaces' => array(
                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__
                )
            )
        );
    }

    public function init($moduleManager)
    {
         $moduleManager->loadModule('ZfcUser');
    }
}

I'm on ZF2 2.2.5.

Answer 1

Might be a silly question, but do you have the PHP gettext module (verified via your phpinfo())? If yes, you could much easier use _('Translatable string') for strings needing translation. You'd have a .mo and .po file in a language folder (next to src, public, etc.).

(Asking the above because you seem to be putting a lot of effort into this, even though your code shows you use gettext as a translator, which should allow you to already translate static strings, such as home in a config file)

As an example the picture below, it is the basic setup for one of my own ZF2 vendor modules:

Next, you'd need Poedit (Free version should be plenty.).

NOTE: Make sure to always use Poedit to edit the .mo/.po files.

Use Poedit to open the files in the language folder, no need to "translate" strings that are the same string as the language they should be, unless you're using shortcuts for strings (ie. "index" string should display "Show overview", but please don't :p)

Within Poedit you have a few options to add additional strings that it searches for in your files and you can also add additional file extensions. I would suggest you have it look for these strings:

• $this->translate()
• _()

and these file extensions:

• .php
• .phtml

That way you've covered the basics. Of course your setup may be different, so modify as needed.

Lastly, you need to register the usage of gettext PHP extensions in you module config. You need to do this for every module, as you need to give a language folder path, as that is where your module 'should' be translated (though feel free to make it global and have a huge translation file if you must, not recommended).

Add the following bit to your module.config.php file:

'translator' => [
    'locale' => 'en_US', // This line needs to be in the "root" config, feel free to override with/per module settings and/or user settings
    'translation_file_patterns' => [
        [
            'type'     => 'gettext',
            'base_dir' => __DIR__ . '/../language',
            'pattern'  => '%s.mo',
        ],
    ],
],

With all of the above, translating your breadcrumbs should be done like so:

'navigation' => array(
    'default' => array(
        array(
            'label' => _('Home'),
            'route' => 'home',
            'resource' => 'route/home',
            'pages' => array(
            ),
        ),

Answer 2

It seems that namespace Zend\View\Helper\Navigation\Breadcrumbs; is not instanciated correctly in your service manager. Therefore, the translator will not work because it also provided by the service manager as a dependancy

What you should do is to verify if Zend\View\Helper\Navigation\Breadcrumbs::line#113 is actually parsed when you load your breadcrumbs. At least this one.

You can also check the method htmlify of AbstractHelper to test if the translator is enabled.