Class Mage_Eav_Model_Entity_Setup

Description
Description | Descendents | Vars (details) | Methods (details) Constants

EAV Entity Setup Model

Located in /Eav/Model/Entity/Setup.php (line 35) 

Mage_Core_Model_Resource_Setup
   |
   --Mage_Eav_Model_Entity_Setup
Direct descendents
Description | Descendents | Vars (details) | Methods (details) Constants
Class Description
Mage_Catalog_Model_Resource_Eav_Mysql4_Setup Catalog entity setup
Mage_Customer_Model_Entity_Setup Customer resource setup model
Mage_Sales_Model_Mysql4_Setup Magento
Mage_Sales_Model_Entity_Setup Magento
Mage_Checkout_Model_Mysql4_Setup Checkout Resource Setup Model
Variable Summary
Description | Descendents | Vars (details) | Methods (details) Constants
mixed $defaultGroupIdAssociations
mixed $_attributeTableFields
mixed $_generalGroupName
Method Summary
Description | Descendents | Constants Vars (details) | Methods (details)
Mage_Eav_Model_Entity_Setup addAttribute (string|integer $entityTypeId, string $code,  $attr)
Mage_Eav_Model_Entity_Setup addAttributeGroup (mixed $entityTypeId, mixed $setId, string $name, [int $sortOrder = null])
void addAttributeOption (array $option)
Mage_Eav_Model_Entity_Setup addAttributeSet (mixed $entityTypeId, string $name, [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup addAttributeToGroup (int|string $entityType, int|string $setId, int|string $groupId, int|string $attributeId, [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup addAttributeToSet (mixed $entityTypeId, mixed $setId, mixed $groupId, mixed $attributeId, [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup addEntityType (string $code,  $params)
Mage_Eav_Model_Entity_Setup cleanCache ()
unknown createEntityTables (unknown_type $baseName, [ $options = array()])
array getAllAttributeSetIds ([ $entityTypeId = null])
mixed getAttribute (mixed $entityTypeId, mixed $id, [string $field = null])
mixed getAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id, [string $field = null])
Mage_Eav_Model_Entity_Setup getAttributeGroupId (mixed $entityTypeId, mixed $setId, mixed $groupId)
int getAttributeGroupSortOrder (mixed $entityTypeId, mixed $setId, [int $sortOrder = null])
int getAttributeId (mixed $entityTypeId, mixed $id)
mixed getAttributeSet (mixed $entityTypeId, mixed $id, [string $field = null])
int getAttributeSetId (mixed $entityTypeId, mixed $setId)
int getAttributeSetSortOrder (mixed $entityTypeId, [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup getAttributeSortOrder (mixed $entityTypeId, mixed $setId, mixed $groupId, [int $sortOrder = null])
string getAttributeTable (int|string $entityTypeId, int|string $id)
int getDefaultAttributeGroupId (string|int $entityType, [int $attributeSetId = null])
int getDefaultAttributeSetId (string|int $entityType)
mixed getEntityType (int|string $id, [string $field = null])
int getEntityTypeId (mixed $entityTypeId)
Mage_Eav_Model_Entity_Setup installDefaultGroupIds ()
Mage_Eav_Model_Entity_Setup installEntities ([array $entities = null])
Mage_Eav_Model_Entity_Setup removeAttribute (mixed $entityTypeId, mixed $code)
Mage_Eav_Model_Entity_Setup removeAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id)
Mage_Eav_Model_Entity_Setup removeAttributeSet (mixed $entityTypeId, mixed $id)
Mage_Eav_Model_Entity_Setup removeEntityType (mixed $id)
Mage_Eav_Model_Entity_Setup setDefaultSetToEntityType (mixed $entityType, [ $attributeSet = 'Default'])
Mage_Eav_Model_Entity_Setup updateAttribute (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null], [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup updateAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id, string $field, [mixed $value = null])
Mage_Eav_Model_Entity_Setup updateAttributeSet (mixed $entityTypeId, int $id, string $field, [mixed $value = null])
Mage_Eav_Model_Entity_Setup updateEntityType (string $code, string $field, [string $value = null])
array _getAttributeTableFields ()
string _getValue (array $array, string $key, [string $default = null])
Mage_Eav_Model_Entity_Setup _insertAttribute ( $data)
Mage_Eav_Model_Entity_Setup _insertAttributeAdditionalData ( $entityTypeId,  $data)
array _prepareValues (array $attr)
Mage_Eav_Model_Entity_Setup _updateAttribute (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null], [int $sortOrder = null])
Mage_Eav_Model_Entity_Setup _updateAttributeAdditionalData (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null])
Variables
Description | Descendents | Vars (details) Constants | Methods (details)
mixed $defaultGroupIdAssociations = array('General'=>1) (line 40)
  • access: public
mixed $_attributeTableFields (line 37)
  • access: protected
mixed $_generalGroupName = 'General' (line 38)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Resource_Setup

Mage_Core_Model_Resource_Setup::$_callAfterApplyAllUpdates
 Mage_Core_Model_Resource_Setup::$_conn
 Mage_Core_Model_Resource_Setup::$_connectionConfig
 Mage_Core_Model_Resource_Setup::$_hadUpdates
 Mage_Core_Model_Resource_Setup::$_moduleConfig
 Mage_Core_Model_Resource_Setup::$_resourceConfig
 Mage_Core_Model_Resource_Setup::$_resourceName
 Mage_Core_Model_Resource_Setup::$_schemaUpdatesChecked
 Mage_Core_Model_Resource_Setup::$_setupCache
 Mage_Core_Model_Resource_Setup::$_tables
Methods
Description | Descendents | Vars (details) Constants Methods (details)
addAttribute (line 564)

Add attribute to an entity type

If attribute is system will add to all existing attribute sets

  • access: public
Mage_Eav_Model_Entity_Setup addAttribute (string|integer $entityTypeId, string $code,  $attr)
  • string|integer $entityTypeId
  • string $code
  • array $attr
Redefined in descendants as:
addAttributeGroup (line 373)

Add Attribute Group

  • access: public
Mage_Eav_Model_Entity_Setup addAttributeGroup (mixed $entityTypeId, mixed $setId, string $name, [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $setId
  • string $name
  • int $sortOrder
addAttributeOption (line 610)

Add Attribure Option

  • access: public
void addAttributeOption (array $option)
  • array $option
addAttributeSet (line 212)

Add Attribute Set

  • access: public
Mage_Eav_Model_Entity_Setup addAttributeSet (mixed $entityTypeId, string $name, [int $sortOrder = null])
  • mixed $entityTypeId
  • string $name
  • int $sortOrder
addAttributeToGroup (line 950)

Add or update attribute to group

  • access: public
Mage_Eav_Model_Entity_Setup addAttributeToGroup (int|string $entityType, int|string $setId, int|string $groupId, int|string $attributeId, [int $sortOrder = null])
  • int|string $entityType
  • int|string $setId
  • int|string $groupId
  • int|string $attributeId
  • int $sortOrder
addAttributeToSet (line 912)

Add Attribute to All Groups on Attribute Set

  • access: public
Mage_Eav_Model_Entity_Setup addAttributeToSet (mixed $entityTypeId, mixed $setId, mixed $groupId, mixed $attributeId, [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $setId
  • mixed $groupId
  • mixed $attributeId
  • int $sortOrder
addEntityType (line 92)

Add an entity type

If already exists updates the entity type with params data

  • access: public
Mage_Eav_Model_Entity_Setup addEntityType (string $code,  $params)
  • string $code
  • array $params
cleanCache (line 47)

Clean cache

  • access: public
Mage_Eav_Model_Entity_Setup cleanCache ()
createEntityTables (line 1072)

Enter description here...

  • access: public
unknown createEntityTables (unknown_type $baseName, [ $options = array()])
  • unknown_type $baseName
  • array $options: - no-main
    • no-default-types
    • types
getAllAttributeSetIds (line 318)

Get identifiers of all attribute sets

  • access: public
array getAllAttributeSetIds ([ $entityTypeId = null])
  • $entityTypeId
getAttribute (line 772)

Retrieve Attribute Data By Id or Code

  • access: public
mixed getAttribute (mixed $entityTypeId, mixed $id, [string $field = null])
  • mixed $entityTypeId
  • mixed $id
  • string $field
getAttributeGroup (line 428)

Retrieve Attribute Group Data

  • access: public
mixed getAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id, [string $field = null])
  • mixed $entityTypeId
  • mixed $setId
  • mixed $id
  • string $field
getAttributeGroupId (line 456)

Retrieve Attribute Group Id by Id or Name

  • access: public
Mage_Eav_Model_Entity_Setup getAttributeGroupId (mixed $entityTypeId, mixed $setId, mixed $groupId)
  • mixed $entityTypeId
  • mixed $setId
  • mixed $groupId
getAttributeGroupSortOrder (line 352)

Retrieve Attribute Group Sort order

  • access: public
int getAttributeGroupSortOrder (mixed $entityTypeId, mixed $setId, [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $setId
  • int $sortOrder
getAttributeId (line 815)

Retrieve Attribute Id Data By Id or Code

  • access: public
int getAttributeId (mixed $entityTypeId, mixed $id)
  • mixed $entityTypeId
  • mixed $id
getAttributeSet (line 258)

Retrieve Attribute set data by id or name

  • access: public
mixed getAttributeSet (mixed $entityTypeId, mixed $id, [string $field = null])
  • mixed $entityTypeId
  • mixed $id
  • string $field
getAttributeSetId (line 275)

Retrieve Attribute Set Id By Id or Name

  • throws: Mage_Eav_Exception
  • access: public
int getAttributeSetId (mixed $entityTypeId, mixed $setId)
  • mixed $entityTypeId
  • mixed $setId
getAttributeSetSortOrder (line 192)

Retrieve Attribute Set Sort order

  • access: public
int getAttributeSetSortOrder (mixed $entityTypeId, [int $sortOrder = null])
  • mixed $entityTypeId
  • int $sortOrder
getAttributeSortOrder (line 890)

Retrieve Attribute Sort Order

  • access: public
Mage_Eav_Model_Entity_Setup getAttributeSortOrder (mixed $entityTypeId, mixed $setId, mixed $groupId, [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $setId
  • mixed $groupId
  • int $sortOrder
getAttributeTable (line 834)

Return table name for eav attribute

  • access: public
string getAttributeTable (int|string $entityTypeId, int|string $id)
  • int|string $entityTypeId: Entity Type id or Entity Type code
  • int|string $id: Attribute id or Attribute code
getDefaultAttributeGroupId (line 497)

Retrieve Default Attribute Group Id By Entity Type and Attribute Set

  • access: public
int getDefaultAttributeGroupId (string|int $entityType, [int $attributeSetId = null])
  • string|int $entityType
  • int $attributeSetId
getDefaultAttributeSetId (line 334)

Retrieve Default Attribute Set for Entity Type

  • access: public
int getDefaultAttributeSetId (string|int $entityType)
  • string|int $entityType
getEntityType (line 141)

Retrieve Entity Type Data

  • access: public
mixed getEntityType (int|string $id, [string $field = null])
  • int|string $id
  • string $field
getEntityTypeId (line 155)

Retrieve Entity Type Id By Id or Code

  • access: public
int getEntityTypeId (mixed $entityTypeId)
  • mixed $entityTypeId
installDefaultGroupIds (line 58)

Install Default Group Ids

  • access: public
Mage_Eav_Model_Entity_Setup installDefaultGroupIds ()
installEntities (line 1007)

Install entities

  • access: public
Mage_Eav_Model_Entity_Setup installEntities ([array $entities = null])
  • array $entities
removeAttribute (line 868)

Remove Attribute

  • access: public
Mage_Eav_Model_Entity_Setup removeAttribute (mixed $entityTypeId, mixed $code)
  • mixed $entityTypeId
  • mixed $code
removeAttributeGroup (line 480)

Remove Attribute Group By Id or Name

  • access: public
Mage_Eav_Model_Entity_Setup removeAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id)
  • mixed $entityTypeId
  • mixed $setId
  • mixed $id
removeAttributeSet (line 293)

Remove Attribute Set

  • access: public
Mage_Eav_Model_Entity_Setup removeAttributeSet (mixed $entityTypeId, mixed $id)
  • mixed $entityTypeId
  • mixed $id
removeEntityType (line 172)

Remove entity type by Id or Code

  • access: public
Mage_Eav_Model_Entity_Setup removeEntityType (mixed $id)
  • mixed $id
setDefaultSetToEntityType (line 305)

Set Default Attribute Set to Entity Type

  • access: public
Mage_Eav_Model_Entity_Setup setDefaultSetToEntityType (mixed $entityType, [ $attributeSet = 'Default'])
  • mixed $entityType
  • $attributeSet
updateAttribute (line 668)

Update Attribute data and Attribute additional data

  • access: public
Mage_Eav_Model_Entity_Setup updateAttribute (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null], [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $id
  • string $field
  • mixed $value
  • int $sortOrder
updateAttributeGroup (line 409)

Update Attribute Group Data

  • access: public
Mage_Eav_Model_Entity_Setup updateAttributeGroup (mixed $entityTypeId, mixed $setId, mixed $id, string $field, [mixed $value = null])
  • mixed $entityTypeId
  • mixed $setId
  • mixed $id
  • string $field
  • mixed $value
updateAttributeSet (line 240)

Update attribute set data

  • access: public
Mage_Eav_Model_Entity_Setup updateAttributeSet (mixed $entityTypeId, int $id, string $field, [mixed $value = null])
  • mixed $entityTypeId
  • int $id
  • string $field
  • mixed $value
updateEntityType (line 125)

Update entity row

  • access: public
Mage_Eav_Model_Entity_Setup updateEntityType (string $code, string $field, [string $value = null])
  • string $code
  • string $field
  • string $value
_getAttributeTableFields (line 1146)

Retrieve attribute table fields

  • access: protected
array _getAttributeTableFields ()
_getValue (line 522)

Retrieve value from array by key or return default value

  • access: protected
string _getValue (array $array, string $key, [string $default = null])
  • array $array
  • string $key
  • string $default
_insertAttribute (line 1155)

Insert attribute and filter data

  • access: protected
Mage_Eav_Model_Entity_Setup _insertAttribute ( $data)
  • array $data
_insertAttributeAdditionalData (line 1184)

Insert attribute additional data

  • access: protected
Mage_Eav_Model_Entity_Setup _insertAttributeAdditionalData ( $entityTypeId,  $data)
  • array $data
  • $entityTypeId
_prepareValues (line 533)

Prepare attribute values to save

  • access: protected
array _prepareValues (array $attr)
  • array $attr
Redefined in descendants as:
_updateAttribute (line 685)

Update Attribute data

  • access: protected
Mage_Eav_Model_Entity_Setup _updateAttribute (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null], [int $sortOrder = null])
  • mixed $entityTypeId
  • mixed $id
  • string $field
  • mixed $value
  • int $sortOrder
_updateAttributeAdditionalData (line 730)

Update Attribute Additional data

  • access: protected
Mage_Eav_Model_Entity_Setup _updateAttributeAdditionalData (mixed $entityTypeId, mixed $id, string $field, [mixed $value = null])
  • mixed $entityTypeId
  • mixed $id
  • string $field
  • mixed $value

Inherited Methods

Inherited From Mage_Core_Model_Resource_Setup

Mage_Core_Model_Resource_Setup::__construct()
Mage_Core_Model_Resource_Setup::addConfigField()
Mage_Core_Model_Resource_Setup::afterApplyAllUpdates()
Mage_Core_Model_Resource_Setup::applyAllDataUpdates()
Mage_Core_Model_Resource_Setup::applyAllUpdates()
Mage_Core_Model_Resource_Setup::applyDataUpdates()
Mage_Core_Model_Resource_Setup::applyUpdates()
Mage_Core_Model_Resource_Setup::deleteConfigData()
Mage_Core_Model_Resource_Setup::deleteTableRow()
Mage_Core_Model_Resource_Setup::endSetup()
Mage_Core_Model_Resource_Setup::getCallAfterApplyAllUpdates()
Mage_Core_Model_Resource_Setup::getConnection()
Mage_Core_Model_Resource_Setup::getTable()
Mage_Core_Model_Resource_Setup::getTableRow()
Mage_Core_Model_Resource_Setup::run()
Mage_Core_Model_Resource_Setup::setConfigData()
Mage_Core_Model_Resource_Setup::setTable()
Mage_Core_Model_Resource_Setup::startSetup()
Mage_Core_Model_Resource_Setup::tableExists()
Mage_Core_Model_Resource_Setup::updateTable()
Mage_Core_Model_Resource_Setup::updateTableRow()
Mage_Core_Model_Resource_Setup::_getModifySqlFiles()
Mage_Core_Model_Resource_Setup::_getResource()
Mage_Core_Model_Resource_Setup::_installData()
Mage_Core_Model_Resource_Setup::_installResourceDb()
Mage_Core_Model_Resource_Setup::_modifyResourceDb()
Mage_Core_Model_Resource_Setup::_rollbackResourceDb()
Mage_Core_Model_Resource_Setup::_uninstallResourceDb()
Mage_Core_Model_Resource_Setup::_upgradeData()
Mage_Core_Model_Resource_Setup::_upgradeResourceDb()
Class Constants
Description | Descendants | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from Mage_Core_Model_Resource_Setup

Mage_Core_Model_Resource_Setup::DEFAULT_SETUP_CONNECTION
 Mage_Core_Model_Resource_Setup::VERSION_COMPARE_EQUAL
 Mage_Core_Model_Resource_Setup::VERSION_COMPARE_GREATER
 Mage_Core_Model_Resource_Setup::VERSION_COMPARE_LOWER

Documentation generated on Fri, 11 Feb 2011 17:12:30 +0200 by phpDocumentor 1.4.3