Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wickedone/phrase-translation-provider
symfony phrase translation provider
https://github.com/wickedone/phrase-translation-provider
phrase symfony translation-providers
Last synced: about 2 months ago
JSON representation
symfony phrase translation provider
- Host: GitHub
- URL: https://github.com/wickedone/phrase-translation-provider
- Owner: wickedOne
- License: mit
- Created: 2022-12-25T07:51:52.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-18T05:46:52.000Z (7 months ago)
- Last Synced: 2024-05-21T13:06:14.525Z (7 months ago)
- Topics: phrase, symfony, translation-providers
- Language: PHP
- Homepage:
- Size: 857 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# phrase-translation-provider
symfony phrase translation provider bridge
[](https://dashboard.stryker-mutator.io/reports/github.com/wickedOne/phrase-translation-provider/master)
[](https://codecov.io/gh/wickedOne/phrase-translation-provider)
[](https://shepherd.dev/github/wickedOne/phrase-translation-provider)
[](https://packagist.org/packages/wickedone/phrase-translation-provider)
[](https://packagist.org/packages/wickedone/phrase-translation-provider)
[](https://packagist.org/packages/wickedone/phrase-translation-provider)
[](https://packagist.org/packages/wickedone/phrase-translation-provider)
> :warning: this translation provider [has been integrated](https://github.com/symfony/phrase-translation-provider) into symfony starting at version 6.4.
> this repository will be archived once [lts expires](https://symfony.com/releases/5.4) for symfony 5.4
## installation
```bash
composer require wickedone/phrase-translation-provider
```
## dsn example
```dotenv
PHRASE_DSN=phrase://PROJECT_ID:API_TOKEN@default?userAgent=myProject
```
### dsn elements
- `PROJECT_ID`: can be retrieved in phrase from `project settings > API > Project ID`
- `API_TOKEN`: can be created in your [phrase profile settings](https://app.phrase.com/settings/oauth_access_tokens)
- `default`: endpoint, defaults to `api.phrase.com`
### required dsn query parameters
- `userAgent`: please read [this](https://developers.phrase.com/api/#overview--identification-via-user-agent) for some examples.
see [fine tuning your phrase api calls](#fine-tuning-your-phrase-api-calls) for additional dsn options
## service phrase provider
in your `services.yaml` add the following to enable the phrase provider.
```yaml
Symfony\Component\Translation\Bridge\Phrase\PhraseProviderFactory:
tags: ['translation.provider_factory']
arguments:
$defaultLocale: '%kernel.default_locale%'
$loader: '@translation.loader.xliff'
$xliffFileDumper: '@translation.dumper.xliff'
$cache: '@cache.app'
```
and in your `translations.yaml` you can add:
```yaml
framework:
translator:
providers:
phrase:
dsn: '%env(PHRASE_DSN)%'
domains: ~
locales: ~
```
## phrase locale names
translations being imported using the symfony xlf format in phrase, locales are matched on locale name in phrase.
therefor it's necessary the locale names should be as defined in [RFC4646](https://www.ietf.org/rfc/rfc4646.txt) (e.g. pt-BR rather than pt_BR).
not doing so will result in phrase creating a new locale for the imported keys.
## locale creation
if you define a locale in your `translation.yaml` which is not configured in your phrase project, it will be automatically created. deletion of locales however, is (currently) not managed by this provider.
## domains as tags
translations will be tagged in phrase with the symfony translation domain they belong to.
check the [wickedone/phrase-tag-bundle](https://github.com/wickedOne/phrase-tag-bundle) if you need help managing your tags in phrase
## cache
the read responses from phrase are cached to speed up the read and delete method of this provider.
therefor the factory should be initialised with a PSR-6 compatible cache adapter.
## events
to enable you to perform post-processing on translation values and / or keys, two events are dispatched by this provider class.
### PhraseReadEvent
_after_ reading the catalogue from phrase, the resulting `TranslatorBag` is dispatched in a `PhraseReadEvent` prior to being returned from the read method.
### PhraseWriteEvent
_before_ writing the catalogue to phrase, the `TranslatorBag` is dispatched in a `PhraseWriteEvent`.
## fine tuning your phrase api calls
you can fine tune the read and write methods of this provider by adding query parameters to your dsn configuration.
general usage is `read|write[option_name]=value`
**example:** `phrase://PROJECT_ID:API_TOKEN@default?read[encoding]=UTF-8&write[update_descriptions]=0`
see tables below for available options and, if applicable, their default values.
### read
in order to read translations from phrase the [download locale](https://developers.phrase.com/api/#get-/projects/-project_id-/locales/-id-/download) call is made to the phrase api. this call provides the following options.
| name | type | default value | comment |
|-----------------------------------|:------:|:----------------:|-------------------------------------------------------------------------------------|
| `branch` | string | | |
| `include_empty_translations` | bool | 1 | |
| `exclude_empty_zero_forms` | bool | | |
| `include_translated_keys` | bool | | |
| `keep_notranslate_tags` | bool | | |
| `format_options` | array | enclose_in_cdata | | |
| `encoding` | string | | | |
| `skip_unverified_translations` | bool | | | |
| `include_unverified_translations` | bool | | | |
| `use_last_reviewed_version` | bool | | | |
| `fallback_locale_enabled` | bool | 0 | when the fallback locale is enabled, caching responses from phrase will be disabled |
### write
in order to write translations to phrase the [upload](https://developers.phrase.com/api/#post-/projects/-project_id-/uploads) call is made to the phrase api. this call provides the following options.
| name | type | default value | comment |
|-----------------------|:------:|:-------------:|---------|
| `update_translations` | bool | 1 | |
| `update_descriptions` | bool | | |
| `skip_upload_tags` | bool | | |
| `skip_unverification` | bool | | |
| `file_encoding` | string | | |
| `locale_mapping` | array | | |
| `format_options` | array | | |
| `autotranslate` | bool | | |
| `mark_reviewed` | bool | | |