Class Mage_XmlConnect_Helper_Image

XmlConnect image helper

Mage_XmlConnect_Helper_Image

Package: Mage\XmlConnect
Category: Mage
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/XmlConnect/Helper/Image.php

Methods summary
`public`	# `handleUpload( string $field )` Process uploaded file setup file names to the configuration Process uploaded file setup file names to the configuration Parameters `$field` `string` $field Retun string
`protected string`	# `_getScreenSize( )` Return current screen_size parameter Return current screen_size parameter Returns `string`
`protected string`	# `_getResizedFilename( string $fieldPath, string $fileName, boolean $default = false )` Return correct system filename for current screenSize Return correct system filename for current screenSize Parameters `$fieldPath` `string` $fieldPath `$fileName` `string` $fileName `$default` `boolean` $default Returns `string` Throws `Mage_Core_Exception`
`protected null`	# `_handleResize( string $fieldPath, string $file )` Resize uploaded file Resize uploaded file Parameters `$fieldPath` `string` $fieldPath `$file` `string` $file Returns `null`
`protected`	# `_forcedConvertPng( string $field )` Convert uploaded file to PNG Convert uploaded file to PNG Parameters `$field` `string` $field
`public string`	# `getSkinImagesUrl( string $name = null )` Retrieve xmlconnect images skin url Retrieve xmlconnect images skin url Parameters `$name` `string` $name Returns `string`
`public string`	# `getCustomSizeDirPrefix( )` Return CustomSizeDirPrefix Return CustomSizeDirPrefix Returns `string`
`public string`	# `getFileDefaultSizeSuffixAsUrl( string $fileName )` Return FileDefaultSizeSuffixAsUrl Return FileDefaultSizeSuffixAsUrl Parameters `$fileName` `string` $fileName Returns `string`
`public string`	# `getFileCustomDirSuffixAsUrl( string $confPath, string $fileName )` Return getFileCustomDirSuffixAsUrl Return getFileCustomDirSuffixAsUrl Parameters `$confPath` `string` $confPath `$fileName` `string` $fileName Returns `string`
`public integer`	# `getImageSizeForContent( string $imageName )` Return correct size for given $imageName and device screen_size Return correct size for given $imageName and device screen_size Parameters `$imageName` `string` $imageName Returns `integer`
`public array`	# `getInterfaceImageLimits( )` Return setting for interface images (image size limits) Return setting for interface images (image size limits) Returns `array`
`public integer`	# `getImageSizeForInterface( string $imagePath )` Return correct size for given $imageName and device screen_size Return correct size for given $imageName and device screen_size Parameters `$imagePath` `string` $imagePath Returns `integer`
`public string`	# `getMediaPath( string $path = '' )` Return the filesystem path to XmlConnect media files Return the filesystem path to XmlConnect media files Parameters `$path` `string` $path Right part of the path Returns `string`
`public string`	# `getMediaUrl( string $image = '' )` Return Url for media image Return Url for media image Parameters `$image` `string` $image Returns `string`
`public string`	# `getDefaultDesignUrl( string $image = '' )` Return URL for default design image Return URL for default design image Parameters `$image` `string` $image Returns `string`
`public string`	# `getDefaultDesignSuffixAsUrl( string $image = '' )` Return suffix as URL for default design image Return suffix as URL for default design image Parameters `$image` `string` $image Returns `string`
`public string\|null`	# `getCustomSizeImageUrl( string $imageUrl, integer $width = 100, integer $height = 100 )` Retrieve thumbnail image url Retrieve thumbnail image url Parameters `$imageUrl` `string` $imageUrl `$width` `integer` $width `$height` `integer` $height Returns `string\|null`
`public string`	# `filterScreenSize( string $screenSize )` Ensure correct $screenSize value Ensure correct $screenSize value Parameters `$screenSize` `string` $screenSize Returns `string`
`public array`	# `getImageLimits( string $screenSize = Mage_XmlConnect_Model_Application::APP_SCREEN_SIZE_DEFAULT )` Return correct size array for given device screen_size(320x480/640x960_a) Return correct size array for given device screen_size(320x480/640x960_a) Parameters `$screenSize` `string` $screenSize Returns `array`
`public mixed &`	# `findPath( array & $array, string $path )` Return reference to the $path in $array Return reference to the $path in $array Parameters `$array` `array` &$array `$path` `string` $path Returns `mixed` reference
`protected null`	# `_zoom( mixed & $item, mixed $key, string $value )` Multiply given $item by $value if non array Multiply given $item by $value if non array Parameters `$item` `mixed` $item (argument to change) `$key` `mixed` $key (used with array_walk_recursive function as a key of given array) `$value` `string` $value (contains float) Returns `null`
`protected`	# `_verifyDirExist( string $dir )` Ensure $dir exists (if not then create one) Ensure $dir exists (if not then create one) Parameters `$dir` `string` $dir Throw Mage_Core_Exception
`public string`	# `getCustomSizeUploadDir( string $screenSize )` Return customSizeUploadDir path Return customSizeUploadDir path Parameters `$screenSize` `string` $screenSize Returns `string`
`public string`	# `getOriginalSizeUploadDir( )` Return originalSizeUploadDir path Return originalSizeUploadDir path Returns `string`
`public string`	# `getOldUploadDir( )` Return oldUpload dir path (media/xmlconnect) Return oldUpload dir path (media/xmlconnect) Returns `string`
`public string`	# `getDefaultSizeUploadDir( )` Return default size upload dir path Return default size upload dir path Returns `string`
`public array`	# `getInterfaceImagesPathsConf( )` Return array for interface images paths in the config Return array for interface images paths in the config Returns `array`
`public array\|string`	# `getInterfaceImagesPaths( string $imagePath = null )` Return default interface image path for specified $imagePath array of image paths Return default interface image path for specified $imagePath array of image paths Parameters `$imagePath` `string` $imagePath Returns `array\|string`
`public boolean`	# `checkAndGetImagePath( string & $icon )` Check image and get full file path Check image and get full file path Parameters `$icon` `string` &$icon Returns `boolean`

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()`

Constants summary
`string`	`XMLCONNECT_GLUE`	`'_'`	# Xml connect glue Xml connect glue

Properties summary
`protected array\|null`	`$_content`	`null`	# Image limits for content Image limits for content
`protected array\|null`	`$_interface`	`null`	# Image limits for interface Image limits for interface
`protected array`	`$_interfacePath`	`array()`	# Array of interface image paths in xmlConfig Array of interface image paths in xmlConfig
`protected array`	`$_imageLimits`	`array()`	# Image limits array Image limits array
`protected array\|null`	`$_confPaths`	`null`	# Images paths in the config Images paths in the config

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

Packages

Classes

Interfaces

Class Mage_XmlConnect_Helper_Image

Parameters

Retun

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throw

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns