php-crowdin-api

A simple PHP Crowdin API client http://crowdin.net/page/api., _(*1)

Crowdin is a translation and localization management platform : http://crowdin.net/, _(*2)

FYI, an official and more complete Ruby Client exists here : https://github.com/crowdin/crowdin-api, _(*3)

, _(*4)

Features

PSR-2 conventions and coding standard, _(*5)

Wrap following API methods :, _(*6)

Add a file, delete a file
Add a directory, delete a directory, change a directory
Update File, Upload translations, Upload fresh version of your localization file
Export Translations, Build fresh package with the latest translations.
Download Translations, Download last exported translation package (one language or all languages as one zip file).
Supported Languages, Get supported languages list with Crowdin codes mapped to locale name and standardized codes.
Translation Status, Track overall translation and proofreading progress of each target language.
Project Info, Shows project details and meta information.

Missing API methods https://github.com/akeneo/php-crowdin-api/issues?q=is%3Aopen+is%3Aissue+label%3Aapi-method, _(*7)

Requirements

PHP >= 8.1
Docker for a better dev experience

How to use ?

Add the following lines in your project composer.json :, _(*8)

{
    "require": {
        "akeneo/crowdin-api": "^2.0.0"
    },
    "minimum-stability": "stable"
}

Then, to instantiate the client and use available API methods :, _(*9)

<?php
require 'vendor/autoload.php';

use Akeneo\Crowdin\Client;

$project = 'akeneo';
$key     = 'my-api-key';
$client  = new Client($project, $key);

// download last build package from Crowdin
$api = $client->api('download');
$api->setCopyDestination('/tmp/download-crowdin');
$api->setPackage('fr.zip');
$result = $api->execute();

// update a Crowdin file from local filesystem
$api = $client->api('update-file');
$localPath = '/home/nico/git/pim/src/Pim/Bundle/CatalogBundle/Resources/translations/messages.en.yml';
$crowdinPath = 'PimCommunity/CatalogBundle/Resources/translations/messages.en.yml';
$api->addTranslation($localPath, $crowdinPath);
$result = $api->execute();

Run tests

docker-compose run --rm php vendor/bin/php-cs-fixer fix --config=.php_cs.php --diff
docker-compose run --rm php vendor/bin/phpstan analyze src --level 5
docker-compose run --rm php vendor/bin/phpspec run

Use cases

You can take a look at following use cases to see more real life samples., _(*10)

The Akeneo core team uses this library in Nelson, a command based translation workflow between Crowdin and GitHub (cf https://github.com/akeneo/nelson)., _(*11)

The Sylius core team uses this library in SyliusBot to manage community translations https://github.com/SyliusBot/SyliusBot., _(*12)

If you use this library don't hesitate to open a PR to explain your use case here :), _(*13)

Licence

The MIT License (MIT), _(*14)

Contribution

Feel free to fork and propose PR to complete missing API methods https://github.com/akeneo/php-crowdin-api/issues?q=is%3Aopen+is%3Aissue+label%3Aapi-method, _(*15)

Any contributions are welcome!, _(*16)