Agreement Class Reference

Inheritance diagram for Agreement:

Public Member Functions
	addOrderRelation ($agreementId, $orderId)
	addOrdersFilter (\Magento\Framework\Data\Collection\AbstractDb $orderCollection, $agreementIds)
Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)
	__sleep ()
	__wakeup ()
	getIdFieldName ()
	getMainTable ()
	getTable ($tableName)
	getConnection ()
	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)
	save (\Magento\Framework\Model\AbstractModel $object)
	delete (\Magento\Framework\Model\AbstractModel $object)
	addUniqueField ($field)
	resetUniqueField ()
	unserializeFields (\Magento\Framework\Model\AbstractModel $object)
	getUniqueFields ()
	hasDataChanged ($object)
	getChecksum ($table)
	afterLoad (\Magento\Framework\DataObject $object)
	beforeSave (\Magento\Framework\DataObject $object)
	afterSave (\Magento\Framework\DataObject $object)
	beforeDelete (\Magento\Framework\DataObject $object)
	afterDelete (\Magento\Framework\DataObject $object)
	serializeFields (\Magento\Framework\Model\AbstractModel $object)
Public Member Functions inherited from AbstractResource
	__construct ()
	getConnection ()
	beginTransaction ()
	addCommitCallback ($callback)
	commit ()
	rollBack ()
	getValidationRulesBeforeSave ()

Protected Member Functions
	_construct ()
Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)
	_setResource ($connections, $tables=null)
	_setMainTable ($mainTable, $idFieldName=null)
	_getConnection ($resourceName)
	_getLoadSelect ($field, $value, $object)
	_initUniqueFields ()
	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)
	_prepareValueForSave ($value, $type)
	_checkUnique (\Magento\Framework\Model\AbstractModel $object)
	_afterLoad (\Magento\Framework\Model\AbstractModel $object)
	_beforeSave (\Magento\Framework\Model\AbstractModel $object)
	_afterSave (\Magento\Framework\Model\AbstractModel $object)
	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)
	_afterDelete (\Magento\Framework\Model\AbstractModel $object)
	_serializeFields (\Magento\Framework\Model\AbstractModel $object)
	prepareDataForUpdate ($object)
	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)
	saveNewObject (\Magento\Framework\Model\AbstractModel $object)
	updateObject (\Magento\Framework\Model\AbstractModel $object)
	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)
	isModified (\Magento\Framework\Model\AbstractModel $object)
	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)
Protected Member Functions inherited from AbstractResource
	_construct ()
	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)
	_unserializeField (DataObject $object, $field, $defaultValue=null)
	_prepareDataForTable (DataObject $object, $table)
	_prepareTableValueForSave ($value, $type)
	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)
	getSerializer ()

Additional Inherited Members
Protected Attributes inherited from AbstractDb
	$_resources
	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION
	$_connections = []
	$_resourceModel
	$_tables = []
	$_mainTable
	$_idFieldName
	$_isPkAutoIncrement = true
	$_useIsObjectNew = false
	$_mainTableFields
	$_uniqueFields = null
	$_serializableFields = []
	$transactionManager
	$objectRelationProcessor
Protected Attributes inherited from AbstractResource
	$serializer
	$_logger

Detailed Description

Billing agreement resource model

Definition at line 11 of file Agreement.php.

Member Function Documentation

_construct()

_construct ( )

protected

Resource initialization

Returns

void

Definition at line 18 of file Agreement.php.

    {
        $this->_init('paypal_billing_agreement', 'agreement_id');
    }

addOrderRelation()

addOrderRelation	(		$agreementId,
			$orderId
	)

Add order relation to billing agreement

Parameters

int	$agreementId
int	$orderId

Returns

$this

Definition at line 30 of file Agreement.php.

    {
        $this->getConnection()->insert(
            $this->getTable('paypal_billing_agreement_order'),
            ['agreement_id' => $agreementId, 'order_id' => $orderId]
        );
        return $this;
    }

addOrdersFilter()

addOrdersFilter	(	\Magento\Framework\Data\Collection\AbstractDb	$orderCollection,
			$agreementIds
	)

Add billing agreement filter on orders collection

Parameters

\Magento\Framework\Data\Collection\AbstractDb	$orderCollection
string | int | array	$agreementIds

Returns

$this

Definition at line 46 of file Agreement.php.

    {
        $agreementIds = is_array($agreementIds) ? $agreementIds : [$agreementIds];
        $orderIds = $this->getConnection()->fetchCol(
            $this->getConnection()->select()
                ->from(['pbao' => $this->getTable('paypal_billing_agreement_order')], ['order_id'])
                ->where(
                    'pbao.agreement_id IN(?)',
                    $agreementIds
                )
        );
        $orderCollection->getSelect()
            ->where('main_table.entity_id IN (?)', $orderIds);
        return $this;
    }

---

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

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