Viewing file:  Payment.php (6.08 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Laravel\Cashier;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Support\Traits\ForwardsCalls;
use JsonSerializable;
use Laravel\Cashier\Exceptions\IncompletePayment;
use Stripe\PaymentIntent as StripePaymentIntent;
class Payment implements Arrayable, Jsonable, JsonSerializable
{
use ForwardsCalls;
/**
* The Stripe PaymentIntent instance.
*
* @var \Stripe\PaymentIntent
*/
protected $paymentIntent;
/**
* The related customer instance.
*
* @var \Laravel\Cashier\Billable
*/
protected $customer;
/**
* Create a new Payment instance.
*
* @param \Stripe\PaymentIntent $paymentIntent
* @return void
*/
public function __construct(StripePaymentIntent $paymentIntent)
{
$this->paymentIntent = $paymentIntent;
}
/**
* Get the total amount that will be paid.
*
* @return string
*/
public function amount()
{
return Cashier::formatAmount($this->rawAmount(), $this->paymentIntent->currency);
}
/**
* Get the raw total amount that will be paid.
*
* @return int
*/
public function rawAmount()
{
return $this->paymentIntent->amount;
}
/**
* The Stripe PaymentIntent client secret.
*
* @return string
*/
public function clientSecret()
{
return $this->paymentIntent->client_secret;
}
/**
* Capture a payment that is being held for the customer.
*
* @param array $options
* @return \Stripe\PaymentIntent
*/
public function capture(array $options = [])
{
return $this->paymentIntent->capture($options);
}
/**
* Determine if the payment needs a valid payment method.
*
* @return bool
*/
public function requiresPaymentMethod()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_REQUIRES_PAYMENT_METHOD;
}
/**
* Determine if the payment needs an extra action like 3D Secure.
*
* @return bool
*/
public function requiresAction()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_REQUIRES_ACTION;
}
/**
* Determine if the payment needs to be confirmed.
*
* @return bool
*/
public function requiresConfirmation()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_REQUIRES_CONFIRMATION;
}
/**
* Determine if the payment needs to be captured.
*
* @return bool
*/
public function requiresCapture()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_REQUIRES_CAPTURE;
}
/**
* Determine if the payment was canceled.
*
* @return bool
*/
public function isCanceled()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_CANCELED;
}
/**
* Determine if the payment was canceled.
*
* @return bool
*
* @deprecated Use isCanceled instead.
*/
public function isCancelled()
{
return $this->isCanceled();
}
/**
* Determine if the payment was successful.
*
* @return bool
*/
public function isSucceeded()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_SUCCEEDED;
}
/**
* Determine if the payment is processing.
*
* @return bool
*/
public function isProcessing()
{
return $this->paymentIntent->status === StripePaymentIntent::STATUS_PROCESSING;
}
/**
* Validate if the payment intent was successful and throw an exception if not.
*
* @return void
*
* @throws \Laravel\Cashier\Exceptions\IncompletePayment
*/
public function validate()
{
if ($this->requiresPaymentMethod()) {
throw IncompletePayment::paymentMethodRequired($this);
} elseif ($this->requiresAction()) {
throw IncompletePayment::requiresAction($this);
} elseif ($this->requiresConfirmation()) {
throw IncompletePayment::requiresConfirmation($this);
}
}
/**
* Retrieve the related customer for the payment intent if one exists.
*
* @return \Laravel\Cashier\Billable|null
*/
public function customer()
{
if ($this->customer) {
return $this->customer;
}
return $this->customer = Cashier::findBillable($this->paymentIntent->customer);
}
/**
* The Stripe PaymentIntent instance.
*
* @param array $expand
* @return \Stripe\PaymentIntent
*/
public function asStripePaymentIntent(array $expand = [])
{
if ($expand) {
return $this->customer()->stripe()->paymentIntents->retrieve(
$this->paymentIntent->id, ['expand' => $expand]
);
}
return $this->paymentIntent;
}
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray()
{
return $this->asStripePaymentIntent()->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->paymentIntent->{$key};
}
/**
* Dynamically pass missing methods to the PaymentIntent instance.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
return $this->forwardCallTo($this->paymentIntent, $method, $parameters);
}
}
|