Class Mage_SalesRule_Model_Validator

SalesRule Validator Model

Allows dispatching before and after events for each controller action

Varien_Object

Mage_SalesRule_Model_Validator

Package: Mage\SalesRule
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/SalesRule/Model/Validator.php

Methods summary
`public Mage_SalesRule_Model_Validator`	# `init( integer $websiteId, integer $customerGroupId, string $couponCode )` Init validator Init process load collection of rules for specific website, customer group and coupon code Init validator Init process load collection of rules for specific website, customer group and coupon code Parameters `$websiteId` `integer` $websiteId `$customerGroupId` `integer` $customerGroupId `$couponCode` `string` $couponCode Returns `Mage_SalesRule_Model_Validator`
`protected Mage_SalesRule_Model_Mysql4_Rule_Collection`	# `_getRules( )` Get rules collection for current object state Get rules collection for current object state Returns `Mage_SalesRule_Model_Mysql4_Rule_Collection`
`protected Mage_Sales_Model_Quote_Address`	# `_getAddress( Mage_Sales_Model_Quote_Item_Abstract $item )` Get address object which can be used for discount calculation Get address object which can be used for discount calculation Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `Mage_Sales_Model_Quote_Address`
`protected boolean`	# `_canProcessRule( Mage_SalesRule_Model_Rule $rule, Mage_Sales_Model_Quote_Address $address )` Check if rule can be applied for specific address/quote/customer Check if rule can be applied for specific address/quote/customer Parameters `$rule` `Mage_SalesRule_Model_Rule` $rule `$address` `Mage_Sales_Model_Quote_Address` $address Returns `boolean`
`public Mage_SalesRule_Model_Validator`	# `processFreeShipping( Mage_Sales_Model_Quote_Item_Abstract $item )` 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 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 Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `Mage_SalesRule_Model_Validator`
`public Mage_SalesRule_Model_Validator`	# `reset( Mage_Sales_Model_Quote_Address $address )` Reset quote and address applied rules Reset quote and address applied rules Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `Mage_SalesRule_Model_Validator`
`public Mage_SalesRule_Model_Validator`	# `process( Mage_Sales_Model_Quote_Item_Abstract $item )` Quote item discount calculation process Quote item discount calculation process Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `Mage_SalesRule_Model_Validator`
`public Mage_SalesRule_Model_Validator`	# `processShippingAmount( Mage_Sales_Model_Quote_Address $address )` Apply discounts to shipping amount Apply discounts to shipping amount Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `Mage_SalesRule_Model_Validator`
`public array`	# `mergeIds( array\|string $a1, array\|string $a2, boolean $asString = true )` Merge two sets of ids Merge two sets of ids Parameters `$a1` `array\|string` $a1 `$a2` `array\|string` $a2 `$asString` `boolean` $asString Returns `array`
`public`	# `setCartFixedRuleUsedForAddress( integer $ruleId, integer $itemId )` Set information about usage cart fixed rule by quote address Set information about usage cart fixed rule by quote address Parameters `$ruleId` `integer` $ruleId `$itemId` `integer` $itemId
`public integer\|null`	# `getCartFixedRuleUsedForAddress( integer $ruleId )` Retrieve information about usage cart fixed rule by quote address Retrieve information about usage cart fixed rule by quote address Parameters `$ruleId` `integer` $ruleId Returns `integer\|null`
`public Mage_SalesRule_Model_Validator`	# `initTotals( mixed $items, Mage_Sales_Model_Quote_Address $address )` Calculate quote totals for each rule and save results Calculate quote totals for each rule and save results Parameters `$items` `mixed` $items `$address` `Mage_Sales_Model_Quote_Address` $address Returns `Mage_SalesRule_Model_Validator`
`protected Mage_SalesRule_Model_Validator`	# `_maintainAddressCouponCode( Mage_Sales_Model_Quote_Address $address, Mage_SalesRule_Model_Rule $rule )` Set coupon code to address if $rule contains validated coupon Set coupon code to address if $rule contains validated coupon Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$rule` `Mage_SalesRule_Model_Rule` $rule Returns `Mage_SalesRule_Model_Validator`
`protected Mage_SalesRule_Model_Validator`	# `_addDiscountDescription( Mage_Sales_Model_Quote_Address $address, Mage_SalesRule_Model_Rule $rule )` Add rule discount description label to address object Add rule discount description label to address object Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$rule` `Mage_SalesRule_Model_Rule` $rule Returns `Mage_SalesRule_Model_Validator`
`protected float`	# `_getItemPrice( Mage_Sales_Model_Quote_Item_Abstract $item )` Return item price Return item price Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `float`
`protected float`	# `_getItemOriginalPrice( Mage_Sales_Model_Quote_Item_Abstract $item )` Return item original price Return item original price Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `float`
`protected float`	# `_getItemBasePrice( Mage_Sales_Model_Quote_Item_Abstract $item )` Return item base price Return item base price Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `float`
`protected float`	# `_getItemBaseOriginalPrice( Mage_Sales_Model_Quote_Item_Abstract $item )` Return item base original price Return item base original price Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `float`
`protected integer`	# `_getItemQty( Mage_Sales_Model_Quote_Item_Abstract $item, Mage_SalesRule_Model_Rule $rule )` Return discount item qty Return discount item qty Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item `$rule` `Mage_SalesRule_Model_Rule` $rule Returns `integer`
`public Mage_SalesRule_Model_Validator`	# `prepareDescription( Mage_Sales_Model_Quote_Address $address, string $separator = ', ' )` Convert address discount description array to string Convert address discount description array to string Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$separator` `string` $separator Returns `Mage_SalesRule_Model_Validator`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _beforeSave(), _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()

Properties summary
`protected Mage_SalesRule_Model_Mysql4_Rule_Collection`	`$_rules`		# Rule source collection Rule source collection
`protected array`	`$_roundingDeltas`	`array()`	#
`protected array`	`$_baseRoundingDeltas`	`array()`	#
`protected boolean`	`$_isFirstTimeResetRun`	`true`	# Defines if method Mage_SalesRule_Model_Validator::reset() wasn't called Used for clearing applied rule ids in Quote and in Address Defines if method Mage_SalesRule_Model_Validator::reset() wasn't called Used for clearing applied rule ids in Quote and in Address
`protected array`	`$_rulesItemTotals`	`array()`	# Information about item totals for rules. Information about item totals for rules.
`protected array`	`$_cartFixedRuleUsedForAddress`	`array()`	# Store information about addresses which cart fixed rule applied for Store information about addresses which cart fixed rule applied for

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

Packages

Classes

Interfaces

Class Mage_SalesRule_Model_Validator

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns