GloBee-Official / payment-api-php

src/Connectors/GloBeeCurlConnector.php

<?php

namespace GloBee\PaymentApi\Connectors;

use GloBee\PaymentApi\PaymentApi;

class GloBeeCurlConnector extends Connector
{
    /**
     * @var string
     */
    private $apiKey;

    /**
     * @var string
     */
    private $baseUrl;

    /**
     * @var CurlWrapper
     */
    private $client;

    /**
     * @var array
     */
    private $platforms;

    /**
     * GloBeeCurlConnector constructor.
     *
     * @param string           $apiKey

Missing parameter comment

     * @param bool             $live

Missing parameter comment

Expected "boolean" but found "bool" for parameter type

     * @param array            $platforms

Missing parameter comment

     * @param CurlWrapper|null $curlConnector

Missing parameter comment

     */
    public function __construct($apiKey, $live = true, array $platforms = [], CurlWrapper $curlConnector = null)

Type hint "string" missing for $apiKey

Type hint "bool" missing for $live

    {
        $this->apiKey = $apiKey;
        $this->baseUrl = $live ? 'https://globee.com/payment-api' : 'https://test.globee.com/payment-api';
        $this->platforms = $platforms;
        $this->client = $curlConnector ?: new CurlWrapper();
    }

    /**
     * @param string $uri

Missing parameter comment

     *
     * @return array
     */
    public function getJson($uri)

Type hint "string" missing for $uri

    {
        return $this->send('GET', $uri);
    }

    /**
     * @param string $uri

Missing parameter comment

     * @param array  $data

Missing parameter comment

     *
     * @return array
     */
    public function postJson($uri, array $data)

Type hint "string" missing for $uri

    {
        $json = json_encode($data);

        return $this->send('POST', $uri, $json, [
            'Content-Type' => 'application/json',
        ]);
    }

    /**
     * @param string $method

Missing parameter comment

     * @param string $uri

Missing parameter comment

     * @param string $body

Missing parameter comment

     * @param array  $headers

Missing parameter comment

     *
     * @return array
     */
    protected function send($method, $uri, $body = null, array $headers = [])

Type hint "string" missing for $method

Type hint "string" missing for $uri

Type hint "string" missing for $body

    {
        $headers = $this->compileHeaders($headers);

        $this->client->setOptions([
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_URL => $this->baseUrl.'/'.$uri,
            CURLOPT_ACCEPT_ENCODING => 'application/json',
            CURLOPT_CUSTOMREQUEST => $method,
            CURLOPT_HTTPHEADER => $headers,
            CURLOPT_USERAGENT => $this->getUserAgentString(),
        ]);

        if ($method !== 'GET' && $body) {
            $this->client->setOption(CURLOPT_POSTFIELDS, $body);
        }

        $response = $this->client->exec();
        $httpcode = $this->client->getInfo(CURLINFO_HTTP_CODE);

        if ($httpcode >= 400) {
            $this->handleErrors($httpcode, $response);
        }

        return json_decode($response, true);

It seems like $response can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @param array $headers

Missing parameter comment

     *
     * @return array
     */
    protected function compileHeaders(array $headers = [])
    {
        $headers = [
                'X-AUTH-KEY' => $this->apiKey,
            ] + $headers;

        $return = [];
        foreach ($headers as $key => $value) {
            $return[] = $key.': '.$value;
        }

        return $return;
    }

    protected function getUserAgentString()

Missing function doc comment

    {
        $platforms = $this->platforms;
        array_walk($platforms, function (&$version, $platform) {
            $version = $platform.'/'.$version;
        });
        $platforms = implode(' ', $platforms);
        $userAgent = sprintf('GloBeePaymentSdk/%s (%s) PHP/%s', PaymentApi::VERSION, PHP_OS, PHP_VERSION);

        return trim($userAgent.' '.$platforms);
    }

    /**
     * @param string $url

Missing parameter comment

     */

Missing @return tag in function comment

    public function setBaseUrl($url)

Type hint "string" missing for $url

    {
        $this->baseUrl = $url;
    }
}