Arcanedev\Stripe\Resources\Invoice

Complexity

Total Complexity

6

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

10.53%

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	0	4	1
A	create()	0	4	1
A	retrieve()	0	4	1
A	save()	0	4	1
A	upcoming()	0	12	1
A	pay()	0	9	1

<?php namespace Arcanedev\Stripe\Resources;

use Arcanedev\Stripe\Contracts\Resources\InvoiceInterface;
use Arcanedev\Stripe\StripeResource;
use Arcanedev\Stripe\Utilities\Util;

/**
 * Class     Invoice
 *
 * @package  Arcanedev\Stripe\Resources
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @link https://stripe.com/docs/api/php#invoices
 *
 * @property  string                            id
 * @property  string                            object // "invoice"
 * @property  bool                              livemode
 * @property  int                               amount_due
 * @property  int                               attempt_count
 * @property  bool                              attempted
 * @property  bool                              closed
 * @property  string                            currency
 * @property  string                            customer
 * @property  int                               date
 * @property  bool                              forgiven
 * @property  \Arcanedev\Stripe\Collection      lines
 * @property  bool                              paid
 * @property  int                               period_end
 * @property  int                               period_start
 * @property  int                               starting_balance
 * @property  int                               subtotal
 * @property  int                               total
 * @property  int                               application_fee
 * @property  string                            charge
 * @property  string                            description
 * @property  \Arcanedev\Stripe\StripeObject    discount              // Discount Object
 * @property  int                               ending_balance
 * @property  int                               next_payment_attempt
 * @property  string                            receipt_number
 * @property  string                            statement_descriptor
 * @property  string                            subscription
 * @property  int                               webhooks_delivered_at
 * @property  \Arcanedev\Stripe\AttachedObject  metadata
 * @property  int                               tax
 * @property  float                             tax_percent
 *
 * @todo:     Update the properties.
 */
class Invoice extends StripeResource implements InvoiceInterface
{
    /* ------------------------------------------------------------------------------------------------
     |  CRUD Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create an invoice.
     *
     * @link   https://stripe.com/docs/api/php#create_invoice
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self|array
     */
    public static function create($params = [], $options = null)
    {
        return self::scopedCreate($params, $options);
    }

    /**
     * Retrieving an Invoice
     *
     * @link   https://stripe.com/docs/api/php#retrieve_invoice
     *
     * @param  string             $id
     * @param  array|string|null  $options
     *
     * @return self
     */
    public static function retrieve($id, $options = null)
    {
        return self::scopedRetrieve($id, $options);
    }

    /**
     * List of all Invoices.
     *
     * @link   https://stripe.com/docs/api/php#list_customer_invoices
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Collection|array
     */
    public static function all($params = [], $options = null)
    {
        return self::scopedAll($params, $options);
    }

    /**
     * Update/Save an invoice.
     *
     * @link   https://stripe.com/docs/api/php#update_invoice
     *
     * @param  array|string|null  $options
     *
     * @return self
     */
    public function save($options = null)
    {
        return self::scopedSave($options);
    }

    /**
     * Retrieve Upcoming Invoice.
     *
     * @link   https://stripe.com/docs/api/php#retrieve_customer_invoice
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self|array
     */
    public static function upcoming($params = [], $options = null)
    {
        $url  = self::classUrl(get_class()) . '/upcoming';

        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $opts) = self::staticRequest('get', $url, $params, $options);

        $object = Util::convertToStripeObject($response->getJson(), $opts);

The expression \Arcanedev\Stripe\Utilities\Util::convertToStripeObject($response->getJson(), $opts); of type array|Arcanedev\Stripe\StripeObject adds the type Arcanedev\Stripe\StripeObject to the return on line 134 which is incompatible with the return type declared by the interface Arcanedev\Stripe\Contracts\Resources\InvoiceInterface::upcoming of type Arcanedev\Stripe\Contracts\Resources\InvoiceInterface|array.

        $object->setLastResponse($response);

        return $object;
    }

    /**
     * Pay an invoice.
     *
     * @link   https://stripe.com/docs/api/php#pay_invoice
     *
     * @param  array|string|null  $options
     *
     * @return self
     */
    public function pay($options = null)
    {
        $url = $this->instanceUrl() . '/pay';

        list($response, $opts) = $this->request('post', $url, [], $options);
        $this->refreshFrom($response, $opts);

        return $this;
    }
}