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 api
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Customer
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Customer_Model_Customer_Api extends Mage_Customer_Model_Api_Resource
 35: {
 36:     protected $_mapAttributes = array(
 37:         'customer_id' => 'entity_id'
 38:     );
 39:     /**
 40:      * Prepare data to insert/update.
 41:      * Creating array for stdClass Object
 42:      *
 43:      * @param stdClass $data
 44:      * @return array
 45:      */
 46:     protected function _prepareData($data)
 47:     {
 48:        foreach ($this->_mapAttributes as $attributeAlias=>$attributeCode) {
 49:             if(isset($data[$attributeAlias]))
 50:             {
 51:                 $data[$attributeCode] = $data[$attributeAlias];
 52:                 unset($data[$attributeAlias]);
 53:             }
 54:         }
 55:         return $data;
 56:     }
 57: 
 58:     /**
 59:      * Create new customer
 60:      *
 61:      * @param array $customerData
 62:      * @return int
 63:      */
 64:     public function create($customerData)
 65:     {
 66:         $customerData = $this->_prepareData($customerData);
 67:         try {
 68:             $customer = Mage::getModel('customer/customer')
 69:                 ->setData($customerData)
 70:                 ->save();
 71:         } catch (Mage_Core_Exception $e) {
 72:             $this->_fault('data_invalid', $e->getMessage());
 73:         }
 74:         return $customer->getId();
 75:     }
 76: 
 77:     /**
 78:      * Retrieve customer data
 79:      *
 80:      * @param int $customerId
 81:      * @param array $attributes
 82:      * @return array
 83:      */
 84:     public function info($customerId, $attributes = null)
 85:     {
 86:         $customer = Mage::getModel('customer/customer')->load($customerId);
 87: 
 88:         if (!$customer->getId()) {
 89:             $this->_fault('not_exists');
 90:         }
 91: 
 92:         if (!is_null($attributes) && !is_array($attributes)) {
 93:             $attributes = array($attributes);
 94:         }
 95: 
 96:         $result = array();
 97: 
 98:         foreach ($this->_mapAttributes as $attributeAlias=>$attributeCode) {
 99:             $result[$attributeAlias] = $customer->getData($attributeCode);
100:         }
101: 
102:         foreach ($this->getAllowedAttributes($customer, $attributes) as $attributeCode=>$attribute) {
103:             $result[$attributeCode] = $customer->getData($attributeCode);
104:         }
105: 
106:         return $result;
107:     }
108: 
109:     /**
110:      * Retrieve customers data
111:      *
112:      * @param  object|array $filters
113:      * @return array
114:      */
115:     public function items($filters)
116:     {
117:         $collection = Mage::getModel('customer/customer')->getCollection()->addAttributeToSelect('*');
118:         /** @var $apiHelper Mage_Api_Helper_Data */
119:         $apiHelper = Mage::helper('api');
120:         $filters = $apiHelper->parseFilters($filters, $this->_mapAttributes);
121:         try {
122:             foreach ($filters as $field => $value) {
123:                 $collection->addFieldToFilter($field, $value);
124:             }
125:         } catch (Mage_Core_Exception $e) {
126:             $this->_fault('filters_invalid', $e->getMessage());
127:         }
128:         $result = array();
129:         foreach ($collection as $customer) {
130:             $data = $customer->toArray();
131:             $row  = array();
132:             foreach ($this->_mapAttributes as $attributeAlias => $attributeCode) {
133:                 $row[$attributeAlias] = (isset($data[$attributeCode]) ? $data[$attributeCode] : null);
134:             }
135:             foreach ($this->getAllowedAttributes($customer) as $attributeCode => $attribute) {
136:                 if (isset($data[$attributeCode])) {
137:                     $row[$attributeCode] = $data[$attributeCode];
138:                 }
139:             }
140:             $result[] = $row;
141:         }
142: 
143:         return $result;
144:     }
145: 
146:     /**
147:      * Update customer data
148:      *
149:      * @param int $customerId
150:      * @param array $customerData
151:      * @return boolean
152:      */
153:     public function update($customerId, $customerData)
154:     {
155:         $customerData = $this->_prepareData($customerData);
156: 
157:         $customer = Mage::getModel('customer/customer')->load($customerId);
158: 
159:         if (!$customer->getId()) {
160:             $this->_fault('not_exists');
161:         }
162: 
163:         foreach ($this->getAllowedAttributes($customer) as $attributeCode=>$attribute) {
164:             if (isset($customerData[$attributeCode])) {
165:                 $customer->setData($attributeCode, $customerData[$attributeCode]);
166:             }
167:         }
168: 
169:         $customer->save();
170:         return true;
171:     }
172: 
173:     /**
174:      * Delete customer
175:      *
176:      * @param int $customerId
177:      * @return boolean
178:      */
179:     public function delete($customerId)
180:     {
181:         $customer = Mage::getModel('customer/customer')->load($customerId);
182: 
183:         if (!$customer->getId()) {
184:             $this->_fault('not_exists');
185:         }
186: 
187:         try {
188:             $customer->delete();
189:         } catch (Mage_Core_Exception $e) {
190:             $this->_fault('not_deleted', $e->getMessage());
191:         }
192: 
193:         return true;
194:     }
195: 
196: } // Class Mage_Customer_Model_Customer_Api End
197: 
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0