Download the PHP package kunstmaan/translator-bundle without Composer
On this page you can find all versions of the php package kunstmaan/translator-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kunstmaan/translator-bundle
More information about kunstmaan/translator-bundle
Files in kunstmaan/translator-bundle
Package translator-bundle
Short Description A bundle which enables editing translations in the admin interface without need for editing the translations files. Translations will be stored in a (default) database and retrieved on the most efficient way possible.
License MIT
Homepage https://github.com/Kunstmaan/KunstmaanTranslatorBundle
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package translator-bundle
KunstmaanTranslatorBundle
A bundle which enables editing translations in the admin interface without need for editing the translations files. Translations will be stored in a (default) database and retrieved on the most efficient way possible.
Installation requirements
You should be able to get Symfony >=2.3 up and running before you can install the KunstmaanTranslatorBundle.
Installation instructions
Assuming you have installed composer.phar or composer binary:
Add the KunstmaanTranslatorBundle to your AppKernel.php file:
Add the KunstmaanTranslatorBundle to your routing.yml. Take your own routing into account, it's possible you will need to add the following code prior to your own routing configurations
Configuration
Overwrite the KunstmaanTranslatorBundle config to your needs in config.yml, these are the default values:
- : Enabled or disable the KunstmaanTranslatorBundle
- : Which bundles are used for the import functionality in the backend. Possible values: 'own', 'all', 'custom'.
- own : All bundles in your src directory
- all : All bundles in your src directory + all bundles in your vendor directory
- custom : Only the bundles you specify in
bundles
- : A list of bundles that will be used for the import functionality in the backend. Only used when
default_bundleis set to 'custom'. - : Cached translations dir
- : Which locale translation files should be imported
- : Which type of translation files should be imported
- : When debug is enabled the translation caching is disabled
Example configurations:
Database schema
Update your database schema with doctrine
Migrate dev translations to production
Use the following command to generate a doctrine migration with all new and updated translations from your current environment.
When you want to include these migrated translations into your (other) environment use the normal doctrine migrate command.
Import existing translation files
When migrating your current project you can easily import the existing translation files.
Without parameters, all translations, locales from the current main project will be included.
If you have already existing translations in the database with the same combination of 'domain', 'keyword', 'locale', non of them will be overwritten
To force overwrite the existing translations in the stasher:
To import translations from a specific bundle:
To import only specific locales:
To import translations from the global Resources (app/Resources/translations)
How does the cache work
Translations are stored in a database, but cached (as Symfony normally does) when not running in debug mode.
When editing translations in the backend changes aren't immediately visible on your website.
The backend will show a warning message when not newer or updated translations aren't loaded into the cache.
Click on the Refresh live button to rebuild the cache.
Clear cache and request status
Clear translation cache files, this will trigger a rebuild of the translation cache when visiting a page
Request status of the current cache
Reset translation flags
When all translations are up to date, e.g when migrated all develop translations into production. You need to reset all the flags which mark translations as new or updated. Otherwise already migrated translations will be added into later migrations again (which can cause errors with inserts and unique keys)
Lookup keyword/domain of your translations
You probably don't always remember which keyword and/or domain your translations on specific pages are using. To solve this problem you can add an extra GET parameter to your request. Add ?transSource=1 to your url to see all sources of the translated labels.
You instead of "Hello world" you might see header.hello_world (messages). This means:
- keyword is header.hello_world
- domain is messages
Symfony Profiler integration
The Symfony Profiler show the number of translations used on the current request:
When you click on this item, you can see all translations used on the current request and a link to add or edit them in the Kunstmaan Admin backend.
Workflow example (new project)
- Add translations (with keywords) in your template files (dev)
- Add the translations of (1) into your backend via "Add Translation" (dev)
- Repeat 1 & 2
- Create migrations diff
bin/console kuma:translator:migrations:diff(dev) - Reset translation flags
bin/console kuma:translator:flag --reset(dev) - Deploy your application
- Execute doctrine migrations
bin/console doctrine:migrations:migrate(prod) - Edit/add translations (prod)
- When ready editing/adding, click
Refresh liveorbin/console kuma:translator:cache --flush(prod) - Repeat 7 & 8 when editing/adding translations in prod
Workflow example (existing project)
- Import current translations, click
Import -> Importorbin/console kuma:translator:import(prod/dev) - If you did 1 in dev, go to 4 of
"Workflow example (new project)", otherwise go to 7"Workflow example (new project)"
Features
- Import bundle/global translations from any type of translation file
- Import only specific translations (onlu from console command)
- Force import to overwrite existing translations with same domain/keyword/locale
- Edit stored translations from the backend interface
- Add new translations from the backend interface
- Translations are cached (if debug is disabled)
- Warning when cached translations aren't up to date with the stored translations
- Clear translation cache to rebuild translations from the stored translations
- Newer or updated translations are flagged
- Create a Doctrine Migrations file with all flagged translations
- Reset all flagged translations (from console command)
- Clear and check translation cache from console command
- Check your page with the keyword and domain of all translations
Development instructions
Run unit tests
Run PHP CS Fixer, after installing php-cs-fixer system wide
How to create your own file exporter
- Tag your exporter with `translation.exporter
- implement \Kunstmaan\TranslatorBundle\Service\Exporter\FileExporterInterface
NOTE : exporting isn't stable (yet)
