Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maschmann/translationloaderbundle
Symfony2 bundle with database translation loader
https://github.com/maschmann/translationloaderbundle
bundle php symfony symfony-bundle
Last synced: about 2 months ago
JSON representation
Symfony2 bundle with database translation loader
- Host: GitHub
- URL: https://github.com/maschmann/translationloaderbundle
- Owner: maschmann
- Created: 2013-12-22T11:21:29.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-24T06:16:55.000Z (over 4 years ago)
- Last Synced: 2024-08-19T06:39:48.359Z (4 months ago)
- Topics: bundle, php, symfony, symfony-bundle
- Language: PHP
- Size: 316 KB
- Stars: 23
- Watchers: 4
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
TranslationLoaderBundle
=========
[](https://travis-ci.org/maschmann/TranslationLoaderBundle)
[](https://packagist.org/packages/asm/translation-loader-bundle)
[](https://packagist.org/packages/asm/translation-loader-bundle)
[](https://scrutinizer-ci.com/g/maschmann/TranslationLoaderBundle/?branch=master)
[](https://insight.sensiolabs.com/projects/11ee80ea-d70f-41f6-84e6-31a71411c7e8)
[](http://knpbundles.com/maschmann/TranslationLoaderBundle) [](http://phpci.br0ken.de)
TranslationLoaderBundle allows you to do several cool things with your symfony standard edition translations. It relies mostly on the Translator component and doctrine.
So you can...
- import all your bundle's translations (if they are in the default path)
- export all translations in your preferred format
- add translations via commandline
Installation
----------
1. Add `asm/translation-loader-bundle` as a dependency of your project:
```bash
$ composer require asm/translation-loader-bundle "~1.0"
```
1. Register the bundle in the kernel:
```php
// app/AppKernel.php
// ...
public function registerBundles()
{
$bundles = array(
// ...
new Asm\TranslationLoaderBundle\AsmTranslationLoaderBundle(),
);
return $bundles;
}
```
1. If you want the admin gui, add routing config:
```yaml
# app/config/routing.yml
asm_translation_loader.gui:
resource: "@AsmTranslationLoaderBundle/Resources/config/routing.yml"
prefix: /translation
```
How does it work?
----------
It's quite simple.
For every cache clear you do, the translation dumper is generating a MessageCatalogue in your cache directory from which the application later retrieves all your translations and according fallbacks. So far, so good... We're not changing that but moving the translations from files to a flat database table, so they're (in some cases) easier to change and maintain.
After installing and following the setup steps, your cache MessageCatalogue will be created directly from the database.
Getting started
----------
###EntityManager
You can tell the bundle to use an EntityManager other than your default manager.
Therefore you need to add a configuration node to your app/config/config.yml
```yml
asm_translation_loader:
driver: orm
database:
entity_manager: # default: null
```
###History
If enabled, the history feature listens on doctrine actions and adds an entry for each change, adding the name of the currently logged-in user.
```yml
asm_translation_loader:
history: true # default false
```
###Setup the translation table
```sh
php app/console doctrine:schema:update --force
```
This will create the translation table for you, so you can start importing.
###Importing all translations to database
```sh
php app/console asm:translations:import
```
__Be careful:__ The import might take a while, since the process checks for each translation if it's already present and then either inserts or updates. I'm open to suggestions here ;-)
This command also has a "-c" so you can clear the database first. might be a bit faster for larger imports if your table is already filled.
###Generate dummy translation files or using configuration
```sh
php app/console asm:translations:dummy
```
Since the TranslationLoader bases on files, you'd have to create empty files like "messages.en_US.db" for each language you want to use with your translation database. I have not yet found a nice way around that, so for the time being, you can use the dummy file generator which creates such a file for each message domain/locale you have in your db. The files will be placed in app/Resources/translations/*
The other option is configuring the loader for specific locales and message domains:
```yml
asm_translation_loader:
resources:
fr: [ foo, bar ]
de: baz
en: ~
driver: orm
history: true # default false
database:
entity_manager: default
```
###Delete your old translation files
After checking your translation table, you should delete all translation files from your custom bundle's directories.
Type a short
```sh
php app/console ca:cl
```
and check your symfony cache dir for the brand new MessageCatalogue we've now filled from the db :-)
###Funstuff
If you're tired of database-translations, don't despair: Just use the file dumper and re-generate your files!
```sh
php app/console help asm:translations:dump
```
Check out your translation files in app/Resources/translations and if you remove all *.db files, your're back on file-mode!
###Testing
I've not yet completed my test-setup and be glad to get a little contribution here ;-)
Contributions
---------
Great thanks got to xabbuh for supporting with refactorings and testing (implementation)!
Anyone who wants to contribute is greatly welcome!
License
----
AsmTranslationLoaderBundle is licensed under the MIT license. See the [LICENSE](Resources/meta/LICENSE) for the full license text.
**Free Software, Hell Yeah!**