Completed
Push — master ( 21ba0c...a4807e )
by Benjamin
05:43 queued 01:11
created

DeeplTranslator::setSource()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 6
ccs 0
cts 5
cp 0
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
crap 2
1
<?php
2
3
namespace Ben182\AutoTranslate\Translators;
4
5
use Scn\DeeplApiConnector\DeeplClient;
6
use Scn\DeeplApiConnector\Model\TranslationConfig;
7
use Scn\DeeplApiConnector\Exception\RequestException;
8
use Ben182\AutoTranslate\Exceptions\LanguageCodeNotExist;
9
10
class DeeplTranslator implements TranslatorInterface
11
{
12
    protected $translator;
13
    protected $source;
14
    protected $target;
15
16
    public function __construct()
17
    {
18
        $this->translator = DeeplClient::create(config('auto-translate.deepl.api_key'));
19
    }
20
21
    public function setSource(string $source)
22
    {
23
        $this->source = strtoupper($source);
24
25
        return $this;
26
    }
27
28
    public function setTarget(string $target)
29
    {
30
        $this->target = strtoupper($target);
31
32
        return $this;
33
    }
34
35
    public function translate(string $string) : string
36
    {
37
        $translation = new TranslationConfig(
38
            $string,
39
            $this->target,
40
            $this->source
41
        );
42
43
        try {
44
            return $this->translator->getTranslation($translation)->getText();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Scn\DeeplApiConnector\Model\ResponseModelInterface as the method getText() does only exist in the following implementations of said interface: Scn\DeeplApiConnector\Model\Translation.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
45
        } catch (RequestException $th) {
46
            if ($th->getMessage() === '400 {"message":"Value for \'target_lang\' is not supported."}') {
47
                throw LanguageCodeNotExist::throw($this->source, $this->target);
48
            }
49
50
            throw $th;
51
        }
52
    }
53
}
54