shapintv / stripe

src/Model/Customer/Customer.php

<?php

declare(strict_types=1);

/*
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Shapin\Stripe\Model\Customer;

use Money\Currency;
use Shapin\Stripe\Exception\LogicException;
use Shapin\Stripe\Model\ContainsMetadata;
use Shapin\Stripe\Model\CreatableFromArray;
use Shapin\Stripe\Model\LivemodeTrait;
use Shapin\Stripe\Model\MetadataCollection;
use Shapin\Stripe\Model\MetadataTrait;
use Shapin\Stripe\Model\Source\Source;
use Shapin\Stripe\Model\Source\SourceCollection;
use Shapin\Stripe\Model\Subscription\Subscription;
use Shapin\Stripe\Model\Subscription\SubscriptionCollection;

final class Customer implements CreatableFromArray, ContainsMetadata
{
    use LivemodeTrait;
    use MetadataTrait;

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

    /**
     * @var int
     */
    private $balance;

    /**
     * @var \DateTimeImmutable
     */
    private $createdAt;

    /**
     * @var ?Currency
     */
    private $currency;

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

    /**
     * @var bool
     */
    private $delinquent;

    /**
     * @var ?string
     */
    private $description;

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

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

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

    /**
     * @var ?InvoiceSettings
     */
    private $invoiceSettings;

    /**
     * @var ?Shipping
     */
    private $shipping;

    /**
     * @var SourceCollection
     */
    private $sources;

    /**
     * @var SubscriptionCollection
     */
    private $subscriptions;

    /**
     * @var TaxInfo
     */
    private $taxInfo;

    /**
     * @var TaxInfoVerification
     */
    private $taxInfoVerification;

    private function __construct()
    {
    }

    public static function createFromArray(array $data): self
    {
        $model = new self();
        $model->id = $data['id'];
        $model->balance = (int) $data['balance'];
        $model->createdAt = new \DateTimeImmutable('@'.$data['created']);
        if (isset($data['currency'])) {
            $model->currency = new Currency(strtoupper($data['currency']));
        }
        $model->defaultSourceId = $data['default_source'];
        $model->delinquent = (bool) $data['delinquent'];
        $model->description = $data['description'];
        $model->discount = \array_key_exists('discount', $data) ? $data['discount'] : null;
        $model->email = $data['email'];
        $model->invoicePrefix = $data['invoice_prefix'];
        $model->invoiceSettings = \array_key_exists('invoice_settings', $data) ? InvoiceSettings::createFromArray($data['invoice_settings']) : null;
        $model->live = (bool) $data['livemode'];
        $model->metadata = MetadataCollection::createFromArray($data['metadata']);

It seems like \Shapin\Stripe\Model\MetadataCollection::createFromArray($data['metadata']) of type object<self> is incompatible with the declared type object<Shapin\Stripe\Model\MetadataCollection> of property $metadata.

        if (isset($data['shipping'])) {
            $model->shipping = Shipping::createFromArray($data['shipping']);
        }
        $model->sources = SourceCollection::createFromArray($data['sources']);

It seems like \Shapin\Stripe\Model\Source\SourceCollection::createFromArray($data['sources']) of type object<self> is incompatible with the declared type object<Shapin\Stripe\Model\Source\SourceCollection> of property $sources.

        $model->subscriptions = SubscriptionCollection::createFromArray($data['subscriptions']);

It seems like \Shapin\Stripe\Model\Subscription\SubscriptionCollection::createFromArray($data['subscriptions']) of type object<self> is incompatible with the declared type object<Shapin\Stripe\Model\Subscription\SubscriptionCollection> of property $subscriptions.

        if (isset($data['tax_info'])) {
            $model->taxInfo = TaxInfo::createFromArray($data['tax_info']);

It seems like \Shapin\Stripe\Model\Customer\TaxInfo::createFromArray($data['tax_info']) of type object<self> is incompatible with the declared type object<Shapin\Stripe\Model\Customer\TaxInfo> of property $taxInfo.

        }
        if (isset($data['tax_info_verification'])) {
            $model->taxInfoVerification = TaxInfoVerification::createFromArray($data['tax_info_verification']);

It seems like \Shapin\Stripe\Model\Customer\TaxInfoVerification::createFromArray($data['tax_info_verification']) of type object<self> is incompatible with the declared type object<Shapin\Stripe\Model\Customer\TaxInfoVerification> of property $taxInfoVerification.

        }

        return $model;
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function getAccountBalance(): int
    {
        @trigger_error('Calling the method getAccountBalance is deprecated since Stripe API 2019-10-17. Use getBalance instead.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        return $this->balance;
    }

    public function getBalance(): int
    {
        return $this->balance;
    }

    public function getCreatedAt(): \DateTimeImmutable
    {
        return $this->createdAt;
    }

    public function getCurrency(): ?Currency
    {
        return $this->currency;
    }

    public function getDefaultSource(): ?Source
    {
        if (null === $this->defaultSourceId) {
            return null;
        }

        foreach ($this->sources->getElements() as $source) {
            if ($this->defaultSourceId === $source->getId()) {
                return $source;
            }
        }

        throw new LogicException('Unable to find default source in available sources.');
    }

    public function getDefaultSourceId(): ?string
    {
        return $this->defaultSourceId;
    }

    public function hasDefaultSource(): bool
    {
        return null !== $this->defaultSourceId;
    }

    public function isDelinquent(): bool
    {
        return $this->delinquent;
    }

    public function getDescription(): ?string
    {
        return $this->description;
    }

    public function getDiscount(): ?array
    {
        return $this->discount;
    }

    public function getEmail(): ?string
    {
        return $this->email;
    }

    public function getInvoicePrefix(): ?string
    {
        return $this->invoicePrefix;
    }

    public function getInvoiceSettings(): ?InvoiceSettings
    {
        return $this->invoiceSettings;
    }

    public function getShipping(): ?Shipping
    {
        return $this->shipping;
    }

    public function getSources(): SourceCollection
    {
        return $this->sources;
    }

    public function getSubscriptions(): SubscriptionCollection
    {
        return $this->subscriptions;
    }

    public function getLatestSubscription(): ?Subscription
    {
        $subscriptions = $this->subscriptions->getElements();
        if (0 === \count($subscriptions)) {
            return null;
        }

        return reset($subscriptions);
    }

    public function getTaxInfo(): ?TaxInfo
    {
        return $this->taxInfo;
    }

    public function getTaxInfoVerification(): ?TaxInfoVerification
    {
        return $this->taxInfoVerification;
    }
}