Documentation

Mage_Eav_Model_Entity_Attribute_Abstract extends Mage_Core_Model_Abstract
in package

Mage

Eav

implements Mage_Eav_Model_Entity_Attribute_Interface

AbstractYes

Interfaces

Mage_Eav_Model_Entity_Attribute_Interface

Constants

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 : string|bool|array<string|int, mixed>: Model cache tag for clear cache in after save and after delete
$_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: Parameter name in event
$_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

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
_getFlatColumnsDdlDefinition() : array<string|int, mixed>: Retrieve flat columns DDL definition
_getResource() : Mage_Eav_Model_Resource_Entity_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
flagDirty() : $this
getAlias() : string: Get attribute alias as "entity_type/attribute_code"
getApplyTo() : array<string|int, mixed>
getAttributeCode() : mixed
getAttributeId() : int|null: Get attribute identifier
getAttributeModel() : mixed
getAttributeSetId() : mixed
getAttributeSetInfo() : array<string|int, mixed>
getBackend() : Mage_Eav_Model_Entity_Attribute_Backend_Abstract: Retrieve backend instance
getBackendModel() : mixed
getBackendTable() : string: Get attribute backend table name
getBackendType() : mixed
getBillingAddress() : Mage_Customer_Model_Address_Abstract
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_Core_Model_Resource_Db_Collection_Abstract|false
getConfig() : $this: Retrieve attribute configuration (deprecated)
getCreatedAt() : string
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
getEntity() : Mage_Eav_Model_Entity_Abstract: Retrieve entity instance
getEntityId() : int
getEntityIdField() : string: Retrieve entity type
getEntityType() : Mage_Eav_Model_Entity_Type: Retrieve entity type
getEntityTypeId() : mixed
getFlatAddChildData() : bool
getFlatAddFilterableAttributes() : array<string|int, mixed>
getFlatColumns() : array<string|int, mixed>: Retrieve flat columns definition
getFlatIndexes() : array<string|int, mixed>: Retrieve index data for flat table
getFlatUpdateSelect() : $this|Select|null: Retrieve Select For Flat Attribute update
getFrontend() : Mage_Eav_Model_Entity_Attribute_Frontend_Abstract: Retrieve frontend instance
getFrontendClass() : string
getFrontendInput() : string
getFrontendLabel() : string
getFrontendModel() : string
getId() : int|string|null: Retrieve model object identifier
getIdByCode() : int: Return attribute id
getIdFieldName() : string: Retrieve identifier field name for model
getIsConfigurable() : bool
getIsFilterable() : bool
getIsFilterableInSearch() : bool
getIsRequired() : bool
getIsSearchable() : bool
getIsUnique() : bool
getIsUserDefined() : bool
getIsVisible() : bool
getIsVisibleInAdvancedSearch() : bool
getIsVisibleOnFront() : mixed
getName() : string: Get attribute name
getOrigData() : mixed: Get object loaded data (original data)
getResource() : Mage_Core_Model_Resource_Db_Abstract: Retrieve model resource
getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract: Get collection instance
getResourceName() : string: Retrieve model resource name
getShippingAddress() : Mage_Customer_Model_Address_Abstract
getSortOrder() : string
getSource() : Mage_Eav_Model_Entity_Attribute_Source_Abstract: Retrieve source instance
getSourceModel() : string
getStoreId() : int
getStoreLabel() : string
getUsedForSortBy() : string
getValidateRules() : array<string|int, mixed>
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
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() : $this
setAttributeId() : $this: Specify attribute identifier
setAttributeModel() : $this
setAttributeSetId() : $this
setAttributeSetInfo() : $this
setAttributeValidationAsPassed() : mixed: Mark current attribute as passed validation
setBackendModel() : $this
setBackendTable() : $this
setBackendType() : $this
setCreatedAt() : $this
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setEntity() : $this: Set attribute entity instance
setEntityType() : $this
setEntityTypeId() : $this
setFrontendModel() : $this
setId() : $this: Declare model object identifier value
setIdFieldName() : $this: set name of object id field
setIsGlobal() : $this
setName() : $this: Set attribute name
setOrigData() : $this: Initialize object original data
setSortOrder() : $this
setSourceModel() : $this
setStoreId() : $this
setUpdatedAt() : $this
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.
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: Processing object after save 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: Internal constructor not depended on params. Can be used for object initialization
_getData() : mixed: Get value from _data array without parse key
_getDefaultBackendModel() : string
_getDefaultFrontendModel() : string
_getDefaultSourceModel() : string
_getEventData() : array<string|int, mixed>: Get array of objects transferred to default events processing
_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

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

Model cache tag for clear cache in after save and after delete


        protected
            string|bool|array<string|int, mixed>
    $_cacheTag
     = \false

When you use true - all cache will be clean

$_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

Parameter name in event


        protected
            string
    $_eventObject
     = 'object'

In observe method you can use $observer->getEvent()->getObject() in this case

$_eventPrefix

Prefix of model events names


        protected
            string
    $_eventPrefix
     = 'core_abstract'

$_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
     = []

__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>

_getFlatColumnsDdlDefinition()

Retrieve flat columns DDL definition


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

Return values

array<string|int, mixed>

_getResource()

Get resource instance


    public
                    _getResource() : Mage_Eav_Model_Resource_Entity_Attribute

Return values

Mage_Eav_Model_Resource_Entity_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

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

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>

Return values

array<string|int, mixed>

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

getBillingAddress()


    public
                    getBillingAddress() : Mage_Customer_Model_Address_Abstract

Return values

Mage_Customer_Model_Address_Abstract

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_Core_Model_Resource_Db_Collection_Abstract|false

Return values

Mage_Core_Model_Resource_Db_Collection_Abstract|false

getConfig()

Retrieve attribute configuration (deprecated)


    public
                    getConfig() : $this

Return values

$this

getCreatedAt()


    public
                    getCreatedAt() : string

Return values

string

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

Return values

string

getDefaultValue()


    public
                    getDefaultValue() : mixed

getEntity()

Retrieve entity instance


    public
                    getEntity() : Mage_Eav_Model_Entity_Abstract

Return values

Mage_Eav_Model_Entity_Abstract

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

getFlatAddChildData()


    public
                    getFlatAddChildData() : bool

Return values

bool

getFlatAddFilterableAttributes()


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

Return values

array<string|int, mixed>

getFlatColumns()

Retrieve flat columns definition


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

Return values

array<string|int, mixed>

getFlatIndexes()

Retrieve index data for flat table


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

Return values

array<string|int, mixed>

getFlatUpdateSelect()

Retrieve Select For Flat Attribute update


    public
                    getFlatUpdateSelect([int $store = null ]) : $this|Select|null

Parameters

$store : int = null

Return values

$this|Select|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

Return values

string

getFrontendInput()


    public
                    getFrontendInput() : string

Return values

string

getFrontendLabel()


    public
                    getFrontendLabel() : string

Return values

string

getFrontendModel()


    public
                    getFrontendModel() : string

Return values

string

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

Return values

bool

getIsFilterable()


    public
                    getIsFilterable() : bool

Return values

bool

getIsFilterableInSearch()


    public
                    getIsFilterableInSearch() : bool

Return values

bool

getIsRequired()


    public
                    getIsRequired() : bool

Return values

bool

getIsSearchable()


    public
                    getIsSearchable() : bool

Return values

bool

getIsUnique()


    public
                    getIsUnique() : bool

Return values

bool

getIsUserDefined()


    public
                    getIsUserDefined() : bool

Return values

bool

getIsVisible()


    public
                    getIsVisible() : bool

Return values

bool

getIsVisibleInAdvancedSearch()


    public
                    getIsVisibleInAdvancedSearch() : bool

Return values

bool

getIsVisibleOnFront()


    public
                    getIsVisibleOnFront() : 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_Core_Model_Resource_Db_Abstract

Return values

Mage_Core_Model_Resource_Db_Abstract

getResourceCollection()

Get collection instance


    public
                    getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract

Return values

Mage_Core_Model_Resource_Db_Collection_Abstract

getResourceName()

Retrieve model resource name


    public
                    getResourceName() : string

Return values

string

getShippingAddress()


    public
                    getShippingAddress() : Mage_Customer_Model_Address_Abstract

Return values

Mage_Customer_Model_Address_Abstract

getSortOrder()


    public
                    getSortOrder() : string

Return values

string

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

Return values

string

getStoreId()


    public
                    getStoreId() : int

Return values

int

getStoreLabel()


    public
                    getStoreLabel() : string

Return values

string

getUsedForSortBy()


    public
                    getUsedForSortBy() : string

Return values

string

getValidateRules()


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

Return values

array<string|int, mixed>

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

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 $value) : $this

Parameters

$value : int

Return values

$this

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> $value) : $this

Parameters

$value : array<string|int, mixed>

Return values

$this

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 $currentTime) : $this

Parameters

$currentTime : string

Return values

$this

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

setEntity()

Set attribute entity instance


    public
                    setEntity(Mage_Eav_Model_Entity_Abstract $entity) : $this

Parameters

$entity : Mage_Eav_Model_Entity_Abstract

Return values

$this

setEntityType()


    public
                    setEntityType(mixed $type) : $this

Parameters

$type : mixed

Return values

$this

setEntityTypeId()


    public
                    setEntityTypeId(mixed $id) : $this

Parameters

$id : mixed

Return values

$this

setFrontendModel()


    public
                    setFrontendModel(string $value) : $this

Parameters

$value : string

Return values

$this

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

setIsGlobal()


    public
                    setIsGlobal(int $value) : $this

Parameters

$value : int

Return values

$this

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

setSortOrder()


    public
                    setSortOrder(string $value) : $this

Parameters

$value : string

Return values

$this

setSourceModel()


    public
                    setSourceModel(string $value) : $this

Parameters

$value : string

Return values

$this

setStoreId()


    public
                    setStoreId(int $value) : $this

Parameters

$value : int

Return values

$this

setUpdatedAt()


    public
                    setUpdatedAt(string $currentTime) : $this

Parameters

$currentTime : string

Return values

$this

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

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()

Processing object after save data


    protected
                    _afterSave() : $this

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()

Internal constructor not depended on params. Can be used for object initialization


    protected
                    _construct() : void

#[Override]

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_getDefaultBackendModel()


    protected
                    _getDefaultBackendModel() : string

Return values

string

_getDefaultFrontendModel()


    protected
                    _getDefaultFrontendModel() : string

Return values

string

_getDefaultSourceModel()


    protected
                    _getDefaultSourceModel() : string

since 26.1 use getDefaultSourceModel() instead

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>

_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_Eav_Model_Entity_Attribute_Abstract extends Mage_Core_Model_Abstract in package Mage Eav implements Mage_Eav_Model_Entity_Attribute_Interface

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

TYPE_STATIC

Properties

$_attributeIdCache

$_attributeValidationPassed

$_backend

$_cacheTag

$_data

$_dataSaveAllowed

$_dataTable

$_dirty

$_entity

$_eventObject

$_eventPrefix

$_frontend

$_hasDataChanges

$_idFieldName

$_isDeleted

$_isObjectNew

$_name

$_oldFieldsMap

$_origData

$_resource

$_resourceCollectionName

$_resourceName

$_source

$_syncFieldsMap

$_underscoreCache

Methods

__call()

Parameters

__construct()

__get()

Parameters

__set()

Parameters

__toArray()

Parameters

Return values

_getFlatColumnsDdlDefinition()

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

flagDirty()

Parameters

Return values

getAlias()

Parameters

Return values

getApplyTo()

Return values

getAttributeCode()

getAttributeId()

Return values

Mage_Eav_Model_Entity_Attribute_Abstract extends Mage_Core_Model_Abstract
in package

Mage

Eav

implements Mage_Eav_Model_Entity_Attribute_Interface