Documentation

Mage_Customer_Model_Attribute extends Mage_Eav_Model_Attribute
in package

Mage

Customer

Customer attribute model

Constants

ATTRIBUTE_CODE_MAX_LENGTH : mixed = 64
CACHE_TAG : mixed = 'EAV_ATTRIBUTE'
MODULE_NAME : mixed = 'Mage_Customer': Name of the module
TYPE_STATIC : mixed = 'static'

Properties

$_attributeIdCache : array<string|int, mixed>: Attribute id cache
$_attributeValidationPassed : bool: Attribute validation flag
$_backend : Mage_Eav_Model_Entity_Attribute_Backend_Abstract|null: Backend instance
$_cacheTag : mixed
$_data : array<string|int, mixed>|null: Object attributes
$_dataSaveAllowed : bool: Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped
$_dataTable : string: Attribute data table name
$_dirty : array<string|int, mixed>
$_entity : Mage_Eav_Model_Entity_Abstract: Entity instance
$_eventObject : string: Prefix of model events object
$_eventPrefix : string: Prefix of model events names
$_frontend : Mage_Eav_Model_Entity_Attribute_Frontend_Abstract|null: Frontend instance
$_hasDataChanges : bool: Data changes flag (true after setData|unsetData call)
$_idFieldName : string: Name of object id field
$_isDeleted : bool: Object delete flag
$_isObjectNew : bool|null: Flag which allow detect object state: is it new object (without id) or existing one (with id)
$_name : string: Attribute name
$_oldFieldsMap : array<string|int, mixed>: Map short fields names to its full names
$_origData : array<string|int, mixed>|null: Original data that was loaded
$_resource : Mage_Core_Model_Resource_Db_Abstract: Resource model instance
$_resourceCollectionName : string: Name of the resource collection model
$_resourceName : string: Name of the resource model
$_source : Mage_Eav_Model_Entity_Attribute_Source_Abstract|null: Source instance
$_syncFieldsMap : mixed: Map of fields to sync to other fields upon changing their data
$_underscoreCache : array<string|int, mixed>: Setter/Getter underscore transformation cache
$_website : Mage_Core_Model_Website|null: Active Website instance

Methods

__call() : mixed: Set/Get attribute wrapper
__construct() : mixed: Constructor
__get() : mixed: Attribute getter (deprecated)
__set() : mixed: Attribute setter (deprecated)
__toArray() : array<string|int, mixed>: Convert object attributes to array
_getResource() : Mage_Customer_Model_Resource_Attribute: Get resource instance
addData() : $this: Add data to the object.
afterCommitCallback() : $this: Callback function which called after transaction commit in resource model
afterLoad() : $this: Object after load processing. Implemented as public interface for supporting objects after load in collections
cleanModelCache() : $this: Remove model object related cache
clearInstance() : $this: Clearing object for correct deleting by garbage collector
dataHasChangedFor() : bool: Compare object data with original data
debug() : string|array<string|int, mixed>: Present object data as string in debug mode
delete() : $this: Delete object from database
deleteEntity() : Mage_Eav_Model_Resource_Entity_Attribute: Delete entity
flagDirty() : $this
getAlias() : string: Get attribute alias as "entity_type/attribute_code"
getApplyTo() : array<string|int, mixed>
getAttributeCode() : mixed
getAttributeCodesByFrontendType() : array<string|int, mixed>: Retrieve attribute codes by frontend type
getAttributeGroupId() : int|null
getAttributeId() : int|null: Get attribute identifier
getAttributeModel() : mixed
getAttributeSetId() : mixed
getAttributeSetInfo() : array<string|int, mixed>|null
getBackend() : Mage_Eav_Model_Entity_Attribute_Backend_Abstract: Retrieve backend instance
getBackendModel() : mixed
getBackendTable() : string: Get attribute backend table name
getBackendType() : mixed
getBackendTypeByInput() : string: Detect backend storage type using frontend input type
getBillingAddress() : Mage_Customer_Model_Address_Abstract|null
getCacheIdTags() : array<string|int, mixed>|false: Get cache tags associated with object id
getCacheTags() : array<string|int, mixed>|false: Get list of cache tags applied to model object.
getCollection() : Mage_Customer_Model_Resource_Attribute_Collection
getConfig() : $this: Retrieve attribute configuration (deprecated)
getCreatedAt() : string|null
getData() : mixed: Object data getter
getDataByKey() : mixed: Get object data by particular key
getDataByPath() : mixed: Get object data by path
getDataSetDefault() : mixed: Fast get data or set default if value is not available
getDataUsingMethod() : mixed: Get object data by key with calling getter method
getDefaultSourceModel() : string: Get default source model
getDefaultValue() : mixed: Return default value for attribute
getDefaultValueByInput() : string: Detect default value using frontend input type
getEntity() : Mage_Eav_Model_Entity_Abstract: Retrieve entity instance
getEntityAttributeId() : int|null
getEntityId() : int
getEntityIdField() : string: Retrieve entity type
getEntityType() : Mage_Eav_Model_Entity_Type: Retrieve entity type
getEntityTypeId() : mixed
getFilterOptions() : array<string|int, mixed>|null
getFrontend() : Mage_Eav_Model_Entity_Attribute_Frontend_Abstract: Retrieve frontend instance
getFrontendClass() : string|null
getFrontendInput() : string|null
getFrontendLabel() : array<string|int, mixed>|string|null
getFrontendModel() : string|null
getId() : int|string|null: Retrieve model object identifier
getIdByCode() : int: Return attribute id
getIdFieldName() : string: Retrieve identifier field name for model
getIsConfigurable() : bool|null
getIsFilterable() : int|null
getIsFilterableInSearch() : bool|null
getIsRequired() : bool|null: Return is attribute value required
getIsSearchable() : bool|null
getIsUnique() : bool|null
getIsUserDefined() : bool|null
getIsVisible() : bool|null: Return is visible attribute flag
getIsVisibleInAdvancedSearch() : bool|null
getIsVisibleOnFront() : mixed
getMultilineCount() : mixed: Return count of lines for multiply line attribute
getName() : string: Get attribute name
getOrigData() : mixed: Get object loaded data (original data)
getResource() : Mage_Customer_Model_Resource_Attribute: Retrieve model resource
getResourceCollection() : Mage_Eav_Model_Resource_Entity_Attribute_Collection: Get collection instance
getResourceName() : string: Retrieve model resource name
getScopeMultilineCount() : int|null
getShippingAddress() : Mage_Customer_Model_Address_Abstract|null
getSortOrder() : int|null
getSource() : Mage_Eav_Model_Entity_Attribute_Source_Abstract: Retrieve source instance
getSourceModel() : string|null
getStoreId() : int|null
getStoreLabel() : string|null: Return store label of attribute
getStoreLabels() : array<string|int, mixed>: Return array of labels of stores
getUsedForSortBy() : bool|null
getUsedInForms() : array<string|int, mixed>: Return forms in which the attribute
getValidateRules() : array<string|int, mixed>
getWebsite() : Mage_Core_Model_Website: Return active website instance
hasAttributeSetInfo() : bool
hasData() : bool: If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges() : bool: Get data change status
hasErrors() : bool
hasIsVisible() : bool
isAttributeValidationPassed() : bool: Check if attribute is valid
isDeleted() : bool: Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty() : bool
isEmpty() : bool: checks whether the object is empty
isInGroup() : bool: Check if attribute in specified group
isInSet() : bool: Check if attribute in specified set
isModuleEnabled() : bool
isObjectNew() : bool: Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction
isStatic() : bool: Check if attribute is static
isValueEmpty() : bool
jsonSerialize() : array<string|int, mixed>: Implementation of JsonSerializable::jsonSerialize()
load() : $this: Load object data
loadByCode() : $this: Load attribute data by code
loadEntityAttributeIdBySet() : $this: Load entity_attribute_id into $this by $this->attribute_set_id
offsetExists() : bool: Implementation of ArrayAccess::offsetExists()
offsetGet() : mixed: Implementation of ArrayAccess::offsetGet()
offsetSet() : void: Implementation of ArrayAccess::offsetSet()
offsetUnset() : void: Implementation of ArrayAccess::offsetUnset()
save() : $this: Save object data
serialize() : string: serialize object attributes
setAttribute() : $this
setAttributeCode() : $this
setAttributeGroupId() : static
setAttributeId() : $this: Specify attribute identifier
setAttributeModel() : $this
setAttributeSetId() : $this
setAttributeSetInfo() : static
setAttributeValidationAsPassed() : mixed: Mark current attribute as passed validation
setBackendModel() : $this
setBackendTable() : $this
setBackendType() : $this
setCreatedAt() : static
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setDefaultValue() : static
setEntity() : $this: Set attribute entity instance
setEntityAttributeId() : static
setEntityType() : $this
setEntityTypeId() : $this
setFrontendLabel() : static
setFrontendModel() : static
setId() : $this: Declare model object identifier value
setIdFieldName() : $this: set name of object id field
setIsFilterable() : static
setIsGlobal() : static
setName() : $this: Set attribute name
setOrigData() : $this: Initialize object original data
setScopeIsRequired() : static
setScopeIsVisible() : static
setScopeMultilineCount() : static
setSortOrder() : static
setSourceModel() : static
setStoreId() : static
setUpdatedAt() : static
setValidateRules() : static
setWebsite() : Mage_Eav_Model_Attribute: Set active website instance
toArray() : array<string|int, mixed>: Public wrapper for __toArray
toJson() : string: Public wrapper for __toJson
toString() : string: Public wrapper for __toString
toXml() : string: Public wrapper for __toXml
unsetData() : $this: Unset data from the object.
unsetOldData() : $this: Unset old fields data from the object.
unsIsVisible() : $this
usesSource() : bool
__toJson() : string: Convert object attributes to JSON
__toXml() : string: Convert object attributes to XML
_addFullNames() : mixed
_afterDelete() : $this: Processing object after delete data
_afterDeleteCommit() : $this: Processing manipulation after main transaction commit
_afterLoad() : $this: Processing object after load data
_afterSave() : $this: Save additional data
_beforeDelete() : $this: Processing object before delete data
_beforeLoad() : $this: Processing object before load data
_beforeSave() : $this: Processing object before save data
_camelize() : string
_clearData() : $this: Clearing object's data
_clearReferences() : $this: Clearing cyclic references
_construct() : void: Init resource model
_getData() : mixed: Get value from _data array without parse key
_getDefaultBackendModel() : string: Retrieve default attribute backend model by attribute code
_getDefaultFrontendModel() : string: Retrieve default attribute frontend model
_getDefaultSourceModel() : string: Retrieve default attribute source model
_getEventData() : array<string|int, mixed>: Get array of objects transferred to default events processing
_getScopeValue() : mixed: Return scope value by key
_hasModelChanged() : bool: Check whether model has changed data.
_init() : mixed: Standard model initialization
_initOldFieldsMap() : mixed: Inits mapping array of object's previously used fields to new fields.
_prepareArray() : array<string|int, mixed>: Set required array elements
_prepareSyncFieldsMap() : $this: Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_protectFromNonAdmin() : mixed: Safeguard func that will check, if we are in admin area
_setResourceModel() : mixed: Set resource names
_underscore() : string: Converts field names for setters and getters

ATTRIBUTE_CODE_MAX_LENGTH


    public
        mixed
    ATTRIBUTE_CODE_MAX_LENGTH
    = 64

CACHE_TAG


    public
        mixed
    CACHE_TAG
    = 'EAV_ATTRIBUTE'

MODULE_NAME

Name of the module


    public
        mixed
    MODULE_NAME
    = 'Mage_Customer'

TYPE_STATIC


    public
        mixed
    TYPE_STATIC
    = 'static'

$_attributeIdCache

Attribute id cache


        protected
            array<string|int, mixed>
    $_attributeIdCache
     = []

$_attributeValidationPassed

Attribute validation flag


        protected
            bool
    $_attributeValidationPassed
     = \false

$_backend

Backend instance


        protected
            Mage_Eav_Model_Entity_Attribute_Backend_Abstract|null
    $_backend

$_cacheTag


        protected
            mixed
    $_cacheTag
     = 'EAV_ATTRIBUTE'

#[Override]

$_data

Object attributes


        protected
            array<string|int, mixed>|null
    $_data
     = []

$_dataSaveAllowed

Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped


        protected
            bool
    $_dataSaveAllowed
     = \true

$_dataTable

Attribute data table name


        protected
            string
    $_dataTable
     = \null

$_dirty


        protected
            array<string|int, mixed>
    $_dirty

$_entity

Entity instance


        protected
            Mage_Eav_Model_Entity_Abstract
    $_entity

$_eventObject

Prefix of model events object


        protected
            string
    $_eventObject
     = 'attribute'

#[Override]

$_eventPrefix

Prefix of model events names


        protected
            string
    $_eventPrefix
     = 'customer_entity_attribute'

#[Override]

$_frontend

Frontend instance


        protected
            Mage_Eav_Model_Entity_Attribute_Frontend_Abstract|null
    $_frontend

$_hasDataChanges

Data changes flag (true after setData|unsetData call)


        protected
            bool
    $_hasDataChanges
     = false

$_idFieldName

Name of object id field


        protected
            string
    $_idFieldName
     = null

$_isDeleted

Object delete flag


        protected
            bool
    $_isDeleted
     = false

$_isObjectNew

Flag which allow detect object state: is it new object (without id) or existing one (with id)


        protected
            bool|null
    $_isObjectNew
     = \null

$_name

Attribute name


        protected
            string
    $_name

$_oldFieldsMap

Map short fields names to its full names


        protected
            array<string|int, mixed>
    $_oldFieldsMap
     = []

$_origData

Original data that was loaded


        protected
            array<string|int, mixed>|null
    $_origData

$_resource

Resource model instance


        protected
            Mage_Core_Model_Resource_Db_Abstract
    $_resource

$_resourceCollectionName

Name of the resource collection model


        protected
            string
    $_resourceCollectionName

$_resourceName

Name of the resource model


        protected
            string
    $_resourceName

$_source

Source instance


        protected
            Mage_Eav_Model_Entity_Attribute_Source_Abstract|null
    $_source

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data


        protected
            mixed
    $_syncFieldsMap
     = []

$_underscoreCache

Setter/Getter underscore transformation cache


        protected
        static    array<string|int, mixed>
    $_underscoreCache
     = []

$_website

Active Website instance


        protected
            Mage_Core_Model_Website|null
    $_website

__call()

Set/Get attribute wrapper


    public
                    __call(string $method, array<string|int, mixed> $args) : mixed

Parameters

$method : string
$args : array<string|int, mixed>

__construct()

Constructor


    public
                    __construct() : mixed

By default, is looking for first argument as array and assigns it as object attributes This behaviour may change in child classes

__get()

Attribute getter (deprecated)


    public
                    __get(string $var) : mixed

Parameters

$var : string

__set()

Attribute setter (deprecated)


    public
                    __set(string $var, mixed $value) : mixed

Parameters

$var : string
$value : mixed

__toArray()

Convert object attributes to array


    public
                    __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

array<string|int, mixed>

_getResource()

Get resource instance


    public
                    _getResource() : Mage_Customer_Model_Resource_Attribute

Return values

Mage_Customer_Model_Resource_Attribute

addData()

Add data to the object.


    public
                    addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters

$arr : array<string|int, mixed>

Return values

$this

afterCommitCallback()

Callback function which called after transaction commit in resource model


    public
                    afterCommitCallback() : $this

Return values

$this

afterLoad()

Object after load processing. Implemented as public interface for supporting objects after load in collections


    public
                    afterLoad() : $this

Return values

$this

cleanModelCache()

Remove model object related cache


    public
                    cleanModelCache() : $this

Return values

$this

clearInstance()

Clearing object for correct deleting by garbage collector


    public
        final            clearInstance() : $this

Return values

$this

dataHasChangedFor()

Compare object data with original data


    public
                    dataHasChangedFor(string $field) : bool

Parameters

$field : string

Return values

bool

debug()

Present object data as string in debug mode


    public
                    debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>

Parameters

$data : mixed = null
$objects : array<string|int, mixed> = []

Return values

string|array<string|int, mixed>

delete()

Delete object from database


    public
                    delete() : $this

Return values

$this

deleteEntity()

Delete entity


    public
                    deleteEntity() : Mage_Eav_Model_Resource_Entity_Attribute

Return values

Mage_Eav_Model_Resource_Entity_Attribute

flagDirty()


    public
                    flagDirty(string $field[, bool $flag = true ]) : $this

Parameters

$field : string
$flag : bool = true

Return values

$this

getAlias()

Get attribute alias as "entity_type/attribute_code"


    public
                    getAlias([Mage_Eav_Model_Entity_Abstract $entity = null ]) : string

Parameters

$entity : Mage_Eav_Model_Entity_Abstract = null: exclude this entity

Return values

string

getApplyTo()


    public
                    getApplyTo() : array<string|int, mixed>

Return values

array<string|int, mixed>

getAttributeCode()


    public
                    getAttributeCode() : mixed

getAttributeCodesByFrontendType()

Retrieve attribute codes by frontend type


    public
                    getAttributeCodesByFrontendType(string $type) : array<string|int, mixed>

Parameters

$type : string

Return values

array<string|int, mixed>

getAttributeGroupId()


    public
                    getAttributeGroupId() : int|null

Return values

int|null

getAttributeId()

Get attribute identifier


    public
                    getAttributeId() : int|null

Return values

int|null

getAttributeModel()


    public
                    getAttributeModel() : mixed

getAttributeSetId()


    public
                    getAttributeSetId() : mixed

getAttributeSetInfo()


    public
                    getAttributeSetInfo() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getBackend()

Retrieve backend instance


    public
                    getBackend() : Mage_Eav_Model_Entity_Attribute_Backend_Abstract

Return values

Mage_Eav_Model_Entity_Attribute_Backend_Abstract

getBackendModel()


    public
                    getBackendModel() : mixed

getBackendTable()

Get attribute backend table name


    public
                    getBackendTable() : string

Return values

string

getBackendType()


    public
                    getBackendType() : mixed

getBackendTypeByInput()

Detect backend storage type using frontend input type


    public
                    getBackendTypeByInput(string $type) : string

Parameters

$type : string: frontend_input field value

Return values

string —

backend_type field value

getBillingAddress()


    public
                    getBillingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getCacheIdTags()

Get cache tags associated with object id


    public
                    getCacheIdTags() : array<string|int, mixed>|false

Return values

array<string|int, mixed>|false

getCacheTags()

Get list of cache tags applied to model object.


    public
                    getCacheTags() : array<string|int, mixed>|false

Return false if cache tags are not supported by model

Return values

array<string|int, mixed>|false

getCollection()


    public
                    getCollection() : Mage_Customer_Model_Resource_Attribute_Collection

Return values

Mage_Customer_Model_Resource_Attribute_Collection

getConfig()

Retrieve attribute configuration (deprecated)


    public
                    getConfig() : $this

Return values

$this

getCreatedAt()


    public
                    getCreatedAt() : string|null

Return values

string|null

getData()

Object data getter


    public
                    getData([string $key = '' ][, string|int $index = null ]) : mixed

If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

$key : string = ''
$index : string|int = null

getDataByKey()

Get object data by particular key


    public
                    getDataByKey(string $key) : mixed

Parameters

$key : string

getDataByPath()

Get object data by path


    public
                    getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

$path : string

getDataSetDefault()

Fast get data or set default if value is not available


    public
                    getDataSetDefault(string $key, mixed $default) : mixed

Parameters

$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method


    public
                    getDataUsingMethod(string $key[, mixed $args = null ]) : mixed

Parameters

$key : string
$args : mixed = null

getDefaultSourceModel()

Get default source model


    public
                    getDefaultSourceModel() : string

#[Override]

Return values

string

getDefaultValue()

Return default value for attribute


    public
                    getDefaultValue() : mixed

#[Override]

getDefaultValueByInput()

Detect default value using frontend input type


    public
                    getDefaultValueByInput(string $type) : string

Parameters

$type : string: frontend_input field name

Return values

string —

default_value field value

getEntity()

Retrieve entity instance


    public
                    getEntity() : Mage_Eav_Model_Entity_Abstract

Return values

Mage_Eav_Model_Entity_Abstract

getEntityAttributeId()


    public
                    getEntityAttributeId() : int|null

Return values

int|null

getEntityId()


    public
                    getEntityId() : int

Return values

int

getEntityIdField()

Retrieve entity type


    public
                    getEntityIdField() : string

Return values

string

getEntityType()

Retrieve entity type


    public
                    getEntityType() : Mage_Eav_Model_Entity_Type

Return values

Mage_Eav_Model_Entity_Type

getEntityTypeId()


    public
                    getEntityTypeId() : mixed

getFilterOptions()


    public
                    getFilterOptions() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getFrontend()

Retrieve frontend instance


    public
                    getFrontend() : Mage_Eav_Model_Entity_Attribute_Frontend_Abstract

Return values

Mage_Eav_Model_Entity_Attribute_Frontend_Abstract

getFrontendClass()


    public
                    getFrontendClass() : string|null

Return values

string|null

getFrontendInput()


    public
                    getFrontendInput() : string|null

Return values

string|null

getFrontendLabel()


    public
                    getFrontendLabel() : array<string|int, mixed>|string|null

Return values

array<string|int, mixed>|string|null

getFrontendModel()


    public
                    getFrontendModel() : string|null

Return values

string|null

getId()

Retrieve model object identifier


    public
                    getId() : int|string|null

#[Override]

Return values

int|string|null

getIdByCode()

Return attribute id


    public
                    getIdByCode(string $entityType, string $code) : int

Parameters

$entityType : string
$code : string

Return values

int

getIdFieldName()

Retrieve identifier field name for model


    public
                    getIdFieldName() : string

#[Override]

Return values

string

getIsConfigurable()


    public
                    getIsConfigurable() : bool|null

Return values

bool|null

getIsFilterable()


    public
                    getIsFilterable() : int|null

Return values

int|null

getIsFilterableInSearch()


    public
                    getIsFilterableInSearch() : bool|null

Return values

bool|null

getIsRequired()

Return is attribute value required


    public
                    getIsRequired() : bool|null

#[Override]

Return values

bool|null

getIsSearchable()


    public
                    getIsSearchable() : bool|null

Return values

bool|null

getIsUnique()


    public
                    getIsUnique() : bool|null

Return values

bool|null

getIsUserDefined()


    public
                    getIsUserDefined() : bool|null

Return values

bool|null

getIsVisible()

Return is visible attribute flag


    public
                    getIsVisible() : bool|null

#[Override]

Return values

bool|null

getIsVisibleInAdvancedSearch()


    public
                    getIsVisibleInAdvancedSearch() : bool|null

Return values

bool|null

getIsVisibleOnFront()


    public
                    getIsVisibleOnFront() : mixed

getMultilineCount()

Return count of lines for multiply line attribute


    public
                    getMultilineCount() : mixed

getName()

Get attribute name


    public
                    getName() : string

Return values

string

getOrigData()

Get object loaded data (original data)


    public
                    getOrigData([string $key = null ]) : mixed

Parameters

$key : string = null

getResource()

Retrieve model resource


    public
                    getResource() : Mage_Customer_Model_Resource_Attribute

Return values

Mage_Customer_Model_Resource_Attribute

getResourceCollection()

Get collection instance


    public
                    getResourceCollection() : Mage_Eav_Model_Resource_Entity_Attribute_Collection

Return values

Mage_Eav_Model_Resource_Entity_Attribute_Collection

getResourceName()

Retrieve model resource name


    public
                    getResourceName() : string

Return values

string

getScopeMultilineCount()


    public
                    getScopeMultilineCount() : int|null

Return values

int|null

getShippingAddress()


    public
                    getShippingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getSortOrder()


    public
                    getSortOrder() : int|null

Return values

int|null

getSource()

Retrieve source instance


    public
                    getSource() : Mage_Eav_Model_Entity_Attribute_Source_Abstract

Return values

Mage_Eav_Model_Entity_Attribute_Source_Abstract

getSourceModel()


    public
                    getSourceModel() : string|null

Return values

string|null

getStoreId()


    public
                    getStoreId() : int|null

Return values

int|null

getStoreLabel()

Return store label of attribute


    public
                    getStoreLabel([int|string|Mage_Core_Model_Store|null $storeId = null ]) : string|null

Parameters

$storeId : int|string|Mage_Core_Model_Store|null = null

Return values

string|null

getStoreLabels()

Return array of labels of stores


    public
                    getStoreLabels() : array<string|int, mixed>

Return values

array<string|int, mixed>

getUsedForSortBy()


    public
                    getUsedForSortBy() : bool|null

Return values

bool|null

getUsedInForms()

Return forms in which the attribute


    public
                    getUsedInForms() : array<string|int, mixed>

Return values

array<string|int, mixed>

getValidateRules()


    public
                    getValidateRules() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWebsite()

Return active website instance


    public
                    getWebsite() : Mage_Core_Model_Website

Return values

Mage_Core_Model_Website

hasAttributeSetInfo()


    public
                    hasAttributeSetInfo() : bool

Return values

bool

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.


    public
                    hasData([string $key = '' ]) : bool

Parameters

$key : string = ''

Return values

bool

hasDataChanges()

Get data change status


    public
                    hasDataChanges() : bool

Return values

bool

hasErrors()


    public
                    hasErrors() : bool

Return values

bool

hasIsVisible()


    public
                    hasIsVisible() : bool

Return values

bool

isAttributeValidationPassed()

Check if attribute is valid


    public
                    isAttributeValidationPassed() : bool

Return values

bool

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value


    public
                    isDeleted([bool $isDeleted = null ]) : bool

Parameters

$isDeleted : bool = null

Return values

bool

isDirty()


    public
                    isDirty([string $field = null ]) : bool

Parameters

$field : string = null

Return values

bool

isEmpty()

checks whether the object is empty


    public
                    isEmpty() : bool

Return values

bool

isInGroup()

Check if attribute in specified group


    public
                    isInGroup(int $setId, int $groupId) : bool

Parameters

$setId : int
$groupId : int

Return values

bool

isInSet()

Check if attribute in specified set


    public
                    isInSet(int|array<string|int, mixed> $setId) : bool

Parameters

$setId : int|array<string|int, mixed>

Return values

bool

isModuleEnabled()


    public
                    isModuleEnabled(string $moduleName[, string $helperAlias = 'core' ]) : bool

Parameters

$moduleName : string
$helperAlias : string = 'core'

Return values

bool

isObjectNew()

Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction


    public
                    isObjectNew([bool $flag = null ]) : bool

Parameters

$flag : bool = null

Return values

bool

isStatic()

Check if attribute is static


    public
                    isStatic() : bool

Return values

bool

isValueEmpty()


    public
                    isValueEmpty(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

jsonSerialize()

Implementation of JsonSerializable::jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:

If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
If a nested DataObject has a custom toJson() method, it's converted to JSON string
If a nested DataObject uses only the base implementations, it's excluded from output

This prevents infinite recursion and circular references when serializing object hierarchies.

#[Override]

Return values

array<string|int, mixed>

load()

Load object data


    public
                    load(string|null|int $id[, string|null $field = null ]) : $this

Parameters

$id : string|null|int
$field : string|null = null

Return values

$this

loadByCode()

Load attribute data by code


    public
                    loadByCode(mixed $entityType, string $code) : $this

Parameters

$entityType : mixed
$code : string

Return values

$this

loadEntityAttributeIdBySet()

Load entity_attribute_id into $this by $this->attribute_set_id


    public
                    loadEntityAttributeIdBySet() : $this

Return values

$this

offsetExists()

Implementation of ArrayAccess::offsetExists()


    public
                    offsetExists(string $offset) : bool

Parameters

$offset : string

Return values

bool

offsetGet()

Implementation of ArrayAccess::offsetGet()


    public
                    offsetGet(string $offset) : mixed

Parameters

$offset : string

offsetSet()

Implementation of ArrayAccess::offsetSet()


    public
                    offsetSet(string $offset, mixed $value) : void

Parameters

$offset : string
$value : mixed

offsetUnset()

Implementation of ArrayAccess::offsetUnset()


    public
                    offsetUnset(string $offset) : void

Parameters

$offset : string

save()

Save object data


    public
                    save() : $this

Return values

$this

serialize()

serialize object attributes


    public
                    serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string

Parameters

$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'

Return values

string

setAttribute()


    public
                    setAttribute(Mage_Eav_Model_Entity_Attribute_Abstract $value) : $this

Parameters

$value : Mage_Eav_Model_Entity_Attribute_Abstract

Return values

$this

setAttributeCode()


    public
                    setAttributeCode(mixed $data) : $this

Parameters

$data : mixed

Return values

$this

setAttributeGroupId()


    public
                    setAttributeGroupId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setAttributeId()

Specify attribute identifier


    public
                    setAttributeId(int $data) : $this

Parameters

$data : int

Return values

$this

setAttributeModel()


    public
                    setAttributeModel(mixed $data) : $this

Parameters

$data : mixed

Return values

$this

setAttributeSetId()


    public
                    setAttributeSetId(mixed $id) : $this

Parameters

$id : mixed

Return values

$this

setAttributeSetInfo()


    public
                    setAttributeSetInfo(array<string|int, mixed>|null $value) : static

Parameters

$value : array<string|int, mixed>|null

Return values

static

setAttributeValidationAsPassed()

Mark current attribute as passed validation


    public
                    setAttributeValidationAsPassed() : mixed

setBackendModel()


    public
                    setBackendModel(mixed $data) : $this

Parameters

$data : mixed

Return values

$this

setBackendTable()


    public
                    setBackendTable(mixed $data) : $this

Parameters

$data : mixed

Return values

$this

setBackendType()


    public
                    setBackendType(mixed $data) : $this

Parameters

$data : mixed

Return values

$this

setCreatedAt()


    public
                    setCreatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

setData()

Overwrite data in the object.


    public
                    setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

setDataChanges()

Clears data changes status


    public
                    setDataChanges(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDataUsingMethod()

Set object data with calling setter method


    public
                    setDataUsingMethod(string $key[, mixed $args = [] ]) : $this

Parameters

$key : string
$args : mixed = []

Return values

$this

setDefaultValue()


    public
                    setDefaultValue(int|string|null $value) : static

Parameters

$value : int|string|null

Return values

static

setEntity()

Set attribute entity instance


    public
                    setEntity(Mage_Eav_Model_Entity_Abstract $entity) : $this

Parameters

$entity : Mage_Eav_Model_Entity_Abstract

Return values

$this

setEntityAttributeId()


    public
                    setEntityAttributeId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setEntityType()


    public
                    setEntityType(mixed $type) : $this

Parameters

$type : mixed

Return values

$this

setEntityTypeId()


    public
                    setEntityTypeId(mixed $id) : $this

Parameters

$id : mixed

Return values

$this

setFrontendLabel()


    public
                    setFrontendLabel(string|null $value) : static

Parameters

$value : string|null

Return values

static

setFrontendModel()


    public
                    setFrontendModel(string|null $value) : static

Parameters

$value : string|null

Return values

static

setId()

Declare model object identifier value


    public
                    setId(mixed $id) : $this

Parameters

$id : mixed

#[Override]

Return values

$this

setIdFieldName()

set name of object id field


    public
                    setIdFieldName(string $name) : $this

Parameters

$name : string

Return values

$this

setIsFilterable()


    public
                    setIsFilterable(int|null $value) : static

Parameters

$value : int|null

Return values

static

setIsGlobal()


    public
                    setIsGlobal(int|null $value) : static

Parameters

$value : int|null

Return values

static

setName()

Set attribute name


    public
                    setName(string $name) : $this

Parameters

$name : string

Return values

$this

setOrigData()

Initialize object original data


    public
                    setOrigData([string $key = null ][, mixed $data = null ]) : $this

Parameters

$key : string = null
$data : mixed = null

Return values

$this

setScopeIsRequired()


    public
                    setScopeIsRequired([bool|null $value = true ]) : static

Parameters

$value : bool|null = true

Return values

static

setScopeIsVisible()


    public
                    setScopeIsVisible([bool|null $value = true ]) : static

Parameters

$value : bool|null = true

Return values

static

setScopeMultilineCount()


    public
                    setScopeMultilineCount(int|null $value) : static

Parameters

$value : int|null

Return values

static

setSortOrder()


    public
                    setSortOrder(int|null $value) : static

Parameters

$value : int|null

Return values

static

setSourceModel()


    public
                    setSourceModel(string|null $value) : static

Parameters

$value : string|null

Return values

static

setStoreId()


    public
                    setStoreId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setUpdatedAt()


    public
                    setUpdatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

setValidateRules()


    public
                    setValidateRules(array<string|int, mixed>|string|null $value) : static

Parameters

$value : array<string|int, mixed>|string|null

Return values

static

setWebsite()

Set active website instance


    public
                    setWebsite(Mage_Core_Model_Website|int $website) : Mage_Eav_Model_Attribute

Parameters

$website : Mage_Core_Model_Website|int

Return values

Mage_Eav_Model_Attribute

toArray()

Public wrapper for __toArray


    public
                    toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

array<string|int, mixed>

toJson()

Public wrapper for __toJson


    public
                    toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

string

toString()

Public wrapper for __toString


    public
                    toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters

$format : string = ''

Return values

string

toXml()

Public wrapper for __toXml


    public
                    toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

unsetData()

Unset data from the object.


    public
                    unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsetOldData()

Unset old fields data from the object.


    public
                    unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsIsVisible()


    public
                    unsIsVisible() : $this

Return values

$this

usesSource()


    public
                    usesSource() : bool

Return values

bool

__toJson()

Convert object attributes to JSON


    protected
                    __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

string

__toXml()

Convert object attributes to XML


    protected
                    __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes
$rootName : string = 'item': name of the root element
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

_addFullNames()


    protected
                    _addFullNames() : mixed

_afterDelete()

Processing object after delete data


    protected
                    _afterDelete() : $this

Return values

$this

_afterDeleteCommit()

Processing manipulation after main transaction commit


    protected
                    _afterDeleteCommit() : $this

Return values

$this

_afterLoad()

Processing object after load data


    protected
                    _afterLoad() : $this

Return values

$this

_afterSave()

Save additional data


    protected
                    _afterSave() : $this

#[Override]

Return values

$this

_beforeDelete()

Processing object before delete data


    protected
                    _beforeDelete() : $this

Return values

$this

_beforeLoad()

Processing object before load data


    protected
                    _beforeLoad(int $id[, string|null $field = null ]) : $this

Parameters

$id : int
$field : string|null = null

Return values

$this

_beforeSave()

Processing object before save data


    protected
                    _beforeSave() : $this

Return values

$this

_camelize()


    protected
                    _camelize(string $name) : string

Parameters

$name : string

Return values

string

_clearData()

Clearing object's data


    protected
                    _clearData() : $this

Return values

$this

_clearReferences()

Clearing cyclic references


    protected
                    _clearReferences() : $this

Return values

$this

_construct()

Init resource model


    protected
                    _construct() : void

#[Override]

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_getDefaultBackendModel()

Retrieve default attribute backend model by attribute code


    protected
                    _getDefaultBackendModel() : string

#[Override]

Return values

string

_getDefaultFrontendModel()

Retrieve default attribute frontend model


    protected
                    _getDefaultFrontendModel() : string

#[Override]

Return values

string

_getDefaultSourceModel()

Retrieve default attribute source model


    protected
                    _getDefaultSourceModel() : string

since 26.1 use getDefaultSourceModel() instead

#[Override]

Return values

string

_getEventData()

Get array of objects transferred to default events processing


    protected
                    _getEventData() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getScopeValue()

Return scope value by key


    protected
                    _getScopeValue(string $key) : mixed

Parameters

$key : string

_hasModelChanged()

Check whether model has changed data.


    protected
                    _hasModelChanged() : bool

Can be overloaded in child classes to perform advanced check whether model needs to be saved e.g. using resourceModel->hasDataChanged() or any other technique

Return values

bool

_init()

Standard model initialization


    protected
                    _init(string $resourceModel) : mixed

Parameters

$resourceModel : string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.


    protected
                    _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_prepareArray()

Set required array elements


    protected
                    _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.


    protected
                    _prepareSyncFieldsMap() : $this

Return values

$this

_protectFromNonAdmin()

Safeguard func that will check, if we are in admin area


    protected
                    _protectFromNonAdmin() : mixed

_setResourceModel()

Set resource names


    protected
                    _setResourceModel(string $resourceName[, string|null $resourceCollectionName = null ]) : mixed

If collection name is omitted, resource name will be used with _collection appended

Parameters

$resourceName : string
$resourceCollectionName : string|null = null

_underscore()

Converts field names for setters and getters


    protected
                    _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

$name : string

Return values

string

Mage_Customer_Model_Attribute extends Mage_Eav_Model_Attribute in package Mage Customer

Table of Contents

Constants

Properties

Methods

Constants

ATTRIBUTE_CODE_MAX_LENGTH

CACHE_TAG

MODULE_NAME

TYPE_STATIC

Properties

$_attributeIdCache

$_attributeValidationPassed

$_backend

$_cacheTag

Attributes

$_data

$_dataSaveAllowed

$_dataTable

$_dirty

$_entity

$_eventObject

Attributes

$_eventPrefix

Attributes

$_frontend

$_hasDataChanges

$_idFieldName

$_isDeleted

$_isObjectNew

$_name

$_oldFieldsMap

$_origData

$_resource

$_resourceCollectionName

$_resourceName

$_source

$_syncFieldsMap

$_underscoreCache

$_website

Methods

__call()

Parameters

__construct()

__get()

Parameters

__set()

Parameters

__toArray()

Parameters

Return values

_getResource()

Return values

addData()

Parameters

Return values

afterCommitCallback()

Return values

afterLoad()

Return values

cleanModelCache()

Return values

clearInstance()

Return values

dataHasChangedFor()

Parameters

Return values

debug()

Parameters

Return values

delete()

Tags

Return values

deleteEntity()

Return values

flagDirty()

Parameters

Return values

getAlias()

Parameters

Mage_Customer_Model_Attribute extends Mage_Eav_Model_Attribute
in package

Mage

Customer