Class Mage_Cms_Helper_Wysiwyg_Images

Wysiwyg Images Helper

Mage_Cms_Helper_Wysiwyg_Images

Package: Mage\Cms
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Cms/Helper/Wysiwyg/Images.php

Methods summary
`public`	# `setStoreId( <type> $store )` Set a specified store ID value Set a specified store ID value Parameters `$store` `<type>` $store
`public string`	# `getStorageRoot( )` Images Storage root directory Images Storage root directory Returns `string`
`public string`	# `getBaseUrl( )` Images Storage base URL Images Storage base URL Returns `string`
`public string`	# `getTreeNodeName( )` Ext Tree node key name Ext Tree node key name Returns `string`
`public string`	# `convertPathToId( string $path )` Encode path to HTML element id Encode path to HTML element id Parameters `$path` `string` $path Path to file/directory Returns `string`
`public string`	# `convertIdToPath( string $id )` Decode HTML element id Decode HTML element id Parameters `$id` `string` $id Returns `string`
`public string`	# `correctPath( string $path, boolean $trim = true )` File system path correction File system path correction Parameters `$path` `string` $path Original path `$trim` `boolean` $trim Trim slashes or not Returns `string`
`public string`	# `convertPathToUrl( string $path )` Return file system path as Url string Return file system path as Url string Parameters `$path` `string` $path Returns `string`
`public boolean`	# `isUsingStaticUrlsAllowed( )` Check whether using static URLs is allowed Check whether using static URLs is allowed Returns `boolean`
`public string`	# `getImageHtmlDeclaration( string $filename, boolean $renderAsTag = false )` Prepare Image insertion declaration for Wysiwyg or textarea(as_is mode) Prepare Image insertion declaration for Wysiwyg or textarea(as_is mode) Parameters `$filename` `string` $filename Filename transferred via Ajax `$renderAsTag` `boolean` $renderAsTag Leave image HTML as is or transform it to controller directive Returns `string`
`public string`	# `getCurrentPath( )` Return path of the current selected directory or root directory for startup Try to create target directory if it doesn't exist Return path of the current selected directory or root directory for startup Try to create target directory if it doesn't exist Returns `string` Throws `Mage_Core_Exception`
`public string`	# `getCurrentUrl( )` Return URL based on current selected directory or root directory for startup Return URL based on current selected directory or root directory for startup Returns `string`
`public Mage_Cms_Model_Page_Wysiwyg_Images_Storage`	# `getStorage( )` Storage model singleton Storage model singleton Returns `Mage_Cms_Model_Page_Wysiwyg_Images_Storage`
`public string`	# `idEncode( string $string )` Encode string to valid HTML id element, based on base64 encoding Encode string to valid HTML id element, based on base64 encoding Parameters `$string` `string` $string Returns `string`
`public string`	# `idDecode( string $string )` Revert opration to idEncode Revert opration to idEncode Parameters `$string` `string` $string Returns `string`
`public string`	# `getShortFilename( string $filename, integer $maxLength = 20 )` Reduce filename by replacing some characters with dots Reduce filename by replacing some characters with dots Parameters `$filename` `string` $filename `$maxLength` `integer` $maxLength Maximum filename Returns `string` Truncated filename

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 string`	`$_currentPath`		# Current directory path Current directory path
`protected string`	`$_currentUrl`		# Current directory URL Current directory URL
`protected integer`	`$_storeId`	`null`	# Currenty selected store ID if applicable Currenty selected store ID if applicable

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

Packages

Classes

Class Mage_Cms_Helper_Wysiwyg_Images

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns