Class Mage_Payment_Model_Recurring_Profile

Recurring payment profile Extends from Mage_Core_Abstract for a reason: to make descendants have its own resource

Varien_Object

Mage_Payment_Model_Recurring_Profile

Direct known subclasses

Package: Mage\Payment
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Payment/Model/Recurring/Profile.php

Methods summary
`public boolean`	# `isValid( )` Check whether the object data is valid Returns true if valid. Check whether the object data is valid Returns true if valid. Returns `boolean`
`public array`	# `getValidationErrors( boolean $isGrouped = true, mixed $asMessage = false )` Getter for errors that may appear after validation Getter for errors that may appear after validation Parameters `$isGrouped` `boolean` $isGrouped `$asMessage` Returns `array`
`public Mage_Payment_Model_Recurring_Profile`	# `setMethodInstance( Mage_Payment_Model_Method_Abstract $object )` Setter for payment method instance Setter for payment method instance Parameters `$object` `Mage_Payment_Model_Method_Abstract` $object Returns `Mage_Payment_Model_Recurring_Profile` Throws `Exception`
`public Mage_Payment_Model_Recurring_Profile`	# `importBuyRequest( Varien_Object $buyRequest )` Collect needed information from buy request Then filter data Collect needed information from buy request Then filter data Parameters `$buyRequest` `Varien_Object` $buyRequest Returns `Mage_Payment_Model_Recurring_Profile` Throws `Mage_Core_Exception`
`public Mage_Payment_Model_Recurring_Profile\|false`	# `importProduct( Mage_Catalog_Model_Product $product )` Import product recurring profile information Returns false if it cannot be imported Import product recurring profile information Returns false if it cannot be imported Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Payment_Model_Recurring_Profile\|false`
`public array`	# `exportScheduleInfo( )` Render available schedule information Render available schedule information Returns `array`
`public Mage_Payment_Model_Recurring_Profile`	# `setNearestStartDatetime( Zend_Date $minAllowed = null )` Determine nearest possible profile start date Determine nearest possible profile start date Parameters `$minAllowed` `Zend_Date` $minAllowed Returns `Mage_Payment_Model_Recurring_Profile`
`public Zend_Date\|string`	# `exportStartDatetime( boolean $asString = true )` Convert the start datetime (if set) to proper locale/timezone and return Convert the start datetime (if set) to proper locale/timezone and return Parameters `$asString` `boolean` $asString Returns `Zend_Date\|string`
`public Mage_Payment_Model_Recurring_Profile`	# `setLocale( Mage_Core_Model_Locale $locale )` Locale instance setter Locale instance setter Parameters `$locale` `Mage_Core_Model_Locale` $locale Returns `Mage_Payment_Model_Recurring_Profile`
`public Mage_Payment_Model_Recurring_Profile`	# `setStore( Mage_Core_Model_Store $store )` Store instance setter Store instance setter Parameters `$store` `Mage_Core_Model_Store` $store Returns `Mage_Payment_Model_Recurring_Profile`
`public array`	# `getAllPeriodUnits( boolean $withLabels = true )` Getter for available period units Getter for available period units Parameters `$withLabels` `boolean` $withLabels Returns `array`
`public`	# `getPeriodUnitLabel( string $unit )` Render label for specified period unit Render label for specified period unit Parameters `$unit` `string` $unit
`public string\|null`	# `getFieldLabel( string $field )` Getter for field label Getter for field label Parameters `$field` `string` $field Returns `string\|null`
`public string\|null`	# `getFieldComment( string $field )` Getter for field comments Getter for field comments Parameters `$field` `string` $field Returns `string\|null`
`public mixed`	# `renderData( string $key )` Transform some specific data for output Transform some specific data for output Parameters `$key` `string` $key Returns `mixed`
`protected Mage_Payment_Model_Recurring_Profile`	# `_filterValues( )` Filter self data to make sure it can be validated properly Filter self data to make sure it can be validated properly Returns `Mage_Payment_Model_Recurring_Profile`
`protected`	# `_ensureLocaleAndStore( )` Check that locale and store instances are set Check that locale and store instances are set Throws `Exception`
`protected Mage_Payment_Model_Method_Abstract`	# `getMethodInstance( )` Return payment method instance Return payment method instance Returns `Mage_Payment_Model_Method_Abstract`
`protected boolean`	# `_validatePeriodFrequency( string $unitKey, string $frequencyKey )` Check accordance of the unit and frequency Check accordance of the unit and frequency Parameters `$unitKey` `string` $unitKey `$frequencyKey` `string` $frequencyKey Returns `boolean`
`protected`	# `_validateBeforeSave( )` Perform full validation before saving Perform full validation before saving Throws `Mage_Core_Exception`
`protected Mage_Payment_Model_Recurring_Profile`	# `_beforeSave( )` Validate before saving Validate before saving Returns `Mage_Payment_Model_Recurring_Profile` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected array`	# `_renderSchedule( string $periodKey, string $frequencyKey, string $cyclesKey )` Generate explanations for specified schedule parameters Generate explanations for specified schedule parameters TODO: utilize Zend_Translate_Plural or similar stuff to render proper declensions with numerals. Parameters `$periodKey` `string` $periodKey `$frequencyKey` `string` $frequencyKey `$cyclesKey` `string` $cyclesKey Returns `array`

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`	`BUY_REQUEST_START_DATETIME`	`'recurring_profile_start_datetime'`	# Constants for passing data through catalog Constants for passing data through catalog
`string`	`PRODUCT_OPTIONS_KEY`	`'recurring_profile_options'`	#
`string`	`PERIOD_UNIT_DAY`	`'day'`	# Period units Period units
`string`	`PERIOD_UNIT_WEEK`	`'week'`	#
`string`	`PERIOD_UNIT_SEMI_MONTH`	`'semi_month'`	#
`string`	`PERIOD_UNIT_MONTH`	`'month'`	#
`string`	`PERIOD_UNIT_YEAR`	`'year'`	#

Properties summary
`protected array`	`$_errors`	`array()`	# Errors collected during validation Errors collected during validation
`protected Mage_Payment_Model_Method_Abstract`	`$_methodInstance`	`null`	#
`protected Mage_Core_Model_Locale`	`$_locale`	`null`	# Locale instance used for importing/exporting data Locale instance used for importing/exporting data
`protected Mage_Core_Model_Store`	`$_store`	`null`	# Store instance used by locale or method instance Store instance used by locale or method instance
`protected array`	`$_paymentMethods`	`array()`	# Payment methods reference Payment methods reference

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

Packages

Classes

Interfaces

Exceptions

Class Mage_Payment_Model_Recurring_Profile

Direct known subclasses

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Overrides

Parameters

Returns