[Translation] added method to expose collected message #9859

Grygir · 2013-12-25T14:10:01Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	no
Fixed tickets	#2435
License	MIT
Doc PR	symfony/symfony-docs#3386

jakzal · 2013-12-26T08:53:14Z

@Grygir there's no need to create a new PR. You could've just pushed to your branch and PR would be updated.

You have to merge master into your branch and resolve conflicts.

Please add a PR description with a table.

Grygir · 2013-12-26T10:46:00Z

@jakzal thanks. That was a bit misunderstanding from my side.

I've applied all changes for comments from #8597 and created a paragraph in symfony/symfony-docs#3386.

fabpot · 2013-12-28T07:28:55Z

@Grygir You should remove the merge commit (squashing you commits would help here).

fabpot · 2013-12-28T07:29:29Z

src/Symfony/Component/Translation/Translator.php

@@ -222,6 +222,56 @@ public function transChoice($id, $number, array $parameters = array(), $domain =
        return strtr($this->selector->choose($catalogue->get($id, $domain), (int) $number, $locale), $parameters);
    }

+    /**
+     * Messages exposing


Should be something like: Collects all messages.

Grygir · 2014-01-08T10:00:23Z

@fabpot thanks, all commented issues are fixed.

piotrpasich · 2014-01-08T10:04:01Z

src/Symfony/Component/Translation/Translator.php

+
+        $domains = array_flip($domains);
+        $messages = array();
+        for ($i = count($catalogues) - 1; $i >= 0; $i--) {


is it a good idea to do it with for? not foreach? You have flipped $domains and left $catalogues

$domains is usually small array (several items) and $catalogues is often quite big. So the for-loop is used here (instead of array_flip + foreach-loop) in only matter of performance.

aitboudad · 2014-01-14T09:25:21Z

You should update the CHANGELOG file (in the component dir)

Grygir · 2014-01-15T09:23:58Z

@aitboudad, do I understand correctly, this note should be in a section related to the coming version (2.5.0)?

aitboudad · 2014-01-15T10:18:45Z

@Grygir yes https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Translation/CHANGELOG.md

Grygir · 2014-01-15T10:29:10Z

@aitboudad, done, thanks

wouterj · 2014-07-24T12:20:04Z

@fabpot is there any change this can be merged?

@Grygir you have to rebase this PR, there are merge conflicts now.

Grygir · 2014-07-24T14:02:13Z

@wouterj pull request is updated, thanks

wouterj · 2014-07-24T14:23:47Z

👍 great!

fabpot · 2014-07-24T14:28:25Z

src/Symfony/Component/Translation/Translator.php

+     *
+     * @return array
+     */
+    public function exposeMessages(array $domains = array(), $locale = null)


I don't really like the exposeMessages() name. What about just getMessages()?

Grygir · 2014-07-24T17:16:56Z

@fabpot thank you, all comments are fixed (related symfony-docs pull request is updated as well)

fabpot · 2014-07-24T17:47:56Z

👍

wouterj · 2014-07-24T17:49:19Z

Great work, @fabpot, nice to see this one picked up that fast!

sstok · 2014-07-24T18:44:47Z

👍

Tobion · 2014-07-24T19:34:33Z

src/Symfony/Component/Translation/Translator.php

+     *
+     * @return array
+     */
+    public function getMessages(array $domains = null, $locale = null)


I don't see any difference between passing array() and null for domains. Then I would just use array $domains = array() without null.

I see @fabpot suggested that. But I don't agree with that. First of all, it makes the argument type dynamic and secondly, there is no semantic difference.

So when you see code like

$translator->getMessages(array()); $translator->getMessages(null);

you would think both do something different and look at the implementation what the difference is. But in fact it's the same.

@Tobion agree with you. That how I first time made. Then @fabpot asked to change. But I think it's not critical. Both variants are fine for me.

Whatever. Use array() if you want to, I don't really care.

Please note what the default means: every domain. It seems wrong to use every domain if you pass an empty list. Null stands for no argument, if you pass no argument to domain, it seems logical to get all domains.

@wouterj It's perfectly right to get every domain if you pass an empty list. The argument filters the required domains (see phpdoc), i.e. an empty filter will return everything. Pretty logical.
Btw, it's the same as in Route::setSchemes.

What I also find bad is that you can get all messages for all domains, but not for all locales.
I'd propose to simply remove the domains parameter. The logic that it implements can simply be done by the user. And the method should only have a single responsibility, and that is not filtering domains.

@Tobion Frankly, don't see anything bad of allowing to filter messages at the fetch method. It looks natural for me. Confident, that other developers will find it usefull.

Regarding "null vs. array()", I'm like 45/55. Your argument

to get every domain if you pass an empty list.

seems reasonable for me. That's how most UI filters works "empty filter list --> all records". That's why, have implemented it this way first time. But, really don't see a big deal to use null for all messages. There's only matter of integrity and consistency, and IMHO array() fits more those requirements.

Yes it might be useful, but everything is useful for someone. The point is,

it violates single responsibility

is really simply to do in user-land, just `$messages['mydomain']

@Tobion, you are definitely right. It won't be hard to pick proper domains by array's keys in afterwords. I've updated the method, the test and documentation as well.
Thank you.

wouterj · 2014-07-25T08:50:52Z

👍 thanks @Grygir (although I have no vote permission)

Tobion · 2014-08-15T17:23:26Z

src/Symfony/Component/Translation/Translator.php

+     *
+     * @param string|null $locale  Locale of translations, by default is current locale
+     *
+     * @return array


Missing description that it returns array[array] indexed by catalog.

Tobion · 2014-08-16T16:45:08Z

Apart from the phpdoc above, 👍

Grygir · 2014-08-18T13:13:19Z

@Tobion, thank you. Done.

jakzal · 2014-08-19T16:57:48Z

src/Symfony/Component/Translation/Tests/TranslatorTest.php

+    public function testGetMessages($resources, $locale, $expected)
+    {
+        $locales = array_keys($resources);
+        $_locale = !is_null($locale) ? $locale : reset($locales);


Why is this calculated instead of setting the value explicitly in the data provider?

fabpot · 2014-08-27T12:55:45Z

Thank you @Grygir.

…(Grygir) This PR was merged into the 2.6-dev branch. Discussion ---------- [Translation] added method to expose collected message | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | #2435 | License | MIT | Doc PR | symfony/symfony-docs#3386 Commits ------- ef5d7c5 [Translation] added method to expose collected messages

…(Grygir) This PR was merged into the master branch. Discussion ---------- [Translation] added method to expose collected message | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#9859) | Applies to | all (or 2.4+) | Fixed tickets | Commits ------- f701f73 [Translation] added method to expose collected message

jakzal mentioned this pull request Dec 26, 2013

[Translation] added method to expose collected message #8597

Closed

Grygir mentioned this pull request Dec 26, 2013

[Translation] added method to expose collected message symfony/symfony-docs#3386

Merged

fabpot reviewed Dec 28, 2013
View reviewed changes

piotrpasich reviewed Jan 8, 2014
View reviewed changes

fabpot reviewed Jul 24, 2014
View reviewed changes

Tobion reviewed Jul 24, 2014
View reviewed changes

fabpot mentioned this pull request Jul 25, 2014

[Translator] [FrameworkBundle] Translation loader - ignore locale #9225

Closed

Tobion reviewed Aug 15, 2014
View reviewed changes

[Translation] added method to expose collected messages

ef5d7c5

jakzal reviewed Aug 19, 2014
View reviewed changes

fabpot merged commit ef5d7c5 into symfony:master Aug 27, 2014

Tobion mentioned this pull request Sep 22, 2014

[Translation] added LoggingTranslator. #10887

Closed

aitboudad mentioned this pull request Sep 24, 2014

[Translation][changelog] fix typo. #12011

Merged

stof mentioned this pull request May 4, 2015

[Translation] Translator::getMessages() is not part of an interface #14529

Closed

[Translation] added method to expose collected message #9859

[Translation] added method to expose collected message #9859

Conversation

Grygir commented Dec 25, 2013

jakzal commented Dec 26, 2013

Grygir commented Dec 26, 2013

fabpot commented Dec 28, 2013

Choose a reason for hiding this comment

Grygir commented Jan 8, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aitboudad commented Jan 14, 2014

Grygir commented Jan 15, 2014

aitboudad commented Jan 15, 2014

Grygir commented Jan 15, 2014

wouterj commented Jul 24, 2014

Grygir commented Jul 24, 2014

wouterj commented Jul 24, 2014

Choose a reason for hiding this comment

Grygir commented Jul 24, 2014

fabpot commented Jul 24, 2014

wouterj commented Jul 24, 2014

sstok commented Jul 24, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Jul 25, 2014

Choose a reason for hiding this comment

Tobion commented Aug 16, 2014

Grygir commented Aug 18, 2014

Choose a reason for hiding this comment

fabpot commented Aug 27, 2014