Class Mage_SalesRule_Model_Validator

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

SalesRule Validator Model

Allows dispatching before and after events for each controller action

Located in /SalesRule/Model/Validator.php (line 37) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_SalesRule_Model_Validator
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_baseRoundingDeltas
array $_cartFixedRuleUsedForAddress
bool $_isFirstTimeProcessRun
bool $_isFirstTimeResetRun
mixed $_roundingDeltas
Mage_SalesRule_Model_Mysql4_Rule_Collection $_rules
array $_rulesItemTotals
Method Summary
Description | Vars (details) | Methods (details)
int|null getCartFixedRuleUsedForAddress (int $ruleId)
Mage_SalesRule_Model_Validator init (int $websiteId, int $customerGroupId, string $couponCode)
Mage_SalesRule_Model_Validator initTotals (mixed $items,  $address)
array mergeIds (array|string $a1, array|string $a2, [bool $asString = true])
Mage_SalesRule_Model_Validator prepareDescription (Mage_Sales_Model_Quote_Address $address, [string $separator = ', '])
Mage_SalesRule_Model_Validator process ( $item)
Mage_SalesRule_Model_Validator processFreeShipping ( $item)
Mage_SalesRule_Model_Validator processShippingAmount ( $address)
Mage_SalesRule_Model_Validator reset ( $address)
void setCartFixedRuleUsedForAddress (int $ruleId, int $itemId)
Mage_SalesRule_Model_Validator _addDiscountDescription (Mage_Sales_Model_Quote_Address $address, Mage_SalesRule_Model_Rule $rule)
bool _canProcessRule (Mage_SalesRule_Model_Rule $rule, Mage_Sales_Model_Quote_Address $address)
Mage_Sales_Model_Quote_Address _getAddress ( $item)
float _getItemBasePrice (Mage_Sales_Model_Quote_Item_Abstract $item)
float _getItemPrice (Mage_Sales_Model_Quote_Item_Abstract $item)
int _getItemQty (Mage_Sales_Model_Quote_Item_Abstract $item, Mage_SalesRule_Model_Rule $rule)
Mage_SalesRule_Model_Mysql4_Rule_Collection _getRules ()
array _maintainAddressCouponCode ( $address,  $rule)
Variables
Description | Vars (details) | Methods (details)
mixed $_baseRoundingDeltas = array() (line 47)
  • access: protected
array $_cartFixedRuleUsedForAddress = array() (line 77)

Store information about addresses which cart fixed rule applied for

  • access: protected
bool $_isFirstTimeProcessRun = false (line 56)

Defines if method Mage_SalesRule_Model_Validator::process() was already called Used for clearing applied rule ids in Quote and in Address

  • deprecated: since 1.4.2.0
  • access: protected
bool $_isFirstTimeResetRun = true (line 64)

Defines if method Mage_SalesRule_Model_Validator::reset() wasn't called Used for clearing applied rule ids in Quote and in Address

  • access: protected
mixed $_roundingDeltas = array() (line 46)
  • access: protected
Mage_SalesRule_Model_Mysql4_Rule_Collection $_rules (line 44)

Rule source collection

  • access: protected
array $_rulesItemTotals = array() (line 70)

Information about item totals for rules.

  • access: protected

Inherited Variables

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) Methods (details)
getCartFixedRuleUsedForAddress (line 580)

Retrieve information about usage cart fixed rule by quote address

  • access: public
int|null getCartFixedRuleUsedForAddress (int $ruleId)
  • int $ruleId
init (line 89)

Init validator Init process load collection of rules for specific website, customer group and coupon code

  • access: public
Mage_SalesRule_Model_Validator init (int $websiteId, int $customerGroupId, string $couponCode)
  • int $websiteId
  • int $customerGroupId
  • string $couponCode
initTotals (line 595)

Calculate quote totals for each rule and save results

  • access: public
Mage_SalesRule_Model_Validator initTotals (mixed $items,  $address)
mergeIds (line 547)

Merge two sets of ids

  • access: public
array mergeIds (array|string $a1, array|string $a2, [bool $asString = true])
  • array|string $a1
  • array|string $a2
  • bool $asString
prepareDescription (line 720)

Convert address discount description array to string

  • access: public
Mage_SalesRule_Model_Validator prepareDescription (Mage_Sales_Model_Quote_Address $address, [string $separator = ', '])
process (line 263)

Quote item discount calculation process

  • access: public
Mage_SalesRule_Model_Validator process ( $item)
processFreeShipping (line 209)

Quote item free shipping ability check This process not affect information about applied rules, coupon code etc.

This information will be added during discount amounts processing

  • access: public
Mage_SalesRule_Model_Validator processFreeShipping ( $item)
processShippingAmount (line 459)

Apply discounts to shipping amount

  • access: public
Mage_SalesRule_Model_Validator processShippingAmount ( $address)
reset (line 246)

Reset quote and address applied rules

  • access: public
Mage_SalesRule_Model_Validator reset ( $address)
setCartFixedRuleUsedForAddress (line 569)

Set information about usage cart fixed rule by quote address

  • access: public
void setCartFixedRuleUsedForAddress (int $ruleId, int $itemId)
  • int $ruleId
  • int $itemId
_addDiscountDescription (line 658)

Add rule discount description label to address object

  • access: protected
Mage_SalesRule_Model_Validator _addDiscountDescription (Mage_Sales_Model_Quote_Address $address, Mage_SalesRule_Model_Rule $rule)
_canProcessRule (line 140)

Check if rule can be applied for specific address/quote/customer

  • access: protected
bool _canProcessRule (Mage_SalesRule_Model_Rule $rule, Mage_Sales_Model_Quote_Address $address)
_getAddress (line 121)

Get address object which can be used for discount calculation

  • access: protected
Mage_Sales_Model_Quote_Address _getAddress ( $item)
_getItemBasePrice (line 694)

Return item base price

  • access: protected
float _getItemBasePrice (Mage_Sales_Model_Quote_Item_Abstract $item)
_getItemPrice (line 682)

Return item price

  • access: protected
float _getItemPrice (Mage_Sales_Model_Quote_Item_Abstract $item)
_getItemQty (line 707)

Return discount item qty

  • access: protected
int _getItemQty (Mage_Sales_Model_Quote_Item_Abstract $item, Mage_SalesRule_Model_Rule $rule)
_getRules (line 109)

Get rules collection for current object state

  • access: protected
Mage_SalesRule_Model_Mysql4_Rule_Collection _getRules ()
_maintainAddressCouponCode (line 641)

Retrieve subordinate coupon IDs

  • access: protected
array _maintainAddressCouponCode ( $address,  $rule)
  • $address
  • $rule

Inherited Methods

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()

Documentation generated on Fri, 11 Feb 2011 17:15:49 +0200 by phpDocumentor 1.4.3