Validation Class Reference

Public Member Functions
	__construct (\Magento\Checkout\Api\AgreementsValidatorInterface $agreementsValidator, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfiguration, \Magento\CheckoutAgreements\Api\CheckoutAgreementsListInterface $checkoutAgreementsList, \Magento\CheckoutAgreements\Model\Api\SearchCriteria\ActiveStoreAgreementsFilter $activeStoreAgreementsFilter)
	beforeSavePaymentInformationAndPlaceOrder (\Magento\Checkout\Api\PaymentInformationManagementInterface $subject, $cartId, \Magento\Quote\Api\Data\PaymentInterface $paymentMethod, \Magento\Quote\Api\Data\AddressInterface $billingAddress=null)
	beforeSavePaymentInformation (\Magento\Checkout\Api\PaymentInformationManagementInterface $subject, $cartId, \Magento\Quote\Api\Data\PaymentInterface $paymentMethod, \Magento\Quote\Api\Data\AddressInterface $billingAddress=null)

Protected Member Functions
	validateAgreements (\Magento\Quote\Api\Data\PaymentInterface $paymentMethod)
	isAgreementEnabled ()

Protected Attributes
	$scopeConfiguration
	$agreementsValidator

Detailed Description

Class Validation

Definition at line 16 of file Validation.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Checkout\Api\AgreementsValidatorInterface	$agreementsValidator,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfiguration,
		\Magento\CheckoutAgreements\Api\CheckoutAgreementsListInterface	$checkoutAgreementsList,
		\Magento\CheckoutAgreements\Model\Api\SearchCriteria\ActiveStoreAgreementsFilter	$activeStoreAgreementsFilter
	)

Parameters

\Magento\Checkout\Api\AgreementsValidatorInterface	$agreementsValidator
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfiguration
\Magento\CheckoutAgreements\Api\CheckoutAgreementsListInterface	$checkoutAgreementsList
ActiveStoreAgreementsFilter	$activeStoreAgreementsFilter

Definition at line 44 of file Validation.php.

      {
        $this->agreementsValidator = $agreementsValidator;
        $this->scopeConfiguration = $scopeConfiguration;
        $this->checkoutAgreementsList = $checkoutAgreementsList;
        $this->activeStoreAgreementsFilter = $activeStoreAgreementsFilter;
    }

Member Function Documentation

beforeSavePaymentInformation()

beforeSavePaymentInformation	(	\Magento\Checkout\Api\PaymentInformationManagementInterface	$subject,
			$cartId,
		\Magento\Quote\Api\Data\PaymentInterface	$paymentMethod,
		\Magento\Quote\Api\Data\AddressInterface	$billingAddress = null
	)

Parameters

\Magento\Checkout\Api\PaymentInformationManagementInterface	$subject
int	$cartId
\Magento\Quote\Api\Data\PaymentInterface	$paymentMethod
\Magento\Quote\Api\Data\AddressInterface | null	$billingAddress

Exceptions

Definition at line 85 of file Validation.php.

      {
        if ($this->isAgreementEnabled()) {
            $this->validateAgreements($paymentMethod);
        }
    }

beforeSavePaymentInformationAndPlaceOrder()

beforeSavePaymentInformationAndPlaceOrder	(	\Magento\Checkout\Api\PaymentInformationManagementInterface	$subject,
			$cartId,
		\Magento\Quote\Api\Data\PaymentInterface	$paymentMethod,
		\Magento\Quote\Api\Data\AddressInterface	$billingAddress = null
	)

Parameters

\Magento\Checkout\Api\PaymentInformationManagementInterface	$subject
int	$cartId
\Magento\Quote\Api\Data\PaymentInterface	$paymentMethod
\Magento\Quote\Api\Data\AddressInterface | null	$billingAddress

Exceptions

Definition at line 65 of file Validation.php.

      {
        if ($this->isAgreementEnabled()) {
            $this->validateAgreements($paymentMethod);
        }
    }

isAgreementEnabled()

isAgreementEnabled ( )

protected

Verify if agreement validation needed

Returns

bool

Definition at line 121 of file Validation.php.

    {
        $isAgreementsEnabled = $this->scopeConfiguration->isSetFlag(
            AgreementsProvider::PATH_ENABLED,
            ScopeInterface::SCOPE_STORE
        );
        $agreementsList = $isAgreementsEnabled
            ? $this->checkoutAgreementsList->getList($this->activeStoreAgreementsFilter->buildSearchCriteria())
            : [];
        return (bool)($isAgreementsEnabled && count($agreementsList) > 0);
    }

validateAgreements()

validateAgreements ( \Magento\Quote\Api\Data\PaymentInterface  $paymentMethod )

protected

Parameters

\Magento\Quote\Api\Data\PaymentInterface

$paymentMethod

Exceptions

Definition at line 101 of file Validation.php.

    {
        $agreements = $paymentMethod->getExtensionAttributes() === null
            ? []
            : $paymentMethod->getExtensionAttributes()->getAgreementIds();

        if (!$this->agreementsValidator->isValid($agreements)) {
            throw new \Magento\Framework\Exception\CouldNotSaveException(
                __(
                    "The order wasn't placed. "
                    . "First, agree to the terms and conditions, then try placing your order again."
                )
            );
        }
    }

Field Documentation

$agreementsValidator

$agreementsValidator

protected

Definition at line 26 of file Validation.php.

$scopeConfiguration

$scopeConfiguration

protected

Definition at line 21 of file Validation.php.

---

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

• vendor/magento/module-checkout-agreements/Model/Checkout/Plugin/Validation.php