Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_GiftMessage_Block_Adminhtml_Product_Helper_Form_Config
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_Create_Form
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_Create_Giftoptions
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_Create_Items
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_View_Form
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_View_Giftoptions
  • Mage_GiftMessage_Block_Adminhtml_Sales_Order_View_Items
  • Mage_GiftMessage_Block_Message_Inline
  • Mage_GiftMessage_Helper_Data
  • Mage_GiftMessage_Helper_Message
  • Mage_GiftMessage_Helper_Url
  • Mage_GiftMessage_Model_Api
  • Mage_GiftMessage_Model_Api_V2
  • Mage_GiftMessage_Model_Message
  • Mage_GiftMessage_Model_Mysql4_Message
  • Mage_GiftMessage_Model_Mysql4_Message_Collection
  • Mage_GiftMessage_Model_Mysql4_Setup
  • Mage_GiftMessage_Model_Observer
  • Mage_GiftMessage_Model_Resource_Message
  • Mage_GiftMessage_Model_Resource_Message_Collection
  • Mage_GiftMessage_Model_Resource_Setup
  • Overview
  • Package
  • Class
  • Tree

Class Mage_GiftMessage_Helper_Message

Gift Message helper

Mage_Core_Helper_Abstract
Extended by Mage_Core_Helper_Data
Extended by Mage_GiftMessage_Helper_Message
Package: Mage\GiftMessage
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/GiftMessage/Helper/Message.php
Methods summary
public string
# getButton( string $type, Varien_Object $entity )

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

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

Parameters

$type
string
$type
$entity
Varien_Object
$entity

Returns

string
public string
# getInline( string $type, Varien_Object $entity, boolean $dontDisplayContainer = false )

Retrive inline giftmessage edit form for specified entity

Retrive inline giftmessage edit form for specified entity

Parameters

$type
string
$type
$entity
Varien_Object
$entity
$dontDisplayContainer
boolean
$dontDisplayContainer

Returns

string
public boolean
# isMessagesAvailable( string $type, Varien_Object $entity, Mage_Core_Model_Store|integer $store = null )

Check availability of giftmessages for specified entity.

Check availability of giftmessages for specified entity.

Parameters

$type
string
$type
$entity
Varien_Object
$entity
$store
Mage_Core_Model_Store|integer
$store

Returns

boolean
protected boolean
# _getDependenceFromStoreConfig( integer $productGiftMessageAllow, Mage_Core_Model_Store|integer $store = null )

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

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

Parameters

$productGiftMessageAllow
integer
$productGiftMessageAllow
$store
Mage_Core_Model_Store|integer
$store

Returns

boolean
public boolen
# getIsMessagesAvailable( string $type, Varien_Object $entity, Mage_Core_Model_Store|integer $store = null )

Alias for isMessagesAvailable(...)

Alias for isMessagesAvailable(...)

Parameters

$type
string
$type
$entity
Varien_Object
$entity
$store
Mage_Core_Model_Store|integer
$store

Returns

boolen
public unknown
# getEscapedGiftMessage( Varien_Object $entity )

Retrive escaped and preformated gift message text for specified entity

Retrive escaped and preformated gift message text for specified entity

Parameters

$entity
Varien_Object
$entity

Returns

unknown
public Mage_GiftMessage_Model_Message
# getGiftMessageForEntity( Varien_Object $entity )

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

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

Parameters

$entity
Varien_Object
$entity

Returns

Mage_GiftMessage_Model_Message
public mixed|null
# getCached( string $key )

Retrive internal cached data with specified key.

Retrive internal cached data with specified key.

If cached data not found return null.

Parameters

$key
string
$key

Returns

mixed|null
public boolean
# isCached( string $key )

Check availability for internal cached data with specified key

Check availability for internal cached data with specified key

Parameters

$key
string
$key

Returns

boolean
public Mage_GiftMessage_Helper_Message
# setCached( string $key, mixed $value )

Set internal cache data with specified key

Set internal cache data with specified key

Parameters

$key
string
$key
$value
mixed
$value

Returns

Mage_GiftMessage_Helper_Message
public boolen
# getAvailableForQuoteItems( array $quote, Mage_Core_Model_Store|integer $store = null )

Check availability for onepage checkout items

Check availability for onepage checkout items

Parameters

$quote
array
$items
$store
Mage_Core_Model_Store|integer
$store

Returns

boolen
public boolen
# getAvailableForAddressItems( array $items, Mage_Core_Model_Store|integer $store = null )

Check availability for multishiping checkout items

Check availability for multishiping checkout items

Parameters

$items
array
$items
$store
Mage_Core_Model_Store|integer
$store

Returns

boolen
public Mage_GiftMessage_Model_Message
# getGiftMessage( integer $messageId = null )

Retrive gift message with specified id

Retrive gift message with specified id

Parameters

$messageId
integer
$messageId

Returns

Mage_GiftMessage_Model_Message
Methods inherited from Mage_Core_Helper_Data
assocToXml(), checkLfiProtection(), copyFieldset(), currency(), currencyByStore(), decorateArray(), decrypt(), encrypt(), formatCurrency(), formatDate(), formatPrice(), formatTime(), getCacheBetaTypes(), getCacheTypes(), getDefaultCountry(), getEncryptor(), getExactDivision(), getHash(), getMerchantCountryCode(), getMerchantVatNumber(), getProtectedFileExtensions(), getPublicFilesValidPath(), getRandomString(), getStoreId(), isCountryInEU(), isDevAllowed(), jsonDecode(), jsonEncode(), mergeFiles(), removeAccents(), uniqHash(), useDbCompatibleMode(), validateHash(), validateKey(), xmlToAssoc()
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 XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS 'sales/gift_options/allow_items'
#

Giftmessages allow section in configuration

Giftmessages allow section in configuration

string XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER 'sales/gift_options/allow_order'
#
Constants inherited from Mage_Core_Helper_Data
CHARS_DIGITS, CHARS_LOWERS, CHARS_PASSWORD_DIGITS, CHARS_PASSWORD_LOWERS, CHARS_PASSWORD_SPECIALS, CHARS_PASSWORD_UPPERS, CHARS_SPECIALS, CHARS_UPPERS, DIVIDE_EPSILON, XML_PATH_CACHE_BETA_TYPES, XML_PATH_CONNECTION_TYPE, XML_PATH_DEFAULT_COUNTRY, XML_PATH_DEV_ALLOW_IPS, XML_PATH_ENCRYPTION_MODEL, XML_PATH_EU_COUNTRIES_LIST, XML_PATH_MERCHANT_COUNTRY_CODE, XML_PATH_MERCHANT_VAT_NUMBER, XML_PATH_PROTECTED_FILE_EXTENSIONS, XML_PATH_PUBLIC_FILES_VALID_PATHS
Properties summary
protected integer $_nextId 0
#

Next id for edit gift message block

Next id for edit gift message block

protected array $_innerCache array()
#

Inner cache

Inner cache

Properties inherited from Mage_Core_Helper_Data
$_allowedFormats, $_encryptor
Properties inherited from Mage_Core_Helper_Abstract
$_layout, $_moduleName, $_request
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0