Class Mage_XmlConnect_Helper_Data

XmlConnect default helper

Mage_XmlConnect_Helper_Data

Package: Mage\XmlConnect
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/XmlConnect/Helper/Data.php

Methods summary
`public Mage_XmlConnect_Model_Preview_Abstract`	# `getPreviewModel( )` Get device preview model Get device preview model Returns `Mage_XmlConnect_Model_Preview_Abstract` Throws `Mage_Core_Exception`
`public Mage_Core_Helper_Abstract`	# `getDeviceHelper( Mage_XmlConnect_Model_Application $application = null )` Get device helper Get device helper Parameters `$application` `Mage_XmlConnect_Model_Application` $application Returns `Mage_Core_Helper_Abstract` Throws `Mage_Core_Exception`
`public string`	# `getDeviceType( Mage_XmlConnect_Model_Application $application = null )` Get device tipe from application Get device tipe from application Parameters `$application` `Mage_XmlConnect_Model_Application` $application Returns `string`
`public Mage_XmlConnect_Model_Application`	# `getApplication( )` Getter for current loaded application model Getter for current loaded application model Returns `Mage_XmlConnect_Model_Application` Throws `Mage_Core_Exception`
`public array`	# `getFilterByKey( string $key )` Create array with filter model and filter block by key Create array with filter model and filter block by key Create array with: Mage_Catalog_Model_Layer_Filter_Abstract Mage_Catalog_Block_Layer_Filter_Abstract Parameters `$key` `string` $key Returns `array`
`public array`	# `getUrl( string $route, array $params = array() )` Export $this->_getUrl() function to public Export $this->_getUrl() function to public Parameters `$route` `string` $route `$params` `array` $params Returns `array`
`public array`	# `getCountryOptionsArray( boolean $isItunes = false )` Retrieve device specific country options array Retrieve device specific country options array Parameters `$isItunes` `boolean` $isItunes deprecated after 1.6.0.0 Returns `array` Throws `Mage_Core_Exception`
`public static array`	# `getSupportedDevices( )` Get list of predefined and supported Devices Get list of predefined and supported Devices Returns `array`
`public array`	# `getStatusOptions( )` Get list of predefined and supported Devices Get list of predefined and supported Devices Returns `array`
`public array`	# `getDeviceTypeOptions( )` Retrieve supported device types as "html select options" Retrieve supported device types as "html select options" Returns `array`
`public array`	# `getDefaultApplicationDesignTabs( )` Get default application tabs Get default application tabs Returns `array`
`public integer`	# `getDefaultCacheLifetime( )` Get default Cache Lifetime Get default Cache Lifetime Returns `integer`
`protected array`	# `_getTabLabelActionArray( )` Return array for tabs like label -> action array Return array for tabs like label -> action array Returns `array`
`public string\|boolean`	# `getTabLabel( string $action )` Return Translated tab label for given $action Return Translated tab label for given $action Parameters `$action` `string` $action Returns `string\|boolean`
`public static array`	# `arrayMergeRecursive( mixed $target, mixed $changes )` Merges $changes array to $target array recursive, overwriting existing key, and adding new one Merges $changes array to $target array recursive, overwriting existing key, and adding new one Parameters `$target` `mixed` $target `$changes` `mixed` $changes Returns `array`
`public string`	# `htmlize( string $body )` Wrap $body with HTML4 headers Wrap $body with HTML4 headers Parameters `$body` `string` $body Returns `string`
`public string`	# `getArrayAsXmlItemValues( array $dataArray, string $selected )` Return select options for xml from array Return select options for xml from array Parameters `$dataArray` `array` $dataArray source array `$selected` `string` $selected selected item Returns `string`
`public string`	# `getSoloXml( string $ssCcMonths, string $ssCcYears )` Return Solo Xml optional fieldset Return Solo Xml optional fieldset Parameters `$ssCcMonths` `string` $ssCcMonths `$ssCcYears` `string` $ssCcYears Returns `string`
`public string`	# `formatPriceForXml( float $price )` Format price for correct view inside xml strings Format price for correct view inside xml strings Parameters `$price` `float` $price Returns `string`
`public static array`	# `getSupportedMessageTypes( )` Get list of predefined and supported message types Get list of predefined and supported message types Returns `array`
`public array`	# `getMessageTypeOptions( )` Retrieve supported message types as "html select options" Retrieve supported message types as "html select options" Returns `array`
`public integer`	# `getPushTitleLength( )` Get push title length Get push title length Returns `integer`
`public integer`	# `getMessageTitleLength( )` Get message title length Get message title length Returns `integer`
`public array`	# `getApplicationOptions( )` Retrieve applications as "html select options" Retrieve applications as "html select options" Returns `array`
`public array`	# `getApplications( )` Get applications array like `code` as `name` Get applications array like `code` as `name` Returns `array`
`public`	# `sendBroadcastMessage( Mage_XmlConnect_Model_Queue $queue )` Send broadcast message Send broadcast message Parameters `$queue` `Mage_XmlConnect_Model_Queue` $queue Throws `Mage_Core_Exception`
`public array`	# `getHttpHeaders( )` Get headers for broadcast message Get headers for broadcast message Returns `array`
`protected array`	# `_getCurlConfig( string $userPwd, integer $timeout = Mage_XmlConnect_Helper_Data::CURLOPT_DEFAULT_TIMEOUT )` Get urban airship curl request configuration Get urban airship curl request configuration Parameters `$userPwd` `string` $userPwd `$timeout` `integer` $timeout Returns `array`
`public array`	# `excludeXmlConfigKeys( array $data, array $excludedKeys = array() )` Remove from array the unnecessary parameters by given keys Remove from array the unnecessary parameters by given keys Parameters `$data` `array` $data Source array `$excludedKeys` `array` $excludedKeys Keys to be excluded from array. Keys must be in xPath notation Returns `array`
`public array`	# `getExcludedXmlConfigKeys( )` Get excluded keys as array Get excluded keys as array Returns `array`
`public string`	# `getApplicationName( string $appCode = null )` Returns Application name by it's code Returns Application name by it's code Parameters `$appCode` `string` $appCode Returns `string`
`public string`	# `getTemplateName( string $templateId = null )` Returns Application name by it's code Returns Application name by it's code Parameters `$templateId` `string` $templateId Returns `string`
`public null`	# `_injectFieldToArray( array & $target, string $fieldPath, mixed $fieldValue, string $delimiter = '/' )` Set value into multidimensional array 'conf/native/navigationBar/icon' Set value into multidimensional array 'conf/native/navigationBar/icon' Parameters `$target` `array` &$target pointer to target array `$fieldPath` `string` $fieldPath 'conf/native/navigationBar/icon' `$fieldValue` `mixed` $fieldValue 'Some Value' \|\| 12345 \|\| array(1=>3, 'aa'=>43) `$delimiter` `string` $delimiter path delimiter Returns `null`
`public string`	# `urlToPath( string $icon )` Convert Url link to file path for images Convert Url link to file path for images Parameters `$icon` `string` $icon Returns `string`
`public boolean`	# `validateConfFieldNotEmpty( string $field, array $native )` Validate config body field is not empty Validate config body field is not empty Parameters `$field` `string` $field `$native` `array` $native Returns `boolean`
`public boolean`	# `isNotificationsAllowed( Mage_XmlConnect_Model_Application $application = null )` Check the notifications are allowed for current type of application Check the notifications are allowed for current type of application Parameters `$application` `Mage_XmlConnect_Model_Application` $application Returns `boolean`
`public string`	# `getActionUrl( string $action, array $params = array() )` Get front url for action Get front url for action Parameters `$action` `string` $action `$params` `array` $params Returns `string` url
`public string`	# `trimLineBreaks( string $string )` Remove trilling line breaks Remove trilling line breaks Parameters `$string` `string` $string Returns `string`

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
`integer`	`PUSH_TITLE_LENGTH`	`140`	# Push title length Push title length
`integer`	`MESSAGE_TITLE_LENGTH`	`255`	# Message title length Message title length
`integer`	`CURLOPT_DEFAULT_TIMEOUT`	`60`	# Curl default timeout Curl default timeout
`string`	`XML_NODE_CONFIG_EXCLUDE_FROM_XML`	`'xmlconnect/mobile_application/nodes_excluded_from_config_xml'`	# XML path to nodes to be excluded XML path to nodes to be excluded
`string`	`DEVICE_TYPE_DEFAULT`	`'unknown'`	# Default device type Default device type
`string`	`DEVICE_TYPE_IPHONE`	`'iphone'`	# iPhone device identifier iPhone device identifier
`string`	`DEVICE_TYPE_IPAD`	`'ipad'`	# iPad device identifier iPad device identifier
`string`	`DEVICE_TYPE_ANDROID`	`'android'`	# Android device identifier Android device identifier
`string`	`SOCIAL_NETWORK_TWITTER`	`'twitter'`	# Social network Twitter id Social network Twitter id
`string`	`SOCIAL_NETWORK_FACEBOOK`	`'facebook'`	# Social network Facebook id Social network Facebook id
`string`	`SOCIAL_NETWORK_LINKEDIN`	`'linkedin'`	# Social network LinkedIn id Social network LinkedIn id

Properties summary
`protected array`	`$_excludedXmlConfigKeys`	`array('notifications/applicationMasterSecret')`	# List of the keys for xml config that have to be excluded form application config List of the keys for xml config that have to be excluded form application config
`protected array`	`$_appNames`	`array()`	# Application names array Application names array
`protected array`	`$_tplNames`	`array()`	# Template names array Template names array

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

Packages

Classes

Interfaces

Class Mage_XmlConnect_Helper_Data

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Throws

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns