Class Mage_Catalog_Helper_Image

Catalog image helper

Mage_Catalog_Helper_Image

Direct known subclasses

Mage_XmlConnect_Helper_Catalog_Category_Image

Package: Mage\Catalog
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Catalog/Helper/Image.php

Methods summary
`protected Mage_Catalog_Helper_Image`	# `_reset( )` Reset all previous data Reset all previous data Returns `Mage_Catalog_Helper_Image`
`public Mage_Catalog_Helper_Image`	# `init( Mage_Catalog_Model_Product $product, string $attributeName, mixed $imageFile = null )` Initialize Helper to work with Image Initialize Helper to work with Image Parameters `$product` `Mage_Catalog_Model_Product` $product `$attributeName` `string` $attributeName `$imageFile` `mixed` $imageFile Returns `Mage_Catalog_Helper_Image`
`public Mage_Catalog_Helper_Image`	# `resize( integer $width, integer $height = null )` Schedule resize of the image $width or $height can be null - in this case, lacking dimension will be calculated. Schedule resize of the image $width or $height can be null - in this case, lacking dimension will be calculated. Parameters `$width` `integer` $width `$height` `integer` $height Returns `Mage_Catalog_Helper_Image` See `Mage_Catalog_Model_Product_Image`
`public Mage_Catalog_Helper_Image`	# `setQuality( integer $quality )` Set image quality, values in percentage from 0 to 100 Set image quality, values in percentage from 0 to 100 Parameters `$quality` `integer` $quality Returns `Mage_Catalog_Helper_Image`
`public Mage_Catalog_Helper_Image`	# `keepAspectRatio( boolean $flag )` Guarantee, that image picture width/height will not be distorted. Applicable before calling resize() It is true by default. Guarantee, that image picture width/height will not be distorted. Applicable before calling resize() It is true by default. Parameters `$flag` `boolean` $flag Returns `Mage_Catalog_Helper_Image` See `Mage_Catalog_Model_Product_Image`
`public Mage_Catalog_Helper_Image`	# `keepFrame( boolean $flag, array $position = array('center', 'middle') )` Guarantee, that image will have dimensions, set in $width/$height Applicable before calling resize() Not applicable, if keepAspectRatio(false) Guarantee, that image will have dimensions, set in $width/$height Applicable before calling resize() Not applicable, if keepAspectRatio(false) $position - TODO, not used for now - picture position inside the frame. Parameters `$flag` `boolean` $flag `$position` `array` $position Returns `Mage_Catalog_Helper_Image` See `Mage_Catalog_Model_Product_Image`
`public Mage_Catalog_Helper_Image`	# `keepTransparency( boolean $flag, integer $alphaOpacity = null )` Guarantee, that image will not lose transparency if any. Applicable before calling resize() It is true by default. Guarantee, that image will not lose transparency if any. Applicable before calling resize() It is true by default. $alphaOpacity - TODO, not used for now Parameters `$flag` `boolean` $flag `$alphaOpacity` `integer` $alphaOpacity Returns `Mage_Catalog_Helper_Image` See `Mage_Catalog_Model_Product_Image`
`public Mage_Catalog_Helper_Image`	# `constrainOnly( boolean $flag )` Guarantee, that image picture will not be bigger, than it was. Applicable before calling resize() It is false by default Guarantee, that image picture will not be bigger, than it was. Applicable before calling resize() It is false by default Parameters `$flag` `boolean` $flag Returns `Mage_Catalog_Helper_Image`
`public Mage_Catalog_Helper_Image`	# `backgroundColor( array $colorRGB )` Set color to fill image frame with. Applicable before calling resize() The keepTransparency(true) overrides this (if image has transparent color) It is white by default. Set color to fill image frame with. Applicable before calling resize() The keepTransparency(true) overrides this (if image has transparent color) It is white by default. Parameters `$colorRGB` `array` $colorRGB Returns `Mage_Catalog_Helper_Image` See `Mage_Catalog_Model_Product_Image`
`public Mage_Catalog_Helper_Image`	# `rotate( integer $angle )` Rotate image into specified angle Rotate image into specified angle Parameters `$angle` `integer` $angle Returns `Mage_Catalog_Helper_Image`
`public Mage_Catalog_Helper_Image`	# `watermark( string $fileName, string $position, string $size = null, integer $imageOpacity = null )` Add watermark to image size param in format 100x200 Add watermark to image size param in format 100x200 Parameters `$fileName` `string` $fileName `$position` `string` $position `$size` `string` $size `$imageOpacity` `integer` $imageOpacity Returns `Mage_Catalog_Helper_Image`
`public`	# `placeholder( string $fileName )` Set placeholder Set placeholder Parameters `$fileName` `string` $fileName
`public string`	# `getPlaceholder( )` Get Placeholder Get Placeholder Returns `string`
`public string`	# `__toString( )` Return Image URL Return Image URL Returns `string`
`protected Mage_Catalog_Helper_Image`	# `_setModel( Mage_Catalog_Model_Product_Image $model )` Set current Image model Set current Image model Parameters `$model` `Mage_Catalog_Model_Product_Image` $model Returns `Mage_Catalog_Helper_Image`
`protected Mage_Catalog_Model_Product_Image`	# `_getModel( )` Get current Image model Get current Image model Returns `Mage_Catalog_Model_Product_Image`
`protected Mage_Catalog_Helper_Image`	# `setAngle( integer $angle )` Set Rotation Angle Set Rotation Angle Parameters `$angle` `integer` $angle Returns `Mage_Catalog_Helper_Image`
`protected integer`	# `getAngle( )` Get Rotation Angle Get Rotation Angle Returns `integer`
`protected Mage_Catalog_Helper_Image`	# `setWatermark( string $watermark )` Set watermark file name Set watermark file name Parameters `$watermark` `string` $watermark Returns `Mage_Catalog_Helper_Image`
`protected string`	# `getWatermark( )` Get watermark file name Get watermark file name Returns `string`
`protected Mage_Catalog_Helper_Image`	# `setWatermarkPosition( string $position )` Set watermark position Set watermark position Parameters `$position` `string` $position Returns `Mage_Catalog_Helper_Image`
`protected string`	# `getWatermarkPosition( )` Get watermark position Get watermark position Returns `string`
`public Mage_Catalog_Helper_Image`	# `setWatermarkSize( string $size )` Set watermark size param size in format 100x200 Set watermark size param size in format 100x200 Parameters `$size` `string` $size Returns `Mage_Catalog_Helper_Image`
`protected string`	# `getWatermarkSize( )` Get watermark size Get watermark size Returns `string`
`public Mage_Catalog_Helper_Image`	# `setWatermarkImageOpacity( integer $imageOpacity )` Set watermark image opacity Set watermark image opacity Parameters `$imageOpacity` `integer` $imageOpacity Returns `Mage_Catalog_Helper_Image`
`protected integer`	# `getWatermarkImageOpacity( )` Get watermark image opacity Get watermark image opacity Returns `integer`
`protected Mage_Catalog_Helper_Image`	# `setProduct( Mage_Catalog_Model_Product $product )` Set current Product Set current Product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Catalog_Helper_Image`
`protected Mage_Catalog_Model_Product`	# `getProduct( )` Get current Product Get current Product Returns `Mage_Catalog_Model_Product`
`protected Mage_Catalog_Helper_Image`	# `setImageFile( string $file )` Set Image file Set Image file Parameters `$file` `string` $file Returns `Mage_Catalog_Helper_Image`
`protected string`	# `getImageFile( )` Get Image file Get Image file Returns `string`
`protected array\|boolean`	# `parseSize( string $string )` Retrieve size from string Retrieve size from string Parameters `$string` `string` $string Returns `array\|boolean`
`public integer\|null`	# `getOriginalWidth( )` Retrieve original image width Retrieve original image width Returns `integer\|null`
`public integer\|null`	# `getOriginalHeight( )` Retrieve original image height Retrieve original image height Returns `integer\|null`
`public array`	# `getOriginalSizeArray( )` Retrieve Original image size as array 0 - width, 1 - height Retrieve Original image size as array 0 - width, 1 - height Returns `array`
`public boolean`	# `validateUploadFile( string $filePath )` Check - is this file an image Check - is this file an image Parameters `$filePath` `string` $filePath Returns `boolean` Throws `Mage_Core_Exception`

Methods inherited from Mage_Core_Helper_Abstract
`__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()`

Properties summary
`protected Mage_Catalog_Model_Product_Image`	`$_model`		# Current model Current model
`protected boolean`	`$_scheduleResize`	`false`	# Scheduled for resize image Scheduled for resize image
`protected boolean`	`$_scheduleRotate`	`false`	# Scheduled for rotate image Scheduled for rotate image
`protected integer`	`$_angle`		# Angle Angle
`protected string`	`$_watermark`		# Watermark file name Watermark file name
`protected string`	`$_watermarkPosition`		# Watermark Position Watermark Position
`protected string`	`$_watermarkSize`		# Watermark Size Watermark Size
`protected integer`	`$_watermarkImageOpacity`		# Watermark Image opacity Watermark Image opacity
`protected Mage_Catalog_Model_Product`	`$_product`		# Current Product Current Product
`protected string`	`$_imageFile`		# Image File Image File
`protected string`	`$_placeholder`		# Image Placeholder Image Placeholder

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Interfaces

Class Mage_Catalog_Helper_Image

Direct known subclasses

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Throws