Completed
Push — main ( 971251...1e5688 )
by Dante
23s queued 18s
created

Translator::translate()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 3
dl 0
loc 6
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 4
1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * BEdita, API-first content management framework
6
 * Copyright 2023 Atlas Srl, Chialab Srl
7
 *
8
 * This file is part of BEdita: you can redistribute it and/or modify
9
 * it under the terms of the GNU Lesser General Public License as published
10
 * by the Free Software Foundation, either version 3 of the License, or
11
 * (at your option) any later version.
12
 *
13
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
14
 */
15
namespace BEdita\I18n\Deepl\Core;
16
17
use BEdita\I18n\Core\TranslatorInterface;
18
use Cake\Utility\Hash;
19
use DeepL\Translator as DeeplTranslator;
20
21
/**
22
 * Translator class that uses DeepL.
23
 *
24
 * This class uses the DeepL API to translate texts.
25
 * Pass a valid 'auth_key' to the options array to use this engine.
26
 * Example:
27
 * ```
28
 * use BEdita\I18n\Deepl\Core\Translator;
29
 * [...]
30
 * $translator = new Translator();
31
 * $translator->setup(['auth_key' => 'your-auth-key']);
32
 * $translation = $translator->translate(['Hello world!'], 'en', 'it');
33
 * ```
34
 */
35
class Translator implements TranslatorInterface
36
{
37
    /**
38
     * The DeepL API client.
39
     *
40
     * @var \DeepL\Translator
41
     */
42
    protected DeeplTranslator $deeplClient;
43
44
    /**
45
     * The engine options.
46
     *
47
     * @var array
48
     */
49
    protected array $options = [];
50
51
    /**
52
     * Setup translator engine.
53
     *
54
     * @param array $options The options
55
     * @return void
56
     */
57
    public function setup(array $options = []): void
58
    {
59
        $this->options = $options;
60
        $authKey = $this->options['auth_key'] ?? '';
61
        $this->deeplClient = new DeeplTranslator($authKey);
62
    }
63
64
    /**
65
     * Translate an array of texts $texts from language source $from to language target $to
66
     *
67
     * @param array $texts The texts to translate
68
     * @param string $from The source language
69
     * @param string $to The target language
70
     * @param array $options The options
71
     * @return string The translation in json format, i.e.
72
     * {
73
     *     "translation": [
74
     *         "<translation of first text>",
75
     *         "<translation of second text>",
76
     *         [...]
77
     *         "<translation of last text>"
78
     *     ]
79
     * }
80
     */
81
    public function translate(array $texts, string $from, string $to, array $options = []): string
82
    {
83
        $translation = $this->deeplClient->translateText($texts, $from, $to);
84
        $translation = empty($translation) ? [] : (array)Hash::extract($translation, '{n}.text');
85
86
        return (string)json_encode(compact('translation'));
87
    }
88
}
89