GloBee-Official / payment-api-php

src/PaymentApi.php

<?php

namespace GloBee\PaymentApi;

use GloBee\PaymentApi\Connectors\Connector;
use GloBee\PaymentApi\Exceptions\PaymentRequestAlreadyExistsException;
use GloBee\PaymentApi\Models\Account;
use GloBee\PaymentApi\Models\Currency;
use GloBee\PaymentApi\Models\PaymentRequest;

class PaymentApi
{
    const VERSION = '0.5.0';

    /**
     * @var Connector
     */
    private $connector;

    /**
     * PaymentApi constructor.
     *
     * @param Connector $connector

Missing parameter comment

     */
    public function __construct(Connector $connector)
    {
        $this->connector = $connector;
    }

    /**
     * @return Account
     */
    public function getAccount()
    {
        $data = $this->connector->getJson('v1/ping');

        return Account::fromResponse($data['data']);
    }

    /**
     * @return Currency[]
     */
    public function getCurrencies()
    {
        $data = $this->connector->getJson('v1/currencies');

        return Currency::fromResponse($data['data']);
    }

    /**
     * @param string $paymentRequestId

Missing parameter comment

     *
     * @return PaymentRequest
     */
    public function getPaymentRequest($paymentRequestId)

Type hint "string" missing for $paymentRequestId

    {
        $response = $this->connector->getJson('v1/payment-request/'.$paymentRequestId);

        return PaymentRequest::fromResponse($response['data']);
    }

    /**
     * @param PaymentRequest $paymentRequest

Missing parameter comment

     *
     * @return PaymentRequest
     * @throws PaymentRequestAlreadyExistsException

Comment missing for @throws tag in function comment

     */
    public function createPaymentRequest(PaymentRequest $paymentRequest)
    {
        if ($paymentRequest->id !== null) {

The property $id is declared protected in GloBee\PaymentApi\Models\PaymentRequest. Since you implement __get, consider adding a @property or @property-read.

            throw new PaymentRequestAlreadyExistsException();
        }
        $data = $this->filterData($paymentRequest->toArray());
        $response = $this->connector->postJson('v1/payment-request', $data);

        return PaymentRequest::fromResponse($response['data']);
    }

    /**
     * @param array $data

Missing parameter comment

     *
     * @return array
     */
    protected function filterData(array $data)
    {
        $data = array_map(function ($item) {
            if (is_array($item)) {
                $item = $this->filterData($item);
            }

            return $item;
        }, $data);

        return array_filter($data, function ($item) {
            if (is_array($item)) {
                return !empty($item);
            }

            return $item !== null;
        });
    }
}