LanguageToolApiClient.php

<?php

declare(strict_types=1);

namespace PhpSpellcheck\Spellchecker\LanguageTool;

/**
 * @TODO refactor by using PSR HTTP Client
 */
class LanguageToolApiClient
{
    /**
     * @var string
     */
    private $baseUrl;

    public function __construct(string $baseUrl)
    {
        $this->baseUrl = $baseUrl;
    }

    /**
     * @param array<string> $languages
     * @param array<mixed> $options
     *
     * @return array{matches: array<array{
     *   offset: int,
     *   context: array{text: string, offset: int, length: int},
     *   replacements: array<array{value: string}>,
     *   sentence: string,
     *   message: string,
     *   rule: string
     * }>}
     */
    public function spellCheck(string $text, array $languages, array $options): array
    {
        $options['text'] = $text;
        $options['language'] = array_shift($languages);

        if (!empty($languages)) {
            $options['altLanguages'] = implode(',', $languages);
        }

        /** @var array{matches: array<array{offset: int, context: array{text: string, offset: int, length: int}, replacements: array<array{value: string}>, sentence: string, message: string, rule: string}>} */
        return $this->requestAPI(
            '/v2/check',
            'POST',
            'Content-type: application/x-www-form-urlencoded; Accept: application/json',
            $options
        );
    }

    /**
     * @return array<string>
     */
    public function getSupportedLanguages(): array
    {
        /** @var array<array{longCode: string}> $languages */
        $languages = $this->requestAPI(
            '/v2/languages',
            'GET',
            'Accept: application/json'
        );

        return array_values(array_unique(array_column($languages, 'longCode')));
    }

    /**
     * @param array<mixed> $queryParams
     *
     * @throws \RuntimeException
     *
     * @return array<mixed>
     */
    public function requestAPI(string $endpoint, string $method, string $header, array $queryParams = []): array
    {
        $httpData = [
            'method' => $method,
            'header' => $header,
        ];

        if (!empty($queryParams)) {
            $httpData['content'] = http_build_query($queryParams);
        }

        $content = \PhpSpellcheck\file_get_contents($this->baseUrl . $endpoint, false, stream_context_create(['http' => $httpData]));
        /** @var array<mixed> $contentAsArray */
        $contentAsArray = \PhpSpellcheck\json_decode($content, true);

        return $contentAsArray;
    }
}