Mage_Dataflow_Model_Convert_Container_Abstract Class Reference

Inheritance diagram for Mage_Dataflow_Model_Convert_Container_Abstract:

List of all members.

Public Member Functions
	getVar ($key, $default=null)
	getVars ()
	setVar ($key, $value=null)
	getAction ()
	setAction (Mage_Dataflow_Model_Convert_Action_Interface $action)
	getProfile ()
	setProfile (Mage_Dataflow_Model_Convert_Profile_Interface $profile)
	getData ()
	setData ($data)
	validateDataString ($data=null)
	validateDataArray ($data=null)
	validateDataGrid ($data=null)
	getGridFields ($grid)
	addException ($error, $level=null)
	getPosition ()
	setPosition ($position)
	setBatchParams ($data)
	getBatchParams ($key=null)
Protected Attributes
	$_batchParams = array()
	$_vars
	$_profile
	$_action
	$_data
	$_position

---

Detailed Description

Definition at line 35 of file Abstract.php.

---

Member Function Documentation

addException	(	$	error,
		$	level = null
	)

Definition at line 161 of file Abstract.php.

    {
        $e = new Mage_Dataflow_Model_Convert_Exception($error);
        $e->setLevel(!is_null($level) ? $level : Mage_Dataflow_Model_Convert_Exception::NOTICE);
        $e->setContainer($this);
        $e->setPosition($this->getPosition());

        if ($this->getProfile()) {
            $this->getProfile()->addException($e);
        }

        return $e;
    }

getAction

(

)

Definition at line 73 of file Abstract.php.

    {
        return $this->_action;
    }

getBatchParams

(

$

key = null

)

Definition at line 194 of file Abstract.php.

    {
        if (!empty($key)) {
            return isset($this->_batchParams[$key]) ? $this->_batchParams[$key] : null;
        }
        return $this->_batchParams;
    }

getData

(

)

Definition at line 95 of file Abstract.php.

    {
        if (is_null($this->_data) && $this->getProfile()) {
            $this->_data = $this->getProfile()->getContainer()->getData();
        }
        return $this->_data;
    }

getGridFields

(

$

grid

)

Definition at line 148 of file Abstract.php.

    {
        $fields = array();
        foreach ($grid as $i=>$row) {
            foreach ($row as $fieldName=>$data) {
                if (!in_array($fieldName, $fields)) {
                    $fields[] = $fieldName;
                }
            }
        }
        return $fields;
    }

getPosition

(

)

Definition at line 175 of file Abstract.php.

    {
        return $this->_position;
    }

getProfile

(

)

Definition at line 84 of file Abstract.php.

    {
        return $this->_profile;
    }

getVar	(	$	key,
		$	default = null
	)

Definition at line 50 of file Abstract.php.

    {
        if (!isset($this->_vars[$key]) || (!is_array($this->_vars[$key]) && strlen($this->_vars[$key]) == 0)) {
            return $default;
        }
        return $this->_vars[$key];
    }

getVars

(

)

Definition at line 58 of file Abstract.php.

    {
        return $this->_vars;
    }

setAction

(

Mage_Dataflow_Model_Convert_Action_Interface $

action

)

Definition at line 78 of file Abstract.php.

    {
        $this->_action = $action;
        return $this;
    }

setBatchParams

(

$

data

)

Definition at line 186 of file Abstract.php.

    {
        if (is_array($data)) {
            $this->_batchParams = $data;
        }
        return $this;
    }

setData

(

$

data

)

Definition at line 103 of file Abstract.php.

    {
        if ($this->getProfile()) {
            $this->getProfile()->getContainer()->setData($data);
        }
        $this->_data = $data;
        return $this;
    }

setPosition

(

$

position

)

Definition at line 180 of file Abstract.php.

    {
        $this->_position = $position;
        return $this;
    }

setProfile

(

Mage_Dataflow_Model_Convert_Profile_Interface $

profile

)

Definition at line 89 of file Abstract.php.

    {
        $this->_profile = $profile;
        return $this;
    }

setVar	(	$	key,
		$	value = null
	)

Definition at line 63 of file Abstract.php.

    {
        if (is_array($key) && is_null($value)) {
            $this->_vars = $key;
        } else {
            $this->_vars[$key] = $value;
        }
        return $this;
    }

validateDataArray

(

$

data = null

)

Definition at line 123 of file Abstract.php.

    {
        if (is_null($data)) {
            $data = $this->getData();
        }
        if (!is_array($data)) {
            $this->addException("Invalid data type, expecting array.", Mage_Dataflow_Model_Convert_Exception::FATAL);
        }
        return true;
    }

validateDataGrid

(

$

data = null

)

Definition at line 134 of file Abstract.php.

    {
        if (is_null($data)) {
            $data = $this->getData();
        }
        if (!is_array($data) || !is_array(current($data))) {
            if (count($data)==0) {
                return true;
            }
            $this->addException("Invalid data type, expecting 2D grid array.", Mage_Dataflow_Model_Convert_Exception::FATAL);
        }
        return true;
    }

validateDataString

(

$

data = null

)

Definition at line 112 of file Abstract.php.

    {
        if (is_null($data)) {
            $data = $this->getData();
        }
        if (!is_string($data)) {
            $this->addException("Invalid data type, expecting string.", Mage_Dataflow_Model_Convert_Exception::FATAL);
        }
        return true;
    }

---

Member Data Documentation

$_action [protected]

Definition at line 44 of file Abstract.php.

$_batchParams = array() [protected]

Definition at line 38 of file Abstract.php.

$_data [protected]

Definition at line 46 of file Abstract.php.

$_position [protected]

Definition at line 48 of file Abstract.php.

$_profile [protected]

Definition at line 42 of file Abstract.php.

$_vars [protected]

Definition at line 40 of file Abstract.php.

---

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

• app/code/core/Mage/Dataflow/Model/Convert/Container/Abstract.php