Class Mage_CatalogRule_Model_Rule

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /CatalogRule/Model/Rule.php (line 28)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Rule_Model_Rule
         |
         --Mage_CatalogRule_Model_Rule
Class Constant Summary
XML_NODE_RELATED_CACHE = 'global/catalogrule/related_cache_types'
Variable Summary
static array $_priceRulesData
string $_eventObject
string $_eventPrefix
mixed $_now
array $_productIds
Method Summary
void applyToProduct (int|Mage_Catalog_Model_Product $product, [array $websiteIds = null])
float|null calcProductPriceRule ( $product, float $price)
void callbackValidateProduct ($args $args)
void getNow ()
void setNow ( $now)
array toArray ([ $arrAttributes = array()])
void toString ([ $format = ''])
void _construct ()
Variables
static array $_priceRulesData = array() (line 62)

Cached data of prices calculated by price rules

  • access: protected
string $_eventObject = 'rule' (line 46)

Parameter name in event

In observe method you can use $observer->getEvent()->getRule() in this case

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventObject
Parameter name in event
string $_eventPrefix = 'catalogrule_rule' (line 37)

Prefix of model events names

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventPrefix
Prefix of model events names
mixed $_now (line 55)
  • access: protected
array $_productIds (line 53)

Matched product ids array

  • access: protected

Inherited Variables

Inherited from Mage_Rule_Model_Rule

Mage_Rule_Model_Rule::$_actions
Mage_Rule_Model_Rule::$_conditions
Mage_Rule_Model_Rule::$_form
Mage_Rule_Model_Rule::$_isDeleteable
Mage_Rule_Model_Rule::$_isReadonly

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName
Methods
applyAll (line 250)

Apply all price rules, invalidate related cache and refresh price index

  • access: public
applyAllRulesToProduct (line 266)

Apply all price rules to product

  • access: public
Mage_CatalogRule_Model_Rule applyAllRulesToProduct (int|Mage_Catalog_Model_Product $product)
applyToProduct (line 213)

Apply rule to product

  • access: public
void applyToProduct (int|Mage_Catalog_Model_Product $product, [array $websiteIds = null])
calcProductPriceRule (line 283)

Calculate price using catalog price rule of product

  • access: public
float|null calcProductPriceRule ( $product, float $price)
callbackValidateProduct (line 196)

Callback function for product matching

  • access: public
void callbackValidateProduct ($args $args)
  • $args $args
getActionsInstance (line 79)
  • access: public
void getActionsInstance ()

Redefinition of:
Mage_Rule_Model_Rule::getActionsInstance()
getConditionsInstance (line 74)
  • access: public
void getConditionsInstance ()

Redefinition of:
Mage_Rule_Model_Rule::getConditionsInstance()
getCustomerGroupIds (line 229)

Get array of assigned customer group ids

  • access: public
array getCustomerGroupIds ()
getMatchingProductIds (line 163)

Get array of product ids which are matched by rule

  • access: public
array getMatchingProductIds ()
getNow (line 84)
  • access: public
void getNow ()
setNow (line 92)
  • access: public
void setNow ( $now)
  • $now
toArray (line 123)

Returns rule as an array for admin interface

Output example: array( 'name'=>'Example rule', 'conditions'=>{condition_combine::toArray} 'actions'=>{action_collection::toArray} )

  • access: public
array toArray ([ $arrAttributes = array()])
  • array $arrAttributes
toString (line 98)
  • access: public
void toString ([ $format = ''])
  • $format
_afterSave (line 152)

Process rule related data after rule save

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::_afterSave()
Processing object after save data
_construct (line 67)

Init resource model and id field

  • access: protected
void _construct ()

Redefinition of:
Mage_Rule_Model_Rule::_construct()
Init resoirce
_invalidateCache (line 137)

Invalidate related cache types

  • access: protected
Mage_CatalogRule_Model_Rule _invalidateCache ()

Inherited Methods

Inherited From Mage_Rule_Model_Rule

Mage_Rule_Model_Rule::afterLoad()
Mage_Rule_Model_Rule::asArray()
Mage_Rule_Model_Rule::asHtml()
Mage_Rule_Model_Rule::asString()
Mage_Rule_Model_Rule::getActions()
Mage_Rule_Model_Rule::getActionsInstance()
Mage_Rule_Model_Rule::getConditions()
Mage_Rule_Model_Rule::getConditionsInstance()
Mage_Rule_Model_Rule::getForm()
Mage_Rule_Model_Rule::isDeleteable()
Mage_Rule_Model_Rule::isReadonly()
Mage_Rule_Model_Rule::loadPost()
Mage_Rule_Model_Rule::setActions()
Mage_Rule_Model_Rule::setConditions()
Mage_Rule_Model_Rule::setIsDeleteable()
Mage_Rule_Model_Rule::setIsReadonly()
Mage_Rule_Model_Rule::validate()
Mage_Rule_Model_Rule::validateData()
Mage_Rule_Model_Rule::_afterLoad()
Mage_Rule_Model_Rule::_beforeSave()
Mage_Rule_Model_Rule::_construct()
Mage_Rule_Model_Rule::_convertFlatToRecursive()
Mage_Rule_Model_Rule::_prepareWebsiteIds()
Mage_Rule_Model_Rule::_resetActions()
Mage_Rule_Model_Rule::_resetConditions()

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()
Class Constants
XML_NODE_RELATED_CACHE = 'global/catalogrule/related_cache_types' (line 30)

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