Class Mage_Catalog_Model_Product_Image

Description
Description | Descendents | Vars (details) | Methods (details)

Catalog product link model

Located in /Catalog/Model/Product/Image.php (line 34) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Catalog_Model_Product_Image
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Mage_XmlConnect_Model_Catalog_Category_Image Catalog category link model
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_angle
mixed $_backgroundColor
mixed $_baseFile
mixed $_constrainOnly
mixed $_destinationSubdir
mixed $_height
mixed $_isBaseFilePlaceholder
mixed $_keepAspectRatio
mixed $_keepFrame
mixed $_keepTransparency
mixed $_newFile
mixed $_processor
mixed $_quality
mixed $_watermarkFile
mixed $_watermarkHeigth
mixed $_watermarkImageOpacity
mixed $_watermarkPosition
mixed $_watermarkWidth
mixed $_width
Method Summary
Description | Descendents | Vars (details) | Methods (details)
void clearCache ()
void getBaseFile ()
string getDestinationSubdir ()
void getHeight ()
Varien_Image getImageProcessor ()
void getNewFile ()
int getQuality ()
string getUrl ()
string getWatermarkFile ()
string getWatermarkHeigth ()
int getWatermarkImageOpacity ()
string getWatermarkPosition ()
int getWatermarkWidth ()
void getWidth ()
void isCached ()
void push ()
Mage_Catalog_Model_Product_Image resize ()
Mage_Catalog_Model_Product_Image rotate ( $angle)
Mage_Catalog_Model_Product_Image saveFile ()
Mage_Catalog_Model_Product_Image setAngle (int $angle)
Mage_Catalog_Model_Product_Image setBackgroundColor ( $rgbArray)
Mage_Catalog_Model_Product_Image setBaseFile (string $file)
Mage_Catalog_Model_Product_Image setConstrainOnly ( $flag)
Mage_Catalog_Model_Product_Image setDestinationSubdir ( $dir)
Mage_Catalog_Model_Product_Image setHeight ( $height)
Mage_Catalog_Model_Product_Image setImageProcessor ( $processor)
Mage_Catalog_Model_Product_Image setKeepAspectRatio ( $keep)
Mage_Catalog_Model_Product_Image setKeepFrame ( $keep)
Mage_Catalog_Model_Product_Image setKeepTransparency ( $keep)
Mage_Catalog_Model_Product_Image setQuality (int $quality)
Mage_Catalog_Model_Product_Image setSize ( $size)
Mage_Catalog_Model_Product_Image setWatermark (string $file, [string $position = null], [string $size = null], [int $width = null], [int $heigth = null], [int $imageOpacity = null])
Mage_Catalog_Model_Product_Image setWatermarkFile (string $file)
Mage_Catalog_Model_Product_Image setWatermarkHeigth (int $heigth)
Mage_Catalog_Model_Product_Image setWatermarkImageOpacity (int $imageOpacity)
Mage_Catalog_Model_Product_Image setWatermarkPosition (string $position)
Mage_Catalog_Model_Product_Image setWatermarkSize (array $size)
Mage_Catalog_Model_Product_Image setWatermarkWidth (int $width)
Mage_Catalog_Model_Product_Image setWidth ( $width)
void _checkMemory ([ $file = null])
bool _fileExists (string $filename)
void _getMemoryLimit ()
void _getMemoryUsage ()
void _getNeedMemoryForFile ([ $file = null])
string _getWatermarkFilePath ()
string _rgbToString (array $rgbArray)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_angle (line 51)
  • access: protected
mixed $_backgroundColor = array(255, 255, 255) (line 44)
  • access: protected
mixed $_baseFile (line 46)
  • access: protected
mixed $_constrainOnly = false (line 43)
  • access: protected
mixed $_destinationSubdir (line 50)
  • access: protected
mixed $_height (line 37)
  • access: protected
mixed $_isBaseFilePlaceholder (line 47)
  • access: protected
mixed $_keepAspectRatio = true (line 40)
  • access: protected
mixed $_keepFrame = true (line 41)
  • access: protected
mixed $_keepTransparency = true (line 42)
  • access: protected
mixed $_newFile (line 48)
  • access: protected
mixed $_processor (line 49)
  • access: protected
mixed $_quality = 90 (line 38)
  • access: protected
mixed $_watermarkFile (line 53)
  • access: protected
mixed $_watermarkHeigth (line 56)
  • access: protected
mixed $_watermarkImageOpacity = 70 (line 57)
  • access: protected
mixed $_watermarkPosition (line 54)
  • access: protected
mixed $_watermarkWidth (line 55)
  • access: protected
mixed $_width (line 36)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_eventObject
 Mage_Core_Model_Abstract::$_eventPrefix
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Descendents | Vars (details) Methods (details)
clearCache (line 686)
  • access: public
void clearCache ()
Redefined in descendants as:
getBaseFile (line 351)
  • access: public
void getBaseFile ()
getDestinationSubdir (line 516)
  • access: public
string getDestinationSubdir ()
getHeight (line 82)
  • access: public
void getHeight ()
getImageProcessor (line 373)
  • access: public
Varien_Image getImageProcessor ()
getNewFile (line 356)
  • access: public
void getNewFile ()
getQuality (line 104)

Get image quality

  • access: public
int getQuality ()
getUrl (line 492)
  • access: public
string getUrl ()
getWatermarkFile (line 543)

Get watermark file name

  • access: public
string getWatermarkFile ()
getWatermarkHeigth (line 681)

Get watermark heigth

  • access: public
string getWatermarkHeigth ()
getWatermarkImageOpacity (line 622)

Get watermark image opacity

  • access: public
int getWatermarkImageOpacity ()
getWatermarkPosition (line 600)

Get watermark position

  • access: public
string getWatermarkPosition ()
getWatermarkWidth (line 659)

Get watermark width

  • access: public
int getWatermarkWidth ()
getWidth (line 68)
  • access: public
void getWidth ()
isCached (line 521)
  • access: public
void isCached ()
push (line 499)
  • access: public
void push ()
resize (line 395)
  • see: Varien_Image_Adapter_Abstract
  • access: public
Mage_Catalog_Model_Product_Image resize ()
rotate (line 407)
  • access: public
Mage_Catalog_Model_Product_Image rotate ( $angle)
  • $angle
saveFile (line 481)
  • access: public
Mage_Catalog_Model_Product_Image saveFile ()
setAngle (line 422)

Set angle for rotating

This func actually affects only the cache filename.

  • access: public
Mage_Catalog_Model_Product_Image setAngle (int $angle)
  • int $angle
setBackgroundColor (line 148)
  • access: public
Mage_Catalog_Model_Product_Image setBackgroundColor ( $rgbArray)
  • array $rgbArray
setBaseFile (line 263)

Set filenames for base file and new file

  • access: public
Mage_Catalog_Model_Product_Image setBaseFile (string $file)
  • string $file
Redefined in descendants as:
setConstrainOnly (line 139)
  • access: public
Mage_Catalog_Model_Product_Image setConstrainOnly ( $flag)
  • $flag
setDestinationSubdir (line 507)
  • access: public
Mage_Catalog_Model_Product_Image setDestinationSubdir ( $dir)
  • $dir
setHeight (line 76)
  • access: public
Mage_Catalog_Model_Product_Image setHeight ( $height)
  • $height
setImageProcessor (line 364)
  • access: public
Mage_Catalog_Model_Product_Image setImageProcessor ( $processor)
  • $processor
setKeepAspectRatio (line 112)
  • access: public
Mage_Catalog_Model_Product_Image setKeepAspectRatio ( $keep)
  • $keep
setKeepFrame (line 121)
  • access: public
Mage_Catalog_Model_Product_Image setKeepFrame ( $keep)
  • $keep
setKeepTransparency (line 130)
  • access: public
Mage_Catalog_Model_Product_Image setKeepTransparency ( $keep)
  • $keep
setQuality (line 93)

Set image quality, values in percentage from 0 to 100

  • access: public
Mage_Catalog_Model_Product_Image setQuality (int $quality)
  • int $quality
setSize (line 157)
  • access: public
Mage_Catalog_Model_Product_Image setSize ( $size)
  • $size
setWatermark (line 440)

Add watermark to image size param in format 100x200

  • access: public
Mage_Catalog_Model_Product_Image setWatermark (string $file, [string $position = null], [string $size = null], [int $width = null], [int $heigth = null], [int $imageOpacity = null])
  • string $file
  • string $position
  • string $size
  • int $width
  • int $heigth
  • int $imageOpacity
setWatermarkFile (line 532)

Set watermark file name

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkFile (string $file)
  • string $file
setWatermarkHeigth (line 670)

Set watermark heigth

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkHeigth (int $heigth)
  • int $heigth
setWatermarkImageOpacity (line 611)

Set watermark image opacity

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkImageOpacity (int $imageOpacity)
  • int $imageOpacity
setWatermarkPosition (line 589)

Set watermark position

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkPosition (string $position)
  • string $position
setWatermarkSize (line 633)

Set watermark size

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkSize (array $size)
  • array $size
setWatermarkWidth (line 648)

Set watermark width

  • access: public
Mage_Catalog_Model_Product_Image setWatermarkWidth (int $width)
  • int $width
setWidth (line 62)
  • access: public
Mage_Catalog_Model_Product_Image setWidth ( $width)
  • $width
_checkMemory (line 173)
  • access: protected
void _checkMemory ([ $file = null])
  • $file
_fileExists (line 702)

First check this file on FS If it doesn't exist - try to download it from DB

  • access: protected
bool _fileExists (string $filename)
  • string $filename
_getMemoryLimit (line 182)
  • access: protected
void _getMemoryLimit ()
_getMemoryUsage (line 202)
  • access: protected
void _getMemoryUsage ()
_getNeedMemoryForFile (line 210)
  • access: protected
void _getNeedMemoryForFile ([ $file = null])
  • $file
_getWatermarkFilePath (line 554)

Get relative watermark file path or false if file not found

  • return: | bool
  • access: protected
string _getWatermarkFilePath ()
Redefined in descendants as:
_rgbToString (line 243)

Convert array of 3 items (decimal r, g, b) to string of their hex values

  • access: protected
string _rgbToString (array $rgbArray)
  • array $rgbArray
Redefined in descendants as:

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Documentation generated on Fri, 11 Feb 2011 17:06:21 +0200 by phpDocumentor 1.4.3