Zvermafia\Transliteration\Abstracts\HttpTransliteratorAbstract

Complexity

Total Complexity

6

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

50%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	translit()	0	5	1
A	makeRequest()	0	13	3
A	__destruct()	0	3	1
A	__construct()	0	10	1

<?php

namespace Zvermafia\Transliteration\Abstracts;

use Zvermafia\Transliteration\Interfaces\TransliteratorInterface;
use Zvermafia\Transliteration\Exceptions\TransliteratorException;

/**
 * Base transliterator class
 *
 * This base class can be extended by all transliterators which will use cURL as an HTTP handler.
 */
abstract class HttpTransliteratorAbstract extends TransliteratorAbstract
{
    /** @var resource */
    protected $curl_handle;

    /**
     * Initialize a cURL instance.
     */
    public function __construct()
    {
        $this->curl_handle = \curl_init();

It seems like curl_init() can also be of type false. However, the property $curl_handle is declared as type resource. Maybe add an additional type check?

        \curl_setopt_array(
            $this->curl_handle,

It seems like $this->curl_handle can also be of type false; however, parameter $ch of curl_setopt_array() does only seem to accept resource, maybe add an additional type check?

            array_replace(
                $this->getDefaultOptions(),
                [
                    \CURLOPT_RETURNTRANSFER => true,
                    \CURLOPT_USERAGENT => 'Zvermafia-Transliteration/2.0.0 (+https://zvermafia/transliteration)',
                ]
            )
        );
    }

    /**
     * Destroy the cURL instance.
     */
    public function __destruct()
    {
        \curl_close($this->curl_handle);
    }

    /**
     * @inheritDoc
     */
    public function translit(): TransliteratorInterface
    {
        $this->setResult($this->getResultFromResponse($this->makeRequest()));

        return $this;
    }

    /**
     * Make request to an API.
     *
     * @throws \Zvermafia\Transliteration\Exceptions\TransliteratorException
     * @return string Response body
     */
    protected function makeRequest(): string
    {
        \curl_setopt_array($this->curl_handle, $this->getPerRequestOptions());
        $response = \curl_exec($this->curl_handle);

        if ($response === false || \curl_errno($this->curl_handle) !== 0) {
            throw new TransliteratorException(
                \curl_error($this->curl_handle),
                \curl_getinfo($this->curl_handle, CURLINFO_HTTP_CODE)
            );
        }

        return $response;
    }

    /**
     * Get default options for all the subsequent requests.
     *
     * @return array
     */
    abstract protected function getDefaultOptions(): array;

    /**
     * Get per request options.
     *
     * @return array
     */
    abstract protected function getPerRequestOptions(): array;

    /**
     * Fetch the result from the response and return it.
     *
     * @param string $response
     * @return string
     */
    abstract protected function getResultFromResponse(string $response): string;
}