Current File : //home/forge/api-takeaseat.eco-n-tech.co.uk/vendor/laravel/cashier/src/Invoice.php
<?php
namespace Laravel\Cashier;
use Carbon\Carbon;
use Dompdf\Dompdf;
use Dompdf\Options;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\View;
use JsonSerializable;
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 \Stripe\Collection|\Stripe\InvoiceLineItem[]
*/
protected $items;
/**
* The taxes applied to the invoice.
*
* @var \Laravel\Cashier\Tax[]
*/
protected $taxes;
/**
* Create a new invoice instance.
*
* @param \Illuminate\Database\Eloquent\Model $owner
* @param \Stripe\Invoice $invoice
* @return void
*
* @throws \Laravel\Cashier\Exceptions\InvalidInvoice
*/
public function __construct($owner, StripeInvoice $invoice)
{
if ($owner->stripe_id !== $invoice->customer) {
throw InvalidInvoice::invalidOwner($invoice, $owner);
}
$this->owner = $owner;
$this->invoice = $invoice;
}
/**
* Get a Carbon date for the invoice.
*
* @param \DateTimeZone|string $timezone
* @return \Carbon\Carbon
*/
public function date($timezone = null)
{
$carbon = Carbon::createFromTimestampUTC($this->invoice->created ?? $this->invoice->date);
return $timezone ? $carbon->setTimezone($timezone) : $carbon;
}
/**
* Get the total amount that was paid (or will be paid).
*
* @return string
*/
public function total()
{
return $this->formatAmount($this->rawTotal());
}
/**
* Get the raw total amount that was paid (or will be paid).
*
* @return int
*/
public function rawTotal()
{
return $this->invoice->total + $this->rawStartingBalance();
}
/**
* Get the total of the invoice (before discounts).
*
* @return string
*/
public function subtotal()
{
return $this->formatAmount($this->invoice->subtotal);
}
/**
* 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 invoice has a discount.
*
* @return bool
*/
public function hasDiscount()
{
return $this->rawDiscount() > 0;
}
/**
* Get the discount amount.
*
* @return string
*/
public function discount()
{
return $this->formatAmount($this->rawDiscount());
}
/**
* Get the raw discount amount.
*
* @return int
*/
public function rawDiscount()
{
if (! isset($this->invoice->discount)) {
return 0;
}
$total = 0;
foreach ($this->invoice->total_discount_amounts as $discount) {
$total += $discount->amount;
}
return (int) $total;
}
/**
* Get the coupon code applied to the invoice.
*
* @return string|null
*/
public function coupon()
{
if (isset($this->invoice->discount)) {
return $this->invoice->discount->coupon->id;
}
}
/**
* Get the coupon name applied to the invoice.
*
* @return string|null
*/
public function couponName()
{
if (isset($this->invoice->discount)) {
return $this->invoice->discount->coupon->name ?: $this->invoice->discount->coupon->id;
}
}
/**
* Determine if the discount is a percentage.
*
* @return bool
*/
public function discountIsPercentage()
{
return isset($this->invoice->discount) && isset($this->invoice->discount->coupon->percent_off);
}
/**
* Get the discount percentage for the invoice.
*
* @return int
*/
public function percentOff()
{
if ($this->coupon()) {
return $this->invoice->discount->coupon->percent_off;
}
return 0;
}
/**
* Get the discount amount for the invoice.
*
* @return string
*/
public function amountOff()
{
return $this->formatAmount($this->rawAmountOff());
}
/**
* Get the raw discount amount for the invoice.
*
* @return int
*/
public function rawAmountOff()
{
if (isset($this->invoice->discount->coupon->amount_off)) {
return $this->invoice->discount->coupon->amount_off;
}
return 0;
}
/**
* Get the total tax amount.
*
* @return string
*/
public function tax()
{
return $this->formatAmount($this->invoice->tax);
}
/**
* Determine if the invoice has tax applied.
*
* @return bool
*/
public function hasTax()
{
$lineItems = $this->invoiceItems() + $this->subscriptions();
return collect($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->refreshWithExpandedTaxRates();
return $this->taxes = collect($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;
}
/**
* Get all of the "invoice item" line items.
*
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function invoiceItems()
{
return $this->invoiceLineItemsByType('invoiceitem');
}
/**
* Get all of the "subscription" line items.
*
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function subscriptions()
{
return $this->invoiceLineItemsByType('subscription');
}
/**
* Get all of the invoice items by a given type.
*
* @param string $type
* @return \Laravel\Cashier\InvoiceLineItem[]
*/
public function invoiceLineItemsByType($type)
{
if (is_null($this->items)) {
$this->refreshWithExpandedTaxRates();
$this->items = new Collection($this->invoice->lines->autoPagingIterator());
}
return $this->items->filter(function (StripeInvoiceLineItem $item) use ($type) {
return $item->type === $type;
})->map(function (StripeInvoiceLineItem $item) {
return new InvoiceLineItem($this, $item);
})->all();
}
/**
* Refresh the invoice with expanded TaxRate objects.
*
* @return void
*/
protected function refreshWithExpandedTaxRates()
{
if ($this->invoice->id) {
$this->invoice = StripeInvoice::retrieve([
'id' => $this->invoice->id,
'expand' => [
'lines.data.tax_amounts.tax_rate',
'total_tax_amounts.tax_rate',
],
], $this->owner->stripeOptions());
} else {
// If no invoice ID is present then assume this is the customer's upcoming invoice...
$this->invoice = StripeInvoice::upcoming([
'customer' => $this->owner->stripe_id,
'expand' => [
'lines.data.tax_amounts.tax_rate',
'total_tax_amounts.tax_rate',
],
], $this->owner->stripeOptions());
}
}
/**
* Format the given amount into a displayable currency.
*
* @param int $amount
* @return string
*/
protected function formatAmount($amount)
{
return Cashier::formatAmount($amount, $this->invoice->currency);
}
/**
* Finalize the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function finalize(array $options = [])
{
$this->invoice = $this->invoice->finalizeInvoice($options, $this->owner->stripeOptions());
return $this;
}
/**
* Pay the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function pay(array $options = [])
{
$this->invoice = $this->invoice->pay($options, $this->owner->stripeOptions());
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, $this->owner->stripeOptions());
return $this;
}
/**
* Void the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function void(array $options = [])
{
$this->invoice = $this->invoice->voidInvoice($options, $this->owner->stripeOptions());
return $this;
}
/**
* Mark an invoice as uncollectible.
*
* @param array $options
* @return $this
*/
public function markUncollectible(array $options = [])
{
$this->invoice = $this->invoice->markUncollectible($options, $this->owner->stripeOptions());
return $this;
}
/**
* Delete the Stripe invoice.
*
* @param array $options
* @return $this
*/
public function delete(array $options = [])
{
$this->invoice = $this->invoice->delete($options, $this->owner->stripeOptions());
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)
{
if (! defined('DOMPDF_ENABLE_AUTOLOAD')) {
define('DOMPDF_ENABLE_AUTOLOAD', false);
}
$options = new Options;
$options->setChroot(base_path());
$dompdf = new Dompdf($options);
$dompdf->setPaper(config('cashier.paper', 'letter'));
$dompdf->loadHtml($this->view($data)->render());
$dompdf->render();
return $dompdf->output();
}
/**
* 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
*/
public function jsonSerialize()
{
return $this->toArray();
}
/**
* Dynamically get values from the Stripe invoice.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
return $this->invoice->{$key};
}
}
Mini Shell