Mage_Catalog_Model_Convert_Parser_Product Class Reference

Inheritance diagram for Mage_Catalog_Model_Convert_Parser_Product:

List of all members.

Public Member Functions
	__construct ()
	getResource ()
	getCollection ($storeId)
	getProductTypes ()
	getProductTypeName ($code)
	getProductTypeId ($name)
	getProductModel ()
	getStore ()
	getStoreId ()
	setProductTypeInstance (Mage_Catalog_Model_Product $product)
	getAttributeSetInstance ()
	getAttribute ($code)
	parse ()
	setInventoryItems ($items)
	getInventoryItems ()
	unparse ()
	getExternalAttributes ()
Public Attributes
const	MULTI_DELIMITER = ' , '
Protected Attributes
	$_resource
	$_collections
	$_productTypeInstances = array()
	$_productTypes
	$_inventoryFields = array()
	$_imageFields = array()
	$_systemFields = array()
	$_internalFields = array()
	$_externalFields = array()
	$_inventoryItems = array()
	$_productModel
	$_setInstances = array()
	$_store
	$_storeId
	$_attributes = array()

---

Detailed Description

Definition at line 28 of file Product.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 73 of file Product.php.

    {
        foreach (Mage::getConfig()->getFieldset('catalog_product_dataflow', 'admin') as $code=>$node) {
            if ($node->is('inventory')) {
                $this->_inventoryFields[] = $code;
                if ($node->is('use_config')) {
                    $this->_inventoryFields[] = 'use_config_'.$code;
                }
            }
            if ($node->is('internal')) {
                $this->_internalFields[] = $code;
            }
            if ($node->is('system')) {
                $this->_systemFields[] = $code;
            }
            if ($node->is('external')) {
                $this->_externalFields[$code] = $code;
            }
            if ($node->is('img')) {
                $this->_imageFields[] = $code;
            }
        }
    }

---

Member Function Documentation

getAttribute

(

$

code

)

Retrieve eav entity attribute model

Parameters:

string

$code

Returns:

Mage_Eav_Model_Entity_Attribute

Definition at line 248 of file Product.php.

    {
        if (!isset($this->_attributes[$code])) {
            $this->_attributes[$code] = $this->getProductModel()->getResource()->getAttribute($code);
        }
        return $this->_attributes[$code];
    }

getAttributeSetInstance

(

)

Definition at line 229 of file Product.php.

    {
        $productType = $this->getProductModel()->getType();
        $attributeSetId = $this->getProductModel()->getAttributeSetId();

        if (!isset($this->_setInstances[$productType][$attributeSetId])) {
            $this->_setInstances[$productType][$attributeSetId] =
                Mage::getSingleton('catalog/product_type')->factory($this->getProductModel());
        }

        return $this->_setInstances[$productType][$attributeSetId];
    }

getCollection

(

$

storeId

)

Definition at line 112 of file Product.php.

    {
        if (!isset($this->_collections[$storeId])) {
            $this->_collections[$storeId] = Mage::getResourceModel('catalog/product_collection');
            $this->_collections[$storeId]->getEntity()->setStore($storeId);
        }
        return $this->_collections[$storeId];
    }

getExternalAttributes

(

)

Retrieve accessible external product attributes

Returns:

array

Definition at line 485 of file Product.php.

    {
        $entityTypeId = Mage::getSingleton('eav/config')->getEntityType('catalog_product')->getId();
        $productAttributes = Mage::getResourceModel('eav/entity_attribute_collection')
            ->setEntityTypeFilter($entityTypeId)
            ->load();

            var_dump($this->_externalFields);

        $attributes = $this->_externalFields;

        foreach ($productAttributes as $attr) {
            $code = $attr->getAttributeCode();
            if (in_array($code, $this->_internalFields) || $attr->getFrontendInput() == 'hidden') {
                continue;
            }
            $attributes[$code] = $code;
        }

        foreach ($this->_inventoryFields as $field) {
            $attributes[$field] = $field;
        }

        return $attributes;
    }

getInventoryItems

(

)

Definition at line 376 of file Product.php.

    {
        return $this->_inventoryItems;
    }

getProductModel

(

)

Retrieve product model cache

Returns:

Mage_Catalog_Model_Product

Definition at line 170 of file Product.php.

    {
        if (is_null($this->_productModel)) {
            $productModel = Mage::getModel('catalog/product');
            $this->_productModel = Mage::objects()->save($productModel);
        }
        return Mage::objects()->load($this->_productModel);
    }

getProductTypeId

(

$

name

)

Retrieve product type code by name

Parameters:

string

$name

Returns:

string

Definition at line 156 of file Product.php.

    {
        $productTypes = $this->getProductTypes();
        if ($code = array_search($name, $productTypes)) {
            return $code;
        }
        return false;
    }

getProductTypeName

(

$

code

)

Retrieve Product type name by code

Parameters:

string

$code

Returns:

string

Definition at line 141 of file Product.php.

    {
        $productTypes = $this->getProductTypes();
        if (isset($productTypes[$code])) {
            return $productTypes[$code];
        }
        return false;
    }

getProductTypes

(

)

Retrieve product type options

Returns:

array

Definition at line 126 of file Product.php.

    {
        if (is_null($this->_productTypes)) {
            $this->_productTypes = Mage::getSingleton('catalog/product_type')
                ->getOptionArray();
        }
        return $this->_productTypes;
    }

getResource

(

)

Returns:

Mage_Catalog_Model_Mysql4_Convert

Definition at line 100 of file Product.php.

    {
        if (!$this->_resource) {
            $this->_resource = Mage::getResourceSingleton('catalog_entity/convert');
                #->loadStores()
                #->loadProducts()
                #->loadAttributeSets()
                #->loadAttributeOptions();
        }
        return $this->_resource;
    }

getStore

(

)

Retrieve current store model

Returns:

Mage_Core_Model_Store

Definition at line 184 of file Product.php.

    {
        if (is_null($this->_store)) {
            try {
                $store = Mage::app()->getStore($this->getVar('store'));
            }
            catch (Exception $e) {
                $this->addException(Mage::helper('catalog')->__('Invalid store specified'), Varien_Convert_Exception::FATAL);
                throw $e;
            }
            $this->_store = $store;
        }
        return $this->_store;
    }

getStoreId

(

)

Retrieve store ID

Returns:

int

Definition at line 204 of file Product.php.

    {
        if (is_null($this->_storeId)) {
            $this->_storeId = $this->getStore()->getId();
        }
        return $this->_storeId;
    }

parse

(

)

Deprecated:

not used anymore

Implements Mage_Dataflow_Model_Convert_Parser_Interface.

Definition at line 259 of file Product.php.

    {
        $data = $this->getData();

        $entityTypeId = Mage::getSingleton('eav/config')->getEntityType('catalog_product')->getId();

        $result = array();
        $inventoryFields = array();
        foreach ($data as $i=>$row) {
            $this->setPosition('Line: '.($i+1));
            try {
                // validate SKU
                if (empty($row['sku'])) {
                    $this->addException(Mage::helper('catalog')->__('Missing SKU, skipping the record'), Mage_Dataflow_Model_Convert_Exception::ERROR);
                    continue;
                }
                $this->setPosition('Line: '.($i+1).', SKU: '.$row['sku']);

                // try to get entity_id by sku if not set
                if (empty($row['entity_id'])) {
                    $row['entity_id'] = $this->getResource()->getProductIdBySku($row['sku']);
                }

                // if attribute_set not set use default
                if (empty($row['attribute_set'])) {
                    $row['attribute_set'] = 'Default';
                }
                // get attribute_set_id, if not throw error
                $row['attribute_set_id'] = $this->getAttributeSetId($entityTypeId, $row['attribute_set']);
                if (!$row['attribute_set_id']) {
                    $this->addException(Mage::helper('catalog')->__("Invalid attribute set specified, skipping the record"), Mage_Dataflow_Model_Convert_Exception::ERROR);
                    continue;
                }

                if (empty($row['type'])) {
                    $row['type'] = 'Simple';
                }
                // get product type_id, if not throw error
                $row['type_id'] = $this->getProductTypeId($row['type']);
                if (!$row['type_id']) {
                    $this->addException(Mage::helper('catalog')->__("Invalid product type specified, skipping the record"), Mage_Dataflow_Model_Convert_Exception::ERROR);
                    continue;
                }

                // get store ids
                $storeIds = $this->getStoreIds(isset($row['store']) ? $row['store'] : $this->getVar('store'));
                if (!$storeIds) {
                    $this->addException(Mage::helper('catalog')->__("Invalid store specified, skipping the record"), Mage_Dataflow_Model_Convert_Exception::ERROR);
                    continue;
                }

                // import data
                $rowError = false;
                foreach ($storeIds as $storeId) {
                    $collection = $this->getCollection($storeId);
                    $entity = $collection->getEntity();

                    $model = Mage::getModel('catalog/product');
                    $model->setStoreId($storeId);
                    if (!empty($row['entity_id'])) {
                        $model->load($row['entity_id']);
                    }
                    foreach ($row as $field=>$value) {
                        $attribute = $entity->getAttribute($field);

                        if (!$attribute) {
                            //$inventoryFields[$row['sku']][$field] = $value;

                            if (in_array($field, $this->_inventoryFields)) {
                                $inventoryFields[$row['sku']][$field] = $value;
                            }
                            continue;
                            #$this->addException(Mage::helper('catalog')->__("Unknown attribute: %s", $field), Mage_Dataflow_Model_Convert_Exception::ERROR);
                        }
                        if ($attribute->usesSource()) {
                            $source = $attribute->getSource();
                            $optionId = $this->getSourceOptionId($source, $value);
                            if (is_null($optionId)) {
                                $rowError = true;
                                $this->addException(Mage::helper('catalog')->__("Invalid attribute option specified for attribute %s (%s), skipping the record", $field, $value), Mage_Dataflow_Model_Convert_Exception::ERROR);
                                continue;
                            }
                            $value = $optionId;
                        }
                        $model->setData($field, $value);

                    }//foreach ($row as $field=>$value)

                    //echo 'Before **********************<br/><pre>';
                    //print_r($model->getData());
                    if (!$rowError) {
                        $collection->addItem($model);
                    }
                    unset($model);
                } //foreach ($storeIds as $storeId)
            } catch (Exception $e) {
                if (!$e instanceof Mage_Dataflow_Model_Convert_Exception) {
                    $this->addException(Mage::helper('catalog')->__("Error during retrieval of option value: %s", $e->getMessage()), Mage_Dataflow_Model_Convert_Exception::FATAL);
                }
            }
        }

        // set importinted to adaptor
        if (sizeof($inventoryFields) > 0) {
            Mage::register('current_imported_inventory', $inventoryFields);
            //$this->setInventoryItems($inventoryFields);
        } // end setting imported to adaptor

        $this->setData($this->_collections);
        return $this;
    }

setInventoryItems

(

$

items

)

Definition at line 371 of file Product.php.

    {
        $this->_inventoryItems = $items;
    }

setProductTypeInstance

(

Mage_Catalog_Model_Product $

product

)

ReDefine Product Type Instance to Product

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

Mage_Catalog_Model_Convert_Adapter_Product

Definition at line 218 of file Product.php.

    {
        $type = $product->getTypeId();
        if (!isset($this->_productTypeInstances[$type])) {
            $this->_productTypeInstances[$type] = Mage::getSingleton('catalog/product_type')
                ->factory($product, true);
        }
        $product->setTypeInstance($this->_productTypeInstances[$type], true);
        return $this;
    }

unparse

(

)

Unparse (prepare data) loaded products

Returns:

Mage_Catalog_Model_Convert_Parser_Product

Implements Mage_Dataflow_Model_Convert_Parser_Interface.

Definition at line 386 of file Product.php.

    {
        $entityIds = $this->getData();

        foreach ($entityIds as $i => $entityId) {
            $product = $this->getProductModel()
                ->reset()
                ->setStoreId($this->getStoreId())
                ->load($entityId);
            $this->setProductTypeInstance($product);
            /* @var $product Mage_Catalog_Model_Product */

            $position = Mage::helper('catalog')->__('Line %d, SKU: %s', ($i+1), $product->getSku());
            $this->setPosition($position);

            $row = array(
                'store'         => $this->getStore()->getCode(),
                'websites'      => '',
                'attribute_set' => $this->getAttributeSetName($product->getEntityTypeId(), $product->getAttributeSetId()),
                'type'          => $product->getTypeId(),
            );

            if ($this->getStore()->getCode() == Mage_Core_Model_Store::ADMIN_CODE) {
                $websiteCodes = array();
                foreach ($product->getWebsiteIds() as $websiteId) {
                    $websiteCode = Mage::app()->getWebsite($websiteId)->getCode();
                    $websiteCodes[$websiteCode] = $websiteCode;
                }
                $row['websites'] = join(',', $websiteCodes);
            }
            else {
                $row['websites'] = $this->getStore()->getWebsite()->getCode();
                if ($this->getVar('url_field')) {
                    $row['url'] = $product->getProductUrl(false);
                }
            }

            foreach ($product->getData() as $field => $value) {
                if (in_array($field, $this->_systemFields) || is_object($value)) {
                    continue;
                }

                $attribute = $this->getAttribute($field);
                if (!$attribute) {
                    continue;
                }

                if ($attribute->usesSource()) {
                    $option = $attribute->getSource()->getOptionText($value);
                    if ($value && empty($option)) {
                        $message = Mage::helper('catalog')->__("Invalid option id specified for %s (%s), skipping the record", $field, $value);
                        $this->addException($message, Mage_Dataflow_Model_Convert_Exception::ERROR);
                        continue;
                    }
                    if (is_array($option)) {
                        $value = join(self::MULTI_DELIMITER, $option);
                    } else {
                        $value = $option;
                    }
                    unset($option);
                }
                elseif (is_array($value)) {
                    continue;
                }

                $row[$field] = $value;
            }

            if ($stockItem = $product->getStockItem()) {
                foreach ($stockItem->getData() as $field => $value) {
                    if (in_array($field, $this->_systemFields) || is_object($value)) {
                        continue;
                    }
                    $row[$field] = $value;
                }
            }

            foreach ($this->_imageFields as $field) {
                if (isset($row[$field]) && $row[$field] == 'no_selection') {
                    $row[$field] = null;
                }
            }

            $batchExport = $this->getBatchExportModel()
                ->setId(null)
                ->setBatchId($this->getBatchModel()->getId())
                ->setBatchData($row)
                ->setStatus(1)
                ->save();
        }

        return $this;
    }

---

Member Data Documentation

$_attributes = array() [protected]

Definition at line 71 of file Product.php.

$_collections [protected]

Definition at line 39 of file Product.php.

$_externalFields = array() [protected]

Definition at line 61 of file Product.php.

$_imageFields = array() [protected]

Definition at line 57 of file Product.php.

$_internalFields = array() [protected]

Definition at line 60 of file Product.php.

$_inventoryFields = array() [protected]

Definition at line 55 of file Product.php.

$_inventoryItems = array() [protected]

Definition at line 63 of file Product.php.

$_productModel [protected]

Definition at line 65 of file Product.php.

$_productTypeInstances = array() [protected]

Definition at line 46 of file Product.php.

$_productTypes [protected]

Definition at line 53 of file Product.php.

$_resource [protected]

Definition at line 32 of file Product.php.

$_setInstances = array() [protected]

Definition at line 67 of file Product.php.

$_store [protected]

Definition at line 69 of file Product.php.

$_storeId [protected]

Definition at line 70 of file Product.php.

$_systemFields = array() [protected]

Definition at line 59 of file Product.php.

const MULTI_DELIMITER = ' , '

Definition at line 31 of file Product.php.

---

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

• app/code/core/Mage/Catalog/Model/Convert/Parser/Product.php