Class Mage_Eav_Model_Entity_Setup

EAV Entity Setup Model

Mage_Eav_Model_Entity_Setup

Direct known subclasses

Mage_Catalog_Model_Resource_Setup, Mage_Checkout_Model_Resource_Setup, Mage_Customer_Model_Resource_Setup, Mage_Sales_Model_Entity_Setup, Mage_Sales_Model_Resource_Setup

Indirect known subclasses

Mage_Catalog_Model_Resource_Eav_Mysql4_Setup, Mage_Checkout_Model_Mysql4_Setup, Mage_Tax_Model_Mysql4_Setup, Mage_Tax_Model_Resource_Setup, Mage_Weee_Model_Mysql4_Setup, Mage_Weee_Model_Resource_Setup, Mage_XmlConnect_Model_Mysql4_Setup, Mage_XmlConnect_Model_Resource_Setup, Mage_Customer_Model_Entity_Setup, Mage_GiftMessage_Model_Mysql4_Setup, Mage_GiftMessage_Model_Resource_Setup, Mage_GoogleCheckout_Model_Mysql4_Setup, Mage_GoogleCheckout_Model_Resource_Setup, Mage_Paypal_Model_Mysql4_Setup, Mage_Paypal_Model_Resource_Setup, Mage_Sales_Model_Mysql4_Setup

Package: Mage\Eav
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Eav/Model/Entity/Setup.php

Methods summary
`public Mage_Eav_Model_Entity_Setup`	# `cleanCache( )` Clean cache Clean cache Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `installDefaultGroupIds( )` Install Default Group Ids Install Default Group Ids Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `addEntityType( string $code, array $params )` Add an entity type Add an entity type If already exists updates the entity type with params data Parameters `$code` `string` $code `$params` `array` $params Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `updateEntityType( string $code, string $field, string $value = null )` Update entity row Update entity row Parameters `$code` `string` $code `$field` `string` $field `$value` `string` $value Returns `Mage_Eav_Model_Entity_Setup`
`public mixed`	# `getEntityType( integer\|string $id, string $field = null )` Retrieve Entity Type Data Retrieve Entity Type Data Parameters `$id` `integer\|string` $id `$field` `string` $field Returns `mixed`
`public integer`	# `getEntityTypeId( mixed $entityTypeId )` Retrieve Entity Type Id By Id or Code Retrieve Entity Type Id By Id or Code Parameters `$entityTypeId` `mixed` $entityTypeId Returns `integer`
`public Mage_Eav_Model_Entity_Setup`	# `removeEntityType( mixed $id )` Remove entity type by Id or Code Remove entity type by Id or Code Parameters `$id` `mixed` $id Returns `Mage_Eav_Model_Entity_Setup`
`public integer`	# `getAttributeSetSortOrder( mixed $entityTypeId, integer $sortOrder = null )` Retrieve Attribute Set Sort order Retrieve Attribute Set Sort order Parameters `$entityTypeId` `mixed` $entityTypeId `$sortOrder` `integer` $sortOrder Returns `integer`
`public Mage_Eav_Model_Entity_Setup`	# `addAttributeSet( mixed $entityTypeId, string $name, integer $sortOrder = null )` Add Attribute Set Add Attribute Set Parameters `$entityTypeId` `mixed` $entityTypeId `$name` `string` $name `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `updateAttributeSet( mixed $entityTypeId, integer $id, string $field, mixed $value = null )` Update attribute set data Update attribute set data Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `integer` $id `$field` `string` $field `$value` `mixed` $value Returns `Mage_Eav_Model_Entity_Setup`
`public mixed`	# `getAttributeSet( mixed $entityTypeId, mixed $id, string $field = null )` Retrieve Attribute set data by id or name Retrieve Attribute set data by id or name Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id `$field` `string` $field Returns `mixed`
`public integer`	# `getAttributeSetId( mixed $entityTypeId, mixed $setId )` Retrieve Attribute Set Id By Id or Name Retrieve Attribute Set Id By Id or Name Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId Returns `integer` Throws `Mage_Eav_Exception`
`public Mage_Eav_Model_Entity_Setup`	# `removeAttributeSet( mixed $entityTypeId, mixed $id )` Remove Attribute Set Remove Attribute Set Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `setDefaultSetToEntityType( mixed $entityType, mixed $attributeSet = 'Default' )` Set Default Attribute Set to Entity Type Set Default Attribute Set to Entity Type Parameters `$entityType` `mixed` $entityType `$attributeSet` Returns `Mage_Eav_Model_Entity_Setup`
`public array`	# `getAllAttributeSetIds( mixed $entityTypeId = null )` Get identifiers of all attribute sets Get identifiers of all attribute sets Returns `array`
`public integer`	# `getDefaultAttributeSetId( string\|integer $entityType )` Retrieve Default Attribute Set for Entity Type Retrieve Default Attribute Set for Entity Type Parameters `$entityType` `string\|integer` $entityType Returns `integer`
`public integer`	# `getAttributeGroupSortOrder( mixed $entityTypeId, mixed $setId, integer $sortOrder = null )` Retrieve Attribute Group Sort order Retrieve Attribute Group Sort order Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$sortOrder` `integer` $sortOrder Returns `integer`
`public Mage_Eav_Model_Entity_Setup`	# `addAttributeGroup( mixed $entityTypeId, mixed $setId, string $name, integer $sortOrder = null )` Add Attribute Group Add Attribute Group Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$name` `string` $name `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `updateAttributeGroup( mixed $entityTypeId, mixed $setId, mixed $id, string $field, mixed $value = null )` Update Attribute Group Data Update Attribute Group Data Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$id` `mixed` $id `$field` `string` $field `$value` `mixed` $value Returns `Mage_Eav_Model_Entity_Setup`
`public mixed`	# `getAttributeGroup( mixed $entityTypeId, mixed $setId, mixed $id, string $field = null )` Retrieve Attribute Group Data Retrieve Attribute Group Data Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$id` `mixed` $id `$field` `string` $field Returns `mixed`
`public Mage_Eav_Model_Entity_Setup`	# `getAttributeGroupId( mixed $entityTypeId, mixed $setId, mixed $groupId )` Retrieve Attribute Group Id by Id or Name Retrieve Attribute Group Id by Id or Name Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$groupId` `mixed` $groupId Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `removeAttributeGroup( mixed $entityTypeId, mixed $setId, mixed $id )` Remove Attribute Group By Id or Name Remove Attribute Group By Id or Name Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$id` `mixed` $id Returns `Mage_Eav_Model_Entity_Setup`
`public integer`	# `getDefaultAttributeGroupId( string\|integer $entityType, integer $attributeSetId = null )` Retrieve Default Attribute Group Id By Entity Type and Attribute Set Retrieve Default Attribute Group Id By Entity Type and Attribute Set Parameters `$entityType` `string\|integer` $entityType `$attributeSetId` `integer` $attributeSetId Returns `integer`
`protected string`	# `_getValue( array $array, string $key, string $default = null )` Retrieve value from array by key or return default value Retrieve value from array by key or return default value Parameters `$array` `array` $array `$key` `string` $key `$default` `string` $default Returns `string`
`protected array`	# `_prepareValues( array $attr )` Prepare attribute values to save Prepare attribute values to save Parameters `$attr` `array` $attr Returns `array`
`protected true`	# `_validateAttributeData( array $data )` Validate attribute data before insert into table Validate attribute data before insert into table Parameters `$data` `array` $data Returns `true` Throws `Mage_Eav_Exception`
`public Mage_Eav_Model_Entity_Setup`	# `addAttribute( string\|integer $entityTypeId, string $code, array $attr )` Add attribute to an entity type Add attribute to an entity type If attribute is system will add to all existing attribute sets Parameters `$entityTypeId` `string\|integer` $entityTypeId `$code` `string` $code `$attr` `array` $attr Returns `Mage_Eav_Model_Entity_Setup`
`public`	# `addAttributeOption( array $option )` Add Attribure Option Add Attribure Option Parameters `$option` `array` $option
`public Mage_Eav_Model_Entity_Setup`	# `updateAttribute( mixed $entityTypeId, mixed $id, string $field, mixed $value = null, integer $sortOrder = null )` Update Attribute data and Attribute additional data Update Attribute data and Attribute additional data Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id `$field` `string` $field `$value` `mixed` $value `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`protected Mage_Eav_Model_Entity_Setup`	# `_updateAttribute( mixed $entityTypeId, mixed $id, string $field, mixed $value = null, integer $sortOrder = null )` Update Attribute data Update Attribute data Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id `$field` `string` $field `$value` `mixed` $value `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`protected Mage_Eav_Model_Entity_Setup`	# `_updateAttributeAdditionalData( mixed $entityTypeId, mixed $id, string $field, mixed $value = null )` Update Attribute Additional data Update Attribute Additional data Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id `$field` `string` $field `$value` `mixed` $value Returns `Mage_Eav_Model_Entity_Setup`
`public mixed`	# `getAttribute( mixed $entityTypeId, mixed $id, string $field = null )` Retrieve Attribute Data By Id or Code Retrieve Attribute Data By Id or Code Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id `$field` `string` $field Returns `mixed`
`public integer`	# `getAttributeId( mixed $entityTypeId, mixed $id )` Retrieve Attribute Id Data By Id or Code Retrieve Attribute Id Data By Id or Code Parameters `$entityTypeId` `mixed` $entityTypeId `$id` `mixed` $id Returns `integer`
`public string`	# `getAttributeTable( integer\|string $entityTypeId, integer\|string $id )` Return table name for eav attribute Return table name for eav attribute Parameters `$entityTypeId` `integer\|string` $entityTypeId Entity Type id or Entity Type code `$id` `integer\|string` $id Attribute id or Attribute code Returns `string`
`public Mage_Eav_Model_Entity_Setup`	# `removeAttribute( mixed $entityTypeId, mixed $code )` Remove Attribute Remove Attribute Parameters `$entityTypeId` `mixed` $entityTypeId `$code` `mixed` $code Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `getAttributeSortOrder( mixed $entityTypeId, mixed $setId, mixed $groupId, integer $sortOrder = null )` Retrieve Attribute Sort Order Retrieve Attribute Sort Order Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$groupId` `mixed` $groupId `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `addAttributeToSet( mixed $entityTypeId, mixed $setId, mixed $groupId, mixed $attributeId, integer $sortOrder = null )` Add Attribute to All Groups on Attribute Set Add Attribute to All Groups on Attribute Set Parameters `$entityTypeId` `mixed` $entityTypeId `$setId` `mixed` $setId `$groupId` `mixed` $groupId `$attributeId` `mixed` $attributeId `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `addAttributeToGroup( integer\|string $entityType, integer\|string $setId, integer\|string $groupId, integer\|string $attributeId, integer $sortOrder = null )` Add or update attribute to group Add or update attribute to group Parameters `$entityType` `integer\|string` $entityType `$setId` `integer\|string` $setId `$groupId` `integer\|string` $groupId `$attributeId` `integer\|string` $attributeId `$sortOrder` `integer` $sortOrder Returns `Mage_Eav_Model_Entity_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `installEntities( array $entities = null )` Install entities Install entities Parameters `$entities` `array` $entities Returns `Mage_Eav_Model_Entity_Setup`
`public unknown`	# `createEntityTables( string $baseTableName, array $options = array() )` Create entity tables Create entity tables Parameters `$baseTableName` `string` $baseName `$options` `array` $options - no-main - no-default-types - types Returns `unknown`
`protected array`	# `_getAttributeTableFields( )` Retrieve attribute table fields Retrieve attribute table fields Returns `array`
`protected Mage_Eav_Model_Entity_Setup`	# `_insertAttribute( array $data )` Insert attribute and filter data Insert attribute and filter data Parameters `$data` `array` $data Returns `Mage_Eav_Model_Entity_Setup`
`protected Mage_Eav_Model_Entity_Setup`	# `_insertAttributeAdditionalData( integer $entityTypeId, array $data )` Insert attribute additional data Insert attribute additional data Parameters `$entityTypeId` `integer` $entityTypeId `$data` `array` $data Returns `Mage_Eav_Model_Entity_Setup`

Methods inherited from Mage_Core_Model_Resource_Setup
__construct(), _getAvailableDataFiles(), _getAvailableDbFiles(), _getModifySqlFiles(), _getResource(), _getTableCacheName(), _hookQueries(), _installData(), _installResourceDb(), _modifyResourceDb(), _rollbackResourceDb(), _setResourceVersion(), _unhookQueries(), _uninstallResourceDb(), _upgradeData(), _upgradeResourceDb(), afterApplyAllUpdates(), applyAllDataUpdates(), applyAllUpdates(), applyDataUpdates(), applyUpdates(), callbackQueryHook(), deleteConfigData(), deleteTableRow(), endSetup(), getCallAfterApplyAllUpdates(), getConnection(), getFkName(), getIdxName(), getTable(), getTableRow(), run(), setConfigData(), setTable(), startSetup(), tableExists(), updateTableRow()

Constants inherited from Mage_Core_Model_Resource_Setup
`DEFAULT_SETUP_CONNECTION, TYPE_DATA_INSTALL, TYPE_DATA_UPGRADE, TYPE_DB_INSTALL, TYPE_DB_ROLLBACK, TYPE_DB_UNINSTALL, TYPE_DB_UPGRADE, VERSION_COMPARE_EQUAL, VERSION_COMPARE_GREATER, VERSION_COMPARE_LOWER`

Properties summary
`protected string`	`$_generalGroupName`	`'General'`	# General Attribute Group Name General Attribute Group Name
`public array`	`$defaultGroupIdAssociations`	`array( 'General' => 1 )`	# Default attribute group name to id pairs Default attribute group name to id pairs
`protected string`	`$_defaultGroupName`	`'Default'`	# Default attribute group name Default attribute group name
`protected string`	`$_defaultAttributeSetName`	`'Default'`	# Default attribute set name Default attribute set name

Properties inherited from Mage_Core_Model_Resource_Setup
`$_callAfterApplyAllUpdates, $_conn, $_connectionConfig, $_hadUpdates, $_moduleConfig, $_queriesHooked, $_resourceConfig, $_resourceName, $_schemaUpdatesChecked, $_setupCache, $_tables`

Packages

Classes

Interfaces

Exceptions

Class Mage_Eav_Model_Entity_Setup

Direct known subclasses

Indirect known subclasses

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters