mistralys / deepl-xml-translator
DeepL XML Translator.
Installs: 1 119
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 1
Requires
- ext-dom: *
- ext-openssl: *
- guzzlehttp/guzzle: ^7.4.2
- mistralys/application-utils: >=1.3.0
- scn/deepl-api-connector: dev-master
Requires (Dev)
- phpstan/phpstan: >=1.6.0
- phpunit/phpunit: >=9.5.20
README
DeepL XML Translator
This is a drop-in PHP helper class that can translate a bundle of strings, which may contain markup. It uses DeepL's XML translation feature, and is designed to be very easy to use.
Installation
Simply require the package in your project via Composer:
"require": { "mistralys/deepl-xml-translator" : "dev-master" }
See the packagist page: https://packagist.org/packages/mistralys/deepl-xml-translator
Usage
Create a new instance of the helper
$translator = new \DeeplXML\Translator( 'YourAPIKey', // the DeepL API key to use to connect 'EN', // source language 'DE' // target language );
Add strings to translate
$translator->addString('string1', 'Please translate me'); $translator->addString('string2', 'Please also translate me');
Fetch the translation
try { $translator->translate(); } catch(\DeeplXML\Translator_Exception $e) { // handle errors }
Access the translated strings
Retrieving all strings at once:
$strings = $translator->getStrings(); foreach($strings as $string) { $text = $string->getTranslatedText(); }
Retrieving specific strings by ID:
$string = $translator->getStringByID('string2'); $text = $string->getTranslatedText();
Ignoring parts of strings
To avoid parts of strings being translated, the characters to ignore can be specified as needed. They are replaced by placeholders by a simple search & replace before sending the translation to DeepL, and restored again afterwards.
$string = $translator->addString('string1', 'Please ignore me'); // the text "ignore" will not be translated in the string $string->addIgnoreString('ignore');
DeepL API connection
The translator class uses the SC-Networks/deepl-api-connector DeepL API package to connect to the service in the background.
If you need more advanced features, like translating files and the like, you may use the fully configured connector instance directly:
$api = $translator->getConnector(); // do something with it
Running the tests
By default, the unit tests will only test the offline API of the Translator itself. To enable live testing with the DeepL API, rename the file tests/apikey.dist.php
to tests/apikey.php
and edit it to insert your API key. The additional tests will be enabled automatically.