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_Customer_AccountController
  • Mage_Customer_AddressController
  • Mage_Customer_Block_Account
  • Mage_Customer_Block_Account_Dashboard
  • Mage_Customer_Block_Account_Dashboard_Address
  • Mage_Customer_Block_Account_Dashboard_Block
  • Mage_Customer_Block_Account_Dashboard_Hello
  • Mage_Customer_Block_Account_Dashboard_Info
  • Mage_Customer_Block_Account_Dashboard_Newsletter
  • Mage_Customer_Block_Account_Dashboard_Sidebar
  • Mage_Customer_Block_Account_Forgotpassword
  • Mage_Customer_Block_Account_Navigation
  • Mage_Customer_Block_Account_Resetpassword
  • Mage_Customer_Block_Address_Book
  • Mage_Customer_Block_Address_Edit
  • Mage_Customer_Block_Address_Renderer_Default
  • Mage_Customer_Block_Form_Edit
  • Mage_Customer_Block_Form_Login
  • Mage_Customer_Block_Form_Register
  • Mage_Customer_Block_Newsletter
  • Mage_Customer_Block_Widget_Abstract
  • Mage_Customer_Block_Widget_Dob
  • Mage_Customer_Block_Widget_Gender
  • Mage_Customer_Block_Widget_Name
  • Mage_Customer_Block_Widget_Taxvat
  • Mage_Customer_Helper_Address
  • Mage_Customer_Helper_Data
  • Mage_Customer_Model_Address
  • Mage_Customer_Model_Address_Abstract
  • Mage_Customer_Model_Address_Api
  • Mage_Customer_Model_Address_Api_V2
  • Mage_Customer_Model_Address_Config
  • Mage_Customer_Model_Api2_Customer
  • Mage_Customer_Model_Api2_Customer_Address
  • Mage_Customer_Model_Api2_Customer_Address_Rest
  • Mage_Customer_Model_Api2_Customer_Address_Rest_Admin_V1
  • Mage_Customer_Model_Api2_Customer_Address_Rest_Customer_V1
  • Mage_Customer_Model_Api2_Customer_Address_Validator
  • Mage_Customer_Model_Api2_Customer_Rest
  • Mage_Customer_Model_Api2_Customer_Rest_Admin_V1
  • Mage_Customer_Model_Api2_Customer_Rest_Customer_V1
  • Mage_Customer_Model_Api_Resource
  • Mage_Customer_Model_Attribute
  • Mage_Customer_Model_Attribute_Backend_Data_Boolean
  • Mage_Customer_Model_Attribute_Data
  • Mage_Customer_Model_Attribute_Data_Abstract
  • Mage_Customer_Model_Attribute_Data_Boolean
  • Mage_Customer_Model_Attribute_Data_Date
  • Mage_Customer_Model_Attribute_Data_File
  • Mage_Customer_Model_Attribute_Data_Hidden
  • Mage_Customer_Model_Attribute_Data_Image
  • Mage_Customer_Model_Attribute_Data_Multiline
  • Mage_Customer_Model_Attribute_Data_Multiselect
  • Mage_Customer_Model_Attribute_Data_Postcode
  • Mage_Customer_Model_Attribute_Data_Select
  • Mage_Customer_Model_Attribute_Data_Text
  • Mage_Customer_Model_Attribute_Data_Textarea
  • Mage_Customer_Model_Config_Share
  • Mage_Customer_Model_Convert_Adapter_Customer
  • Mage_Customer_Model_Convert_Parser_Customer
  • Mage_Customer_Model_Customer
  • Mage_Customer_Model_Customer_Api
  • Mage_Customer_Model_Customer_Api_V2
  • Mage_Customer_Model_Customer_Attribute_Backend_Billing
  • Mage_Customer_Model_Customer_Attribute_Backend_Password
  • Mage_Customer_Model_Customer_Attribute_Backend_Shipping
  • Mage_Customer_Model_Customer_Attribute_Backend_Store
  • Mage_Customer_Model_Customer_Attribute_Backend_Website
  • Mage_Customer_Model_Customer_Attribute_Source_Group
  • Mage_Customer_Model_Customer_Attribute_Source_Store
  • Mage_Customer_Model_Customer_Attribute_Source_Website
  • Mage_Customer_Model_Entity_Address
  • Mage_Customer_Model_Entity_Address_Attribute_Backend_Region
  • Mage_Customer_Model_Entity_Address_Attribute_Backend_Street
  • Mage_Customer_Model_Entity_Address_Attribute_Collection
  • Mage_Customer_Model_Entity_Address_Attribute_Source_Country
  • Mage_Customer_Model_Entity_Address_Attribute_Source_Region
  • Mage_Customer_Model_Entity_Address_Collection
  • Mage_Customer_Model_Entity_Attribute
  • Mage_Customer_Model_Entity_Attribute_Collection
  • Mage_Customer_Model_Entity_Customer
  • Mage_Customer_Model_Entity_Customer_Collection
  • Mage_Customer_Model_Entity_Form_Attribute
  • Mage_Customer_Model_Entity_Form_Attribute_Collection
  • Mage_Customer_Model_Entity_Group
  • Mage_Customer_Model_Entity_Group_Collection
  • Mage_Customer_Model_Entity_Setup
  • Mage_Customer_Model_Entity_Wishlist_Collection
  • Mage_Customer_Model_Form
  • Mage_Customer_Model_Group
  • Mage_Customer_Model_Group_Api
  • Mage_Customer_Model_Group_Api_V2
  • Mage_Customer_Model_Observer
  • Mage_Customer_Model_Resource_Address
  • Mage_Customer_Model_Resource_Address_Attribute_Backend_Region
  • Mage_Customer_Model_Resource_Address_Attribute_Backend_Street
  • Mage_Customer_Model_Resource_Address_Attribute_Collection
  • Mage_Customer_Model_Resource_Address_Attribute_Source_Country
  • Mage_Customer_Model_Resource_Address_Attribute_Source_Region
  • Mage_Customer_Model_Resource_Address_Collection
  • Mage_Customer_Model_Resource_Attribute
  • Mage_Customer_Model_Resource_Attribute_Collection
  • Mage_Customer_Model_Resource_Customer
  • Mage_Customer_Model_Resource_Customer_Collection
  • Mage_Customer_Model_Resource_Form_Attribute
  • Mage_Customer_Model_Resource_Form_Attribute_Collection
  • Mage_Customer_Model_Resource_Group
  • Mage_Customer_Model_Resource_Group_Collection
  • Mage_Customer_Model_Resource_Setup
  • Mage_Customer_Model_Resource_Wishlist_Collection
  • Mage_Customer_Model_Session
  • Mage_Customer_ReviewController

Interfaces

  • Mage_Customer_Block_Address_Renderer_Interface

Exceptions

  • Mage_Customer_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Customer_Helper_Data

Customer Data Helper

Mage_Core_Helper_Abstract
Extended by Mage_Customer_Helper_Data
Package: Mage\Customer
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/Customer/Helper/Data.php
Methods summary
public boolean
# isLoggedIn( )

Check customer is logged in

Check customer is logged in

Returns

boolean
public Mage_Customer_Model_Customer
# getCustomer( )

Retrieve logged in customer

Retrieve logged in customer

Returns

Mage_Customer_Model_Customer
public Mage_Customer_Model_Entity_Group_Collection
# getGroups( )

Retrieve customer groups collection

Retrieve customer groups collection

Returns

Mage_Customer_Model_Entity_Group_Collection
public Mage_Customer_Model_Customer
# getCurrentCustomer( )

Retrieve current (logged in) customer object

Retrieve current (logged in) customer object

Returns

Mage_Customer_Model_Customer
public string
# getCustomerName( )

Retrieve current customer name

Retrieve current customer name

Returns

string
public boolean
# customerHasAddresses( )

Check customer has address

Check customer has address

Returns

boolean
public string
# getLoginUrl( )

Retrieve customer login url

Retrieve customer login url

Returns

string
public array
# getLoginUrlParams( )

Retrieve parameters of customer login url

Retrieve parameters of customer login url

Returns

array
public string
# getLoginPostUrl( )

Retrieve customer login POST URL

Retrieve customer login POST URL

Returns

string
public string
# getLogoutUrl( )

Retrieve customer logout url

Retrieve customer logout url

Returns

string
public string
# getDashboardUrl( )

Retrieve customer dashboard url

Retrieve customer dashboard url

Returns

string
public string
# getAccountUrl( )

Retrieve customer account page url

Retrieve customer account page url

Returns

string
public string
# getRegisterUrl( )

Retrieve customer register form url

Retrieve customer register form url

Returns

string
public string
# getRegisterPostUrl( )

Retrieve customer register form post url

Retrieve customer register form post url

Returns

string
public string
# getEditUrl( )

Retrieve customer account edit form url

Retrieve customer account edit form url

Returns

string
public string
# getEditPostUrl( )

Retrieve customer edit POST URL

Retrieve customer edit POST URL

Returns

string
public string
# getForgotPasswordUrl( )

Retrieve url of forgot password page

Retrieve url of forgot password page

Returns

string
public boolean
# isConfirmationRequired( )

Check is confirmation required

Check is confirmation required

Returns

boolean
public string
# getEmailConfirmationUrl( string $email = null )

Retrieve confirmation URL for Email

Retrieve confirmation URL for Email

Parameters

$email
string
$email

Returns

string
public boolean
# isRegistrationAllowed( )

Check whether customers registration is allowed

Check whether customers registration is allowed

Returns

boolean
public array|boolean
# getNamePrefixOptions( mixed $store = null )

Retrieve name prefix dropdown options

Retrieve name prefix dropdown options

Returns

array|boolean
public array|boolean
# getNameSuffixOptions( mixed $store = null )

Retrieve name suffix dropdown options

Retrieve name suffix dropdown options

Returns

array|boolean
protected array|boolean
# _prepareNamePrefixSuffixOptions( string $options )

Unserialize and clear name prefix or suffix options

Unserialize and clear name prefix or suffix options

Parameters

$options
string
$options

Returns

array|boolean
public string
# generateResetPasswordLinkToken( )

Generate unique token for reset password confirmation link

Generate unique token for reset password confirmation link

Returns

string
public integer
# getResetPasswordLinkExpirationPeriod( )

Retrieve customer reset password link expiration period in days

Retrieve customer reset password link expiration period in days

Returns

integer
public integer
# getDefaultCustomerGroupId( Mage_Core_Model_Store|string|integer $store = null )

Get default customer group id

Get default customer group id

Parameters

$store
Mage_Core_Model_Store|string|integer
$store

Returns

integer
public null|integer
# getCustomerGroupIdBasedOnVatNumber( string $customerCountryCode, Varien_Object $vatValidationResult, Mage_Core_Model_Store|string|integer $store = null )

Retrieve customer group ID based on his VAT number

Retrieve customer group ID based on his VAT number

Parameters

$customerCountryCode
string
$customerCountryCode
$vatValidationResult
Varien_Object
$vatValidationResult
$store
Mage_Core_Model_Store|string|integer
$store

Returns

null|integer
public Varien_Object
# checkVatNumber( string $countryCode, string $vatNumber, string $requesterCountryCode = '', string $requesterVatNumber = '' )

Send request to VAT validation service and return validation result

Send request to VAT validation service and return validation result

Parameters

$countryCode
string
$countryCode
$vatNumber
string
$vatNumber
$requesterCountryCode
string
$requesterCountryCode
$requesterVatNumber
string
$requesterVatNumber

Returns

Varien_Object
public boolean
# canCheckVatNumber( string $countryCode, string $vatNumber, string $requesterCountryCode, string $requesterVatNumber )

Check if parameters are valid to send to VAT validation service

Check if parameters are valid to send to VAT validation service

Parameters

$countryCode
string
$countryCode
$vatNumber
string
$vatNumber
$requesterCountryCode
string
$requesterCountryCode
$requesterVatNumber
string
$requesterVatNumber

Returns

boolean
public null|string
# getCustomerVatClass( string $customerCountryCode, Varien_Object $vatValidationResult, Mage_Core_Model_Store|string|integer|null $store = null )

Get VAT class

Get VAT class

Parameters

$customerCountryCode
string
$customerCountryCode
$vatValidationResult
Varien_Object
$vatValidationResult
$store
Mage_Core_Model_Store|string|integer|null
$store

Returns

null|string
public Varien_Object
# getVatValidationUserMessage( Mage_Customer_Model_Address $customerAddress, boolean $customerGroupAutoAssignDisabled, Varien_Object $validationResult )

Get validation message that will be displayed to user by VAT validation result object

Get validation message that will be displayed to user by VAT validation result object

Parameters

$customerAddress
Mage_Customer_Model_Address
$customerAddress
$customerGroupAutoAssignDisabled
boolean
$customerGroupAutoAssignDisabled
$validationResult
Varien_Object
$validationResult

Returns

Varien_Object
protected SoapClient
# _createVatNumberValidationSoapClient( boolean $trace = false )

Create SOAP client based on VAT validation service WSDL

Create SOAP client based on VAT validation service WSDL

Parameters

$trace
boolean
$trace

Returns

SoapClient
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 REFERER_QUERY_PARAM_NAME 'referer'
#

Query param name for last url visited

Query param name for last url visited

string ROUTE_ACCOUNT_LOGIN 'customer/account/login'
#

Route for customer account login page

Route for customer account login page

string XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD 'customer/startup/redirect_dashboard'
#

Config name for Redirect Customer to Account Dashboard after Logging in setting

Config name for Redirect Customer to Account Dashboard after Logging in setting

string XML_PATH_CUSTOMER_VIV_INTRA_UNION_GROUP 'customer/create_account/viv_intra_union_group'
#

Config paths to VAT related customer groups

Config paths to VAT related customer groups

string XML_PATH_CUSTOMER_VIV_DOMESTIC_GROUP 'customer/create_account/viv_domestic_group'
#
string XML_PATH_CUSTOMER_VIV_INVALID_GROUP 'customer/create_account/viv_invalid_group'
#
string XML_PATH_CUSTOMER_VIV_ERROR_GROUP 'customer/create_account/viv_error_group'
#
string XML_PATH_CUSTOMER_VIV_GROUP_AUTO_ASSIGN 'customer/create_account/viv_disable_auto_group_assign_default'
#

Config path to option that enables/disables automatic group assignment based on VAT

Config path to option that enables/disables automatic group assignment based on VAT

string XML_PATH_SUPPORT_EMAIL 'trans_email/ident_support/email'
#

Config path to support email

Config path to support email

string VAT_VALIDATION_WSDL_URL 'http://ec.europa.eu/taxation_customs/vies/services/checkVatService?wsdl'
#

WSDL of VAT validation service

WSDL of VAT validation service

string XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD 'default/customer/password/reset_link_expiration_period'
#

Configuration path to expiration period of reset password link

Configuration path to expiration period of reset password link

string VAT_CLASS_DOMESTIC 'domestic'
#

VAT class constants

VAT class constants

string VAT_CLASS_INTRA_UNION 'intra_union'
#
string VAT_CLASS_INVALID 'invalid'
#
string VAT_CLASS_ERROR 'error'
#
Properties summary
protected Mage_Customer_Model_Entity_Group_Collection $_groups
#

Customer groups collection

Customer groups collection

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