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
  1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Customer
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Customer address api V2
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Customer
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Customer_Model_Address_Api_V2 extends Mage_Customer_Model_Address_Api
 35: {
 36:     /**
 37:      * Create new address for customer
 38:      *
 39:      * @param int $customerId
 40:      * @param array $addressData
 41:      * @return int
 42:      */
 43:     public function create($customerId, $addressData)
 44:     {
 45:         $customer = Mage::getModel('customer/customer')
 46:             ->load($customerId);
 47:         /* @var $customer Mage_Customer_Model_Customer */
 48: 
 49:         if (!$customer->getId()) {
 50:             $this->_fault('customer_not_exists');
 51:         }
 52: 
 53:         $address = Mage::getModel('customer/address');
 54: 
 55:         foreach ($this->getAllowedAttributes($address) as $attributeCode=>$attribute) {
 56:             if (isset($addressData->$attributeCode)) {
 57:                 $address->setData($attributeCode, $addressData->$attributeCode);
 58:             }
 59:         }
 60: 
 61:         if (isset($addressData->is_default_billing)) {
 62:             $address->setIsDefaultBilling($addressData->is_default_billing);
 63:         }
 64: 
 65:         if (isset($addressData->is_default_shipping)) {
 66:             $address->setIsDefaultShipping($addressData->is_default_shipping);
 67:         }
 68: 
 69:         $address->setCustomerId($customer->getId());
 70: 
 71:         $valid = $address->validate();
 72: 
 73:         if (is_array($valid)) {
 74:             $this->_fault('data_invalid', implode("\n", $valid));
 75:         }
 76: 
 77:         try {
 78:             $address->save();
 79:         } catch (Mage_Core_Exception $e) {
 80:             $this->_fault('data_invalid', $e->getMessage());
 81:         }
 82: 
 83:         return $address->getId();
 84:     }
 85: 
 86:     /**
 87:      * Retrieve address data
 88:      *
 89:      * @param int $addressId
 90:      * @return array
 91:      */
 92:     public function info($addressId)
 93:     {
 94:         $address = Mage::getModel('customer/address')
 95:             ->load($addressId);
 96: 
 97:         if (!$address->getId()) {
 98:             $this->_fault('not_exists');
 99:         }
100: 
101:         $result = array();
102: 
103:         foreach ($this->_mapAttributes as $attributeAlias => $attributeCode) {
104:             $result[$attributeAlias] = $address->getData($attributeCode);
105:         }
106: 
107:         foreach ($this->getAllowedAttributes($address) as $attributeCode => $attribute) {
108:             $result[$attributeCode] = $address->getData($attributeCode);
109:         }
110: 
111: 
112:         if ($customer = $address->getCustomer()) {
113:             $result['is_default_billing']  = $customer->getDefaultBilling() == $address->getId();
114:             $result['is_default_shipping'] = $customer->getDefaultShipping() == $address->getId();
115:         }
116: 
117:         return $result;
118:     }
119: 
120:     /**
121:      * Update address data
122:      *
123:      * @param int $addressId
124:      * @param array $addressData
125:      * @return boolean
126:      */
127:     public function update($addressId, $addressData)
128:     {
129:         $address = Mage::getModel('customer/address')
130:             ->load($addressId);
131: 
132:         if (!$address->getId()) {
133:             $this->_fault('not_exists');
134:         }
135: 
136:         foreach ($this->getAllowedAttributes($address) as $attributeCode=>$attribute) {
137:             if (isset($addressData->$attributeCode)) {
138:                 $address->setData($attributeCode, $addressData->$attributeCode);
139:             }
140:         }
141: 
142:         if (isset($addressData->is_default_billing)) {
143:             $address->setIsDefaultBilling($addressData->is_default_billing);
144:         }
145: 
146:         if (isset($addressData->is_default_shipping)) {
147:             $address->setIsDefaultShipping($addressData->is_default_shipping);
148:         }
149: 
150:         $valid = $address->validate();
151:         if (is_array($valid)) {
152:             $this->_fault('data_invalid', implode("\n", $valid));
153:         }
154: 
155:         try {
156:             $address->save();
157:         } catch (Mage_Core_Exception $e) {
158:             $this->_fault('data_invalid', $e->getMessage());
159:         }
160: 
161:         return true;
162:     }
163: 
164:     /**
165:      * Delete address
166:      *
167:      * @param int $addressId
168:      * @return boolean
169:      */
170:     public function delete($addressId)
171:     {
172:         $address = Mage::getModel('customer/address')
173:             ->load($addressId);
174: 
175:         if (!$address->getId()) {
176:             $this->_fault('not_exists');
177:         }
178: 
179:         try {
180:             $address->delete();
181:         } catch (Mage_Core_Exception $e) {
182:             $this->_fault('not_deleted', $e->getMessage());
183:         }
184: 
185:         return true;
186:     }
187: } // Class Mage_Customer_Model_Address_Api End
188: 
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0