Class Mage_XmlConnect_Helper_Data

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

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /XmlConnect/Helper/Data.php (line 27) 

Mage_Core_Helper_Abstract
   |
   --Mage_XmlConnect_Helper_Data
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
DEVICE_TYPE_ANDROID = 'android'
DEVICE_TYPE_DEFAULT = 'unknown'
DEVICE_TYPE_IPAD = 'ipad'
DEVICE_TYPE_IPHONE = 'iphone'
MESSAGE_TITLE_LENGTH = 255
PUSH_TITLE_LENGTH = 140
XML_NODE_CONFIG_EXCLUDE_FROM_XML = 'xmlconnect/mobile_application/nodes_excluded_from_config_xml'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
array $_appNames
mixed $_excludedXmlConfigKeys
array $_tplNames
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
static array arrayMergeRecursive (mixed $target, mixed $changes)
static array getSupportedDevices ()
static array getSupportedMessageTypes ()
static boolean isTemplateAllowedForApplication ([Mage_XmlConnect_Model_Application $application = null])
array excludeXmlConfigKeys (array $data, [array $excludedKeys = array()])
string formatPriceForXml (float $price)
Mage_XmlConnect_Model_Application getApplication ()
string getApplicationName ([string $appCode = null])
array getApplicationOptions ()
array getApplications ()
string getArrayAsXmlItemValues (array $dataArray,  $selected, string $info)
array getCountryOptionsArray ([bool $isItunes = false])
array getDefaultApplicationDesignTabs (string 0)
Mage_Core_Helper_Abstract getDeviceHelper ([Mage_XmlConnect_Model_Application $application = null])
string getDeviceType ([Mage_XmlConnect_Model_Application $application = null])
array getDeviceTypeOptions ()
array getExcludedXmlConfigKeys ()
Mage_Catalog_Model_Layer_Filter_Abstract getFilterByKey (string $key)
string getHttpHeaders ()
int getMessageTitleLength ()
array getMessageTypeOptions ()
int getPushTitleLength ()
string getSoloXml (string $ssCcMonths, string $ssCcYears)
array getStatusOptions ()
string|bool getTabLabel (string $action)
string getTemplateName ([ $templateId = null], string $appCode)
array getUrl (string $route, [array $params = array()])
string htmlize (string $body)
void sendBroadcastMessage (Mage_XmlConnect_Model_Queue $queue)
string urlToPath (string $icon)
bool validateConfFieldNotEmpty (string $field, array $native)
array _getTabLabelActionArray ()
null _injectFieldToArray ( &$target, string $fieldPath, mixed $fieldValue, [string $delimiter = '/'], &array $target)
Variables
Description | Vars (details) Constants (details) | Methods (details)
array $_appNames = array() (line 52)

Application names array

  • access: protected
mixed $_excludedXmlConfigKeys = array(
'notifications/applicationMasterSecret',
) (line 43)
  • access: protected
array $_tplNames = array() (line 59)

Template names array

  • 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) Constants (details) Methods (details)
static method arrayMergeRecursive (line 332)

Merges $changes array to $target array recursive, overwriting existing key, and adding new one

  • access: public
static array arrayMergeRecursive (mixed $target, mixed $changes)
  • mixed $target
  • mixed $changes
static method getSupportedDevices (line 242)

Get list of predefined and supported Devices

  • access: public
static array getSupportedDevices ()
static method getSupportedMessageTypes (line 458)

Get list of predefined and supported message types

  • access: public
static array getSupportedMessageTypes ()
static method isTemplateAllowedForApplication (line 547)

Check if creating AirMail template for the application is allowed

  • access: public
static boolean isTemplateAllowedForApplication ([Mage_XmlConnect_Model_Application $application = null])
excludeXmlConfigKeys (line 637)

Remove from array the unnecessary parameters by given keys

  • access: public
array excludeXmlConfigKeys (array $data, [array $excludedKeys = array()])
  • array $data: Source array
  • array $excludedKeys: Keys to be excluded from array. Keys must be in xPath notation
formatPriceForXml (line 448)

Format price for correct view inside xml strings

  • access: public
string formatPriceForXml (float $price)
  • float $price
getApplication (line 146)

Getter for current loaded application model

  • throws: Mage_Core_Exception
  • access: public
Mage_XmlConnect_Model_Application getApplication ()
getApplicationName (line 683)

Returns Application name by it's code

  • access: public
string getApplicationName ([string $appCode = null])
  • string $appCode
getApplicationOptions (line 508)

Retrieve applications as "html select options"

  • access: public
array getApplicationOptions ()
getApplications (line 529)

Get applications array like `code` as `name`

  • staticvar: array $apps:
  • access: public
array getApplications ()
getArrayAsXmlItemValues (line 385)

Return select options for xml from array

  • access: public
string getArrayAsXmlItemValues (array $dataArray,  $selected, string $info)
  • array $dataArray: - source array
  • string $info: - selected item
  • $selected
getCountryOptionsArray (line 199)

Retrieve country options array

  • access: public
array getCountryOptionsArray ([bool $isItunes = false])
  • bool $isItunes
getDefaultApplicationDesignTabs (line 291)

Get default application tabs

  • access: public
array getDefaultApplicationDesignTabs (string 0)
  • string 0
getDeviceHelper (line 103)

Get device helper

  • throws: Mage_Core_Exception
  • access: public
Mage_Core_Helper_Abstract getDeviceHelper ([Mage_XmlConnect_Model_Application $application = null])
getDeviceType (line 126)

Get device tipe from application

  • access: public
string getDeviceType ([Mage_XmlConnect_Model_Application $application = null])
getDeviceTypeOptions (line 272)

Retrieve supported device types as "html select options"

  • access: public
array getDeviceTypeOptions ()
getExcludedXmlConfigKeys (line 667)

Get excluded keys as array

  • access: public
array getExcludedXmlConfigKeys ()
getFilterByKey (line 162)

Create filter object by key

  • access: public
Mage_Catalog_Model_Layer_Filter_Abstract getFilterByKey (string $key)
  • string $key
getHttpHeaders (line 624)

Get headers for broadcast message

  • access: public
string getHttpHeaders ()
getMessageTitleLength (line 498)

Get message title length

  • access: public
int getMessageTitleLength ()
getMessageTypeOptions (line 473)

Retrieve supported message types as "html select options"

  • access: public
array getMessageTypeOptions ()
getPushTitleLength (line 488)

Get push title length

  • access: public
int getPushTitleLength ()
getSoloXml (line 409)

Return Solo Xml optional fieldset

  • access: public
string getSoloXml (string $ssCcMonths, string $ssCcYears)
  • string $ssCcMonths
  • string $ssCcYears
getStatusOptions (line 258)

Get list of predefined and supported Devices

  • access: public
array getStatusOptions ()
getTabLabel (line 318)

Return Translated tab label for given $action

  • access: public
string|bool getTabLabel (string $action)
  • string $action
getTemplateName (line 704)

Returns Application name by it's code

  • access: public
string getTemplateName ([ $templateId = null], string $appCode)
  • string $appCode
  • $templateId
getUrl (line 188)

Export $this->_getUrl() function to public

  • access: public
array getUrl (string $route, [array $params = array()])
  • string $route
  • array $params
htmlize (line 365)

Wrap $body with HTML4 headers

  • access: public
string htmlize (string $body)
  • string $body
sendBroadcastMessage (line 559)

Send broadcast message

  • access: public
void sendBroadcastMessage (Mage_XmlConnect_Model_Queue $queue)
urlToPath (line 748)

Convert Url link to file path for images

  • access: public
string urlToPath (string $icon)
  • string $icon
validateConfFieldNotEmpty (line 764)

Validate config body field is not empty

  • access: public
bool validateConfFieldNotEmpty (string $field, array $native)
  • string $field
  • array $native
_getTabLabelActionArray (line 301)

Return array for tabs like label -> action array

  • access: protected
array _getTabLabelActionArray ()
_injectFieldToArray (line 729)

Set value into multidimensional array 'conf/native/navigationBar/icon'

  • access: public
null _injectFieldToArray ( &$target, string $fieldPath, mixed $fieldValue, [string $delimiter = '/'], &array $target)
  • &array $target: // pointer to target array
  • string $fieldPath: // 'conf/native/navigationBar/icon'
  • mixed $fieldValue: // 'Some Value' || 12345 || array(1=>3, 'aa'=>43)
  • string $delimiter: // path delimiter
  • &$target

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::__()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
DEVICE_TYPE_ANDROID = 'android' (line 94)

Android device identifier

DEVICE_TYPE_DEFAULT = 'unknown' (line 73)

Default device type

DEVICE_TYPE_IPAD = 'ipad' (line 87)

iPad device identifier

DEVICE_TYPE_IPHONE = 'iphone' (line 80)

iPhone device identifier

MESSAGE_TITLE_LENGTH = 255 (line 41)

Message title length

PUSH_TITLE_LENGTH = 140 (line 34)

Push title length

XML_NODE_CONFIG_EXCLUDE_FROM_XML = 'xmlconnect/mobile_application/nodes_excluded_from_config_xml' (line 66)

XML path to nodes to be excluded

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