Class Mage_GiftMessage_Helper_Message

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

Gift Message helper

Located in /GiftMessage/Helper/Message.php (line 35) 

Mage_Core_Helper_Abstract
   |
   --Mage_Core_Helper_Data
      |
      --Mage_GiftMessage_Helper_Message
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS = 'sales/gift_options/allow_items'
XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER = 'sales/gift_options/allow_order'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
array $_innerCache
integer $_nextId
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
boolen getAvailableForAddressItems (array $items, [Mage_Core_Model_Store|integer $store = null])
boolen getAvailableForQuoteItems ( $quote, [Mage_Core_Model_Store|integer $store = null], array $items)
string getButton (string $type,  $entity)
mixed|null getCached (string $key)
unknown getEscapedGiftMessage ( $entity)
Mage_GiftMessage_Model_Message getGiftMessage ([integer $messageId = null])
Mage_GiftMessage_Model_Message getGiftMessageForEntity ( $entity)
string getInline (string $type,  $entity, [boolean $dontDisplayContainer = false])
boolen getIsMessagesAvailable (string $type,  $entity, [Mage_Core_Model_Store|integer $store = null])
boolean isCached (string $key)
boolean isMessagesAvailable (string $type,  $entity, [Mage_Core_Model_Store|integer $store = null])
Mage_GiftMessage_Helper_Message setCached (string $key, mixed $value)
boolean _getDependenceFromStoreConfig (int $productGiftMessageAllow, [Mage_Core_Model_Store|integer $store = null])
Variables
Description | Vars (details) Constants (details) | Methods (details)
array $_innerCache = array() (line 56)

Inner cache

  • access: protected
integer $_nextId = 0 (line 49)

Next id for edit gift message block

  • access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Data

Mage_Core_Helper_Data::$_encryptor

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) Constants (details) Methods (details)
getAvailableForAddressItems (line 288)

Check availability for multishiping checkout items

  • access: public
boolen getAvailableForAddressItems (array $items, [Mage_Core_Model_Store|integer $store = null])
getAvailableForQuoteItems (line 270)

Check availability for onepage checkout items

  • access: public
boolen getAvailableForQuoteItems ( $quote, [Mage_Core_Model_Store|integer $store = null], array $items)
getButton (line 65)

Retrive old stule edit button html for editing of giftmessage in popup

  • access: public
string getButton (string $type,  $entity)
  • string $type
  • Varien_Object $entity
getCached (line 230)

Retrive internal cached data with specified key.

If cached data not found return null.

  • access: public
mixed|null getCached (string $key)
  • string $key
getEscapedGiftMessage (line 198)

Retrive escaped and preformated gift message text for specified entity

  • access: public
unknown getEscapedGiftMessage ( $entity)
  • Varien_Object $entity
getGiftMessage (line 304)

Retrive gift message with specified id

  • access: public
Mage_GiftMessage_Model_Message getGiftMessage ([integer $messageId = null])
  • integer $messageId
getGiftMessageForEntity (line 213)

Retrive gift message for entity. If message not exists return null

  • access: public
Mage_GiftMessage_Model_Message getGiftMessageForEntity ( $entity)
  • Varien_Object $entity
getInline (line 86)

Retrive inline giftmessage edit form for specified entity

  • access: public
string getInline (string $type,  $entity, [boolean $dontDisplayContainer = false])
  • string $type
  • Varien_Object $entity
  • boolean $dontDisplayContainer
getIsMessagesAvailable (line 187)

Alias for isMessagesAvailable(...)

  • access: public
boolen getIsMessagesAvailable (string $type,  $entity, [Mage_Core_Model_Store|integer $store = null])
isCached (line 245)

Check availability for internal cached data with specified key

  • access: public
boolean isCached (string $key)
  • string $key
isMessagesAvailable (line 107)

Check availability of giftmessages for specified entity.

  • access: public
boolean isMessagesAvailable (string $type,  $entity, [Mage_Core_Model_Store|integer $store = null])
setCached (line 257)

Set internal cache data with specified key

  • access: public
Mage_GiftMessage_Helper_Message setCached (string $key, mixed $value)
  • string $key
  • mixed $value
_getDependenceFromStoreConfig (line 169)

Check availablity of gift messages from store config if flag eq 2.

  • access: protected
boolean _getDependenceFromStoreConfig (int $productGiftMessageAllow, [Mage_Core_Model_Store|integer $store = null])

Inherited Methods

Inherited From Mage_Core_Helper_Data

Mage_Core_Helper_Data::assocToXml()
Mage_Core_Helper_Data::copyFieldset()
Mage_Core_Helper_Data::currency()
Mage_Core_Helper_Data::currencyByStore()
Mage_Core_Helper_Data::decorateArray()
Mage_Core_Helper_Data::decrypt()
Mage_Core_Helper_Data::encrypt()
Mage_Core_Helper_Data::formatCurrency()
Mage_Core_Helper_Data::formatDate()
Mage_Core_Helper_Data::formatPrice()
Mage_Core_Helper_Data::formatTime()
Mage_Core_Helper_Data::getCacheBetaTypes()
Mage_Core_Helper_Data::getCacheTypes()
Mage_Core_Helper_Data::getDefaultCountry()
Mage_Core_Helper_Data::getEncryptor()
Mage_Core_Helper_Data::getHash()
Mage_Core_Helper_Data::getRandomString()
Mage_Core_Helper_Data::getStoreId()
Mage_Core_Helper_Data::isDevAllowed()
Mage_Core_Helper_Data::jsonDecode()
Mage_Core_Helper_Data::jsonEncode()
Mage_Core_Helper_Data::mergeFiles()
Mage_Core_Helper_Data::removeAccents()
Mage_Core_Helper_Data::uniqHash()
Mage_Core_Helper_Data::validateHash()
Mage_Core_Helper_Data::validateKey()
Mage_Core_Helper_Data::xmlToAssoc()

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::__()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS = 'sales/gift_options/allow_items' (line 41)

Giftmessages allow section in configuration

XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER = 'sales/gift_options/allow_order' (line 42)

Inherited Constants

Inherited from Mage_Core_Helper_Data

Mage_Core_Helper_Data::XML_PATH_DEFAULT_COUNTRY

Documentation generated on Fri, 11 Feb 2011 17:08:27 +0200 by phpDocumentor 1.4.3