Class Mage_Cms_Helper_Wysiwyg_Images

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

Wysiwyg Images Helper

Located in /Cms/Helper/Wysiwyg/Images.php (line 30) 

Mage_Core_Helper_Abstract
   |
   --Mage_Cms_Helper_Wysiwyg_Images
Variable Summary
Description | Vars (details) | Methods (details)
string $_currentPath
string $_currentUrl
int $_storeId
Method Summary
Description | Vars (details) | Methods (details)
string convertIdToPath (string $id)
string convertPathToId (string $path)
string convertPathToUrl (string $path)
string correctPath (string $path, [boolean $trim = true])
string getBaseUrl ()
string getCurrentPath ()
string getCurrentUrl ()
string getImageHtmlDeclaration (string $filename, [bool $renderAsTag = false])
string getShortFilename (string $filename, [int $maxLength = 20])
Mage_Cms_Model_Page_Wysiwyg_Images_Storage getStorage ()
string getStorageRoot ()
string getTreeNodeName ()
string idDecode (string $string)
string idEncode (string $string)
boolean isUsingStaticUrlsAllowed ()
void setStoreId ( $store)
Variables
Description | Vars (details) | Methods (details)
string $_currentPath (line 37)

Current directory path

  • access: protected
string $_currentUrl (line 43)

Current directory URL

  • access: protected
int $_storeId = null (line 50)

Currenty selected store ID if applicable

  • access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
 Mage_Core_Helper_Abstract::$_moduleName
 Mage_Core_Helper_Abstract::$_request
Methods
Description | Vars (details) Methods (details)
convertIdToPath (line 112)

Decode HTML element id

  • access: public
string convertIdToPath (string $id)
  • string $id
convertPathToId (line 100)

Encode path to HTML element id

  • access: public
string convertPathToId (string $path)
  • string $path: Path to file/directory
convertPathToUrl (line 143)

Return file system path as Url string

  • access: public
string convertPathToUrl (string $path)
  • string $path
correctPath (line 128)

File system path correction

  • access: public
string correctPath (string $path, [boolean $trim = true])
  • string $path: Original path
  • boolean $trim: Trim slashes or not
getBaseUrl (line 79)

Images Storage base URL

  • access: public
string getBaseUrl ()
getCurrentPath (line 196)

Return path of the current selected directory or root directory for startup Try to create target directory if it doesn't exist

  • throws: Mage_Core_Exception
  • access: public
string getCurrentPath ()
getCurrentUrl (line 222)

Return URL based on current selected directory or root directory for startup

  • access: public
string getCurrentUrl ()
getImageHtmlDeclaration (line 171)

Prepare Image insertion declaration for Wysiwyg or textarea(as_is mode)

  • access: public
string getImageHtmlDeclaration (string $filename, [bool $renderAsTag = false])
  • string $filename: Filename transferred via Ajax
  • bool $renderAsTag: Leave image HTML as is or transform it to controller directive
getShortFilename (line 273)

Reduce filename by replacing some characters with dots

  • return: Truncated filename
  • access: public
string getShortFilename (string $filename, [int $maxLength = 20])
  • string $filename
  • int $maxLength: Maximum filename
getStorage (line 238)

Storage model singleton

  • access: public
Mage_Cms_Model_Page_Wysiwyg_Images_Storage getStorage ()
getStorageRoot (line 69)

Images Storage root directory

  • access: public
string getStorageRoot ()
getTreeNodeName (line 89)

Ext Tree node key name

  • access: public
string getTreeNodeName ()
idDecode (line 260)

Revert opration to idEncode

  • access: public
string idDecode (string $string)
  • string $string
idEncode (line 249)

Encode string to valid HTML id element, based on base64 encoding

  • access: public
string idEncode (string $string)
  • string $string
isUsingStaticUrlsAllowed (line 153)

Check whether using static URLs is allowed

  • access: public
boolean isUsingStaticUrlsAllowed ()
setStoreId (line 58)

Set a specified store ID value

  • access: public
void setStoreId ( $store)
  • $store

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

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