Class Mage_Customer_Model_Address_Api

Description

Customer address api

Located in /Customer/Model/Address/Api.php (line 34)

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Customer_Model_Api_Resource
      |
      --Mage_Customer_Model_Address_Api
Direct descendents
Class Description
Mage_Customer_Model_Address_Api_V2 Customer address api V2
Variable Summary
Method Summary
Mage_Customer_Model_Address_Api __construct ()
int create (int $customerId, array $addressData)
boolean delete (int $addressId)
array info (int $addressId)
array items (int $customerId)
boolean update (int $addressId, array $addressData)
Variables
mixed $_mapAttributes = array(
'customer_address_id' => 'entity_id'
)
(line 36)
  • access: protected

Inherited Variables

Inherited from Mage_Customer_Model_Api_Resource

Mage_Customer_Model_Api_Resource::$_ignoredAttributeCodes
Mage_Customer_Model_Api_Resource::$_ignoredAttributeTypes

Inherited from Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::$_resourceConfig
Methods
Constructor __construct (line 40)
  • access: public
Mage_Customer_Model_Address_Api __construct ()
create (line 93)

Create new address for customer

  • access: public
int create (int $customerId, array $addressData)
  • int $customerId
  • array $addressData

Redefined in descendants as:
delete (line 220)

Delete address

  • access: public
boolean delete (int $addressId)
  • int $addressId

Redefined in descendants as:
info (line 142)

Retrieve address data

  • access: public
array info (int $addressId)
  • int $addressId

Redefined in descendants as:
items (line 51)

Retrive customer addresses list

  • access: public
array items (int $customerId)
  • int $customerId
update (line 177)

Update address data

  • access: public
boolean update (int $addressId, array $addressData)
  • int $addressId
  • array $addressData

Redefined in descendants as:

Inherited Methods

Inherited From Mage_Customer_Model_Api_Resource

Mage_Customer_Model_Api_Resource::getAllowedAttributes()
Mage_Customer_Model_Api_Resource::_isAllowedAttribute()

Inherited From Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::getResourceConfig()
Mage_Api_Model_Resource_Abstract::setResourceConfig()
Mage_Api_Model_Resource_Abstract::_fault()
Mage_Api_Model_Resource_Abstract::_getConfig()
Mage_Api_Model_Resource_Abstract::_getServer()
Mage_Api_Model_Resource_Abstract::_getSession()

Documentation generated on Fri, 11 Feb 2011 16:56:36 +0200 by phpDocumentor 1.4.3