Inheritance diagram for Agreement:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Payment\Helper\Data $paymentData, \Magento\Paypal\Model\ResourceModel\Billing\Agreement\CollectionFactory $billingAgreementFactory, \Magento\Framework\Stdlib\DateTime\DateTimeFactory $dateFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	beforeSave ()

	afterSave ()

	getStatusLabel ()

	initToken ()

	verifyToken ()

	place ()

	cancel ()

	canCancel ()

	getStatusesArray ()

	isValid ()

	importOrderPayment (Payment $payment)

	getAvailableCustomerBillingAgreements ($customerId)

	needToCreateForCustomer ($customerId)

	addOrderRelation ($orderId)

Public Member Functions inherited from AbstractAgreement
	initToken ()

	verifyToken ()

	place ()

	cancel ()

	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getPaymentMethodInstance ()

	isValid ()

	beforeSave ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	STATUS_ACTIVE = 'active'

const	STATUS_CANCELED = 'canceled'

Protected Member Functions
	_construct ()

	_saveOrderRelations ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_relatedOrders = []

	$_billingAgreementFactory

	$_dateFactory

Protected Attributes inherited from AbstractAgreement
	$_paymentMethodInstance = null

	$_errors = []

	$_paymentData = null

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Billing Agreement abstract model

@api @method int getCustomerId() @method \Magento\Paypal\Model\Billing\Agreement setCustomerId(int $value) @method string getMethodCode() @method \Magento\Paypal\Model\Billing\Agreement setMethodCode(string $value) @method string getReferenceId() @method \Magento\Paypal\Model\Billing\Agreement setReferenceId(string $value) @method string getStatus() @method \Magento\Paypal\Model\Billing\Agreement setStatus(string $value) @method string getCreatedAt() @method \Magento\Paypal\Model\Billing\Agreement setCreatedAt(string $value) @method string getUpdatedAt() @method \Magento\Paypal\Model\Billing\Agreement setUpdatedAt(string $value) @method int getStoreId() @method \Magento\Paypal\Model\Billing\Agreement setStoreId(int $value) @method string getAgreementLabel() @method \Magento\Paypal\Model\Billing\Agreement setAgreementLabel(string $value)

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 34 of file Agreement.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Paypal\Model\ResourceModel\Billing\Agreement\CollectionFactory	$billingAgreementFactory,
		\Magento\Framework\Stdlib\DateTime\DateTimeFactory	$dateFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Payment\Helper\Data	$paymentData
\Magento\Paypal\Model\ResourceModel\Billing\Agreement\CollectionFactory	$billingAgreementFactory
\Magento\Framework\Stdlib\DateTime\DateTimeFactory	$dateFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 67 of file Agreement.php.

       {
         parent::__construct($context, $registry, $paymentData, $resource, $resourceCollection, $data);
         $this->_billingAgreementFactory = $billingAgreementFactory;
         $this->_dateFactory = $dateFactory;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Init model

Returns: void

Definition at line 87 of file Agreement.php.

     {
         $this->_init(\Magento\Paypal\Model\ResourceModel\Billing\Agreement::class);
     }

◆ _saveOrderRelations()

_saveOrderRelations ( )

protected

Save related orders

Returns: void

Definition at line 310 of file Agreement.php.

     {
         foreach ($this->_relatedOrders as $order) {
             $orderId = $order instanceof \Magento\Sales\Model\Order ? $order->getId() : (int)$order;
             $this->getResource()->addOrderRelation($this->getId(), $orderId);
         }
     }

◆ addOrderRelation()

addOrderRelation ( $orderId )

Add order relation to current billing agreement

Parameters

int | \Magento\Sales\Model\Order $orderId

Returns: $this

Definition at line 299 of file Agreement.php.

     {
         $this->_relatedOrders[] = $orderId;
         return $this;
     }

◆ afterSave()

afterSave ( )

Save agreement order relations

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 113 of file Agreement.php.

     {
         if (!empty($this->_relatedOrders)) {
             $this->_saveOrderRelations();
         }
         return parent::afterSave();
     }

◆ beforeSave()

beforeSave ( )

Set created_at parameter

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 97 of file Agreement.php.

     {
         $date = $this->_dateFactory->create()->gmtDate();
         if ($this->isObjectNew() && !$this->getCreatedAt()) {
             $this->setCreatedAt($date);
         } else {
             $this->setUpdatedAt($date);
         }
         return parent::beforeSave();
     }

◆ canCancel()

canCancel ( )

Check whether can cancel billing agreement

Returns: bool

Definition at line 204 of file Agreement.php.

     {
         return $this->getStatus() != self::STATUS_CANCELED;
     }

◆ cancel()

cancel ( )

Cancel billing agreement

Returns: $this

Definition at line 192 of file Agreement.php.

     {
         $this->setStatus(self::STATUS_CANCELED);
         $this->getPaymentMethodInstance()->updateBillingAgreementStatus($this);
         return $this->save();
     }

◆ getAvailableCustomerBillingAgreements()

getAvailableCustomerBillingAgreements ( $customerId )

Retrieve available customer Billing Agreements

Parameters

int $customerId

Returns: \Magento\Paypal\Model\ResourceModel\Billing\Agreement\Collection

Definition at line 273 of file Agreement.php.

     {
         $collection = $this->_billingAgreementFactory->create();
         $collection->addFieldToFilter('customer_id', $customerId)
             ->addFieldToFilter('status', self::STATUS_ACTIVE)
             ->setOrder('agreement_id');
         return $collection;
     }

◆ getStatusesArray()

getStatusesArray ( )

Retrieve billing agreement statuses array

Returns: array

Definition at line 214 of file Agreement.php.

     {
         return [
             self::STATUS_ACTIVE     => __('Active'),
             self::STATUS_CANCELED   => __('Canceled')
         ];
     }

◆ getStatusLabel()

getStatusLabel ( )

Retrieve billing agreement status label

Returns: \Magento\Framework\Phrase|string

Definition at line 126 of file Agreement.php.

     {
         switch ($this->getStatus()) {
             case self::STATUS_ACTIVE:
                 return __('Active');
             case self::STATUS_CANCELED:
                 return __('Canceled');
             default:
                 return '';
         }
     }

◆ importOrderPayment()

importOrderPayment ( Payment $payment )

Import payment data to billing agreement

$payment->getBillingAgreementData() contains array with following structure : [billing_agreement_id] => string [method_code] => string

Parameters

Payment $payment

Returns: $this

Definition at line 249 of file Agreement.php.

     {
         $baData = $payment->getBillingAgreementData();
 
         $this->_paymentMethodInstance = (isset($baData['method_code']))
             ? $this->_paymentData->getMethodInstance($baData['method_code'])
             : $payment->getMethodInstance();
 
         $this->_paymentMethodInstance->setStore($payment->getMethodInstance()->getStore());
         $this->setCustomerId($payment->getOrder()->getCustomerId())
             ->setMethodCode($this->_paymentMethodInstance->getCode())
             ->setReferenceId($baData['billing_agreement_id'])
             ->setStatus(self::STATUS_ACTIVE)
             ->setAgreementLabel($this->_paymentMethodInstance->getTitle());
 
         return $this;
     }

◆ initToken()

initToken ( )

Initialize token

Returns: string

Definition at line 143 of file Agreement.php.

     {
         $this->getPaymentMethodInstance()
              ->initBillingAgreementToken($this);
 
         return $this->getRedirectUrl();
     }

◆ isValid()

isValid ( )

Validate data

Returns: bool

Definition at line 227 of file Agreement.php.

     {
         $result = parent::isValid();
         if (!$this->getCustomerId()) {
             $this->_errors[] = __('The customer ID is not set.');
         }
         if (!$this->getStatus()) {
             $this->_errors[] = __('The Billing Agreement status is not set.');
         }
         return $result && empty($this->_errors);
     }

◆ needToCreateForCustomer()

needToCreateForCustomer ( $customerId )

Check whether need to create billing agreement for customer

Parameters

int $customerId

Returns: bool

Definition at line 288 of file Agreement.php.

     {
         return $customerId ? count($this->getAvailableCustomerBillingAgreements($customerId)) == 0 : false;
     }

◆ place()

place ( )

Create billing agreement

Returns: $this

Definition at line 170 of file Agreement.php.

     {
         $this->verifyToken();
 
         $paymentMethodInstance = $this->getPaymentMethodInstance();
         $paymentMethodInstance->placeBillingAgreement($this);
 
         $this->setCustomerId($this->getCustomerId())
             ->setMethodCode($this->getMethodCode())
             ->setReferenceId($this->getBillingAgreementId())
             ->setStatus(self::STATUS_ACTIVE)
             ->setAgreementLabel($paymentMethodInstance->getTitle())
             ->save();
 
         return $this;
     }

◆ verifyToken()

verifyToken ( )

Get billing agreement details Data from response is inside this object

Returns: $this

Definition at line 157 of file Agreement.php.

     {
         $this->getPaymentMethodInstance()
              ->getBillingAgreementTokenInfo($this);
 
         return $this;
     }

Field Documentation

◆ $_billingAgreementFactory

$_billingAgreementFactory

protected

Definition at line 50 of file Agreement.php.

◆ $_dateFactory

$_dateFactory

protected

Definition at line 55 of file Agreement.php.

◆ $_relatedOrders

$_relatedOrders = []

protected

Definition at line 45 of file Agreement.php.

◆ STATUS_ACTIVE

const STATUS_ACTIVE = 'active'

Definition at line 36 of file Agreement.php.

◆ STATUS_CANCELED

const STATUS_CANCELED = 'canceled'

Definition at line 38 of file Agreement.php.

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

vendor/magento/module-paypal/Model/Billing/Agreement.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _saveOrderRelations()

◆ addOrderRelation()

◆ afterSave()

◆ beforeSave()

◆ canCancel()

◆ cancel()

◆ getAvailableCustomerBillingAgreements()

◆ getStatusesArray()

◆ getStatusLabel()

◆ importOrderPayment()

◆ initToken()

◆ isValid()

◆ needToCreateForCustomer()

◆ place()

◆ verifyToken()

Field Documentation

◆ $_billingAgreementFactory

◆ $_dateFactory

◆ $_relatedOrders

◆ STATUS_ACTIVE

◆ STATUS_CANCELED