Viewing file:  Invoice.php (19.95 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Laravel\Cashier;
use Carbon\Carbon;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\View;
use JsonSerializable;
use Laravel\Cashier\Contracts\InvoiceRenderer;
use Laravel\Cashier\Exceptions\InvalidInvoice;
use Stripe\Customer as StripeCustomer;
use Stripe\Invoice as StripeInvoice;
use Stripe\InvoiceLineItem as StripeInvoiceLineItem;
use Symfony\Component\HttpFoundation\Response;
class Invoice implements Arrayable, Jsonable, JsonSerializable
{
/**
* The Stripe model instance.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $owner;
/**
* The Stripe invoice instance.
*
* @var \Stripe\Invoice
*/
protected $invoice;
/**
* The Stripe invoice line items.
*
* @var \Laravel\Cashier\InvoiceLineItem[]
*/
protected $items;
/**
* The taxes applied to the invoice.
*
* @var \Laravel\Cashier\Tax[]
*/
protected $taxes;
/**
* The discounts applied to the invoice.
*
* @var \Laravel\Cashier\Discount[]
*/
protected $discounts;
/**
* Indicate if the Stripe Object was refreshed with extra data.
*
* @var bool
*/
protected $refreshed = false;
/**
* The data that will be sent when the invoice is refreshed.
*
* @var array
*/
protected $refreshData = [];
/**
* Create a new invoice instance.
*
* @param \Illuminate\Database\Eloquent\Model $owner
* @param \Stripe\Invoice $invoice
* @param array $refreshData
* @return void
*
* @throws \Laravel\Cashier\Exceptions\InvalidInvoice
*/
public function __construct($owner, StripeInvoice $invoice, array $refreshData = [])
{
if ($owner->stripe_id !== $invoice->customer) {
throw InvalidInvoice::invalidOwner($invoice, $owner);
}
$this->owner = $owner;
$this->invoice = $invoice;
$this->refreshData = $refreshData;
}
/**
* Get a Carbon instance for the invoicing date.
*
* @param \DateTimeZone|string $timezone
* @return \Carbon\Carbon
*/
public function date($timezone = null)
{
$carbon = Carbon::createFromTimestampUTC($this->invoice->created);
return $timezone ? $carbon->setTimezone($timezone) : $carbon;
}
/**
* Get a Carbon instance for the invoice's due date.
*
* @param \DateTimeZone|string $timezone
* @return \Carbon\Carbon|null
*/
public function dueDate($timezone = null)
{
if ($this->invoice->due_date) {
$carbon = Carbon::createFromTimestampUTC($this->invoice->due_date);
return $timezone ? $carbon->setTimezone($timezone) : $carbon;
}
}
/**
* Get the total amount minus the starting balance that was paid (or will be paid).
*
* @return string
*/
public function total()
{
return $this->formatAmount($this->rawTotal());
}
/**
* Get the raw total amount minus the starting balance that was paid (or will be paid).
*
* @return int
*/
public function rawTotal()
{
return $this->invoice->total + $this->rawStartingBalance();
}
/**
* Get the total amount that was paid (or will be paid).
*
* @return string
*/
public function realTotal()
{
return $this->formatAmount($this->rawRealTotal());
}
/**
* Get the raw total amount that was paid (or will be paid).
*
* @return int
*/
public function rawRealTotal()
{
return $this->invoice->total;
}
/**
* Get the total of the invoice (before discounts).
*
* @return string
*/
public function subtotal()
{
return $this->formatAmount($this->invoice->subtotal);
}
/**
* Get the amount due for the invoice.
*
* @return string
*/
public function amountDue()
{
return $this->formatAmount($this->rawAmountDue());
}
/**
* Get the raw amount due for the invoice.
*
* @return int
*/
public function rawAmountDue()
{
return $this->invoice->amount_due ?? 0;
}
/**
* Determine if the account had a starting balance.
*
* @return bool
*/
public function hasStartingBalance()
{
return $this->rawStartingBalance() < 0;
}
/**
* Get the starting balance for the invoice.
*
* @return string
*/
public function startingBalance()
{
return $this->formatAmount($this->rawStartingBalance());
}
/**
* Get the raw starting balance for the invoice.
*
* @return int
*/
public function rawStartingBalance()
{
return $this->invoice->starting_balance ?? 0;
}
/**
* Determine if the account had an ending balance.
*
* @return bool
*/
public function hasEndingBalance()
{
return ! is_null($this->invoice->ending_balance);
}
/**
* Get the ending balance for the invoice.
*
* @return string
*/
public function endingBalance()
{
return $this->formatAmount($this->rawEndingBalance());
}
/**
* Get the raw ending balance for the invoice.
*
* @return int
*/
public function rawEndingBalance()
{
return $this->invoice->ending_balance ?? 0;
}
/**
* Get the applied balance for the invoice.
*
* @return string
*/
public function appliedBalance()
{
return $this->formatAmount($this->rawAppliedBalance());
}
/**
* Get the raw ending balance for the invoice.
*
* @return int
*/
public function rawAppliedBalance()
{
if (! $this->hasEndingBalance()) {
return 0;
}
return $this->rawStartingBalance() - $this->rawEndingBalance();
}
/**
* Determine if the invoice has one or more discounts applied.
*
* @return bool
*/
public function hasDiscount()
{
if (is_null($this->invoice->discounts)) {
return false;
}
return count($this->invoice->discounts) > 0;
}
/**
* Get all of the discount objects from the Stripe invoice.
*
* @return \Laravel\Cashier\Discount[]
*/
public function discounts()
{
if (! is_null($this->discounts)) {
return $this->discounts;
}
$this->refreshWithExpandedData();
return Collection::make($this->invoice->discounts)
->mapInto(Discount::class)
->all();
}
/**
* Calculate the amount for a given discount.
*
* @param \Laravel\Cashier\Discount $discount
* @return string|null
*/
public function discountFor(Discount $discount)
{
if (! is_null($discountAmount = $this->rawDiscountFor($discount))) {
return $this->formatAmount($discountAmount);
}
}
/**
* Calculate the raw amount for a given discount.
*
* @param \Laravel\Cashier\Discount $discount
* @return int|null
*/
public function rawDiscountFor(Discount $discount)
{
return optional(Collection::make($this->invoice->total_discount_amounts)
->first(function ($discountAmount) use ($discount) {
if (is_string($discountAmount->discount)) {
return $discountAmount->discount === $discount->id;
} else {
return $discountAmount->discount->id === $discount->id;
}
}))
->amount;
}
/**
* Get the total discount amount.
*
* @return string
*/
public function discount()
{
return $this->formatAmount($this->rawDiscount());
}
/**
* Get the raw total discount amount.
*
* @return int
*/
public function rawDiscount()
{
$total = 0;
foreach ((array) $this->invoice->total_discount_amounts as $discount) {
$total += $discount->amount;
}
return (int) $total;
}
/**
* Get the total tax amount.
*
* @return string
*/
public function tax()
{
return $this->formatAmount($this->invoice->tax ?? 0);
}
/**
* Determine if the invoice has tax applied.
*
* @return bool
*/
public function hasTax()
{
$lineItems = $this->invoiceItems() + $this->subscriptions();
return Collection::make($lineItems)->contains(function (InvoiceLineItem $item) {
return $item->hasTaxRates();
});
}
/**
* Get the taxes applied to the invoice.
*
* @return \Laravel\Cashier\Tax[]
*/
public function taxes()
{
if (! is_null($this->taxes)) {
return $this->taxes;
}
$this->refreshWithExpandedData();
return $this->taxes = Collection::make($this->invoice->total_tax_amounts)
->sortByDesc('inclusive')
->map(function (object $taxAmount) {
return new Tax($taxAmount->amount, $this->invoice->currency, $taxAmount->tax_rate);
})
->all();
}
/**
* Determine if the customer is not exempted from taxes.
*
* @return bool
*/
public function isNotTaxExempt()
{
return $this->invoice->customer_tax_exempt === StripeCustomer::TAX_EXEMPT_NONE;
}
/**
* Determine if the customer is exempted from taxes.
*
* @return bool
*/
public function isTaxExempt()
{
return $this->invoice->customer_tax_exempt === StripeCustomer::TAX_EXEMPT_EXEMPT;
}
/**
* Determine if reverse charge applies to the customer.
*
* @return bool
*/
public function reverseChargeApplies()
{
return $this->invoice->customer_tax_exempt === StripeCustomer::TAX_EXEMPT_REVERSE;
}
/**
* Determine if the invoice will be charged automatically.
*
* @return bool
*/
public function chargesAutomatically()
{
return $this->invoice->collection_method === StripeInvoice::COLLECTION_METHOD_CHARGE_AUTOMATICALLY;
}
/**
* Determine if the invoice will be be sent by email.
*
* @return bool
*/
public function sendsInvoice()
{
return $this->invoice->collection_method === StripeInvoice::COLLECTION_METHOD_SEND_INVOICE;
}
/**
* Get all of the "invoice item" line items.
*
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function invoiceItems()
{
return Collection::make($this->invoiceLineItems())->filter(function (InvoiceLineItem $item) {
return $item->type === 'invoiceitem';
})->all();
}
/**
* Get all of the "subscription" line items.
*
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function subscriptions()
{
return Collection::make($this->invoiceLineItems())->filter(function (InvoiceLineItem $item) {
return $item->type === 'subscription';
})->all();
}
/**
* Get all of the invoice items.
*
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function invoiceLineItems()
{
if (! is_null($this->items)) {
return $this->items;
}
$this->refreshWithExpandedData();
return $this->items = Collection::make($this->invoice->lines->autoPagingIterator())
->map(function (StripeInvoiceLineItem $item) {
return new InvoiceLineItem($this, $item);
})->all();
}
/**
* Add an invoice item to this invoice.
*
* @param string $description
* @param int $amount
* @param array $options
* @return \Stripe\InvoiceItem
*/
public function tab($description, $amount, array $options = [])
{
$item = $this->owner()->tab($description, $amount, array_merge($options, ['invoice' => $this->invoice->id]));
$this->refresh();
return $item;
}
/**
* Add an invoice item for a specific Price ID to this invoice.
*
* @param string $price
* @param int $quantity
* @param array $options
* @return \Stripe\InvoiceItem
*/
public function tabPrice($price, $quantity = 1, array $options = [])
{
$item = $this->owner()->tabPrice($price, $quantity, array_merge($options, ['invoice' => $this->invoice->id]));
$this->refresh();
return $item;
}
/**
* Refresh the invoice.
*
* @return $this
*/
public function refresh()
{
$this->invoice = $this->invoice->refresh();
return $this;
}
/**
* Refresh the invoice with expanded objects.
*
* @return void
*/
protected function refreshWithExpandedData()
{
if ($this->refreshed) {
return;
}
$expand = [
'account_tax_ids',
'discounts',
'lines.data.tax_amounts.tax_rate',
'total_discount_amounts.discount',
'total_tax_amounts.tax_rate',
];
if ($this->invoice->id) {
$this->invoice = $this->owner->stripe()->invoices->retrieve($this->invoice->id, [
'expand' => $expand,
]);
} else {
// If no invoice ID is present then assume this is the customer's upcoming invoice...
$this->invoice = $this->owner->stripe()->invoices->upcoming(array_merge($this->refreshData, [
'customer' => $this->owner->stripe_id,
'expand' => $expand,
]));
}
$this->refreshed = true;
}
/**
* Format the given amount into a displayable currency.
*
* @param int $amount
* @return string
*/
protected function formatAmount($amount)
{
return Cashier::formatAmount($amount, $this->invoice->currency);
}
/**
* Return the Tax Ids of the account.
*
* @return \Stripe\TaxId[]
*/
public function accountTaxIds()
{
$this->refreshWithExpandedData();
return $this->invoice->account_tax_ids ?? [];
}
/**
* Return the Tax Ids of the customer.
*
* @return array
*/
public function customerTaxIds()
{
return $this->invoice->customer_tax_ids ?? [];
}
/**
* Finalize the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function finalize(array $options = [])
{
$this->invoice = $this->invoice->finalizeInvoice($options);
return $this;
}
/**
* Pay the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function pay(array $options = [])
{
$this->invoice = $this->invoice->pay($options);
return $this;
}
/**
* Send the Stripe invoice to the customer.
*
* @param array $options
* @return $this
*/
public function send(array $options = [])
{
$this->invoice = $this->invoice->sendInvoice($options);
return $this;
}
/**
* Void the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function void(array $options = [])
{
$this->invoice = $this->invoice->voidInvoice($options);
return $this;
}
/**
* Mark an invoice as uncollectible.
*
* @param array $options
* @return $this
*/
public function markUncollectible(array $options = [])
{
$this->invoice = $this->invoice->markUncollectible($options);
return $this;
}
/**
* Delete the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function delete(array $options = [])
{
$this->invoice = $this->invoice->delete($options);
return $this;
}
/**
* Determine if the invoice is open.
*
* @return bool
*/
public function isOpen()
{
return $this->invoice->status === StripeInvoice::STATUS_OPEN;
}
/**
* Determine if the invoice is a draft.
*
* @return bool
*/
public function isDraft()
{
return $this->invoice->status === StripeInvoice::STATUS_DRAFT;
}
/**
* Determine if the invoice is paid.
*
* @return bool
*/
public function isPaid()
{
return $this->invoice->status === StripeInvoice::STATUS_PAID;
}
/**
* Determine if the invoice is uncollectible.
*
* @return bool
*/
public function isUncollectible()
{
return $this->invoice->status === StripeInvoice::STATUS_UNCOLLECTIBLE;
}
/**
* Determine if the invoice is void.
*
* @return bool
*/
public function isVoid()
{
return $this->invoice->status === StripeInvoice::STATUS_VOID;
}
/**
* Determine if the invoice is deleted.
*
* @return bool
*/
public function isDeleted()
{
return $this->invoice->status === StripeInvoice::STATUS_DELETED;
}
/**
* Get the View instance for the invoice.
*
* @param array $data
* @return \Illuminate\Contracts\View\View
*/
public function view(array $data)
{
return View::make('cashier::receipt', array_merge($data, [
'invoice' => $this,
'owner' => $this->owner,
'user' => $this->owner,
]));
}
/**
* Capture the invoice as a PDF and return the raw bytes.
*
* @param array $data
* @return string
*/
public function pdf(array $data)
{
$options = config('cashier.invoices.options', []);
if ($paper = config('cashier.paper')) {
$options['paper'] = $paper;
}
return app(InvoiceRenderer::class)->render($this, $data, $options);
}
/**
* Create an invoice download response.
*
* @param array $data
* @return \Symfony\Component\HttpFoundation\Response
*/
public function download(array $data)
{
$filename = $data['product'].'_'.$this->date()->month.'_'.$this->date()->year;
return $this->downloadAs($filename, $data);
}
/**
* Create an invoice download response with a specific filename.
*
* @param string $filename
* @param array $data
* @return \Symfony\Component\HttpFoundation\Response
*/
public function downloadAs($filename, array $data)
{
return new Response($this->pdf($data), 200, [
'Content-Description' => 'File Transfer',
'Content-Disposition' => 'attachment; filename="'.$filename.'.pdf"',
'Content-Transfer-Encoding' => 'binary',
'Content-Type' => 'application/pdf',
'X-Vapor-Base64-Encode' => 'True',
]);
}
/**
* Get the Stripe model instance.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function owner()
{
return $this->owner;
}
/**
* Get the Stripe invoice instance.
*
* @return \Stripe\Invoice
*/
public function asStripeInvoice()
{
return $this->invoice;
}
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray()
{
return $this->asStripeInvoice()->toArray();
}
/**
* Convert the object to its JSON representation.
*
* @param int $options
* @return string
*/
public function toJson($options = 0)
{
return json_encode($this->jsonSerialize(), $options);
}
/**
* Convert the object into something JSON serializable.
*
* @return array
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->toArray();
}
/**
* Dynamically get values from the Stripe object.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
return $this->invoice->{$key};
}
}
|