Mage_Rule_Model_Action_Collection Class Reference

Inheritance diagram for Mage_Rule_Model_Action_Collection:

List of all members.

Public Member Functions
	__construct ()
	asArray (array $arrAttributes=array())
	loadArray (array $arr)
	addAction (Mage_Rule_Model_Action_Interface $action)
	asHtml ()
	getNewChildElement ()
	asHtmlRecursive ()
	asString ($format='')
	asStringRecursive ($level=0)
	process ()

---

Detailed Description

Definition at line 28 of file Collection.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Mage_Rule_Model_Action_Abstract.

Reimplemented in Mage_CatalogRule_Model_Rule_Action_Collection, and Mage_SalesRule_Model_Rule_Action_Collection.

Definition at line 30 of file Collection.php.

    {
        parent::__construct();
        $this->setActions(array());
        $this->setType('rule/action_collection');
    }

---

Member Function Documentation

addAction

(

Mage_Rule_Model_Action_Interface $

action

)

Definition at line 73 of file Collection.php.

    {
        $actions = $this->getActions();

        $action->setRule($this->getRule());

        $actions[] = $action;
        if (!$action->getId()) {
            $action->setId($this->getId().'.'.sizeof($actions));
        }

        $this->setActions($actions);
        return $this;
    }

asArray

(

array $

arrAttributes = array()

)

Returns array containing actions in the collection

Output example: array( {action.asArray}, {action.asArray} )

Returns:

array

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 48 of file Collection.php.

    {
        $out = parent::asArray();

        foreach ($this->getActions() as $item) {
            $out['actions'][] = $item->asArray();
        }
        return $out;
    }

asHtml

(

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 88 of file Collection.php.

    {
        $html = $this->getTypeElement()->toHtml().'Perform following actions: ';
        if ($this->getId()!='1') {
            $html.= $this->getRemoveLinkHtml();
        }
        return $html;
    }

asHtmlRecursive

(

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 105 of file Collection.php.

    {
        $html = $this->asHtml().'<ul id="action:'.$this->getId().':children">';
        foreach ($this->getActions() as $cond) {
            $html .= '<li>'.$cond->asHtmlRecursive().'</li>';
        }
        $html .= '<li>'.$this->getNewChildElement()->getHtml().'</li></ul>';
        return $html;
    }

asString

(

$

format = ''

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 115 of file Collection.php.

    {
        $str = Mage::helper('rule')->__("Perform following actions");
        return $str;
    }

asStringRecursive

(

$

level = 0

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 121 of file Collection.php.

    {
        $str = $this->asString();
        foreach ($this->getActions() as $action) {
            $str .= "\n".$action->asStringRecursive($level+1);
        }
        return $str;
    }

getNewChildElement

(

)

Definition at line 96 of file Collection.php.

   {
       return $this->getForm()->addField('action:'.$this->getId().':new_child', 'select', array(
           'name'=>'rule[actions]['.$this->getId().'][new_child]',
           'values'=>$this->getNewChildSelectOptions(),
           'value_name'=>$this->getNewChildName(),
       ))->setRenderer(Mage::getBlockSingleton('rule/newchild'));
    }

loadArray

(

array $

arr

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 58 of file Collection.php.

    {
        if (!empty($arr['actions']) && is_array($arr['actions'])) {
            foreach ($arr['actions'] as $actArr) {
                if (empty($actArr['type'])) {
                    continue;
                }
                $action = Mage::getModel($actArr['type']);
                $action->loadArray($actArr);
                $this->addAction($action);
            }
        }
        return $this;
    }

process

(

)

Reimplemented from Mage_Rule_Model_Action_Abstract.

Definition at line 130 of file Collection.php.

    {
        foreach ($this->getActions() as $action) {
            $action->process();
        }
        return $this;
    }

---

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

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