Class Mage_Customer_Model_Customer

Customer model

Varien_Object

Mage_Customer_Model_Customer

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

Methods summary
`public`	# `_construct( )` Initialize customer model Initialize customer model
`public Mage_Customer_Model_Config_Share`	# `getSharingConfig( )` Retrieve customer sharing configuration model Retrieve customer sharing configuration model Returns `Mage_Customer_Model_Config_Share`
`public true`	# `authenticate( string $login, string $password )` Authenticate customer Authenticate customer Parameters `$login` `string` $login `$password` `string` $password Returns `true` Throws `Mage_Core_Exception`
`public Mage_Customer_Model_Customer`	# `loadByEmail( string $customerEmail )` Load customer by email Load customer by email Parameters `$customerEmail` `string` $customerEmail Returns `Mage_Customer_Model_Customer`
`protected Mage_Customer_Model_Customer`	# `_beforeSave( )` Processing object before save data Processing object before save data Returns `Mage_Customer_Model_Customer` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public Mage_Customer_Model_Customer`	# `changePassword( string $newPassword )` Change customer password Change customer password Parameters `$newPassword` `string` $newPassword Returns `Mage_Customer_Model_Customer`
`public string`	# `getName( )` Get full customer name Get full customer name Returns `string`
`public Mage_Customer_Model_Customer`	# `addAddress( Mage_Customer_Model_Address $address )` Add address to address collection Add address to address collection Parameters `$address` `Mage_Customer_Model_Address` $address Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Address`	# `getAddressById( integer $addressId )` Retrieve customer address by address id Retrieve customer address by address id Parameters `$addressId` `integer` $addressId Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Address`	# `getAddressItemById( integer $addressId )` Getting customer address object from collection by identifier Getting customer address object from collection by identifier Parameters `$addressId` `integer` $addressId Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Entity_Address_Collection`	# `getAddressCollection( )` Retrieve not loaded address collection Retrieve not loaded address collection Returns `Mage_Customer_Model_Entity_Address_Collection`
`public Mage_Customer_Model_Entity_Address_Collection`	# `getAddressesCollection( )` Customer addresses collection Customer addresses collection Returns `Mage_Customer_Model_Entity_Address_Collection`
`public array`	# `getAddresses( )` Retrieve customer address array Retrieve customer address array Returns `array`
`public array`	# `getAttributes( )` Retrieve all customer attributes Retrieve all customer attributes Returns `array`
`public Mage_Customer_Model_Entity_Attribute`	# `getAttribute( string $attributeCode )` Get customer attribute model object Get customer attribute model object Parameters `$attributeCode` `string` $attributeCode Returns `Mage_Customer_Model_Entity_Attribute` \| null
`public Mage_Customer_Model_Customer`	# `setPassword( string $password )` Set plain and hashed password Set plain and hashed password Parameters `$password` `string` $password Returns `Mage_Customer_Model_Customer`
`public string`	# `hashPassword( string $password, integer $salt = null )` Hash customer password Hash customer password Parameters `$password` `string` $password `$salt` `integer` $salt Returns `string`
`public string`	# `generatePassword( integer $length = 8 )` Retrieve random password Retrieve random password Parameters `$length` `integer` $length Returns `string`
`public boolean`	# `validatePassword( string $password )` Validate password with salted hash Validate password with salted hash Parameters `$password` `string` $password Returns `boolean`
`public string`	# `encryptPassword( string $password )` Encrypt password Encrypt password Parameters `$password` `string` $password Returns `string`
`public string`	# `decryptPassword( string $password )` Decrypt password Decrypt password Parameters `$password` `string` $password Returns `string`
`public Mage_Customer_Model_Address`	# `getPrimaryAddress( string $attributeCode )` Retrieve default address by type(attribute) Retrieve default address by type(attribute) Parameters `$attributeCode` `string` $attributeCode address type attribute code Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Address`	# `getPrimaryBillingAddress( )` Get customer default billing address Get customer default billing address Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Address`	# `getDefaultBillingAddress( )` Get customer default billing address Get customer default billing address Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Address`	# `getPrimaryShippingAddress( )` Get default customer shipping address Get default customer shipping address Returns `Mage_Customer_Model_Address`
`public Mage_Customer_Model_Address`	# `getDefaultShippingAddress( )` Get default customer shipping address Get default customer shipping address Returns `Mage_Customer_Model_Address`
`public array`	# `getPrimaryAddressIds( )` Retrieve ids of default addresses Retrieve ids of default addresses Returns `array`
`public array`	# `getPrimaryAddresses( )` Retrieve all customer default addresses Retrieve all customer default addresses Returns `array`
`public array`	# `getAdditionalAddresses( )` Retrieve not default addresses Retrieve not default addresses Returns `array`
`public boolean`	# `isAddressPrimary( Mage_Customer_Model_Address $address )` Check if address is primary Check if address is primary Parameters `$address` `Mage_Customer_Model_Address` $address Returns `boolean`
`public Mage_Customer_Model_Customer`	# `sendNewAccountEmail( string $type = 'registered', string $backUrl = '', string $storeId = '0' )` Send email with new account related information Send email with new account related information Parameters `$type` `string` $type `$backUrl` `string` $backUrl `$storeId` `string` $storeId Returns `Mage_Customer_Model_Customer` Throws `Mage_Core_Exception`
`public boolean`	# `isConfirmationRequired( )` Check if accounts confirmation is required in config Check if accounts confirmation is required in config Returns `boolean`
`public string`	# `getRandomConfirmationKey( )` Generate random confirmation key Generate random confirmation key Returns `string`
`public Mage_Customer_Model_Customer`	# `sendPasswordReminderEmail( )` Send email with new customer password Send email with new customer password Returns `Mage_Customer_Model_Customer`
`protected Mage_Customer_Model_Customer`	# `_sendEmailTemplate( string $template, string $sender, array $templateParams = array(), integer\|null $storeId = null )` Send corresponding email template Send corresponding email template Parameters `$template` `string` $emailTemplate configuration path of email template `$sender` `string` $emailSender configuration path of email identity `$templateParams` `array` $templateParams `$storeId` `integer\|null` $storeId Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Customer`	# `sendPasswordResetConfirmationEmail( )` Send email with reset password confirmation link Send email with reset password confirmation link Returns `Mage_Customer_Model_Customer`
`public integer`	# `getGroupId( )` Retrieve customer group identifier Retrieve customer group identifier Returns `integer`
`public integer`	# `getTaxClassId( )` Retrieve customer tax class identifier Retrieve customer tax class identifier Returns `integer`
`public boolean`	# `isInStore( Mage_Core_Model_Store $store )` Check store availability for customer Check store availability for customer Parameters `$store` `Mage_Core_Model_Store` \| int $store Returns `boolean`
`public Mage_Core_Model_Store`	# `getStore( )` Retrieve store where customer was created Retrieve store where customer was created Returns `Mage_Core_Model_Store`
`public array`	# `getSharedStoreIds( )` Retrieve shared store ids Retrieve shared store ids Returns `array`
`public array`	# `getSharedWebsiteIds( )` Retrive shared website ids Retrive shared website ids Returns `array`
`public Mage_Customer_Model_Customer`	# `setStore( Mage_Core_Model_Store $store )` Set store to customer Set store to customer Parameters `$store` `Mage_Core_Model_Store` $store Returns `Mage_Customer_Model_Customer`
`public boolean`	# `validate( )` Validate customer attribute values. For existing customer password + confirmation will be validated only when password is set (i.e. its change is requested) Validate customer attribute values. For existing customer password + confirmation will be validated only when password is set (i.e. its change is requested) Returns `boolean`
`public Mage_Customer_Model_Customer`	# `importFromTextArray( array $row )` Import customer data from text array Import customer data from text array Parameters `$row` `array` $row Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Customer`	# `unsetSubscription( )` Unset subscription Unset subscription Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Customer`	# `cleanAllAddresses( )` Clean all addresses Clean all addresses Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Customer`	# `addError( mixed $error )` Add error Add error Returns `Mage_Customer_Model_Customer`
`public array`	# `getErrors( )` Retreive errors Retreive errors Returns `array`
`public Mage_Customer_Model_Customer`	# `resetErrors( )` Reset errors array Reset errors array Returns `Mage_Customer_Model_Customer`
`public boolean`	# `printError( mixed $error, mixed $line = null )` Print error Print error Parameters `$error` `mixed` $error `$line` `mixed` $line Returns `boolean`
`public boolean`	# `validateAddress( array $data, string $type = 'billing' )` Validate address Validate address Parameters `$data` `array` $data `$type` `string` $type Returns `boolean`
`protected Mage_Core_Model_Abstract`	# `_beforeDelete( )` Prepare customer for delete Prepare customer for delete Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`public integer\|null`	# `getCreatedAtTimestamp( )` Get customer created at date timestamp Get customer created at date timestamp Returns `integer\|null`
`public Mage_Customer_Model_Customer`	# `reset( )` Reset all model data Reset all model data Returns `Mage_Customer_Model_Customer`
`public boolean`	# `isDeleteable( )` Checks model is deleteable Checks model is deleteable Returns `boolean`
`public Mage_Customer_Model_Customer`	# `setIsDeleteable( boolean $value )` Set is deleteable flag Set is deleteable flag Parameters `$value` `boolean` $value Returns `Mage_Customer_Model_Customer`
`public boolean`	# `isReadonly( )` Checks model is readonly Checks model is readonly Returns `boolean`
`public Mage_Customer_Model_Customer`	# `setIsReadonly( boolean $value )` Set is readonly flag Set is readonly flag Parameters `$value` `boolean` $value Returns `Mage_Customer_Model_Customer`
`public boolean`	# `canSkipConfirmation( )` Check whether confirmation may be skipped when registering using certain email address Check whether confirmation may be skipped when registering using certain email address Returns `boolean`
`public`	# `__clone( )` Clone current object Clone current object
`public Mage_Eav_Model_Entity_Type`	# `getEntityType( )` Return Entity Type instance Return Entity Type instance Returns `Mage_Eav_Model_Entity_Type`
`public integer`	# `getEntityTypeId( )` Return Entity Type ID Return Entity Type ID Returns `integer`
`protected integer`	# `_getWebsiteStoreId( integer\|string\|null $defaultStoreId = null )` Get either first store ID from a set website or the provided as default Get either first store ID from a set website or the provided as default Parameters `$defaultStoreId` `integer\|string\|null` $storeId Returns `integer`
`public Mage_Customer_Model_Customer`	# `changeResetPasswordLinkToken( string $newResetPasswordLinkToken )` Change reset password link token Change reset password link token Stores new reset password link token Parameters `$newResetPasswordLinkToken` `string` $newResetPasswordLinkToken Returns `Mage_Customer_Model_Customer`
`public boolean`	# `isResetPasswordLinkTokenExpired( )` Check if current reset password link token is expired Check if current reset password link token is expired Returns `boolean`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`string`	`XML_PATH_REGISTER_EMAIL_TEMPLATE`	`'customer/create_account/email_template'`	# Configuration pathes for email templates and identities Configuration pathes for email templates and identities
`string`	`XML_PATH_REGISTER_EMAIL_IDENTITY`	`'customer/create_account/email_identity'`	#
`string`	`XML_PATH_REMIND_EMAIL_TEMPLATE`	`'customer/password/remind_email_template'`	#
`string`	`XML_PATH_FORGOT_EMAIL_TEMPLATE`	`'customer/password/forgot_email_template'`	#
`string`	`XML_PATH_FORGOT_EMAIL_IDENTITY`	`'customer/password/forgot_email_identity'`	#
`string`	`XML_PATH_DEFAULT_EMAIL_DOMAIN`	`'customer/create_account/email_domain'`	#
`string`	`XML_PATH_IS_CONFIRM`	`'customer/create_account/confirm'`	#
`string`	`XML_PATH_CONFIRM_EMAIL_TEMPLATE`	`'customer/create_account/email_confirmation_template'`	#
`string`	`XML_PATH_CONFIRMED_EMAIL_TEMPLATE`	`'customer/create_account/email_confirmed_template'`	#
`string`	`XML_PATH_GENERATE_HUMAN_FRIENDLY_ID`	`'customer/create_account/generate_human_friendly_id'`	#
`integer`	`EXCEPTION_EMAIL_NOT_CONFIRMED`	`1`	# Codes of exceptions related to customer model Codes of exceptions related to customer model
`integer`	`EXCEPTION_INVALID_EMAIL_OR_PASSWORD`	`2`	#
`integer`	`EXCEPTION_EMAIL_EXISTS`	`3`	#
`integer`	`EXCEPTION_INVALID_RESET_PASSWORD_LINK_TOKEN`	`4`	#
`string`	`SUBSCRIBED_YES`	`'yes'`	#
`string`	`SUBSCRIBED_NO`	`'no'`	#

Properties summary
`protected string`	`$_eventPrefix`	`'customer'`	# Model event prefix Model event prefix
`protected string`	`$_eventObject`	`'customer'`	# Name of the event object Name of the event object
`protected array`	`$_errors`	`array()`	# List of errors List of errors
`protected array`	`$_attributes`		# Assoc array of customer attributes Assoc array of customer attributes
`protected Mage_Customer_Model_Entity_Address_Collection`	`$_addressesCollection`		# Customer addresses collection Customer addresses collection
`protected boolean`	`$_isDeleteable`	`true`	# Is model deleteable Is model deleteable
`protected boolean`	`$_isReadonly`	`false`	# Is model readonly Is model readonly
`private static boolean`	`$_isConfirmationRequired`		# Confirmation requirement flag Confirmation requirement flag

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Exceptions

Class Mage_Customer_Model_Customer

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters