Mage_Catalog_Model_Product_Attribute_Media_Api Class Reference

Inheritance diagram for Mage_Catalog_Model_Product_Attribute_Media_Api:

List of all members.

Public Member Functions
	__construct ()
	items ($productId, $store=null)
	info ($productId, $file, $store=null)
	create ($productId, $data, $store=null)
	update ($productId, $file, $data, $store=null)
	remove ($productId, $file)
	types ($setId)
Public Attributes
const	ATTRIBUTE_CODE = 'media_gallery'
Protected Member Functions
	_getGalleryAttribute ($product)
	_getMediaConfig ()
	_imageToArray (&$image, $product)
	_initProduct ($productId, $store=null)
Protected Attributes
	$_mimeTypes

---

Detailed Description

Definition at line 34 of file Api.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 53 of file Api.php.

    {
        $this->_storeIdSessionField = 'product_store_id';
    }

---

Member Function Documentation

_getGalleryAttribute

(

$

product

)

[protected]

Retrieve gallery attribute from product

Parameters:

	Mage_Catalog_Model_Product	$product
	Mage_Catalog_Model_Resource_Eav_Mysql4_Attribute|boolean

Definition at line 299 of file Api.php.

    {
        $attributes = $product->getTypeInstance(true)
            ->getSetAttributes($product);

        if (!isset($attributes[self::ATTRIBUTE_CODE])) {
            $this->_fault('not_media');
        }

        return $attributes[self::ATTRIBUTE_CODE];
    }

_getMediaConfig

(

)

[protected]

Retrie ve media config

Returns:

Mage_Catalog_Model_Product_Media_Config

Definition at line 317 of file Api.php.

    {
        return Mage::getSingleton('catalog/product_media_config');
    }

_imageToArray	(	&$	image,
		$	product
	)			[protected]

Converts image to api array data

Parameters:

	array	$image
	Mage_Catalog_Model_Product	$product

Returns:

array

Definition at line 329 of file Api.php.

    {
        $result = array(
            'file'      => $image['file'],
            'label'     => $image['label'],
            'position'  => $image['position'],
            'exclude'   => $image['disabled'],
            'url'       => $this->_getMediaConfig()->getMediaUrl($image['file']),
            'types'     => array()
        );


        foreach ($product->getMediaAttributes() as $attribute) {
            if ($product->getData($attribute->getAttributeCode()) == $image['file']) {
                $result['types'][] = $attribute->getAttributeCode();
            }
        }

        return $result;
    }

_initProduct	(	$	productId,
		$	store = null
	)			[protected]

Retrieve product

Parameters:

	int|string	$productId
	string|int	$store

Returns:

Mage_Catalog_Model_Product

Definition at line 357 of file Api.php.

    {
        $product = Mage::getModel('catalog/product')
                       ->setStoreId($this->_getStoreId($store));

        $idBySku = $product->getIdBySku($productId);
        if ($idBySku) {
            $productId = $idBySku;
        }
        /* @var $product Mage_Catalog_Model_Product */

        $product->load($productId);

        if (!$product->getId()) {
            $this->_fault('product_not_exists');
        }

        return $product;
    }

create	(	$	productId,
		$	data,
		$	store = null
	)

Create new image for product and return image filename

Parameters:

	int|string	$productId
	array	$data
	string|int	$store

Returns:

string

Reimplemented in Mage_Catalog_Model_Product_Attribute_Media_Api_V2.

Definition at line 115 of file Api.php.

    {
        $product = $this->_initProduct($productId, $store);

        $gallery = $this->_getGalleryAttribute($product);

        if (!isset($data['file']) || !isset($data['file']['mime']) || !isset($data['file']['content'])) {
            $this->_fault('data_invalid', Mage::helper('catalog')->__('Image not specified.'));
        }

        if (!isset($this->_mimeTypes[$data['file']['mime']])) {
            $this->_fault('data_invalid', Mage::helper('catalog')->__('Invalid image type.'));
        }

        $fileContent = @base64_decode($data['file']['content'], true);
        if (!$fileContent) {
            $this->_fault('data_invalid', Mage::helper('catalog')->__('Image content is not valid base64 data.'));
        }

        unset($data['file']['content']);

        $tmpDirectory = Mage::getBaseDir('var') . DS . 'api' . DS . $this->_getSession()->getSessionId();

        if (isset($data['file']['name']) && $data['file']['name']) {
            $fileName  = $data['file']['name'];
        } else {
            $fileName  = 'image';
        }
        $fileName .= '.' . $this->_mimeTypes[$data['file']['mime']];

        $ioAdapter = new Varien_Io_File();
        try {
            // Create temporary directory for api
            $ioAdapter->checkAndCreateFolder($tmpDirectory);
            $ioAdapter->open(array('path'=>$tmpDirectory));
            // Write image file
            $ioAdapter->write($fileName, $fileContent, 0666);
            unset($fileContent);

            // Adding image to gallery
            $file = $gallery->getBackend()->addImage(
                $product,
                $tmpDirectory . DS . $fileName,
                null,
                true
            );

            // Remove temporary directory
            $ioAdapter->rmdir($tmpDirectory, true);

            $gallery->getBackend()->updateImage($product, $file, $data);

            if (isset($data['types'])) {
                $gallery->getBackend()->setMediaAttribute($product, $data['types'], $file);
            }

            $product->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('not_created', $e->getMessage());
        } catch (Exception $e) {
            $this->_fault('not_created', Mage::helper('catalog')->__('Can\'t create image.'));
        }

        return $gallery->getBackend()->getRenamedImage($file);
    }

info	(	$	productId,
		$	file,
		$	store = null
	)

Retrieve image data

Parameters:

	int|string	$productId
	string	$file
	string|int	$store

Returns:

array

Definition at line 94 of file Api.php.

    {
        $product = $this->_initProduct($productId, $store);

        $gallery = $this->_getGalleryAttribute($product);

        if (!$image = $gallery->getBackend()->getImage($product, $file)) {
            $this->_fault('not_exists');
        }

        return $this->_imageToArray($image, $product);
    }

items	(	$	productId,
		$	store = null
	)

Retrieve images for product

Parameters:

	int|string	$productId
	string|int	$store

Returns:

array

Definition at line 65 of file Api.php.

    {
        $product = $this->_initProduct($productId, $store);

        $gallery = $this->_getGalleryAttribute($product);

        $galleryData = $product->getData(self::ATTRIBUTE_CODE);

        if (!isset($galleryData['images']) || !is_array($galleryData['images'])) {
            return array();
        }

        $result = array();

        foreach ($galleryData['images'] as &$image) {
            $result[] = $this->_imageToArray($image, $product);
        }

        return $result;
    }

remove	(	$	productId,
		$	file
	)

Remove image from product

Parameters:

	int|string	$productId
	string	$file

Returns:

boolean

Definition at line 235 of file Api.php.

    {
        $product = $this->_initProduct($productId);

        $gallery = $this->_getGalleryAttribute($product);

        if (!$gallery->getBackend()->getImage($product, $file)) {
            $this->_fault('not_exists');
        }

        $gallery->getBackend()->removeImage($product, $file);

        try {
            $product->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('not_removed', $e->getMessage());
        }

        return true;
    }

types

(

$

setId

)

Retrieve image types (image, small_image, thumbnail, etc...)

Parameters:

int

$setId

Returns:

array

Definition at line 263 of file Api.php.

    {
        $attributes = Mage::getModel('catalog/product')->getResource()
                ->loadAllAttributes()
                ->getSortedAttributes($setId);

        $result = array();

        foreach ($attributes as $attribute) {
            /* @var $attribute Mage_Catalog_Model_Resource_Eav_Attribute */
            if ($attribute->isInSet($setId)
                && $attribute->getFrontendInput() == 'media_image') {
                if ($attribute->isScopeGlobal()) {
                    $scope = 'global';
                } elseif ($attribute->isScopeWebsite()) {
                    $scope = 'website';
                } else {
                    $scope = 'store';
                }

                $result[] = array(
                    'code'         => $attribute->getAttributeCode(),
                    'scope'        => $scope
                );
            }
        }

        return $result;
    }

update	(	$	productId,
		$	file,
		$	data,
		$	store = null
	)

Update image data

Parameters:

	int|string	$productId
	string	$file
	array	$data
	string|int	$store

Returns:

boolean

Reimplemented in Mage_Catalog_Model_Product_Attribute_Media_Api_V2.

Definition at line 190 of file Api.php.

    {
        $product = $this->_initProduct($productId, $store);

        $gallery = $this->_getGalleryAttribute($product);

        if (!$gallery->getBackend()->getImage($product, $file)) {
            $this->_fault('not_exists');
        }

        $gallery->getBackend()->updateImage($product, $file, $data);

        if (isset($data['types']) && is_array($data['types'])) {
            $oldTypes = array();
            foreach ($product->getMediaAttributes() as $attribute) {
                if ($product->getData($attribute->getAttributeCode()) == $file) {
                     $oldTypes[] = $attribute->getAttributeCode();
                }
            }

            $clear = array_diff($oldTypes, $data['types']);

            if (count($clear) > 0) {
                $gallery->getBackend()->clearMediaAttribute($product, $clear);
            }

            $gallery->getBackend()->setMediaAttribute($product, $data['types'], $file);
        }

        try {
            $product->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('not_updated', $e->getMessage());
        }

        return true;
    }

---

Member Data Documentation

$_mimeTypes [protected]

Initial value:

 array(
        'image/jpeg' => 'jpg',
        'image/gif'  => 'gif',
        'image/png'  => 'png'
    )

Definition at line 47 of file Api.php.

const ATTRIBUTE_CODE = 'media_gallery'

Attribute code for media gallery

Definition at line 40 of file Api.php.

---

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

• app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php