Mage_Rule_Model_Rule Class Reference

Inheritance diagram for Mage_Rule_Model_Rule:

List of all members.

Public Member Functions
	getConditionsInstance ()
	_resetConditions ($conditions=null)
	setConditions ($conditions)
	getConditions ()
	getActionsInstance ()
	_resetActions ($actions=null)
	setActions ($actions)
	getActions ()
	getForm ()
	asString ($format='')
	asHtml ()
	loadPost (array $rule)
	asArray (array $arrAttributes=array())
	validate (Varien_Object $object)
	afterLoad ()
	isDeleteable ()
	setIsDeleteable ($flag)
	isReadonly ()
	setIsReadonly ($value)
Protected Member Functions
	_construct ()
	_convertFlatToRecursive (array $rule)
	_afterLoad ()
	_beforeSave ()
Protected Attributes
	$_conditions
	$_actions
	$_form
	$_isDeleteable = true
	$_isReadonly = false

---

Detailed Description

Definition at line 27 of file Rule.php.

---

Member Function Documentation

_afterLoad

(

)

[protected]

Processing object after load data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 234 of file Rule.php.

    {
        parent::_afterLoad();
        $conditionsArr = unserialize($this->getConditionsSerialized());
        if (!empty($conditionsArr) && is_array($conditionsArr)) {
            $this->getConditions()->loadArray($conditionsArr);
        }

        $actionsArr = unserialize($this->getActionsSerialized());
        if (!empty($actionsArr) && is_array($actionsArr)) {
            $this->getActions()->loadArray($actionsArr);
        }

        $this->setWebsiteIds(explode(',',$this->getWebsiteIds()));
        $groupIds = $this->getCustomerGroupIds();
        if (is_string($groupIds)) {
            $this->setCustomerGroupIds(explode(',',$groupIds));
        }
    }

_beforeSave

(

)

[protected]

Processing object before save data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Reimplemented in Mage_SalesRule_Model_Rule.

Definition at line 254 of file Rule.php.

    {
        // check if discount amount > 0
        if ((int)$this->getDiscountAmount() < 0) {
            Mage::throwException(Mage::helper('rule')->__('Invalid discount amount.'));
        }


        if ($this->getConditions()) {
            $this->setConditionsSerialized(serialize($this->getConditions()->asArray()));
            $this->unsConditions();
        }
        if ($this->getActions()) {
            $this->setActionsSerialized(serialize($this->getActions()->asArray()));
            $this->unsActions();
        }
        if (is_array($this->getWebsiteIds())) {
            $this->setWebsiteIds(join(',', $this->getWebsiteIds()));
        }
        if (is_array($this->getCustomerGroupIds())) {
            $this->setCustomerGroupIds(join(',', $this->getCustomerGroupIds()));
        }
        parent::_beforeSave();
    }

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Reimplemented in Mage_CatalogRule_Model_Rule, and Mage_SalesRule_Model_Rule.

Definition at line 48 of file Rule.php.

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

_convertFlatToRecursive

(

array $

rule

)

[protected]

convert dates into Zend_Date

Definition at line 162 of file Rule.php.

    {
        $arr = array();
        foreach ($rule as $key=>$value) {
            if (($key==='conditions' || $key==='actions') && is_array($value)) {
                foreach ($value as $id=>$data) {
                    $path = explode('--', $id);
                    $node =& $arr;
                    for ($i=0, $l=sizeof($path); $i<$l; $i++) {
                        if (!isset($node[$key][$path[$i]])) {
                            $node[$key][$path[$i]] = array();
                        }
                        $node =& $node[$key][$path[$i]];
                    }
                    foreach ($data as $k=>$v) {
                        $node[$k] = $v;
                    }
                }
            } else {
                /**
                 * convert dates into Zend_Date
                 */
                if (in_array($key, array('from_date', 'to_date')) && $value) {
                    $value = Mage::app()->getLocale()->date(
                        $value,
                        Mage::app()->getLocale()->getDateFormat(Mage_Core_Model_Locale::FORMAT_TYPE_SHORT),
                        null,
                        false
                    );
                }
                $this->setData($key, $value);
            }
        }
        return $arr;
    }

_resetActions

(

$

actions = null

)

Definition at line 94 of file Rule.php.

    {
        if (is_null($actions)) {
            $actions = $this->getActionsInstance();
        }
        $actions->setRule($this)->setId('1')->setPrefix('actions');
        $this->setActions($actions);

        return $this;
    }

_resetConditions

(

$

conditions = null

)

Definition at line 59 of file Rule.php.

    {
        if (is_null($conditions)) {
            $conditions = $this->getConditionsInstance();
        }
        $conditions->setRule($this)->setId('1')->setPrefix('conditions');
        $this->setConditions($conditions);

        return $this;
    }

afterLoad

(

)

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 229 of file Rule.php.

    {
        $this->_afterLoad();
    }

asArray

(

array $

arrAttributes = array()

)

Returns rule as an array for admin interface

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

Returns:

array

Definition at line 210 of file Rule.php.

    {
        $out = array(
            'name'=>$this->getName(),
            'start_at'=>$this->getStartAt(),
            'expire_at'=>$this->getExpireAt(),
            'description'=>$this->getDescription(),
            'conditions'=>$this->getConditions()->asArray(),
            'actions'=>$this->getActions()->asArray(),
        );

        return $out;
    }

asHtml

(

)

Definition at line 138 of file Rule.php.

    {
        $str = Mage::helper('rule')->__("Name: %s", $this->getName()) ."<br/>"
             . Mage::helper('rule')->__("Start at: %s", $this->getStartAt()) ."<br/>"
             . Mage::helper('rule')->__("Expire at: %s", $this->getExpireAt()) ."<br/>"
             . Mage::helper('rule')->__("Description: %s", $this->getDescription()) .'<br/>'
             . '<ul class="rule-conditions">'.$this->getConditions()->asHtmlRecursive().'</ul>'
             . '<ul class="rule-actions">'.$this->getActions()->asHtmlRecursive()."</ul>";
        return $str;
    }

asString

(

$

format = ''

)

Definition at line 127 of file Rule.php.

    {
        $str = Mage::helper('rule')->__("Name: %s", $this->getName()) ."\n"
             . Mage::helper('rule')->__("Start at: %s", $this->getStartAt()) ."\n"
             . Mage::helper('rule')->__("Expire at: %s", $this->getExpireAt()) ."\n"
             . Mage::helper('rule')->__("Description: %s", $this->getDescription()) ."\n\n"
             . $this->getConditions()->asStringRecursive() ."\n\n"
             . $this->getActions()->asStringRecursive() ."\n\n";
        return $str;
    }

getActions

(

)

Definition at line 111 of file Rule.php.

    {
        if (!$this->_actions) {
            $this->_resetActions();
        }
        return $this->_actions;
    }

getActionsInstance

(

)

Reimplemented in Mage_CatalogRule_Model_Rule, and Mage_SalesRule_Model_Rule.

Definition at line 89 of file Rule.php.

    {
        return Mage::getModel('rule/action_collection');
    }

getConditions

(

)

Retrieve Condition model

Returns:

Mage_SalesRule_Model_Rule_Condition_Abstract

Definition at line 81 of file Rule.php.

    {
        if (empty($this->_conditions)) {
            $this->_resetConditions();
        }
        return $this->_conditions;
    }

getConditionsInstance

(

)

Reimplemented in Mage_CatalogRule_Model_Rule, and Mage_SalesRule_Model_Rule.

Definition at line 54 of file Rule.php.

    {
        return Mage::getModel('rule/condition_combine');
    }

getForm

(

)

Definition at line 119 of file Rule.php.

    {
        if (!$this->_form) {
            $this->_form = new Varien_Data_Form();
        }
        return $this->_form;
    }

isDeleteable

(

)

Check availabitlity to delete model

Returns:

boolean

Definition at line 284 of file Rule.php.

    {
        return $this->_isDeleteable;
    }

isReadonly

(

)

Checks model is readonly

Returns:

boolean

Definition at line 307 of file Rule.php.

    {
        return $this->_isReadonly;
    }

loadPost

(

array $

rule

)

Reimplemented in Mage_SalesRule_Model_Rule.

Definition at line 149 of file Rule.php.

    {
        $arr = $this->_convertFlatToRecursive($rule);
        if (isset($arr['conditions'])) {
            $this->getConditions()->loadArray($arr['conditions'][1]);
        }
        if (isset($arr['actions'])) {
            $this->getActions()->loadArray($arr['actions'][1]);
        }

        return $this;
    }

setActions

(

$

actions

)

Definition at line 105 of file Rule.php.

    {
        $this->_actions = $actions;
        return $this;
    }

setConditions

(

$

conditions

)

Definition at line 70 of file Rule.php.

    {
        $this->_conditions = $conditions;
        return $this;
    }

setIsDeleteable

(

$

flag

)

Set is deleteable flag

Parameters:

boolean

$flag

Returns:

Mage_Rule_Model_Rule

Definition at line 295 of file Rule.php.

    {
        $this->_isDeleteable = (bool) $flag;
        return $this;
    }

setIsReadonly

(

$

value

)

Set is readonly flag

Parameters:

boolean

$value

Returns:

Mage_Rule_Model_Rule

Definition at line 318 of file Rule.php.

    {
        $this->_isReadonly = (boolean) $value;
        return $this;
    }

validate

(

Varien_Object $

object

)

Definition at line 224 of file Rule.php.

    {
        return $this->getConditions()->validate($object);
    }

---

Member Data Documentation

$_actions [protected]

Definition at line 30 of file Rule.php.

$_conditions [protected]

Definition at line 29 of file Rule.php.

$_form [protected]

Definition at line 31 of file Rule.php.

$_isDeleteable = true [protected]

Definition at line 38 of file Rule.php.

$_isReadonly = false [protected]

Definition at line 45 of file Rule.php.

---

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

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