Avoid BC break in TextResult

[VincentLanglet]

Hi @JanEbbing

The commit 04403a0 introduce a BC break by changing the signature of this class, but was tagged as a minor.

The model type used should have a default value to avoid BC break, especially when null is allowed.

[JanEbbing]

Hi @VincentLanglet , do you instantiate TextResults in tests or why does this break something for you? I would discourage usage like that, imo it's better to explicitly access the properties (eg text on TextResult) and run assertions against that.

That said, I do agree with this PR.

[VincentLanglet]

Hi @VincentLanglet , do you instantiate TextResults in tests or why does this break something for you? I would discourage usage like that, imo it's better to explicitly access the properties (eg text on TextResult) and run assertions against that.

That said, I do agree with this PR.

Yes, I do instantiate one TextResult in tests to simulate a response of an API. With something like

$deeplTranslatorClient->method('translateText')->willReturnCallback(
            static function (array $payload, string $from) use (&$translateCalls): array {
                ++$translateCalls;
                if (1 === $translateCalls % 2) {
                    throw new DeepLException('Odd calls are failing');
                }

                return array_map(
                    static fn (string $text): TextResult => new TextResult(
                        \sprintf('translated(%s)', $text),
                        $from,
                        0
                    ),
                    $payload
                );
            }
        );

[daniel-jones-dev]

Sorry for this oversight @VincentLanglet; I assumed this class was internal and wouldn't be used by users, but testing is a valid use-case.

Thanks for the PR.