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_Directory_Block_Adminhtml_Frontend_Currency_Base
  • Mage_Directory_Block_Adminhtml_Frontend_Region_Updater
  • Mage_Directory_Block_Currency
  • Mage_Directory_Block_Data
  • Mage_Directory_CurrencyController
  • Mage_Directory_Helper_Data
  • Mage_Directory_Helper_Url
  • Mage_Directory_Model_Country
  • Mage_Directory_Model_Country_Api
  • Mage_Directory_Model_Country_Api_V2
  • Mage_Directory_Model_Country_Format
  • Mage_Directory_Model_Currency
  • Mage_Directory_Model_Currency_Filter
  • Mage_Directory_Model_Currency_Import_Abstract
  • Mage_Directory_Model_Currency_Import_Webservicex
  • Mage_Directory_Model_Mysql4_Country
  • Mage_Directory_Model_Mysql4_Country_Collection
  • Mage_Directory_Model_Mysql4_Country_Format
  • Mage_Directory_Model_Mysql4_Country_Format_Collection
  • Mage_Directory_Model_Mysql4_Currency
  • Mage_Directory_Model_Mysql4_Currency_Collection
  • Mage_Directory_Model_Mysql4_Region
  • Mage_Directory_Model_Mysql4_Region_Collection
  • Mage_Directory_Model_Observer
  • Mage_Directory_Model_Region
  • Mage_Directory_Model_Region_Api
  • Mage_Directory_Model_Region_Api_V2
  • Mage_Directory_Model_Resource_Country
  • Mage_Directory_Model_Resource_Country_Collection
  • Mage_Directory_Model_Resource_Country_Format
  • Mage_Directory_Model_Resource_Country_Format_Collection
  • Mage_Directory_Model_Resource_Currency
  • Mage_Directory_Model_Resource_Region
  • Mage_Directory_Model_Resource_Region_Collection

Exceptions

  • Mage_Directory_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Directory_Helper_Data

Directory data helper

Mage_Core_Helper_Abstract
Extended by Mage_Directory_Helper_Data
Package: Mage\Directory
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/Directory/Helper/Data.php
Methods summary
public Mage_Directory_Model_Resource_Region_Collection
# getRegionCollection( )

Retrieve region collection

Retrieve region collection

Returns

Mage_Directory_Model_Resource_Region_Collection
public Mage_Directory_Model_Resource_Country_Collection
# getCountryCollection( )

Retrieve country collection

Retrieve country collection

Returns

Mage_Directory_Model_Resource_Country_Collection
public string
# getRegionJson( )

Retrieve regions data json

Retrieve regions data json

Returns

string
public float
# currencyConvert( float $amount, string $from, string $to = null )

Convert currency

Convert currency

Parameters

$amount
float
$amount
$from
string
$from
$to
string
$to

Returns

float
public array|string
# getCountriesWithOptionalZip( boolean $asJson = false )

Return ISO2 country codes, which have optional Zip/Postal pre-configured

Return ISO2 country codes, which have optional Zip/Postal pre-configured

Parameters

$asJson
boolean
$asJson

Returns

array|string
public boolean
# isZipCodeOptional( string $countryCode )

Check whether zip code is optional for specified country code

Check whether zip code is optional for specified country code

Parameters

$countryCode
string
$countryCode

Returns

boolean
public array
# getCountriesWithStatesRequired( boolean $asJson = false )

Returns the list of countries, for which region is required

Returns the list of countries, for which region is required

Parameters

$asJson
boolean
$asJson

Returns

array
public boolean
# getShowNonRequiredState( )

Return flag, which indicates whether or not non required state should be shown

Return flag, which indicates whether or not non required state should be shown

Returns

boolean
public boolean
# isRegionRequired( string $countryId )

Returns flag, which indicates whether region is required for specified country

Returns flag, which indicates whether region is required for specified country

Parameters

$countryId
string
$countryId

Returns

boolean
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 OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH 'general/country/optional_zip_countries'
#

Config value that lists ISO2 country codes which have optional Zip/Postal pre-configured

Config value that lists ISO2 country codes which have optional Zip/Postal pre-configured

string XML_PATH_STATES_REQUIRED 'general/region/state_required'
#
string XML_PATH_DISPLAY_ALL_STATES 'general/region/display_all'
#
Properties summary
protected Mage_Directory_Model_Resource_Country_Collection $_countryCollection
#

Country collection

Country collection

protected Mage_Directory_Model_Resource_Region_Collection $_regionCollection
#

Region collection

Region collection

protected string $_regionJson
#

Json representation of regions data

Json representation of regions data

protected array $_currencyCache array()
#

Currency cache

Currency cache

protected array $_optionalZipCountries null
#

ISO2 country codes which have optional Zip/Postal pre-configured

ISO2 country codes which have optional Zip/Postal pre-configured

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