InstantPurchaseOption Class Reference

Public Member Functions
	__construct (PaymentTokenInterface $paymentToken=null, Address $shippingAddress=null, Address $billingAddress=null, ShippingMethodInterface $shippingMethod=null)
	isAvailable ()
	getPaymentToken ()
	getShippingAddress ()
	getBillingAddress ()
	getShippingMethod ()

Detailed Description

Option to make instant purchase.

@api

Since

100.2.0

Definition at line 21 of file InstantPurchaseOption.php.

Constructor & Destructor Documentation

__construct()

__construct	(	PaymentTokenInterface	$paymentToken = null,
		Address	$shippingAddress = null,
		Address	$billingAddress = null,
		ShippingMethodInterface	$shippingMethod = null
	)

InstantPurchaseOption constructor.

Parameters

PaymentTokenInterface | null	$paymentToken
Address | null	$shippingAddress
Address | null	$billingAddress
ShippingMethodInterface | null	$shippingMethod

Exceptions

InvalidArgumentException

if invalid data provided (implementation error)

@SuppressWarnings(Magento.TypeDuplication) Type duplication verified. This is not a service class and should not be instantiated directly through Object Manager. Use InstantPurchaseOptionFactory instead.

Definition at line 56 of file InstantPurchaseOption.php.

      {
        $customers = [];
        if ($paymentToken) {
            $customers[] = $paymentToken->getCustomerId();
        }
        if ($shippingAddress) {
            $customers[] = $shippingAddress->getCustomerId();
        }
        if ($billingAddress) {
            $customers[] = $billingAddress->getCustomerId();
        }
        if (count(array_unique($customers)) > 1) {
            throw new InvalidArgumentException('Provided data does not belong to same customer.');
        }

        $this->paymentToken = $paymentToken;
        $this->shippingAddress = $shippingAddress;
        $this->billingAddress = $billingAddress;
        $this->shippingMethod = $shippingMethod;
    }

Member Function Documentation

getBillingAddress()

getBillingAddress

(

)

Returns billing address for instant purchase.

Returns

Address

Exceptions

LocalizedException

if billing address is not defined

Since

100.2.0

Definition at line 137 of file InstantPurchaseOption.php.

                                       : Address
    {
        if (!isset($this->billingAddress)) {
            throw new LocalizedException(__('Billing address is not defined for instance purchase.'));
        }
        return $this->billingAddress;
    }

getPaymentToken()

getPaymentToken

(

)

Returns payment token for instant purchase.

Returns

PaymentTokenInterface

Exceptions

LocalizedException

if payment token is not defined

Since

100.2.0

Definition at line 105 of file InstantPurchaseOption.php.

                                     : PaymentTokenInterface
    {
        if (!isset($this->paymentToken)) {
            throw new LocalizedException(
                __("A payment method isn't defined for instance purchase. Verify and try again.")
            );
        }
        return $this->paymentToken;
    }

getShippingAddress()

getShippingAddress

(

)

Returns shipping address for instant purchase.

Returns

Address

Exceptions

LocalizedException

if shipping address is not defined

Since

100.2.0

Definition at line 122 of file InstantPurchaseOption.php.

                                        : Address
    {
        if (!isset($this->shippingAddress)) {
            throw new LocalizedException(__('Shipping address is not defined for instance purchase.'));
        }
        return $this->shippingAddress;
    }

getShippingMethod()

getShippingMethod

(

)

Returns shipping method for instant purchase.

Returns

ShippingMethodInterface

Exceptions

LocalizedException

if shipping method is not defined

Since

100.2.0

Definition at line 152 of file InstantPurchaseOption.php.

                                       : ShippingMethodInterface
    {
        if (!isset($this->shippingMethod)) {
            throw new LocalizedException(__('Shipping method is not defined for instance purchase.'));
        }
        return $this->shippingMethod;
    }

isAvailable()

isAvailable

(

)

Checks if option available

Returns

bool

Since

100.2.0

Definition at line 88 of file InstantPurchaseOption.php.

                                 : bool
    {
        return isset(
            $this->paymentToken,
            $this->shippingAddress,
            $this->billingAddress,
            $this->shippingMethod
        ) && $this->shippingMethod->getAvailable();
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-instant-purchase/Model/InstantPurchaseOption.php