Class Mage_Core_Model_Locale

Locale model

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/Model/Locale.php

Methods summary
`public`	# `__construct( mixed $locale = null )`
`public Mage_Core_Model_Locale`	# `setDefaultLocale( string $locale )` Set default locale code Set default locale code Parameters `$locale` `string` $locale Returns `Mage_Core_Model_Locale`
`public string`	# `getDefaultLocale( )` REtrieve default locale code REtrieve default locale code Returns `string`
`public Mage_Core_Model_Locale`	# `setLocale( string $locale = null )` Set locale Set locale Parameters `$locale` `string` $locale Returns `Mage_Core_Model_Locale`
`public string`	# `getTimezone( )` Retrieve timezone code Retrieve timezone code Returns `string`
`public string`	# `getCurrency( )` Retrieve currency code Retrieve currency code Returns `string`
`public Zend_Locale`	# `getLocale( )` Retrieve locale object Retrieve locale object Returns `Zend_Locale`
`public string`	# `getLocaleCode( )` Retrieve locale code Retrieve locale code Returns `string`
`public Mage_Core_Model_Locale`	# `setLocaleCode( string $code )` Specify current locale code Specify current locale code Parameters `$code` `string` $code Returns `Mage_Core_Model_Locale`
`public array`	# `getOptionLocales( )` Get options array for locale dropdown in currunt locale Get options array for locale dropdown in currunt locale Returns `array`
`public array`	# `getTranslatedOptionLocales( )` Get translated to original locale options array for locale dropdown Get translated to original locale options array for locale dropdown Returns `array`
`protected array`	# `_getOptionLocales( boolean $translatedName = false )` Get options array for locale dropdown Get options array for locale dropdown Parameters `$translatedName` `boolean` $translatedName translation flag Returns `array`
`public array`	# `getOptionTimezones( )` Retrieve timezone option list Retrieve timezone option list Returns `array`
`public array`	# `getOptionWeekdays( )` Retrieve days of week option list Retrieve days of week option list Returns `array`
`public array`	# `getOptionCountries( )` Retrieve country option list Retrieve country option list Returns `array`
`public unknown`	# `getOptionCurrencies( )` Retrieve currency option list Retrieve currency option list Returns `unknown`
`public unknown`	# `getOptionAllCurrencies( )` Retrieve all currency option list Retrieve all currency option list Returns `unknown`
`protected`	# `_sortOptionArray( mixed $option )`
`public array`	# `getAllowLocales( )` Retrieve array of allowed locales Retrieve array of allowed locales Returns `array`
`public unknown`	# `getAllowCurrencies( )` Retrieve array of allowed currencies Retrieve array of allowed currencies Returns `unknown`
`public string`	# `getDateFormat( string $type = null )` Retrieve ISO date format Retrieve ISO date format Parameters `$type` `string` $type Returns `string`
`public string`	# `getDateFormatWithLongYear( )` Retrieve short date format with 4-digit year Retrieve short date format with 4-digit year Returns `string`
`public string`	# `getTimeFormat( string $type = null )` Retrieve ISO time format Retrieve ISO time format Parameters `$type` `string` $type Returns `string`
`public string`	# `getDateTimeFormat( string $type )` Retrieve ISO datetime format Retrieve ISO datetime format Parameters `$type` `string` $type Returns `string`
`public string`	# `getDateStrFormat( string $type )` Retrieve date format by strftime function Retrieve date format by strftime function Parameters `$type` `string` $type Returns `string`
`public string`	# `getTimeStrFormat( string $type )` Retrieve time format by strftime function Retrieve time format by strftime function Parameters `$type` `string` $type Returns `string`
`public Zend_Date`	# `date( mixed $date = null, string $part = null, string\|Zend_Locale $locale = null, boolean $useTimezone = true )` Create Zend_Date object for current locale Create Zend_Date object for current locale Parameters `$date` `mixed` $date `$part` `string` $part `$locale` `string\|Zend_Locale` $locale `$useTimezone` `boolean` $useTimezone Returns `Zend_Date`
`public Zend_Date`	# `storeDate( mixed $store = null, string\|integer\|Zend_Date\|array\|null $date = null, boolean $includeTime = false )` Create Zend_Date object with date converted to store timezone and store Locale Create Zend_Date object with date converted to store timezone and store Locale Parameters `$store` `mixed` $store Information about store `$date` `string\|integer\|Zend_Date\|array\|null` $date date in UTC `$includeTime` `boolean` $includeTime flag for including time to date Returns `Zend_Date`
`public Zend_Date`	# `utcDate( mixed $store = null, string\|integer\|Zend_Date\|array\|null $date, boolean $includeTime = false, null\|string $format = null )` Create Zend_Date object with date converted from store's timezone to UTC time zone. Date can be passed in format of store's locale or in format which was passed as parameter. Create Zend_Date object with date converted from store's timezone to UTC time zone. Date can be passed in format of store's locale or in format which was passed as parameter. Parameters `$store` `mixed` $store Information about store `$date` `string\|integer\|Zend_Date\|array\|null` $date date in store's timezone `$includeTime` `boolean` $includeTime flag for including time to date `$format` `null\|string` $format Returns `Zend_Date`
`public integer`	# `storeTimeStamp( mixed $store = null )` Get store timestamp Timstamp will be builded with store timezone settings Get store timestamp Timstamp will be builded with store timezone settings Parameters `$store` `mixed` $store Returns `integer`
`public Zend_Currency`	# `currency( string $currency )` Create Zend_Currency object for current locale Create Zend_Currency object for current locale Parameters `$currency` `string` $currency Returns `Zend_Currency`
`public float\|null`	# `getNumber( string\|float\|integer $value )` Returns the first found number from an string Parsing depends on given locale (grouping and decimal) Returns the first found number from an string Parsing depends on given locale (grouping and decimal) Examples for input: ' 2345.4356,1234' = 23455456.1234 '+23,3452.123' = 233452.123 ' 12343 ' = 12343 '-9456km' = -9456 '0' = 0 '2 054,10' = 2054.1 '2'054.52' = 2054.52 '2,46 GB' = 2.46 Parameters `$value` `string\|float\|integer` $value Returns `float\|null`
`public array`	# `getJsPriceFormat( )` Functions returns array with price formatting info for js function formatCurrency in js/varien/js.js Functions returns array with price formatting info for js function formatCurrency in js/varien/js.js Returns `array`
`public`	# `emulate( integer $storeId )` Push current locale to stack and replace with locale from specified store Event is not dispatched. Push current locale to stack and replace with locale from specified store Event is not dispatched. Parameters `$storeId` `integer` $storeId
`public`	# `revert( )` Get last locale, used before last emulation Get last locale, used before last emulation
`public array`	# `getTranslationList( string $path = null, string $value = null )` Returns localized informations as array, supported are several types of informations. For detailed information about the types look into the documentation Returns localized informations as array, supported are several types of informations. For detailed information about the types look into the documentation Parameters `$path` `string` $path (Optional) Type of information to return `$value` `string` $value (Optional) Value for detail list Returns `array` Array with the wished information in the given language
`public string\|false`	# `getTranslation( string $value = null, string $path = null )` Returns a localized information string, supported are several types of informations. For detailed information about the types look into the documentation Returns a localized information string, supported are several types of informations. For detailed information about the types look into the documentation Parameters `$value` `string` $value Name to get detailed information about `$path` `string` $path (Optional) Type of information to return Returns `string\|false` The wished information in the given language
`public array`	# `getCountryTranslation( string $value )` Returns the localized country name Returns the localized country name Parameters `$value` `string` $value Name to get detailed information about Returns `array`
`public array`	# `getCountryTranslationList( )` Returns an array with the name of all countries translated to the given language Returns an array with the name of all countries translated to the given language Returns `array`
`public boolean`	# `isStoreDateInInterval( integer\|string\|Mage_Core_Model_Store $store, string\|null $dateFrom = null, string\|null $dateTo = null )` Checks if current date of the given store (in the store timezone) is within the range Checks if current date of the given store (in the store timezone) is within the range Parameters `$store` `integer\|string\|Mage_Core_Model_Store` $store `$dateFrom` `string\|null` $dateFrom `$dateTo` `string\|null` $dateTo Returns `boolean`

Constants summary
`string`	`DEFAULT_LOCALE`	`'en_US'`	# Default locale name Default locale name
`string`	`DEFAULT_TIMEZONE`	`'UTC'`	#
`string`	`DEFAULT_CURRENCY`	`'USD'`	#
`string`	`XML_PATH_DEFAULT_LOCALE`	`'general/locale/code'`	# XML path constants XML path constants
`string`	`XML_PATH_DEFAULT_TIMEZONE`	`'general/locale/timezone'`	#
`string`	`XML_PATH_ALLOW_CODES`	`'global/locale/allow/codes'`	#
`string`	`XML_PATH_ALLOW_CURRENCIES`	`'global/locale/allow/currencies'`	#
`string`	`XML_PATH_ALLOW_CURRENCIES_INSTALLED`	`'system/currency/installed'`	#
`string`	`FORMAT_TYPE_FULL`	`'full'`	# Date and time format codes Date and time format codes
`string`	`FORMAT_TYPE_LONG`	`'long'`	#
`string`	`FORMAT_TYPE_MEDIUM`	`'medium'`	#
`string`	`FORMAT_TYPE_SHORT`	`'short'`	#

Properties summary
`protected string`	`$_defaultLocale`		# Default locale code Default locale code
`protected Zend_Locale`	`$_locale`		# Locale object Locale object
`protected string`	`$_localeCode`		# Locale code Locale code
`protected array`	`$_emulatedLocales`	`array()`	# Emulated locales stack Emulated locales stack
`protected static array`	`$_currencyCache`	`array()`	#

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Locale

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns