Class Mage_SalesRule_Model_Rule

Shopping Cart Rule data model

Varien_Object

Mage_SalesRule_Model_Rule

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/Rule.php

Methods summary
`protected`	# `_construct( )` Set resource model and Id field name Set resource model and Id field name
`public static Mage_SalesRule_Model_Coupon_MassgneratorInterface`	# `getCouponMassGenerator( )` Returns code mass generator instance for auto generated specific coupons Returns code mass generator instance for auto generated specific coupons Returns `Mage_SalesRule_Model_Coupon_MassgneratorInterface`
`protected Mage_SalesRule_Model_Rule`	# `_afterLoad( )` Set coupon code and uses per coupon Set coupon code and uses per coupon Returns `Mage_SalesRule_Model_Rule` Overrides `Mage_Core_Model_Abstract::_afterLoad()`
`protected Mage_SalesRule_Model_Rule`	# `_afterSave( )` Save/delete coupon Save/delete coupon Returns `Mage_SalesRule_Model_Rule` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public Mage_SalesRule_Model_Rule`	# `loadPost( array $data )` Initialize rule model data from array. Set store labels if applicable. Initialize rule model data from array. Set store labels if applicable. Parameters `$data` `array` $data Returns `Mage_SalesRule_Model_Rule` Overrides `Mage_Rule_Model_Abstract::loadPost()`
`public Mage_SalesRule_Model_Rule_Condition_Combine`	# `getConditionsInstance( )` Get rule condition combine model instance Get rule condition combine model instance Returns `Mage_SalesRule_Model_Rule_Condition_Combine`
`public Mage_SalesRule_Model_Rule_Condition_Product_Combine`	# `getActionsInstance( )` Get rule condition product combine model instance Get rule condition product combine model instance Returns `Mage_SalesRule_Model_Rule_Condition_Product_Combine`
`public static Mage_SalesRule_Model_Coupon_CodegeneratorInterface`	# `getCouponCodeGenerator( )` Returns code generator instance for auto generated coupons Returns code generator instance for auto generated coupons Returns `Mage_SalesRule_Model_Coupon_CodegeneratorInterface`
`public static`	# `setCouponCodeGenerator( Mage_SalesRule_Model_Coupon_CodegeneratorInterface $codeGenerator )` Set code generator instance for auto generated coupons Set code generator instance for auto generated coupons Parameters `$codeGenerator` `Mage_SalesRule_Model_Coupon_CodegeneratorInterface`
`public Mage_SalesRule_Model_Coupon`	# `getPrimaryCoupon( )` Retrieve rule's primary coupon Retrieve rule's primary coupon Returns `Mage_SalesRule_Model_Coupon`
`public array`	# `getCustomerGroupIds( )` Get sales rule customer group Ids Get sales rule customer group Ids Returns `array`
`public string\|boolean`	# `getStoreLabel( Mage_Core_Model_Store\|integer\|boolean\|null $store = null )` Get Rule label by specified store Get Rule label by specified store Parameters `$store` `Mage_Core_Model_Store\|integer\|boolean\|null` $store Returns `string\|boolean`
`public array`	# `getStoreLabels( )` Set if not yet and retrieve rule store labels Set if not yet and retrieve rule store labels Returns `array`
`public array`	# `getCoupons( )` Retrieve subordinate coupons Retrieve subordinate coupons Returns `array` of Mage_SalesRule_Model_Coupon
`public array`	# `getCouponTypes( )` Retrieve coupon types Retrieve coupon types Returns `array`
`public Mage_SalesRule_Model_Coupon\|null`	# `acquireCoupon( boolean $saveNewlyCreated = true, integer $saveAttemptCount = 10 )` Acquire coupon instance Acquire coupon instance Parameters `$saveNewlyCreated` `boolean` $saveNewlyCreated Whether or not to save newly created coupon `$saveAttemptCount` `integer` $saveAttemptCount Number of attempts to save newly created coupon Returns `Mage_SalesRule_Model_Coupon\|null`
`public boolean`	# `hasIsValidForAddress( Mage_Sales_Model_Quote_Address $address )` Check cached validation result for specific address Check cached validation result for specific address Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `boolean`
`public Mage_SalesRule_Model_Rule`	# `setIsValidForAddress( Mage_Sales_Model_Quote_Address $address, boolean $validationResult )` Set validation result for specific address to results cache Set validation result for specific address to results cache Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$validationResult` `boolean` $validationResult Returns `Mage_SalesRule_Model_Rule`
`public boolean`	# `getIsValidForAddress( Mage_Sales_Model_Quote_Address $address )` Get cached validation result for specific address Get cached validation result for specific address Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `boolean`
`private string`	# `_getAddressId( Mage_Sales_Model_Quote_Address $address )` Return id for address Return id for address Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `string`

Methods inherited from Mage_Rule_Model_Abstract
`_beforeSave(), _convertFlatToRecursive(), _resetActions(), _resetConditions(), getActions(), getConditions(), getForm(), getWebsiteIds(), isDeleteable(), isReadonly(), setActions(), setConditions(), setIsDeleteable(), setIsReadonly(), validate(), validateData()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _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
`integer`	`FREE_SHIPPING_ITEM`	`1`	# Free Shipping option "For matching items only" Free Shipping option "For matching items only"
`integer`	`FREE_SHIPPING_ADDRESS`	`2`	# Free Shipping option "For shipment with matching items" Free Shipping option "For shipment with matching items"
`integer`	`COUPON_TYPE_NO_COUPON`	`1`	# Coupon types Coupon types
`integer`	`COUPON_TYPE_SPECIFIC`	`2`	#
`integer`	`COUPON_TYPE_AUTO`	`3`	#
`string`	`TO_PERCENT_ACTION`	`'to_percent'`	# Rule type actions Rule type actions
`string`	`BY_PERCENT_ACTION`	`'by_percent'`	#
`string`	`TO_FIXED_ACTION`	`'to_fixed'`	#
`string`	`BY_FIXED_ACTION`	`'by_fixed'`	#
`string`	`CART_FIXED_ACTION`	`'cart_fixed'`	#
`string`	`BUY_X_GET_Y_ACTION`	`'buy_x_get_y'`	#

Properties summary
`protected static Mage_SalesRule_Model_Coupon_CodegeneratorInterface`	`$_couponCodeGenerator`		# Store coupon code generator instance Store coupon code generator instance
`protected string`	`$_eventPrefix`	`'salesrule_rule'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'rule'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getRule() in this case
`protected Mage_SalesRule_Model_Coupon`	`$_primaryCoupon`		# Rule's primary coupon Rule's primary coupon
`protected array`	`$_coupons`		# Rule's subordinate coupons Rule's subordinate coupons
`protected array`	`$_couponTypes`		# Coupon types cache for lazy getter Coupon types cache for lazy getter
`protected array`	`$_validatedAddresses`	`array()`	# Store already validated addresses and validation results Store already validated addresses and validation results

Properties inherited from Mage_Rule_Model_Abstract
`$_actions, $_conditions, $_form, $_isDeleteable, $_isReadonly`

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

Packages

Classes

Interfaces

Class Mage_SalesRule_Model_Rule

Returns

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns