Class Mage_Core_Helper_Data

Core data helper

Mage_Core_Helper_Data

Direct known subclasses

Mage_Adminhtml_Helper_Catalog_Product_Edit_Action_Attribute, Mage_Adminhtml_Helper_Dashboard_Abstract, Mage_Sales_Helper_Data, Mage_Sales_Helper_Guest, Mage_Sales_Helper_Reorder, Mage_Adminhtml_Helper_Dashboard_Data, Mage_Connect_Helper_Data, Mage_CurrencySymbol_Helper_Data, Mage_GiftMessage_Helper_Message, Mage_ImportExport_Helper_Data, Mage_Media_Helper_Data, Mage_Persistent_Helper_Data, Mage_Persistent_Helper_Session

Indirect known subclasses

Mage_Adminhtml_Helper_Dashboard_Order

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

Methods summary
`public Mage_Core_Model_Encryption`	# `getEncryptor( )` Returns `Mage_Core_Model_Encryption`
`public static mixed`	# `currency( float $value, boolean $format = true, boolean $includeContainer = true )` Convert and format price value for current application store Convert and format price value for current application store Parameters `$value` `float` $value `$format` `boolean` $format `$includeContainer` `boolean` $includeContainer Returns `mixed`
`public static mixed`	# `currencyByStore( float $value, integer\|Mage_Core_Model_Store $store = null, boolean $format = true, boolean $includeContainer = true )` Convert and format price value for specified store Convert and format price value for specified store Parameters `$value` `float` $value `$store` `integer\|Mage_Core_Model_Store` $store `$format` `boolean` $format `$includeContainer` `boolean` $includeContainer Returns `mixed`
`public string`	# `formatCurrency( float $value, boolean $includeContainer = true )` Format and convert currency using current store option Format and convert currency using current store option Parameters `$value` `float` $value `$includeContainer` `boolean` $includeContainer Returns `string`
`public string`	# `formatPrice( float $price, boolean $includeContainer = true )` Formats price Formats price Parameters `$price` `float` $price `$includeContainer` `boolean` $includeContainer Returns `string`
`public string`	# `formatDate( date\|Zend_Date\|null $date = null, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT, boolean $showTime = false )` Format date using current locale options and time zone. Format date using current locale options and time zone. Parameters `$date` `date\|Zend_Date\|null` $date `$format` `string` $format See Mage_Core_Model_Locale::FORMAT_TYPE_* constants `$showTime` `boolean` $showTime Whether to include time Returns `string`
`public string`	# `formatTime( date\|Zend_Date\|null $time = null, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT, boolean $showDate = false )` Format time using current locale options Format time using current locale options Parameters `$time` `date\|Zend_Date\|null` $time `$format` `string` $format `$showDate` `boolean` $showDate Returns `string`
`public string`	# `encrypt( string $data )` Encrypt data using application key Encrypt data using application key Parameters `$data` `string` $data Returns `string`
`public string`	# `decrypt( string $data )` Decrypt data using application key Decrypt data using application key Parameters `$data` `string` $data Returns `string`
`public`	# `validateKey( mixed $key )`
`public`	# `getRandomString( mixed $len, mixed $chars = null )`
`public`	# `getHash( string $password, string\|integer\|boolean $salt = false )` Generate salted hash from password Generate salted hash from password Parameters `$password` `string` $password `$salt` `string\|integer\|boolean` $salt
`public`	# `validateHash( mixed $password, mixed $hash )`
`public integer`	# `getStoreId( mixed $store = null )` Retrieve store identifier Retrieve store identifier Parameters `$store` `mixed` $store Returns `integer`
`public`	# `removeAccents( mixed $string, mixed $german = false )`
`public`	# `isDevAllowed( mixed $storeId = null )`
`public array`	# `getCacheTypes( )` Get information about available cache types Get information about available cache types Returns `array`
`public array`	# `getCacheBetaTypes( )` Get information about available cache beta types Get information about available cache beta types Returns `array`
`public boolean`	# `copyFieldset( string $fieldset, string $aspect, array\|Varien_Object $source, array\|Varien_Object $target, string $root = 'global' )` Copy data from object\|array to object\|array containing fields from fieldset matching an aspect. Copy data from object\|array to object\|array containing fields from fieldset matching an aspect. Contents of $aspect are a field name in target object or array. If '*' - will be used the same name as in the source object or array. Parameters `$fieldset` `string` $fieldset `$aspect` `string` $aspect `$source` `array\|Varien_Object` $source `$target` `array\|Varien_Object` $target `$root` `string` $root Returns `boolean`
`public mixed`	# `decorateArray( mixed $array, string $prefix = 'decorated_', boolean $forceSetAll = false )` Decorate a plain array of arrays or objects The array actually can be an object with Iterator interface Decorate a plain array of arrays or objects The array actually can be an object with Iterator interface Keys with prefix_* will be set: _is_first - if the element is first _is_odd / _is_even - for odd/even elements _is_last - if the element is last The respective key/attribute will be set to element, depending on object it is or array. Varien_Object is supported. $forceSetAll true will cause to set all possible values for all elements. When false (default), only non-empty values will be set. Parameters `$array` `mixed` $array `$prefix` `string` $prefix `$forceSetAll` `boolean` $forceSetAll Returns `mixed`
`private`	# `_decorateArrayObject( mixed $element, mixed $key, mixed $value, mixed $dontSkip )`
`public SimpleXMLElement`	# `assocToXml( array $array, string $rootName = '_' )` Transform an assoc array to SimpleXMLElement object Array has some limitations. Appropriate exceptions will be thrown Transform an assoc array to SimpleXMLElement object Array has some limitations. Appropriate exceptions will be thrown Parameters `$array` `array` $array `$rootName` `string` $rootName Returns `SimpleXMLElement` Throws `Exception`
`private SimpleXMLElement`	# `_assocToXml( array $array, string $rootName, SimpleXMLElement & $xml )` Function, that actually recursively transforms array to xml Function, that actually recursively transforms array to xml Parameters `$array` `array` $array `$rootName` `string` $rootName `$xml` `SimpleXMLElement` $xml Returns `SimpleXMLElement` Throws `Exception`
`public array`	# `xmlToAssoc( SimpleXMLElement $xml )` Transform SimpleXMLElement to associative array SimpleXMLElement must be conform structure, generated by assocToXml() Transform SimpleXMLElement to associative array SimpleXMLElement must be conform structure, generated by assocToXml() Parameters `$xml` `SimpleXMLElement` $xml Returns `array`
`public string`	# `jsonEncode( mixed $valueToEncode, boolean $cycleCheck = false, array $options = array() )` Encode the mixed $valueToEncode into the JSON format Encode the mixed $valueToEncode into the JSON format Parameters `$valueToEncode` `mixed` $valueToEncode `$cycleCheck` `boolean` $cycleCheck Optional; whether or not to check for object recursion; off by default `$options` `array` $options Additional options used during encoding Returns `string`
`public mixed`	# `jsonDecode( string $encodedValue, mixed $objectDecodeType = Zend_Json::TYPE_ARRAY )` Decodes the given $encodedValue string which is encoded in the JSON format Decodes the given $encodedValue string which is encoded in the JSON format Parameters `$encodedValue` `string` $encodedValue `$objectDecodeType` Returns `mixed`
`public string`	# `uniqHash( mixed $prefix = '' )` Generate a hash from unique ID Generate a hash from unique ID Parameters `$prefix` `mixed` $prefix Returns `string`
`public boolean\|string`	# `mergeFiles( array $srcFiles, string\|false $targetFile = false, boolean $mustMerge = false, callable $beforeMergeCallback = null, array\|string $extensionsFilter = array() )` Merge specified files into one Merge specified files into one By default will not merge, if there is already merged file exists and it was modified after its components If target file is specified, will attempt to write merged contents into it, otherwise will return merged content May apply callback to each file contents. Callback gets parameters: (<existing system filename>, <file contents>) May filter files by specified extension(s) Returns false on error Parameters `$srcFiles` `array` $srcFiles `$targetFile` `string\|false` $targetFile - file path to be written `$mustMerge` `boolean` $mustMerge `$beforeMergeCallback` `callable` $beforeMergeCallback `$extensionsFilter` `array\|string` $extensionsFilter Returns `boolean\|string`
`public string`	# `getDefaultCountry( Mage_Core_Model_Store\|string\|integer $store = null )` Return default country code Return default country code Parameters `$store` `Mage_Core_Model_Store\|string\|integer` $store Returns `string`
`public array`	# `getProtectedFileExtensions( Mage_Core_Model_Store\|string\|integer $store = null )` Return list with protected file extensions Return list with protected file extensions Parameters `$store` `Mage_Core_Model_Store\|string\|integer` $store Returns `array`
`public array`	# `getPublicFilesValidPath( )` Return list with public files valid paths Return list with public files valid paths Returns `array`
`public boolean`	# `checkLfiProtection( string $name )` Check LFI protection Check LFI protection Parameters `$name` `string` $name Returns `boolean` Throws `Mage_Core_Exception`
`public boolean`	# `useDbCompatibleMode( )` Check whether database compatible mode is used (configs enable it for MySQL by default). Check whether database compatible mode is used (configs enable it for MySQL by default). Returns `boolean`
`public string`	# `getMerchantCountryCode( Mage_Core_Model_Store\|string\|integer\|null $store = null )` Retrieve merchant country code Retrieve merchant country code Parameters `$store` `Mage_Core_Model_Store\|string\|integer\|null` $store Returns `string`
`public string`	# `getMerchantVatNumber( Mage_Core_Model_Store\|string\|integer\|null $store = null )` Retrieve merchant VAT number Retrieve merchant VAT number Parameters `$store` `Mage_Core_Model_Store\|string\|integer\|null` $store Returns `string`
`public boolean`	# `isCountryInEU( string $countryCode, null\|integer $storeId = null )` Check whether specified country is in EU countries list Check whether specified country is in EU countries list Parameters `$countryCode` `string` $countryCode `$storeId` `null\|integer` $storeId Returns `boolean`
`public float\|integer`	# `getExactDivision( float\|integer $dividend, float\|integer $divisor )` Returns the floating point remainder (modulo) of the division of the arguments Returns the floating point remainder (modulo) of the division of the arguments Parameters `$dividend` `float\|integer` $dividend `$divisor` `float\|integer` $divisor Returns `float\|integer`

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`	`XML_PATH_DEFAULT_COUNTRY`	`'general/country/default'`	#
`string`	`XML_PATH_PROTECTED_FILE_EXTENSIONS`	`'general/file/protected_extensions'`	#
`string`	`XML_PATH_PUBLIC_FILES_VALID_PATHS`	`'general/file/public_files_valid_paths'`	#
`string`	`XML_PATH_ENCRYPTION_MODEL`	`'global/helpers/core/encryption_model'`	#
`string`	`XML_PATH_DEV_ALLOW_IPS`	`'dev/restrict/allow_ips'`	#
`string`	`XML_PATH_CACHE_BETA_TYPES`	`'global/cache/betatypes'`	#
`string`	`XML_PATH_CONNECTION_TYPE`	`'global/resources/default_setup/connection/type'`	#
`string`	`CHARS_LOWERS`	`'abcdefghijklmnopqrstuvwxyz'`	#
`string`	`CHARS_UPPERS`	`'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`	#
`string`	`CHARS_DIGITS`	`'0123456789'`	#
`string`	`CHARS_SPECIALS`	`'!$*+-.=?@^_\|~'`	#
`string`	`CHARS_PASSWORD_LOWERS`	`'abcdefghjkmnpqrstuvwxyz'`	#
`string`	`CHARS_PASSWORD_UPPERS`	`'ABCDEFGHJKLMNPQRSTUVWXYZ'`	#
`string`	`CHARS_PASSWORD_DIGITS`	`'23456789'`	#
`string`	`CHARS_PASSWORD_SPECIALS`	`'!$*-.=?@_'`	#
`string`	`XML_PATH_MERCHANT_COUNTRY_CODE`	`'general/store_information/merchant_country'`	# Config pathes to merchant country code and merchant VAT number Config pathes to merchant country code and merchant VAT number
`string`	`XML_PATH_MERCHANT_VAT_NUMBER`	`'general/store_information/merchant_vat_number'`	#
`string`	`XML_PATH_EU_COUNTRIES_LIST`	`'general/country/eu_countries'`	#
`integer`	`DIVIDE_EPSILON`	`10000`	# Const for correct dividing decimal values Const for correct dividing decimal values

Properties summary
`protected Mage_Core_Model_Encryption`	`$_encryptor`	`null`	#
`protected array`	`$_allowedFormats`	`array( Mage_Core_Model_Locale::FORMAT_TYPE_FULL, Mage_Core_Model_Locale::FORMAT_TYPE_LONG, Mage_Core_Model_Locale::FORMAT_TYPE_MEDIUM, Mage_Core_Model_Locale::FORMAT_TYPE_SHORT )`	#

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

Packages

Classes

Exceptions

Functions

Class Mage_Core_Helper_Data

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns