I18n - Allow custom translation loaders to be injected via module config #6244 #6246

rodmcnew · 2014-05-08T20:17:38Z

This change allows modules to add their own translation loaders to the I18n translator via config like this:

'translator_loaders' => array(
    'factories' => array(
        'my_new_loader' => 'ZendI18nDoctrineLoader\Factory\LoaderFactory',
    )
),

Before there was no way to add translation loaders without defining your own new translator service. See the ticket for more details: #6244

…nfig zendframework#6244

samsonasik · 2014-05-08T21:30:36Z

library/Zend/Mvc/Service/TranslatorLoaderManagerFactory.php

+namespace Zend\Mvc\Service;
+
+
+class TranslatorLoaderManagerFactory extends AbstractPluginManagerFactory


to make consistent, I think we should avoid wording "Loader" like ControllerLoader that will be replaced with ControllerManager in ZF3. see #4962

rodmcnew · 2014-05-08T22:07:05Z

Samsonasik,

I agree that the word "loader" is confusing but I don't know what word would be a better substitute in this case. In ZF2 I18n, there is the FileLoaderInterface and RemoteLoaderInterface and this service manager is a container that contains only classes that are translation "Loaders".

public function validatePlugin($plugin)
    {
        if ($plugin instanceof Loader\FileLoaderInterface || $plugin instanceof Loader\RemoteLoaderInterface) {
            // we're okay
            return;
     }

The most important element of this PR is the config key that is being added. Currently I have it named "translator_loaders" and it is a place where you can specify your own translation loaders. Does anyone have an idea for a better name?

rodmcnew · 2014-05-08T22:08:38Z

Perhaps changing the name to "translator_plugins" is more inline with the framework?

samsonasik · 2014-05-08T22:21:21Z

I'm personally 👍 for 'translator_plugins'

rodmcnew · 2014-05-08T23:28:56Z

I renamed the translation loaders to plugins:

'TranslatorPluginManager',
'translator_plugins',
'Zend\ModuleManager\Feature\TranslatorPluginProviderInterface',
'getTranslatorPluginConfig'

Ocramius · 2014-07-28T00:27:41Z

tests/ZendTest/Mvc/Service/TranslatorServiceFactoryTest.php


        $translator = $this->factory->createService($serviceLocator);
        $this->assertInstanceOf('Zend\Mvc\I18n\Translator', $translator);
        $this->assertInstanceOf('Zend\I18n\Translator\Translator', $translator->getTranslator());

+        //#6244


Use a new test and mark it as /** @group 6244 */ instead

adamlundrigan · 2014-11-17T19:12:29Z

Is there a consensus on adding this? If so, @rodmcnew you'll need to add a blurb to the documentation about this feature to the appropriate page (PR to https://github.com/zendframework/zf2-documentation)

rodmcnew · 2014-12-02T18:43:32Z

Sorry for the slow response. I wasn't getting mail notifications from Github so I didn't see the activity on this PR. I have updated this PR per everyone's requests. Please pull it or let me know if any other changes should be made. Thanks for the feedback everyone.

If this is pulled I will add a PR to add to the docs. I think this should be added to the "Configuration mapping table" table near the bottom of http://framework.zend.com/manual/2.2/en/tutorials/config.advanced.html

The Travis Build failed but it doesn't appear to be due to this PR so I'm not sure what I can do to fix that. It failed on "ZendTest\Cache\Storage\Adapter\FilesystemTest::testTouchItem"

rodmcnew · 2014-12-02T21:55:12Z

The build passed

DASPRiD · 2014-12-02T21:58:17Z

tests/ZendTest/Mvc/Service/TranslatorServiceFactoryTest.php

@@ -107,11 +150,14 @@ public function testReturnsTranslatorBasedOnConfigurationWhenNoTranslatorInterfa
        //get any plugins with AbstractPluginManagerFactory
        $routePluginManagerFactory = new RoutePluginManagerFactory;
        $routePluginManager = $routePluginManagerFactory->createService($serviceLocator);
+        $this->assertInstanceOf(


How's this relevant for this PR?

In my original PR I removed the unused var $routePluginManager leaving L152 as:
$routePluginManagerFactory->createService($serviceLocator);

@Ocramius suggested that we keep the var and assert on it.

After looking at this more, my personal opinion is that we are in the test for the TranslatorServiceFactory and should not be doing assertions against the RoutePluginManagerFactory's functionality.

If clean code is more important, I think the best thing to do is to remove this assertion and remove the unused $routePluginManager var. If PR relevance is more important, I could remove all changes to this test from this PR, leaving unused $routePluginManager var intact.

rodmcnew · 2014-12-04T18:11:09Z

@DASPRiD I fixed your two concerns and the build is passing.

I fixed my added test so it is now properly testing the following line that is inside the TranslatorServiceFactory
$i18nTranslator->setPluginManager($serviceLocator->get('TranslatorPluginManager'));

I removed the changes to the unrelated test that you pointed out.

malukenho · 2014-12-04T18:13:13Z

library/Zend/ModuleManager/Feature/TranslatorPluginProviderInterface.php

+interface TranslatorPluginProviderInterface
+{
+    /**
+     * Expected to return \Zend\ServiceManager\Config object or array to


redundancy with documentation @return

I used the same doc block on this that is used in the rest of the framework for provider interfaces. Examples include the ControllerPluginProviderInterface and FilterProviderInterface among many others.

@rodmcnew Okay. Thanks for the explanation.

rodmcnew · 2015-01-12T16:33:11Z

Closing and opening PR to trigger travis rebuild...

rodmcnew · 2015-01-12T16:34:18Z

The build failed in the following file which I don't believe has anything to do with this PR. Is there a way for me to trigger a Travis Rebuild?

/home/travis/build/zendframework/zf2/tests/ZendTest/Cache/Storage/Adapter/CommonAdapterTest.php:862

Ocramius · 2015-01-12T16:46:39Z

@rodmcnew that's (sadly) a test that fails every time the I/O is very slow in the travis infrastructure.

rodmcnew · 2015-01-12T16:58:40Z

I see, thanks @Ocramius.

weierophinney · 2015-02-19T22:45:14Z

library/Zend/Mvc/Service/ServiceListenerFactory.php

@@ -59,6 +59,7 @@ class ServiceListenerFactory implements FactoryInterface
            'InputFilterManager'             => 'Zend\Mvc\Service\InputFilterManagerFactory',
            'LogProcessorManager'            => 'Zend\Mvc\Service\LogProcessorManagerFactory',
            'LogWriterManager'               => 'Zend\Mvc\Service\LogWriterManagerFactory',
+            'TranslatorPluginManager'        => 'Zend\Mvc\Service\TranslatorPluginManagerFactory',


We try to keep these alphabetized; I can make that change on merge, however.

…config I18n - Allow custom translation loaders to be injected via module config #6244 Conflicts: library/Zend/Mvc/Service/ServiceListenerFactory.php

- Removed extraneous line

Close #6246

weierophinney · 2015-02-19T22:52:07Z

Merged for 2.4.0; @rodmcnew , please do a PR against https://github.com/zendframework/zf2-documentation with documentation of this feature. :)

…4-translation-loaders-from-config I18n - Allow custom translation loaders to be injected via module config zendframework/zendframework#6244 Conflicts: library/Zend/Mvc/Service/ServiceListenerFactory.php

Close zendframework/zendframework#6246

Maks3w and others added 2 commits May 7, 2014 20:48

Merge pull request zendframework#6237 in master

369afb5

I18n - Allow custom translation loaders to be injected via module co…

81d05ee

…nfig zendframework#6244

samsonasik reviewed May 8, 2014
View reviewed changes

Rename to "translator_plugins" per samsonasik's request

cd76c0e

Ocramius added I18n and removed EventManager labels May 9, 2014

Ocramius reviewed Jul 28, 2014
View reviewed changes

EvanDotPro force-pushed the master branch from f77f90b to 21a17e5 Compare September 28, 2014 00:34

Ocramius added the awaiting author updates label Nov 14, 2014

Ocramius assigned DASPRiD Nov 27, 2014

rodmcnew added 7 commits December 2, 2014 11:14

chmod to undo erroneous file mode changes

9612002

remove file that should not be part of this PR

0914057

add additional assert per Ocramius's request

bc747f3

fix: add additional assert per Ocramius's request

7a12acd

format code per Ocramius's request

0f2dfe7

split out test per Ocramius's request

e1cfddb

remove erroneously add composer.phar

1a037ba

Ocramius removed the awaiting author updates label Dec 2, 2014

DASPRiD reviewed Dec 2, 2014
View reviewed changes

rodmcnew added 7 commits December 4, 2014 09:48

fix unit test for TranslatorServiceFactory

a976042

clean up comments

dda2cf6

fix code style

cfa2844

remove extra whitespace

048e921

undo change to unrelated test's whitespace

57ec126

clean up test

92ea143

remove unused use statement

b8d6105

malukenho reviewed Dec 4, 2014
View reviewed changes

rodmcnew added 2 commits January 7, 2015 14:46

fix copywrite date

83c3adf

fix copywrite date

e7fcfbc

rodmcnew closed this Jan 12, 2015

rodmcnew reopened this Jan 12, 2015

weierophinney reviewed Feb 19, 2015
View reviewed changes

weierophinney added a commit that referenced this pull request Feb 19, 2015

[#6246] CS fixes

ccbcd9c

- Removed extraneous line

weierophinney added a commit that referenced this pull request Feb 19, 2015

Merge branch 'feature/6246' into develop

049bcce

Close #6246

weierophinney closed this Feb 19, 2015

weierophinney added a commit to zendframework/zend-modulemanager that referenced this pull request May 15, 2015

Merge branch 'feature/6246' into develop

3bbc33b

Close zendframework/zendframework#6246

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

I18n - Allow custom translation loaders to be injected via module config #6244 #6246

I18n - Allow custom translation loaders to be injected via module config #6244 #6246

rodmcnew commented May 8, 2014

samsonasik May 8, 2014

rodmcnew commented May 8, 2014

rodmcnew commented May 8, 2014

samsonasik commented May 8, 2014

rodmcnew commented May 8, 2014

Ocramius Jul 28, 2014

adamlundrigan commented Nov 17, 2014

rodmcnew commented Dec 2, 2014

rodmcnew commented Dec 2, 2014

DASPRiD Dec 2, 2014

rodmcnew Dec 2, 2014

rodmcnew commented Dec 4, 2014

malukenho Dec 4, 2014

rodmcnew Dec 4, 2014

malukenho Dec 4, 2014

rodmcnew commented Jan 12, 2015

rodmcnew commented Jan 12, 2015

Ocramius commented Jan 12, 2015

rodmcnew commented Jan 12, 2015

weierophinney Feb 19, 2015

weierophinney commented Feb 19, 2015

		namespace Zend\Mvc\Service;


		class TranslatorLoaderManagerFactory extends AbstractPluginManagerFactory

I18n - Allow custom translation loaders to be injected via module config #6244 #6246

I18n - Allow custom translation loaders to be injected via module config #6244 #6246

Conversation

rodmcnew commented May 8, 2014

Choose a reason for hiding this comment

rodmcnew commented May 8, 2014

rodmcnew commented May 8, 2014

samsonasik commented May 8, 2014

rodmcnew commented May 8, 2014

Choose a reason for hiding this comment

adamlundrigan commented Nov 17, 2014

rodmcnew commented Dec 2, 2014

rodmcnew commented Dec 2, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodmcnew commented Dec 4, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodmcnew commented Jan 12, 2015

rodmcnew commented Jan 12, 2015

Ocramius commented Jan 12, 2015

rodmcnew commented Jan 12, 2015

Choose a reason for hiding this comment

weierophinney commented Feb 19, 2015