8000 [FrameworkBundle] Add default translations path option and convention by yceruto · Pull Request #24860 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[FrameworkBundle] Add default translations path option and convention #24860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2017

Conversation

yceruto
Copy link
Member
@yceruto yceruto commented Nov 7, 2017
Q A
Branch? 3.4
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets -
License MIT
Doc PR ToDo

Similar to Twig default path, this proposal adds a default_path option under translator config:

framework:
    translator:
        default_path: '%kernel.project_dir%/config/translations'

adding this default path to the discovered translations dirs. Thus, overriding bundle translations is possible by using this new convention: config/translations/<BundleName>/messages.en.xlf.

Also a new container parameter %translator.default_path% is defined by external purpose (similar to #24840)

Note: The current convention %kernel.root_dir%/Resources/translations path has priority over the new one.

TODO:

  • Add more tests about the new path
  • Update changelog

@yceruto
Copy link
Member Author
yceruto commented Nov 7, 2017

Having this in 3.4/4.0 could be awesome but I guess it doesn't qualify, right?

@yceruto
Copy link
Member Author
yceruto commented Nov 10, 2017

Any opinion on this? I'd like to finish it :)

@fabpot
Copy link
Member
fabpot commented Nov 10, 2017

It does qualify. LGTM.

@fabpot
Copy link
Member
fabpot commented Nov 10, 2017

Wouldn't it be "better" to move them to config/translations? Like for serialization and validation configs?

@yceruto yceruto changed the base branch from master to 3.4 November 10, 2017 20:06
@yceruto yceruto force-pushed the translations_default_path branch from dee7d07 to 01dbc55 Compare November 10, 2017 20:13
@yceruto yceruto force-pushed the translations_default_path branch from 01dbc55 to 1a8b1b4 Compare November 10, 2017 20:14
@yceruto
Copy link
Member Author
yceruto commented Nov 11, 2017

Great! ready :)

@fabpot
Copy link
Member
fabpot commented Nov 11, 2017

Thank you @yceruto.

@fabpot fabpot merged commit 1a8b1b4 into symfony:3.4 Nov 11, 2017
fabpot added a commit that referenced this pull request Nov 11, 2017
… and convention (yceruto)

This PR was merged into the 3.4 branch.

Discussion
----------

[FrameworkBundle] Add default translations path option and convention

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | ToDo

Similar to Twig default path, this proposal adds a `default_path` option under `translator` config:
```yaml
framework:
    translator:
        default_path: '%kernel.project_dir%/config/translations'
```
adding this default path to the discovered translations dirs. Thus, overriding bundle translations is possible by using this new convention: `config/translations/<BundleName>/messages.en.xlf`.

Also a new container parameter `%translator.default_path%` is defined by external purpose (similar to #24840)

Note: The current convention `%kernel.root_dir%/Resources/translations` path has priority over the new one.

TODO:
- [x] Add more tests about the new path
- [x] Update changelog

Commits
-------

1a8b1b4 Add default translations path option and convention
@ogizanagi
Copy link
Contributor
ogizanagi commented Nov 11, 2017

Do we want to reflect this change in the existing translation recipe or create a new one for 3.4 (so we can even remove the framework.translator.paths line)?

@fabpot
Copy link
Member
fabpot commented Nov 11, 2017

@ogizanagi Let's update the current recipe to point to the "right" directory. Can you submit a PR?

@ogizanagi
Copy link
Contributor

Sure. Done in symfony/recipes#249

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0