Docs For Class Mage_Customer_Model

Description

Customer Form Model

author: Magento Core Team <[email protected]>

Located in /Customer/Model/Form.php (line 35)

Variable Summary

array $_attributes

Mage_Core_Model_Abstract $_entity

Mage_Eav_Model_Entity_Type $_entityType

string $_formCode

bool $_ignoreInvisible

boolean $_isAjax

Mage_Core_Model_Store $_store

array $_systemAttributes

array $_userAttributes

Method Summary

Mage_Customer_Model_Form compactData ( $data)

array extractData ( $request, [string $scope = null], [boolean $scopeOnly = true])

Mage_Eav_Model_Entity_Attribute|false getAttribute (string $attributeCode)

array getAttributes ()

Mage_Core_Model_Abstract getEntity ()

Mage_Eav_Model_Entity_Type getEntityType ()

string getFormCode ()

boolean getIsAjaxRequest ()

Mage_Core_Model_Store getStore ()

array getSystemAttributes ()

array getUserAttributes ()

bool|Mage_Customer_Model_Form ignoreInvisible ([$setValue $setValue = null])

Mage_Customer_Model_Form initDefaultValues ()

array outputData ([string $format = Mage_Customer_Model_Attribute_Data::OUTPUT_FORMAT_TEXT])

Zend_Controller_Request_Http prepareRequest ( $data)

Mage_Customer_Model_Form resetEntityData ()

Mage_Customer_Model_Form restoreData ( $data)

Mage_Customer_Model_Form setEntity ( $entity)

Mage_Customer_Model_Form setEntityType (Mage_Eav_Model_Entity_Type|string|int $entityType)

Mage_Customer_Model_Form setFormCode (string $formCode)

Mage_Customer_Model_Form setIsAjaxRequest ([boolean $flag = true])

Mage_Customer_Model_Form setStore (Mage_Core_Model_Store|string|int $store)

boolean|array validateData ( $data)

Mage_Customer_Model_Attribute_Data_Abstract _getAttributeDataModel ( $attribute)

bool _isAttributeOmitted (Mage_Customer_Model_Attribute $attribute)

Variables

array $_attributes (line 70)

Array of form attributes

access: protected

Mage_Core_Model_Abstract $_entity (line 56)

Current entity instance

access: protected

Mage_Eav_Model_Entity_Type $_entityType (line 49)

Current entity type instance

access: protected

string $_formCode (line 63)

Current form code

access: protected

bool $_ignoreInvisible = true (line 98)

Whether the invisible form fields need to be filtered/ignored

access: protected

boolean $_isAjax = false (line 91)

Is AJAX request flag

access: protected

Mage_Core_Model_Store $_store (line 42)

Current store instance

access: protected

array $_systemAttributes (line 77)

Array of form system attributes

access: protected

array $_userAttributes (line 84)

Array of form user defined attributes

access: protected

Methods

compactData (line 369)

Compact data array to current entity

access: public

Mage_Customer_Model_Form compactData ( $data)

array $data

extractData (line 317)

Extract data from request and return associative data array

access: public

array extractData ( $request, [string $scope = null], [boolean $scopeOnly = true])

Zend_Controller_Request_Http $request
string $scope: the request scope
boolean $scopeOnly: search value only in scope or search value in global too

getAttribute (line 242)

Return attribute instance by code or false

access: public

Mage_Eav_Model_Entity_Attribute|false getAttribute (string $attributeCode)

string $attributeCode

getAttributes (line 211)

Return array of form attributes

access: public

array getAttributes ()

getEntity (line 198)

Return current entity instance

throws: Mage_Core_Exception
access: public

Mage_Core_Model_Abstract getEntity ()

getEntityType (line 184)

Return entity type instance Return customer entity type if entity type is not defined

access: public

Mage_Eav_Model_Entity_Type getEntityType ()

getFormCode (line 170)

Return current form code

throws: Mage_Core_Exception
access: public

string getFormCode ()

getIsAjaxRequest (line 462)

Return is AJAX Request

access: public

boolean getIsAjaxRequest ()

getStore (line 156)

Return current store instance

access: public

Mage_Core_Model_Store getStore ()

getSystemAttributes (line 270)

Return array of form system attributes

access: public

array getSystemAttributes ()

getUserAttributes (line 256)

Return array of form user defined attributes

access: public

array getUserAttributes ()

ignoreInvisible (line 491)

Combined getter/setter whether to omit invisible attributes during rendering/validation

access: public

bool|Mage_Customer_Model_Form ignoreInvisible ([$setValue $setValue = null])

$setValue $setValue

initDefaultValues (line 472)

Set default attribute values for new entity

access: public

Mage_Customer_Model_Form initDefaultValues ()

outputData (line 414)

Return array of entity formated values

access: public

array outputData ([string $format = Mage_Customer_Model_Attribute_Data::OUTPUT_FORMAT_TEXT])

string $format

prepareRequest (line 299)

Prepare request with data and returns it

access: public

Zend_Controller_Request_Http prepareRequest ( $data)

array $data

resetEntityData (line 433)

Restore entity original data

access: public

Mage_Customer_Model_Form resetEntityData ()

restoreData (line 392)

Restore data array from SESSION to current entity

access: public

Mage_Customer_Model_Form restoreData ( $data)

array $data

setEntity (line 118)

Set entity instance

access: public

Mage_Customer_Model_Form setEntity ( $entity)

Mage_Core_Model_Abstract $entity

setEntityType (line 133)

Set entity type instance

access: public

Mage_Customer_Model_Form setEntityType (Mage_Eav_Model_Entity_Type|string|int $entityType)

Mage_Eav_Model_Entity_Type|string|int $entityType

setFormCode (line 145)

Set form code

access: public

Mage_Customer_Model_Form setFormCode (string $formCode)

string $formCode

setIsAjaxRequest (line 451)

Set is AJAX Request flag

access: public

Mage_Customer_Model_Form setIsAjaxRequest ([boolean $flag = true])

boolean $flag

setStore (line 106)

Set current store

access: public

Mage_Customer_Model_Form setStore (Mage_Core_Model_Store|string|int $store)

Mage_Core_Model_Store|string|int $store

validateData (line 338)

Validate data array and return true or array of errors

access: public

boolean|array validateData ( $data)

array $data

_getAttributeDataModel (line 285)

Return attribute data model by attribute

access: protected

Mage_Customer_Model_Attribute_Data_Abstract _getAttributeDataModel ( $attribute)

Mage_Eav_Model_Entity_Attribute $attribute

_isAttributeOmitted (line 506)

Whether the specified attribute needs to skip rendering/validation

access: protected

bool _isAttributeOmitted (Mage_Customer_Model_Attribute $attribute)

Mage_Customer_Model_Attribute $attribute

Class Mage_Customer_Model_Form