Varien_Convert_Profile_Abstract Class Reference

Inheritance diagram for Varien_Convert_Profile_Abstract:

List of all members.

Public Member Functions
	addAction (Varien_Convert_Action_Interface $action=null)
	setContainers (Varien_Convert_Container_Collection $containers)
	getContainers ()
	getContainer ($name=null)
	addContainer ($name, Varien_Convert_Container_Interface $container)
	getExceptions ()
	getDryRun ()
	setDryRun ($flag)
	addException (Varien_Convert_Exception $e)
	run ()
Protected Attributes
	$_actions
	$_containers
	$_exceptions = array()
	$_dryRun
	$_actionDefaultClass = 'Varien_Convert_Action'
	$_containerCollectionDefaultClass = 'Varien_Convert_Container_Collection'

---

Detailed Description

Definition at line 35 of file Abstract.php.

---

Member Function Documentation

addAction

(

Varien_Convert_Action_Interface $

action = null

)

Definition at line 45 of file Abstract.php.

    {
        if (is_null($action)) {
            $action = new $this->_actionDefaultClass();
        }
        $this->_actions[] = $action;
        $action->setProfile($this);
        return $action;
    }

addContainer	(	$	name,
		Varien_Convert_Container_Interface $	container
	)

Definition at line 77 of file Abstract.php.

    {
        $container = $this->getContainers()->addItem($name, $container);
        $container->setProfile($this);
        return $container;
    }

addException

(

Varien_Convert_Exception $

e

)

Definition at line 100 of file Abstract.php.

    {
        $this->_exceptions[] = $e;
        return $this;
    }

getContainer

(

$

name = null

)

Definition at line 69 of file Abstract.php.

    {
        if (is_null($name)) {
            $name = '_default';
        }
        return $this->getContainers()->getItem($name);
    }

getContainers

(

)

Definition at line 61 of file Abstract.php.

    {
        if (!$this->_containers) {
            $this->_containers = new $this->_containerCollectionDefaultClass();
        }
        return $this->_containers;
    }

getDryRun

(

)

Definition at line 89 of file Abstract.php.

    {
        return $this->_dryRun;
    }

getExceptions

(

)

Definition at line 84 of file Abstract.php.

    {
        return $this->_exceptions;
    }

run

(

)

Definition at line 106 of file Abstract.php.

    {
        if (!$this->_actions) {
            $e = new Varien_Convert_Exception("Could not find any actions for this profile");
            $e->setLevel(Varien_Convert_Exception::FATAL);
            $this->addException($e);
            return;
        }

        foreach ($this->_actions as $action) {
            $action->run();
        }
        return $this;
    }

setContainers

(

Varien_Convert_Container_Collection $

containers

)

Definition at line 55 of file Abstract.php.

    {
        $this->_containers = $containers;
        return $this;
    }

setDryRun

(

$

flag

)

Definition at line 94 of file Abstract.php.

    {
        $this->_dryRun = $flag;
        return $this;
    }

---

Member Data Documentation

$_actionDefaultClass = 'Varien_Convert_Action' [protected]

Definition at line 42 of file Abstract.php.

$_actions [protected]

Definition at line 37 of file Abstract.php.

$_containerCollectionDefaultClass = 'Varien_Convert_Container_Collection' [protected]

Definition at line 43 of file Abstract.php.

$_containers [protected]

Definition at line 38 of file Abstract.php.

$_dryRun [protected]

Definition at line 40 of file Abstract.php.

$_exceptions = array() [protected]

Definition at line 39 of file Abstract.php.

---

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

• lib/Varien/Convert/Profile/Abstract.php