Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_CatalogRule_Helper_Data
  • Mage_CatalogRule_Model_Flag
  • Mage_CatalogRule_Model_Mysql4_Rule
  • Mage_CatalogRule_Model_Mysql4_Rule_Collection
  • Mage_CatalogRule_Model_Mysql4_Rule_Product_Price
  • Mage_CatalogRule_Model_Mysql4_Rule_Product_Price_Collection
  • Mage_CatalogRule_Model_Observer
  • Mage_CatalogRule_Model_Resource_Rule
  • Mage_CatalogRule_Model_Resource_Rule_Collection
  • Mage_CatalogRule_Model_Resource_Rule_Product_Price
  • Mage_CatalogRule_Model_Resource_Rule_Product_Price_Collection
  • Mage_CatalogRule_Model_Rule
  • Mage_CatalogRule_Model_Rule_Action_Collection
  • Mage_CatalogRule_Model_Rule_Action_Product
  • Mage_CatalogRule_Model_Rule_Condition_Combine
  • Mage_CatalogRule_Model_Rule_Condition_Product
  • Mage_CatalogRule_Model_Rule_Product_Price
  • Overview
  • Package
  • Class
  • Tree

Class Mage_CatalogRule_Model_Resource_Rule

Catalog rules resource model

Mage_Core_Model_Resource_Abstract
Extended by Mage_Core_Model_Resource_Db_Abstract
Extended by Mage_Rule_Model_Resource_Abstract
Extended by Mage_CatalogRule_Model_Resource_Rule

Direct known subclasses

Mage_CatalogRule_Model_Mysql4_Rule
Package: Mage\CatalogRule
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/CatalogRule/Model/Resource/Rule.php
Methods summary
protected
# _construct( )

Initialize main table and table id field

Initialize main table and table id field

protected Mage_CatalogRule_Model_Resource_Rule
# _afterLoad( Mage_Core_Model_Abstract $object )

Add customer group ids and website ids to rule data after load

Add customer group ids and website ids to rule data after load

Parameters

$object
Mage_Core_Model_Abstract
$object

Returns

Mage_CatalogRule_Model_Resource_Rule

Overrides

Mage_Core_Model_Resource_Db_Abstract::_afterLoad()
protected Mage_CatalogRule_Model_Resource_Rule
# _afterSave( Mage_Core_Model_Abstract $object )

Bind catalog rule to customer group(s) and website(s). Update products which are matched for rule.

Bind catalog rule to customer group(s) and website(s). Update products which are matched for rule.

Parameters

$object
Mage_Core_Model_Abstract
$object

Returns

Mage_CatalogRule_Model_Resource_Rule

Overrides

Mage_Core_Model_Resource_Db_Abstract::_afterSave()
public Mage_CatalogRule_Model_Resource_Rule
# updateRuleProductData( Mage_CatalogRule_Model_Rule $rule )

Update products which are matched for rule

Update products which are matched for rule

Parameters

$rule
Mage_CatalogRule_Model_Rule
$rule

Returns

Mage_CatalogRule_Model_Resource_Rule
public array
# getRuleProductIds( integer $ruleId )

Get all product ids matched for rule

Get all product ids matched for rule

Parameters

$ruleId
integer
$ruleId

Returns

array
public Mage_CatalogRule_Model_Resource_Rule
# removeCatalogPricesForDateRange( integer|string $fromDate, integer|string $toDate, integer|null $productId = null )

Remove catalog rules product prices for specified date range and product

Remove catalog rules product prices for specified date range and product

Parameters

$fromDate
integer|string
$fromDate
$toDate
integer|string
$toDate
$productId
integer|null
$productId

Returns

Mage_CatalogRule_Model_Resource_Rule
public Mage_CatalogRule_Model_Resource_Rule
# deleteOldData( string $date, integer|null $productId = null )

Delete old price rules data

Delete old price rules data

Parameters

$date
string
$date
$productId
integer|null
$productId

Returns

Mage_CatalogRule_Model_Resource_Rule
protected Zend_Db_Statement_Interface
# _getRuleProductsStmt( integer $fromDate, integer $toDate, integer|null $productId = null, integer|null $websiteId = null )

Get DB resource statement for processing query result

Get DB resource statement for processing query result

Parameters

$fromDate
integer
$fromDate
$toDate
integer
$toDate
$productId
integer|null
$productId
$websiteId
integer|null
$websiteId

Returns

Zend_Db_Statement_Interface
public Mage_CatalogRule_Model_Resource_Rule
# applyAllRulesForDateRange( integer|string|null $fromDate = null, integer|string|null $toDate = null, integer $productId = null )

Generate catalog price rules prices for specified date range If from date is not defined - will be used previous day by UTC If to date is not defined - will be used next day by UTC

Generate catalog price rules prices for specified date range If from date is not defined - will be used previous day by UTC If to date is not defined - will be used next day by UTC

Parameters

$fromDate
integer|string|null
$fromDate
$toDate
integer|string|null
$toDate
$productId
integer
$productId

Returns

Mage_CatalogRule_Model_Resource_Rule
protected float
# _calcRuleProductPrice( array $ruleData, null|array $productData = null )

Calculate product price based on price rule data and previous information

Calculate product price based on price rule data and previous information

Parameters

$ruleData
array
$ruleData
$productData
null|array
$productData

Returns

float
protected Mage_CatalogRule_Model_Resource_Rule
# _saveRuleProductPrices( array $arrData )

Save rule prices for products to DB

Save rule prices for products to DB

Parameters

$arrData
array
$arrData

Returns

Mage_CatalogRule_Model_Resource_Rule
public float|boolean
# getRulePrice( integer|string $date, integer $wId, integer $gId, integer $pId )

Get catalog rules product price for specific date, website and customer group

Get catalog rules product price for specific date, website and customer group

Parameters

$date
integer|string
$date
$wId
integer
$wId
$gId
integer
$gId
$pId
integer
$pId

Returns

float|boolean
public array
# getRulePrices( integer|string $date, integer $websiteId, integer $customerGroupId, array $productIds )

Retrieve product prices by catalog rule for specific date, website and customer group Collect data with product Id => price pairs

Retrieve product prices by catalog rule for specific date, website and customer group Collect data with product Id => price pairs

Parameters

$date
integer|string
$date
$websiteId
integer
$websiteId
$customerGroupId
integer
$customerGroupId
$productIds
array
$productIds

Returns

array
public array
# getRulesFromProduct( integer|string $date, integer $websiteId, integer $customerGroupId, integer $productId )

Get active rule data based on few filters

Get active rule data based on few filters

Parameters

$date
integer|string
$date
$websiteId
integer
$websiteId
$customerGroupId
integer
$customerGroupId
$productId
integer
$productId

Returns

array
public array
# getRulesForProduct( integer|string $date, integer $wId, integer $pId )

Retrieve product price data for all customer groups

Retrieve product price data for all customer groups

Parameters

$date
integer|string
$date
$wId
integer
$wId
$pId
integer
$pId

Returns

array
public Mage_CatalogRule_Model_Resource_Rule
# applyToProduct( Mage_CatalogRule_Model_Rule $rule, Mage_Catalog_Model_Product $product, array $websiteIds )

Apply catalog rule to product

Apply catalog rule to product

Parameters

$rule
Mage_CatalogRule_Model_Rule
$rule
$product
Mage_Catalog_Model_Product
$product
$websiteIds
array
$websiteIds

Returns

Mage_CatalogRule_Model_Resource_Rule
Methods inherited from Mage_Rule_Model_Resource_Abstract
_beforeSave(), _getAssociatedEntityInfo(), bindRuleToEntity(), getAssociatedEntityIds(), getCustomerGroupIds(), getWebsiteIds(), unbindRuleFromEntity()
Methods inherited from Mage_Core_Model_Resource_Db_Abstract
_afterDelete(), _beforeDelete(), _checkUnique(), _getConnection(), _getLoadSelect(), _getReadAdapter(), _getWriteAdapter(), _init(), _initUniqueFields(), _prepareDataForSave(), _prepareValueForSave(), _serializeFields(), _setMainTable(), _setResource(), addUniqueField(), afterLoad(), delete(), getChecksum(), getIdFieldName(), getMainTable(), getReadConnection(), getTable(), getUniqueFields(), getValueTable(), hasDataChanged(), load(), resetUniqueField(), save(), unserializeFields()
Methods inherited from Mage_Core_Model_Resource_Abstract
__construct(), _prepareDataForTable(), _prepareTableValueForSave(), _serializeField(), _unserializeField(), addCommitCallback(), beginTransaction(), commit(), formatDate(), mktime(), rollBack()
Constants summary
integer SECONDS_IN_DAY 86400
#

Store number of seconds in a day

Store number of seconds in a day

Properties summary
protected array $_associatedEntitiesMap array( 'website' => array( 'associations_table' => 'catalogrule/website', 'rule_id_field' => 'rule_id', 'entity_id_field' => 'website_id' ), 'customer_group' => array( 'associations_table' => 'catalogrule/customer_group', 'rule_id_field' => 'rule_id', 'entity_id_field' => 'customer_group_id' ) )
#

Store associated with rule entities information map

Store associated with rule entities information map

Properties inherited from Mage_Core_Model_Resource_Db_Abstract
$_connections, $_fieldsForUpdate, $_idFieldName, $_isPkAutoIncrement, $_mainTable, $_mainTableFields, $_resourceModel, $_resourcePrefix, $_resources, $_serializableFields, $_tables, $_uniqueFields, $_useIsObjectNew
Properties inherited from Mage_Core_Model_Resource_Abstract
$_commitCallbacks
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0