greenlystapp / basecommerce-php

src/Models/Card.php

<?php

declare(strict_types=1);

namespace Greenlyst\BaseCommerce\Models;

use function ArrayHelpers\array_get;
use function ArrayHelpers\array_has;
use Carbon\Carbon;
use Greenlyst\BaseCommerce\ClientException;
use Greenlyst\BaseCommerce\LogicException;
use Greenlyst\BaseCommerce\Traits\HasClient;
use Greenlyst\BaseCommerce\Traits\HasErrorMessages;

class Card
{
    use HasClient, HasErrorMessages;

    private $name;
    private $cardNumber;
    private $cardExpirationMonth;
    private $cardExpirationYear;
    private $token;
    private $status;
    private $billingAddress;
    private $creationDate;
    private $alias;
    private $expirationDate;

The private property $expirationDate is not used, and could be removed.

    private $amount;
    private $recurring;

    const CUSTOM_FIELD_PREFIX_BANK_CARD_TRANSACTION = 'bank_card_transaction';
    const CUSTOM_FIELD_PREFIX_RECURRING_TRANSACTION = 'recurring_transaction';

    const STATUS_DELETED = 'DELETED';
    const STATUS_FAILED = 'FAILED';
    const STATUS_ACTIVE = 'ACTIVE';

    const URI_ADD_BANK_CARD = '/pcms/?f=API_addBankCardV4';
    const URI_UPDATE_BANK_CARD = '/pcms/?f=API_updateBankCardV4';
    const URI_DELETE_BANK_CARD = '/pcms/?f=API_deleteBankCardV4';

    /**
     * @return mixed
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param mixed $name
     */
    public function setName($name): void
    {
        $this->name = $name;
    }

    /**
     * @return mixed
     */
    public function getCardNumber()
    {
        return $this->cardNumber;
    }

    /**
     * @param mixed $cardNumber
     */
    public function setCardNumber($cardNumber): void
    {
        $this->cardNumber = $cardNumber;
    }

    /**
     * @return mixed
     */
    public function getCardExpirationMonth()
    {
        return $this->cardExpirationMonth;
    }

    /**
     * @param mixed $cardExpirationMonth
     */
    public function setCardExpirationMonth($cardExpirationMonth): void
    {
        $this->cardExpirationMonth = $cardExpirationMonth;
    }

    /**
     * @return mixed
     */
    public function getCardExpirationYear()
    {
        return $this->cardExpirationYear;
    }

    /**
     * @param mixed $cardExpirationYear
     */
    public function setCardExpirationYear($cardExpirationYear): void
    {
        $this->cardExpirationYear = $cardExpirationYear;
    }

    /**
     * @return mixed
     */
    public function getToken()
    {
        return $this->token;
    }

    /**
     * @param mixed $token
     */
    public function setToken($token): void
    {
        $this->token = $token;
    }

    /**
     * @return mixed
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * @param mixed $status
     */
    public function setStatus($status): void
    {
        $this->status = $status;
    }

    /**
     * @return Address
     */
    public function getBillingAddress()
    {
        return $this->billingAddress;
    }

    /**
     * @param Address $billingAddress
     */
    public function setBillingAddress(Address $billingAddress): void
    {
        $this->billingAddress = $billingAddress;
    }

    /**
     * @return mixed
     */
    public function getCreationDate()
    {
        return $this->creationDate;
    }

    /**
     * @param mixed $creationDate
     */
    public function setCreationDate($creationDate): void
    {
        $this->creationDate = $creationDate;
    }

    /**
     * @return mixed
     */
    public function getAlias()
    {
        return $this->alias;
    }

    /**
     * @param mixed $alias
     */
    public function setAlias($alias): void
    {
        $this->alias = $alias;
    }

    /**
     * @return mixed
     */
    public function getAmount()
    {
        return $this->amount;
    }

    /**
     * @param mixed $amount
     */
    public function setAmount($amount): void
    {
        $this->amount = $amount;
    }

    /**
     * @return Recurring
     */
    public function getRecurring()
    {
        return $this->recurring;
    }

    /**
     * @param Recurring $recurring
     */
    public function setRecurring($recurring): void
    {
        $this->recurring = $recurring;
    }

    /**
     * @throws ClientException
     * @throws LogicException
     *
     * @return Card
     */
    public function add(): self
    {
        validate_array($this->toCreateCardArray(), [
                'bank_card_name', 'bank_card_number', 'bank_card_expiration_month', 'bank_card_expiration_year',
            ]
        );

        $response = $this->client->postRequest(self::URI_ADD_BANK_CARD, json_encode($this->toCreateCardArray()));

        $instance = $this->fromCardArray($response['bank_card']);

        $this->handleMessages($response);

        return $instance;
    }

    /**
     * @throws ClientException
     * @throws LogicException
     *
     * @return $this
     */
    public function update(): self
    {
        validate_array($this->toCreateCardArray(), [
                'bank_card_token', 'bank_card_expiration_month', 'bank_card_expiration_year',
            ]
        );

        $response = $this->client->postRequest(self::URI_UPDATE_BANK_CARD, json_encode($this->toUpdateCardArray()));

        $instance = $this->fromCardArray($response['bank_card']);

        $instance->handleMessages($response);

        return $instance;
    }

    /**
     * @throws ClientException
     * @throws LogicException
     *
     * @return Card
     */
    public function delete(): self
    {
        validate_array($this->toCreateCardArray(), ['bank_card_token']);

        $response = $this->client->postRequest(self::URI_DELETE_BANK_CARD, array_get($this->toDeleteCardArray(), 'bank_card_token'));

        $instance = $this->fromCardArray($response['bank_card']);

        $instance->handleMessages($response);

        return $instance;
    }

    private function fromCardArray(array $data)
    {
        $instance = new static();

        $instance->setName(array_get($data, 'bank_card_name'));
        $instance->setCardNumber(array_get($data, 'bank_card_number'));
        $instance->setCardExpirationMonth(array_get($data, 'bank_card_expiration_month'));
        $instance->setCardExpirationYear(array_get($data, 'bank_card_expiration_year'));
        $instance->setToken(array_get($data, 'bank_card_token'));
        $instance->setCardNumber(array_get($data, 'bank_card_number'));
        $instance->setBillingAddress((new Address())->fromArray(array_get($data, 'bank_card_billing_address')));

It seems like array_get($data, 'bank_card_billing_address') can also be of type null; however, parameter $data of Greenlyst\BaseCommerce\Models\Address::fromArray() does only seem to accept array, maybe add an additional type check?

        $instance->setCreationDate(Carbon::parse(array_get($data, 'bank_card_creation_date_24hr'))->toDateTime());

        if (array_has($data, 'bank_card_status')) {
            if (gettype(array_get($data, 'bank_card_status')) === 'array') {
                $instance->setStatus(array_get($data, 'bank_card_status.bank_card_status_name'));
            } else {
                $instance->setStatus(array_get($data, 'bank_card_status'));
            }
        }

        if (array_has($data, 'bank_card_deleted')) {
            $instance->setStatus(self::STATUS_DELETED);
        }

        $instance->setAlias(array_get($data, 'bank_card_alias'));

        return $instance;
    }

    public function toCreateCardArray(): array
    {
        return clear_array([
            'bank_card_name'             => $this->getName(),
            'bank_card_number'           => $this->getCardNumber(),
            'bank_card_expiration_month' => $this->getCardExpirationMonth(),
            'bank_card_expiration_year'  => $this->getCardExpirationYear(),
            'bank_card_token'            => $this->getToken(),
            'bank_card_billing_address'  => $this->getBillingAddress() ? $this->getBillingAddress()->toArray() : null,
            'bank_card_alias'            => $this->getAlias(),
        ]);
    }

    private function toUpdateCardArray(): array
    {
        return clear_array([
            'bank_card_expiration_month' => $this->getCardExpirationMonth(),
            'bank_card_expiration_year'  => $this->getCardExpirationYear(),
            'bank_card_token'            => $this->getToken(),
            'bank_card_billing_address'  => $this->getBillingAddress() ? $this->getBillingAddress()->toArray() : null,
        ]);
    }

    private function toDeleteCardArray(): array
    {
        return clear_array([
            'bank_card_token' => $this->getToken(),
        ]);
    }
}