Class Mage_Sales_Model_Recurring_Profile

Sales implementation of recurring payment profiles Implements saving and manageing profiles

Varien_Object

Mage_Sales_Model_Recurring_Profile

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Recurring/Profile.php

Methods summary
`public Mage_Sales_Model_Order`	# `loadByInternalReferenceId( string $internalReferenceId )` Load order by system increment identifier Load order by system increment identifier Parameters `$internalReferenceId` `string` $incrementId Returns `Mage_Sales_Model_Order`
`public`	# `submit( )` Submit a recurring profile right after an order is placed Submit a recurring profile right after an order is placed
`public`	# `activate( )` Activate the suspended profile Activate the suspended profile
`public boolean`	# `canActivate( )` Check whether the workflow allows to activate the profile Check whether the workflow allows to activate the profile Returns `boolean`
`public`	# `suspend( )` Suspend active profile Suspend active profile
`public boolean`	# `canSuspend( )` Check whether the workflow allows to suspend the profile Check whether the workflow allows to suspend the profile Returns `boolean`
`public`	# `cancel( )` Cancel active or suspended profile Cancel active or suspended profile
`public boolean`	# `canCancel( )` Check whether the workflow allows to cancel the profile Check whether the workflow allows to cancel the profile Returns `boolean`
`public`	# `fetchUpdate( )`
`public`	# `canFetchUpdate( )`
`public Mage_Sales_Model_Order`	# `createOrder( )` Initialize new order based on profile data Initialize new order based on profile data Takes arbitrary number of Varien_Object instances to be treated as items for new order Returns `Mage_Sales_Model_Order`
`public boolean`	# `isValid( )` Validate states Validate states Returns `boolean` Overrides `Mage_Payment_Model_Recurring_Profile::isValid()`
`public Mage_Sales_Model_Recurring_Profile`	# `importQuote( Mage_Sales_Model_Quote $quote )` Import quote information to the profile Import quote information to the profile Parameters `$quote` `Mage_Sales_Model_Quote_` $quote Returns `Mage_Sales_Model_Recurring_Profile`
`public Mage_Sales_Model_Recurring_Profile`	# `importQuoteItem( Mage_Sales_Model_Quote_Item_Abstract $item )` Import quote item information to the profile Import quote item information to the profile Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `Mage_Sales_Model_Recurring_Profile`
`public string\|null`	# `getFieldLabel( string $field )` Getter for sales-related field labels Getter for sales-related field labels Parameters `$field` `string` $field Returns `string\|null` Overrides `Mage_Payment_Model_Recurring_Profile::getFieldLabel()`
`public string\|null`	# `getFieldComment( string $field )` Getter for sales-related field comments Getter for sales-related field comments Parameters `$field` `string` $field Returns `string\|null` Overrides `Mage_Payment_Model_Recurring_Profile::getFieldComment()`
`public array`	# `getAllStates( boolean $withLabels = true )` Getter for all available states Getter for all available states Parameters `$withLabels` `boolean` $withLabels Returns `array`
`public string`	# `getStateLabel( string $state )` Get state label based on the code Get state label based on the code Parameters `$state` `string` $state Returns `string`
`public mixed`	# `renderData( string $key )` Render state as label Render state as label Parameters `$key` `string` $key Returns `mixed` Overrides `Mage_Payment_Model_Recurring_Profile::renderData()`
`public mixed\|null`	# `getInfoValue( string $infoKey, string $infoValueKey )` Getter for additional information value It is assumed that the specified additional info is an object or associative array Getter for additional information value It is assumed that the specified additional info is an object or associative array Parameters `$infoKey` `string` $infoKey `$infoValueKey` `string` $infoValueKey Returns `mixed\|null`
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected Mage_Payment_Model_Recurring_Profile`	# `_filterValues( )` Automatically set "unknown" state if not defined Automatically set "unknown" state if not defined Returns `Mage_Payment_Model_Recurring_Profile` Overrides `Mage_Payment_Model_Recurring_Profile::_filterValues()`
`protected`	# `_initWorkflow( )` Initialize the workflow reference Initialize the workflow reference
`protected boolean`	# `_checkWorkflow( string $againstState, boolean $soft = true )` Check whether profile can be changed to specified state Check whether profile can be changed to specified state Parameters `$againstState` `string` $againstState `$soft` `boolean` $soft Returns `boolean` Throws `Mage_Core_Exception`
`public array`	# `getChildOrderIds( )` Return recurring profile child orders Ids Return recurring profile child orders Ids Returns `array`
`public Mage_Sales_Model_Recurring_Profile`	# `addOrderRelation( integer $orderId )` Add order relation to recurring profile Add order relation to recurring profile Parameters `$orderId` `integer` $recurringProfileId Returns `Mage_Sales_Model_Recurring_Profile`
`protected Mage_Sales_Model_Order_Item`	# `_getItem( Varien_Object $itemInfo )` Create and return new order item based on profile item data and $itemInfo Create and return new order item based on profile item data and $itemInfo Parameters `$itemInfo` `Varien_Object` $itemInfo Returns `Mage_Sales_Model_Order_Item`
`protected Mage_Sales_Model_Order_Item`	# `_getRegularItem( Varien_Object $itemInfo )` Create and return new order item based on profile item data and $itemInfo for regular payment Create and return new order item based on profile item data and $itemInfo for regular payment Parameters `$itemInfo` `Varien_Object` $itemInfo Returns `Mage_Sales_Model_Order_Item`
`protected Mage_Sales_Model_Order_Item`	# `_getTrialItem( Varien_Object $itemInfo )` Create and return new order item based on profile item data and $itemInfo for trial payment Create and return new order item based on profile item data and $itemInfo for trial payment Parameters `$itemInfo` `Varien_Object` $itemInfo Returns `Mage_Sales_Model_Order_Item`
`protected Mage_Sales_Model_Order_Item`	# `_getInitialItem( Varien_Object $itemInfo )` Create and return new order item based on profile item data and $itemInfo for initial payment Create and return new order item based on profile item data and $itemInfo for initial payment Parameters `$itemInfo` `Varien_Object` $itemInfo Returns `Mage_Sales_Model_Order_Item`
`protected`	# `_addAdditionalOptionToItem( Mage_Sales_Model_Order_Item $item, array $option )` Add additional options suboption into itev Add additional options suboption into itev Parameters `$item` `Mage_Sales_Model_Order_Item` $itemInfo `$option` `array` $option
`private`	# `_cleanupArray( array & $array )` Recursively cleanup array from objects Recursively cleanup array from objects Parameters `$array` `array` &$array

Methods inherited from Mage_Payment_Model_Recurring_Profile
`_beforeSave(), _ensureLocaleAndStore(), _renderSchedule(), _validateBeforeSave(), _validatePeriodFrequency(), exportScheduleInfo(), exportStartDatetime(), getAllPeriodUnits(), getMethodInstance(), getPeriodUnitLabel(), getValidationErrors(), importBuyRequest(), importProduct(), setLocale(), setMethodInstance(), setNearestStartDatetime(), setStore()`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()

Constants summary
`string`	`STATE_UNKNOWN`	`'unknown'`	# Available states Available states
`string`	`STATE_PENDING`	`'pending'`	#
`string`	`STATE_ACTIVE`	`'active'`	#
`string`	`STATE_SUSPENDED`	`'suspended'`	#
`string`	`STATE_CANCELED`	`'canceled'`	#
`string`	`STATE_EXPIRED`	`'expired'`	#
`string`	`PAYMENT_TYPE_REGULAR`	`'regular'`	# Payment types Payment types
`string`	`PAYMENT_TYPE_TRIAL`	`'trial'`	#
`string`	`PAYMENT_TYPE_INITIAL`	`'initial'`	#

Constants inherited from Mage_Payment_Model_Recurring_Profile
`BUY_REQUEST_START_DATETIME, PERIOD_UNIT_DAY, PERIOD_UNIT_MONTH, PERIOD_UNIT_SEMI_MONTH, PERIOD_UNIT_WEEK, PERIOD_UNIT_YEAR, PRODUCT_OPTIONS_KEY`

Properties summary
`protected array`	`$_workflow`	`null`	# Allowed actions matrix Allowed actions matrix

Properties inherited from Mage_Payment_Model_Recurring_Profile
`$_errors, $_locale, $_methodInstance, $_paymentMethods, $_store`

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Recurring_Profile

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Returns

Overrides

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters