Class Mage_Sales_Model_Billing_Agreement

Description
Description | Vars (details) | Methods (details) Constants (details)

Billing Agreement abstract model

Located in /Sales/Model/Billing/Agreement.php (line 32) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Payment_Model_Billing_AgreementAbstract
         |
         --Mage_Sales_Model_Billing_Agreement
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
STATUS_ACTIVE = 'active'
STATUS_CANCELED = 'canceled'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
array $_relatedOrders
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Mage_Sales_Model_Billing_Agreement addOrderRelation (int $orderId)
bool canCancel ()
Mage_Sales_Model_Billing_Agreement cancel ()
Mage_Paypal_Controller_Express_Abstract getAvailableCustomerBillingAgreements ( $customerId, int $customer)
array getStatusesArray ()
string getStatusLabel ()
Mage_Sales_Model_Billing_Agreement importOrderPayment (Mage_Sales_Model_Order_Payment $payment)
string initToken ()
bool isValid ()
bool needToCreateForCustomer (int $customerId)
Mage_Sales_Model_Billing_Agreement place ()
Mage_Sales_Model_Billing_Agreement verifyToken ()
Mage_Core_Model_Abstract _afterSave ()
Mage_Core_Model_Abstract _beforeSave ()
void _construct ()
void _saveOrderRelations ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
array $_relatedOrders = array() (line 42)

Related agreement orders

  • access: protected

Inherited Variables

Inherited from Mage_Payment_Model_Billing_AgreementAbstract

Mage_Payment_Model_Billing_AgreementAbstract::$_errors
 Mage_Payment_Model_Billing_AgreementAbstract::$_paymentMethodInstance

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_eventObject
 Mage_Core_Model_Abstract::$_eventPrefix
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Vars (details) Constants (details) Methods (details)
addOrderRelation (line 254)

Add order relation to current billing agreement

  • access: public
Mage_Sales_Model_Billing_Agreement addOrderRelation (int $orderId)
  • int $orderId
canCancel (line 160)

Check whether can cancel billing agreement

  • access: public
bool canCancel ()
cancel (line 148)

Cancel billing agreement

  • access: public
Mage_Sales_Model_Billing_Agreement cancel ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::cancel()
Cancel billing agreement
getAvailableCustomerBillingAgreements (line 228)

Retrieve available customer Billing Agreements

  • access: public
Mage_Paypal_Controller_Express_Abstract getAvailableCustomerBillingAgreements ( $customerId, int $customer)
  • int $customer
  • $customerId
getStatusesArray (line 170)

Retrieve billing agreement statuses array

  • access: public
array getStatusesArray ()
getStatusLabel (line 87)

Retrieve billing agreement status label

  • access: public
string getStatusLabel ()
importOrderPayment (line 205)

Import payment data to billing agreement

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

  • access: public
Mage_Sales_Model_Billing_Agreement importOrderPayment (Mage_Sales_Model_Order_Payment $payment)
initToken (line 102)

Initialize token

  • access: public
string initToken ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::initToken()
Init billing agreement
isValid (line 183)

Validate data

  • access: public
bool isValid ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::isValid()
Validate data before save
needToCreateForCustomer (line 243)

Check whether need to create billing agreement for customer

  • access: public
bool needToCreateForCustomer (int $customerId)
  • int $customerId
place (line 127)

Create billing agreement

  • access: public
Mage_Sales_Model_Billing_Agreement place ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::place()
Create billing agreement
verifyToken (line 115)

Get billing agreement details Data from response is inside this object

  • access: public
Mage_Sales_Model_Billing_Agreement verifyToken ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::verifyToken()
Verify billing agreement details
_afterSave (line 74)

Save agreement order relations

  • access: protected
Mage_Core_Model_Abstract _afterSave ()
Redefinition of:
Mage_Core_Model_Abstract::_afterSave()
Processing object after save data
_beforeSave (line 58)

Set created_at parameter

  • access: protected
Mage_Core_Model_Abstract _beforeSave ()
Redefinition of:
Mage_Payment_Model_Billing_AgreementAbstract::_beforeSave()
Before save, it's overriden just to make data validation on before save event
_construct (line 48)

Init model

  • access: protected
void _construct ()
_saveOrderRelations (line 263)

Save related orders

  • access: protected
void _saveOrderRelations ()

Inherited Methods

Inherited From Mage_Payment_Model_Billing_AgreementAbstract

Mage_Payment_Model_Billing_AgreementAbstract::cancel()
Mage_Payment_Model_Billing_AgreementAbstract::getPaymentMethodInstance()
Mage_Payment_Model_Billing_AgreementAbstract::initToken()
Mage_Payment_Model_Billing_AgreementAbstract::isValid()
Mage_Payment_Model_Billing_AgreementAbstract::place()
Mage_Payment_Model_Billing_AgreementAbstract::verifyToken()
Mage_Payment_Model_Billing_AgreementAbstract::_beforeSave()

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
STATUS_ACTIVE = 'active' (line 34)
STATUS_CANCELED = 'canceled' (line 35)

Documentation generated on Fri, 11 Feb 2011 16:56:23 +0200 by phpDocumentor 1.4.3