Mage_CatalogRule_Model_Rule Class Reference

Inheritance diagram for Mage_CatalogRule_Model_Rule:

List of all members.

Public Member Functions
	getConditionsInstance ()
	getActionsInstance ()
	getNow ()
	setNow ($now)
	toString ($format='')
	toArray (array $arrAttributes=array())
	getResourceCollection ()
	getMatchingProductIds ()
	callbackValidateProduct ($args)
	applyToProduct ($product, $websiteIds=null)
	getCustomerGroupIds ()
Protected Member Functions
	_construct ()
	_afterSave ()
Protected Attributes
	$_productIds = array()
	$_now

---

Detailed Description

Definition at line 28 of file Rule.php.

---

Member Function Documentation

_afterSave

(

)

[protected]

Processing object after save data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 131 of file Rule.php.

    {
        $this->_getResource()->updateRuleProductData($this);
        parent::_afterSave();
    }

_construct

(

)

[protected]

Enter description here...

Reimplemented from Mage_Rule_Model_Rule.

Definition at line 34 of file Rule.php.

    {
        parent::_construct();
        $this->_init('catalogrule/rule');
        $this->setIdFieldName('rule_id');
    }

applyToProduct	(	$	product,
		$	websiteIds = null
	)

Definition at line 178 of file Rule.php.

    {
        if (is_numeric($product)) {
            $product = Mage::getModel('catalog/product')->load($product);
        }
        if (is_null($websiteIds)) {
            $websiteIds = explode(',', $this->getWebsiteIds());
        }
        $this->getResource()->applyToProduct($this, $product, $websiteIds);
    }

callbackValidateProduct

(

$

args

)

Definition at line 162 of file Rule.php.

    {
        $product = $args['product']->setData($args['row']);
        if (!empty($args['attributes']['category_ids'])) {
            $categoryCollection = $product->getCategoryCollection()->load();
            $categories = array();
            foreach ($categoryCollection as $category) {
                $categories[] = $category->getId();
            }
            $product->setCategoryIds($categories);
        }
        if ($this->getConditions()->validate($product)) {
            $this->_productIds[] = $product->getId();
        }
    }

getActionsInstance

(

)

Reimplemented from Mage_Rule_Model_Rule.

Definition at line 46 of file Rule.php.

    {
        return Mage::getModel('catalogrule/rule_action_collection');
    }

getConditionsInstance

(

)

Reimplemented from Mage_Rule_Model_Rule.

Definition at line 41 of file Rule.php.

    {
        return Mage::getModel('catalogrule/rule_condition_combine');
    }

getCustomerGroupIds

(

)

Definition at line 189 of file Rule.php.

    {
        $ids = $this->getData('customer_group_ids');
        if (($ids && !$this->getCustomerGroupChecked()) || is_string($ids)) {
            if (is_string($ids)) {
                $ids = explode(',', $ids);
            }

            $groupIds = Mage::getModel('customer/group')->getCollection()->getAllIds();
            $ids = array_intersect($ids, $groupIds);
            $this->setData('customer_group_ids', $ids);
            $this->setCustomerGroupChecked(true);
        }
        return $ids;
    }

getMatchingProductIds

(

)

Definition at line 137 of file Rule.php.

    {
        if (empty($this->_productIds)) {
            $productCollection = Mage::getResourceModel('catalog/product_collection');
            $websiteIds = explode(',', $this->getWebsiteIds());
            if (!empty($websiteIds)) {
                $productCollection->addWebsiteFilter($websiteIds);
            }

            $this->setCollectedAttributes(array());
            $this->getConditions()->collectValidatedAttributes($productCollection);

            $this->_productIds = array();
            Mage::getSingleton('core/resource_iterator')->walk(
                $productCollection->getSelect(),
                array(array($this, 'callbackValidateProduct')),
                array(
                    'attributes'=>$this->getCollectedAttributes(),
                    'product'=>Mage::getModel('catalog/product'),
                )
            );
        }
        return $this->_productIds;
    }

getNow

(

)

Definition at line 51 of file Rule.php.

    {
        if (!$this->_now) {
            return now();
        }
        return $this->_now;
    }

getResourceCollection

(

)

Get collection instance

Returns:

object

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 126 of file Rule.php.

    {
        return Mage::getResourceModel('catalogrule/rule_collection');
    }

setNow

(

$

now

)

Definition at line 59 of file Rule.php.

    {
        $this->_now = $now;
    }

toArray

(

array $

arrAttributes = array()

)

Returns rule as an array for admin interface

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

Returns:

array

Reimplemented from Varien_Object.

Definition at line 89 of file Rule.php.

    {
        $out = parent::toArray($arrAttributes);
        $out['customer_registered'] = $this->getCustomerRegistered();
        $out['customer_new_buyer'] = $this->getCustomerNewBuyer();

        return $out;
    }

toString

(

$

format = ''

)

Public wrapper for __toString

Will use $format as an template and substitute {{key}} for attributes

Parameters:

string

$format

Returns:

string

Reimplemented from Varien_Object.

Definition at line 64 of file Rule.php.

    {
        $str = Mage::helper('catalogrule')->__("Name: %s", $this->getName()) ."\n"
             . Mage::helper('catalogrule')->__("Start at: %s", $this->getStartAt()) ."\n"
             . Mage::helper('catalogrule')->__("Expire at: %s", $this->getExpireAt()) ."\n"
             . Mage::helper('catalogrule')->__("Customer registered: %s", $this->getCustomerRegistered()) ."\n"
             . Mage::helper('catalogrule')->__("Customer is new buyer: %s", $this->getCustomerNewBuyer()) ."\n"
             . Mage::helper('catalogrule')->__("Description: %s", $this->getDescription()) ."\n\n"
             . $this->getConditions()->toStringRecursive() ."\n\n"
             . $this->getActions()->toStringRecursive() ."\n\n";
        return $str;
    }

---

Member Data Documentation

$_now [protected]

Definition at line 32 of file Rule.php.

$_productIds = array() [protected]

Definition at line 30 of file Rule.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/CatalogRule/Model/Rule.php