Mage_Rule_Model_Mysql4_Rule_Collection Class Reference

Inheritance diagram for Mage_Rule_Model_Mysql4_Rule_Collection:

List of all members.

Public Member Functions
	setEnv (Mage_Rule_Model_Environment $env=null)
	getEnv ()
	addItem (Varien_Object $rule)
	setActiveFilter ()
	process ()
Protected Member Functions
	_construct ()
	_afterLoad ()
Protected Attributes
	$_env

---

Detailed Description

Definition at line 34 of file Collection.php.

---

Member Function Documentation

_afterLoad

(

)

[protected]

Reimplemented from Varien_Data_Collection_Db.

Definition at line 145 of file Collection.php.

    {
        $this->walk('afterLoad');
    }

_construct

(

)

[protected]

Initialization here

Reimplemented from Mage_Core_Model_Mysql4_Collection_Abstract.

Definition at line 43 of file Collection.php.

    {
        $this->_init('rule/rule');
    }

addItem

(

Varien_Object $

rule

)

Overload default addItem method to set environment for the rules

Parameters:

Mage_Rule_Model_Abstract

$rule

Returns:

Mage_Rule_Model_Mysql4_Rule_Collection

Reimplemented from Varien_Data_Collection.

Definition at line 97 of file Collection.php.

    {
        $rule->setEnv($this->getEnv())->setIsCollectionValidated(true);
        parent::addItem($rule);
        return $this;
    }

getEnv

(

)

Retrieve environment for the rules in collection

Returns:

Mage_Rule_Model_Mysql4_Rule_Collection

Definition at line 82 of file Collection.php.

    {
        if (!$this->_env) {
            $this->_env = Mage::getModel('core/rule_environment');
            $this->_env->collect();
        }
        return $this->_env;
    }

process

(

)

Process the quote with all the rules in collection

Returns:

Mage_Rule_Model_Mysql4_Rule_Collection

Definition at line 133 of file Collection.php.

    {
        $rules = $this->getItems();
        foreach ($rules as $rule) {
            $rule->process();
            if ($rule->getStopProcessingRules()) {
                break;
            }
        }
        return $this;
    }

setActiveFilter

(

)

Set filter for the collection based on the environment

Returns:

Mage_Rule_Model_Mysql4_Rule_Collection

Definition at line 109 of file Collection.php.

    {
        $e = $this->getEnv()->getData();

        $this->_select->where("is_active=1");

        if (!empty($e['now'])) {
            if (!is_numeric($e['now'])) {
                $e['now'] = strtotime($e['now']);
            }
            $now = date("Y-m-d H:i:s", $e['now']);
        } else {
            $now = date("Y-m-d H:i:s");
        }
        $this->_select->where("start_at<='$now' and expire_at>='$now'");

        return $this;
    }

setEnv

(

Mage_Rule_Model_Environment $

env = null

)

Initialize resource collection variables

Example: Set environment for all rules in collection

Parameters:

Mage_Rule_Model_Environment

$env

Returns:

Mage_Rule_Model_Mysql4_Rule_Collection

Definition at line 71 of file Collection.php.

    {
        $this->_env = $env;
        return $this;
    }

---

Member Data Documentation

$_env [protected]

Definition at line 41 of file Collection.php.

---

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

• app/code/core/Mage/Rule/Model/Mysql4/Rule/Collection.php