Mage_Media_Model_Image Class Reference

Inheritance diagram for Mage_Media_Model_Image:

List of all members.

Public Member Functions
	setConfig (Mage_Media_Model_Image_Config_Interface $config)
	getConfig ()
	getImage ()
	getTmpImage ()
	getDimensions ()
	getDestanationDimensions ()
	getExtension ()
	getFilePath ($useParams=false)
	getFileUrl ($useParams=false)
	getName ()
	addParam ($param, $value=null)
	setParam ($param, $value=null)
	getParam ($param)
	getParams ()
	getParamsSum ()
	getSpecialLink ($file, $size, $extension=null, $watermark=null)
	hasSpecialImage ()
Protected Member Functions
	_construct ()
	_removeResources ()
Protected Attributes
	$_config
	$_image
	$_tmpImage
	$_params = array()

---

Detailed Description

Definition at line 35 of file Image.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 66 of file Image.php.

    {
        $this->_init('media/image');
    }

_removeResources

(

)

[protected]

Definition at line 269 of file Image.php.

    {
        if ($this->_image) {
            $this->_getResource()->destroyResource($this->_image);
            $this->_image = null;
        }

        if ($this->_tmpImage) {
            $this->_getResource()->destroyResource($this->_tmpImage);
            $this->_tmpImage = null;
        }
    }

addParam	(	$	param,
		$	value = null
	)

Definition at line 172 of file Image.php.

    {
        if(is_array($param)) {
            $this->_params = array_merge($this->_params, $param);
        } else {
            $this->_params[$param] = $value;
        }

        return $this;
    }

getConfig

(

)

Retrive media image config instance

Returns:

Mage_Media_Model_Image_Config_Interface

Definition at line 88 of file Image.php.

    {
        return $this->_config;
    }

getDestanationDimensions

(

)

Retrive destanation dimensions object

Returns:

Varien_Object

Definition at line 129 of file Image.php.

    {
        if(!$this->getData('destanation_dimensions')) {
            $this->setData('destanation_dimensions', clone $this->getDimensions());
        }

        return $this->getData('destanation_dimensions');
    }

getDimensions

(

)

Retrive source dimensions object

Returns:

Varien_Object

Definition at line 116 of file Image.php.

    {
        if(!$this->getData('dimensions')) {
            $this->setData('dimensions', $this->_getResource()->getDimensions($this));
        }
        return $this->getData('dimensions');
    }

getExtension

(

)

Definition at line 138 of file Image.php.

    {
        return substr($this->getFileName(), strrpos($this->getFileName(), '.')+1);
    }

getFilePath

(

$

useParams = false

)

Definition at line 143 of file Image.php.

    {
        if($useParams && sizeof($this->getParams())) {
            $changes = '.' . $this->getParamsSum();
        } else {
            $changes = '';
        }

        return $this->getConfig()->getBaseMediaPath() . DS . $this->getName() . $changes . '.'
             . ( ( $useParams && $this->getParam('extension')) ? $this->getParam('extension') : $this->getExtension() );
    }

getFileUrl

(

$

useParams = false

)

Definition at line 155 of file Image.php.

    {
        if($useParams && sizeof($this->getParams())) {
            $changes = '.' . $this->getParamsSum();
        } else {
            $changes = '';
        }

        return $this->getConfig()->getBaseMediaUrl() . '/' . $this->getName() . $changes . '.'
             . ( ( $useParams && $this->getParam('extension')) ? $this->getParam('extension') : $this->getExtension() );
    }

getImage

(

)

Definition at line 93 of file Image.php.

    {
        if(is_null($this->_image)) {
            $this->_image = $this->_getResource()->getImage($this);
        }

        return $this->_image;
    }

getName

(

)

Definition at line 167 of file Image.php.

    {
        return substr($this->getFileName(), 0, strrpos($this->getFileName(), '.'));
    }

getParam

(

$

param

)

Definition at line 194 of file Image.php.

    {
        if(isset($this->_params[$param])) {
            return $this->_params[$param];
        }

        return null;
    }

getParams

(

)

Definition at line 203 of file Image.php.

    {
        return $this->_params;
    }

getParamsSum

(

)

Definition at line 208 of file Image.php.

    {
        return md5(serialize($this->_params));
    }

getSpecialLink	(	$	file,
		$	size,
		$	extension = null,
		$	watermark = null
	)

Return special link (with creating image if not exists)

Parameters:

	string	$file
	string	$size
	string	$extension
	string	$watermark

Returns:

string

Definition at line 222 of file Image.php.

    {
        $this->_removeResources();
        $this->setData(array());
        $this->setParam(array());
        $this->setFileName($file);

        $this->addParam('size', $size);
        $this->addParam('watermark', $watermark);
        $this->addParam('extension', $extension);

        if(!$this->hasSpecialImage()) {
            if (strpos($size, 'x')!==false) {
               list($width, $height) = explode('x', $size);
            } else {
                $width = $size;
                $height = $this->getDimensions()->getHeight();
            }

            $sizeHRate = $width / $this->getDimensions()->getWidth();
            $sizeVRate = $height / $this->getDimensions()->getHeight();

            $rate = min($sizeHRate, $sizeVRate);

            if ($rate > 1) { // If image smaller than needed
                $rate = 1;
            }

            $this->getDestanationDimensions()
                ->setWidth($rate*$this->getDimensions()->getWidth())
                ->setHeight($rate*$this->getDimensions()->getHeight());


            $this->_getResource()->resize($this);
            $this->_getResource()->watermark($this);
            $this->_getResource()->saveAs($this, $extension);
            $this->_removeResources();
        }

        return $this->getFileUrl(true);
    }

getTmpImage

(

)

Definition at line 102 of file Image.php.

    {
        if(is_null($this->_image)) {
            $this->_tmpImage = $this->_getResource()->getTmpImage($this);
        }

        return $this->_tmpImage;
    }

hasSpecialImage

(

)

Definition at line 264 of file Image.php.

    {
        return $this->_getResource()->hasSpecialImage($this);
    }

setConfig

(

Mage_Media_Model_Image_Config_Interface $

config

)

Set media image config instance

Parameters:

Mage_Media_Model_Image_Config_Interface

$config

Returns:

unknown

Definition at line 77 of file Image.php.

    {
        $this->_config = $config;
        return $this;
    }

setParam	(	$	param,
		$	value = null
	)

Definition at line 183 of file Image.php.

    {
        if(is_array($param)) {
            $this->_params = $param;
        } else {
            $this->_params[$param] = $value;
        }

        return $this;
    }

---

Member Data Documentation

$_config [protected]

Definition at line 42 of file Image.php.

$_image [protected]

Definition at line 49 of file Image.php.

$_params = array() [protected]

Definition at line 63 of file Image.php.

$_tmpImage [protected]

Definition at line 56 of file Image.php.

---

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

• app/code/core/Mage/Media/Model/Image.php