https://github.com/php-translation/loco-adapter

Adapter for Localise.biz
https://github.com/php-translation/loco-adapter

Last synced: about 1 year ago
JSON representation

Adapter for Localise.biz

• Host: GitHub
• URL: https://github.com/php-translation/loco-adapter
• Owner: php-translation
• License: mit
• Created: 2016-12-14T19:34:25.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T10:50:05.000Z (over 2 years ago)
• Last Synced: 2025-03-31T09:04:55.150Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 63.5 KB
• Stars: 25
• Watchers: 5
• Forks: 36
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Adapter for Loco

[![Latest Version](https://img.shields.io/github/release/php-translation/loco-adapter.svg?style=flat-square)](https://github.com/php-translation/loco-adapter/releases)

[![Total Downloads](https://img.shields.io/packagist/dt/php-translation/loco-adapter.svg?style=flat-square)](https://packagist.org/packages/php-translation/loco-adapter)

This is an PHP-translation adapter for Loco ([Localise.biz](https://localise.biz/)).

### Install

```bash

composer require php-translation/loco-adapter

```

##### Symfony bundle

If you want to use the Symfony bundle you may activate it in kernel:

```php

// app/AppKernel.php

public function registerBundles()

{

    $bundles = array(

        // ...

        new Translation\PlatformAdapter\Loco\Bridge\Symfony\TranslationAdapterLocoBundle(),

    );

}

```

If you have one Loco project per domain you may configure the bundle like this:

```yaml

# /app/config/config.yml

translation_adapter_loco:

  index_parameter: 'id' # 'text' or 'name'. Leave blank for "auto"  See https://localise.biz/api/docs/export/exportlocale

  projects:

    messages:

      api_key: 'foobar'

    navigation:

      api_key: 'bazbar'

      status: '!untranslated,!rejected' # if you want filter on loco translations statuses. By default only 'translated' translations are pulled.

```

If you just doing one project and have tags for all your translation domains you may use this configuration:

```yaml

# /app/config/config.yml

translation_adapter_loco:

  index_parameter: 'id' # 'text' or 'name'. Leave blank for "auto"  See https://localise.biz/api/docs/export/exportlocale

  projects:

    acme:

      api_key: 'foobar'

      domains: ['messages', 'navigation']

```

This will produce a service named `php_translation.adapter.loco` that could be used in the configuration for

the [Translation Bundle](https://github.com/php-translation/symfony-bundle).

If you need to override the [HTTPlug client](http://docs.php-http.org/en/latest/integrations/symfony-bundle.html#configure-clients):

```yaml

# /app/config/config.yml

translation_adapter_loco:

  httplug_client: httplug.client.loco

  # You can even customize the message and uri factory

  # httplug_message_factory: null

  # httplug_uri_factory: null

httplug:

  clients:

    loco:

      factory: 'httplug.factory.guzzle6'

      plugins:

        - httplug.plugin.content_length

        - httplug.plugin.logger

      config:

        timeout: 2

```

By default it will use the discovery feature of HTTPlug.

### Documentation

Read our documentation at [http://php-translation.readthedocs.io](http://php-translation.readthedocs.io/en/latest/).

### Contribute

Do you want to make a change? Pull requests are welcome.