Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waithawoo/laravel-deeplapi-translate
To translate languages with Deep L Translator API
https://github.com/waithawoo/laravel-deeplapi-translate
deepl deepl-translate deepl-translation-api laravel translate translate-api
Last synced: 1 day ago
JSON representation
To translate languages with Deep L Translator API
- Host: GitHub
- URL: https://github.com/waithawoo/laravel-deeplapi-translate
- Owner: waithawoo
- License: mit
- Created: 2021-10-15T09:16:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T19:05:42.000Z (over 1 year ago)
- Last Synced: 2024-08-17T22:32:54.396Z (3 months ago)
- Topics: deepl, deepl-translate, deepl-translation-api, laravel, translate, translate-api
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel DeepL API Translation Package
[](https://github.com/waithawoo/laravel-deeplapi-translate/issues)
[](https://github.com/waithawoo/laravel-deeplapi-translate/stargazers)
[](https://github.com/waithawoo/laravel-deeplapi-translate/network)
[](https://github.com/waithawoo/laravel-deeplapi-translate/blob/main/LICENSE)
## To translate languages with Deep L Translator API
Easy to use Deep L API for translation in Laravel projects
- **[Installation](#installation)**
- **[Usage](#usage)**
## Installation
Install this package via [Composer](https://getcomposer.org/).
```
composer require waithaw/deeplapitranslate
```
You can publish the config file using the following command:
```
php artisan vendor:publish --provider="WaiThaw\DeeplTranslate\DeeplTranslateServiceProvider"
```
This will create the package's config file called deepltranslate.php in the config directory. The contents of the published config file are as follows.
```php
return [
/*
|-------------------------------------------------------------------------------
| Api Key generated from Deep L account.
|-------------------------------------------------------------------------------
*/
'auth_key' => env('DEEPL_TRANSLATE_API_KEY'),
/*
|-------------------------------------------------------------------------------
| Api Endpoint URL from Deep L account.
|-------------------------------------------------------------------------------
*/
'api_url' => env('DEEPL_TRANSLATE_API_ENDPOINT_URL'),
];
```
## Usage
- After setting up the config file values in .env, you can use translation methods.
### Create DeeplTranslate object
```php
use WaiThaw\DeeplTranslate\DeeplTranslate;
$deepl = new DeeplTranslate();
```
### Translate
```php
// parameters are $text, $source_language, $target_language
$translated_text = $deepl->translate('are you hungry?', 'EN', 'JA'); // Output translated text string
echo $translated_text;
```
### Supported languages
```php
$languages = $deepl->languages();
foreach($languages as $lang){
echo $lang['language']."-".$lang['name'].'
';
}
```
For supported Source-languages
```php
$source_languages = $deepl->languages('source');
foreach($source_languages as $lang){
echo $lang['language']."-".$lang['name'].'
';
}
```
For supported Target-languages
```php
$target_languages = $deepl->languages('target');
foreach($target_languages as $lang){
echo $lang['language']."-".$lang['name'].'
';
}
```
### Monitoring Usage
You can monitor the number of traslated characters and maximun limitations
```php
$usage= $deepl->usage();
echo $usage['character_count'].' characters have been used. Maximum number of characters that can be translated in the current billing period are '.$usage['character_limit'];
```
### Setting for cURL timeout
You can setup a timeout to prevent waiting in case of api unreachable
```php
$deepl->setTimeout(10);
```
## Security
If you discover any security related issues, please email them to [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## License
The MIT License (MIT). Please see the [License File](LICENSE) for more information.