EavSetup Class Reference

Inheritance diagram for EavSetup:

Public Member Functions
	__construct (ModuleDataSetupInterface $setup, Context $context, CacheInterface $cache, CollectionFactory $attrGroupCollectionFactory)
	getSetup ()
	getAttributeGroupCollectionFactory ()
	cleanCache ()
	installDefaultGroupIds ()
	addEntityType ($code, array $params)
	updateEntityType ($code, $field, $value=null)
	getEntityType ($id, $field=null)
	getEntityTypeId ($entityTypeId)
	removeEntityType ($id)
	getAttributeSetSortOrder ($entityTypeId, $sortOrder=null)
	addAttributeSet ($entityTypeId, $name, $sortOrder=null, $setId=null)
	updateAttributeSet ($entityTypeId, $id, $field, $value=null)
	getAttributeSet ($entityTypeId, $id, $field=null)
	getAttributeSetId ($entityTypeId, $setId)
	removeAttributeSet ($entityTypeId, $id)
	setDefaultSetToEntityType ($entityType, $attributeSet='Default')
	getAllAttributeSetIds ($entityTypeId=null)
	getDefaultAttributeSetId ($entityType)
	getAttributeGroupSortOrder ($entityTypeId, $setId, $sortOrder=null)
	addAttributeGroup ($entityTypeId, $setId, $name, $sortOrder=null)
	convertToAttributeGroupCode ($groupName)
	updateAttributeGroup ($entityTypeId, $setId, $id, $field, $value=null)
	getAttributeGroup ($entityTypeId, $setId, $id, $field=null)
	getAttributeGroupByCode ($entityTypeId, $setId, $code, $field=null)
	getAttributeGroupId ($entityTypeId, $setId, $groupId)
	removeAttributeGroup ($entityTypeId, $setId, $id)
	getDefaultAttributeGroupId ($entityType, $attributeSetId=null)
	getAttributesNumberInGroup ($entityTypeId, $setId, $groupId)
	addAttribute ($entityTypeId, $code, array $attr)
	addAttributeOption ($option)
	updateAttribute ($entityTypeId, $id, $field, $value=null, $sortOrder=null)
	getAttribute ($entityTypeId, $id, $field=null)
	getAttributeId ($entityTypeId, $id)
	getAttributeTable ($entityTypeId, $id)
	removeAttribute ($entityTypeId, $code)
	getAttributeSortOrder ($entityTypeId, $setId, $groupId, $sortOrder=null)
	addAttributeToSet ($entityTypeId, $setId, $groupId, $attributeId, $sortOrder=null)
	addAttributeToGroup ($entityType, $setId, $groupId, $attributeId, $sortOrder=null)
	getDefaultEntities ()
	installEntities ($entities=null)

Detailed Description

@api @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @codeCoverageIgnore

Since

100.0.2

Definition at line 25 of file EavSetup.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ModuleDataSetupInterface	$setup,
		Context	$context,
		CacheInterface	$cache,
		CollectionFactory	$attrGroupCollectionFactory
	)

Init

Parameters

ModuleDataSetupInterface	$setup
Context	$context
CacheInterface	$cache
CollectionFactory	$attrGroupCollectionFactory

Definition at line 91 of file EavSetup.php.

      {
        $this->cache = $cache;
        $this->attrGroupCollectionFactory = $attrGroupCollectionFactory;
        $this->attributeMapper = $context->getAttributeMapper();
        $this->setup = $setup;
    }

Member Function Documentation

addAttribute()

addAttribute	(		$entityTypeId,
			$code,
		array	$attr
	)

Add attribute to an entity type

If attribute is system will add to all existing attribute sets

Parameters

string | integer	$entityTypeId
string	$code
array	$attr

Returns

$this

Definition at line 819 of file EavSetup.php.

    {
        $entityTypeId = $this->getEntityTypeId($entityTypeId);

        $data = array_replace(
            ['entity_type_id' => $entityTypeId, 'attribute_code' => $code],
            $this->attributeMapper->map($attr, $entityTypeId)
        );

        $this->_validateAttributeData($data);

        $sortOrder = isset($attr['sort_order']) ? $attr['sort_order'] : null;
        $attributeId = $this->getAttribute($entityTypeId, $code, 'attribute_id');
        if ($attributeId) {
            $this->updateAttribute($entityTypeId, $attributeId, $data, null, $sortOrder);
        } else {
            $this->_insertAttribute($data);
        }

        if (!empty($attr['group']) || empty($attr['user_defined'])) {
            $select = $this->setup->getConnection()->select()->from(
                $this->setup->getTable('eav_attribute_set')
            )->where(
                'entity_type_id = :entity_type_id'
            );
            $sets = $this->setup->getConnection()->fetchAll($select, ['entity_type_id' => $entityTypeId]);
            foreach ($sets as $set) {
                if (!empty($attr['group'])) {
                    $this->addAttributeGroup($entityTypeId, $set['attribute_set_id'], $attr['group']);
                    $this->addAttributeToSet(
                        $entityTypeId,
                        $set['attribute_set_id'],
                        $attr['group'],
                        $code,
                        $sortOrder
                    );
                } else {
                    $this->addAttributeToSet(
                        $entityTypeId,
                        $set['attribute_set_id'],
                        $this->_generalGroupName,
                        $code,
                        $sortOrder
                    );
                }
            }
        }

        if (isset($attr['option']) && is_array($attr['option'])) {
            $option = $attr['option'];
            $option['attribute_id'] = $this->getAttributeId($entityTypeId, $code);
            $this->addAttributeOption($option);
        }

        return $this;
    }

addAttributeGroup()

addAttributeGroup	(		$entityTypeId,
			$setId,
			$name,
			$sortOrder = null
	)

Add Attribute Group

Parameters

int | string	$entityTypeId
int | string	$setId
string	$name
int	$sortOrder

Returns

$this

Definition at line 533 of file EavSetup.php.

    {
        $setId = $this->getAttributeSetId($entityTypeId, $setId);
        $data = ['attribute_set_id' => $setId, 'attribute_group_name' => $name];
        $attributeGroupCode = $this->convertToAttributeGroupCode($name);

        if (isset($this->defaultGroupIdAssociations[$attributeGroupCode])) {
            $data['default_id'] = $this->defaultGroupIdAssociations[$attributeGroupCode];
        }

        if ($sortOrder !== null) {
            $data['sort_order'] = $sortOrder;
        }

        $groupId = $this->getAttributeGroup($entityTypeId, $setId, $attributeGroupCode, 'attribute_group_id');
        if ($groupId) {
            $this->updateAttributeGroup($entityTypeId, $setId, $groupId, $data);
        } else {
            if ($sortOrder === null) {
                $data['sort_order'] = $this->getAttributeGroupSortOrder($entityTypeId, $setId, $sortOrder);
            }
            if (empty($data['attribute_group_code'])) {
                if (empty($attributeGroupCode)) {
                    // in the following code md5 is not used for security purposes
                    $attributeGroupCode = md5($name);
                }
                $data['attribute_group_code'] = $attributeGroupCode;
            }
            $this->setup->getConnection()->insert(
                $this->setup->getTable('eav_attribute_group'),
                $data
            );
        }

        return $this;
    }

addAttributeOption()

addAttributeOption

(

$option

)

Add Attribute Option

Parameters

array

$option

Returns

void

Exceptions

Definition at line 884 of file EavSetup.php.

    {
        $optionTable = $this->setup->getTable('eav_attribute_option');
        $optionValueTable = $this->setup->getTable('eav_attribute_option_value');

        if (isset($option['value'])) {
            foreach ($option['value'] as $optionId => $values) {
                $intOptionId = (int)$optionId;
                if (!empty($option['delete'][$optionId])) {
                    if ($intOptionId) {
                        $condition = ['option_id =?' => $intOptionId];
                        $this->setup->getConnection()->delete($optionTable, $condition);
                    }
                    continue;
                }

                if (!$intOptionId) {
                    $data = [
                        'attribute_id' => $option['attribute_id'],
                        'sort_order' => isset($option['order'][$optionId]) ? $option['order'][$optionId] : 0,
                    ];
                    $this->setup->getConnection()->insert($optionTable, $data);
                    $intOptionId = $this->setup->getConnection()->lastInsertId($optionTable);
                } else {
                    $data = [
                        'sort_order' => isset($option['order'][$optionId]) ? $option['order'][$optionId] : 0,
                    ];
                    $this->setup->getConnection()->update(
                        $optionTable,
                        $data,
                        ['option_id=?' => $intOptionId]
                    );
                }

                // Default value
                if (!isset($values[0])) {
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __("The default option isn't defined. Set the option and try again.")
                    );
                }
                $condition = ['option_id =?' => $intOptionId];
                $this->setup->getConnection()->delete($optionValueTable, $condition);
                foreach ($values as $storeId => $value) {
                    $data = ['option_id' => $intOptionId, 'store_id' => $storeId, 'value' => $value];
                    $this->setup->getConnection()->insert($optionValueTable, $data);
                }
            }
        } elseif (isset($option['values'])) {
            foreach ($option['values'] as $sortOrder => $label) {
                // add option
                $data = ['attribute_id' => $option['attribute_id'], 'sort_order' => $sortOrder];
                $this->setup->getConnection()->insert($optionTable, $data);
                $intOptionId = $this->setup->getConnection()->lastInsertId($optionTable);

                $data = ['option_id' => $intOptionId, 'store_id' => 0, 'value' => $label];
                $this->setup->getConnection()->insert($optionValueTable, $data);
            }
        }
    }

addAttributeSet()

addAttributeSet	(		$entityTypeId,
			$name,
			$sortOrder = null,
			$setId = null
	)

Add Attribute Set

Parameters

int | string	$entityTypeId
string	$name
int	$sortOrder
int	$setId

Returns

$this

Definition at line 331 of file EavSetup.php.

    {
        $data = [
            'entity_type_id' => $this->getEntityTypeId($entityTypeId),
            'attribute_set_name' => $name,
            'sort_order' => $this->getAttributeSetSortOrder($entityTypeId, $sortOrder),
        ];

        if ($setId !== null) {
            $data['attribute_set_id'] = $setId;
        }

        $setId = $this->getAttributeSet($entityTypeId, $name, 'attribute_set_id');
        if ($setId) {
            $this->updateAttributeSet($entityTypeId, $setId, $data);
        } else {
            $this->setup->getConnection()->insert(
                $this->setup->getTable('eav_attribute_set'),
                $data
            );

            $this->addAttributeGroup($entityTypeId, $name, $this->_generalGroupName);
        }

        return $this;
    }

addAttributeToGroup()

addAttributeToGroup	(		$entityType,
			$setId,
			$groupId,
			$attributeId,
			$sortOrder = null
	)

Add or update attribute to group

Parameters

int | string	$entityType
int | string	$setId
int | string	$groupId
int | string	$attributeId
int	$sortOrder

Returns

$this

Definition at line 1334 of file EavSetup.php.

    {
        $entityType = $this->getEntityTypeId($entityType);
        $setId = $this->getAttributeSetId($entityType, $setId);
        $groupId = $this->getAttributeGroupId($entityType, $setId, $groupId);
        $attributeId = $this->getAttributeId($entityType, $attributeId);

        $data = [
            'entity_type_id' => $entityType,
            'attribute_set_id' => $setId,
            'attribute_group_id' => $groupId,
            'attribute_id' => $attributeId,
        ];

        $bind = ['entity_type_id' => $entityType, 'attribute_set_id' => $setId, 'attribute_id' => $attributeId];
        $select = $this->setup->getConnection()->select()->from(
            $this->setup->getTable('eav_entity_attribute')
        )->where(
            'entity_type_id = :entity_type_id'
        )->where(
            'attribute_set_id = :attribute_set_id'
        )->where(
            'attribute_id = :attribute_id'
        );
        $row = $this->setup->getConnection()->fetchRow($select, $bind);
        if ($row) {
            // update
            if ($sortOrder !== null) {
                $data['sort_order'] = $sortOrder;
            }

            $this->setup->getConnection()->update(
                $this->setup->getTable('eav_entity_attribute'),
                $data,
                $this->setup->getConnection()->quoteInto('entity_attribute_id=?', $row['entity_attribute_id'])
            );
        } else {
            if ($sortOrder === null) {
                $select = $this->setup->getConnection()->select()->from(
                    $this->setup->getTable('eav_entity_attribute'),
                    'MAX(sort_order)'
                )->where(
                    'entity_type_id = :entity_type_id'
                )->where(
                    'attribute_set_id = :attribute_set_id'
                )->where(
                    'attribute_id = :attribute_id'
                );

                $sortOrder = $this->setup->getConnection()->fetchOne($select, $bind) + 10;
            }
            $sortOrder = is_numeric($sortOrder) ? $sortOrder : 1;
            $data['sort_order'] = $sortOrder;
            $this->setup->getConnection()->insert(
                $this->setup->getTable('eav_entity_attribute'),
                $data
            );
        }

        return $this;
    }

addAttributeToSet()

addAttributeToSet	(		$entityTypeId,
			$setId,
			$groupId,
			$attributeId,
			$sortOrder = null
	)

Add Attribute to All Groups on Attribute Set

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$groupId
int | string	$attributeId
int	$sortOrder

Returns

$this

Definition at line 1285 of file EavSetup.php.

    {
        $entityTypeId = $this->getEntityTypeId($entityTypeId);
        $setId = $this->getAttributeSetId($entityTypeId, $setId);
        $groupId = $this->getAttributeGroupId($entityTypeId, $setId, $groupId);
        $attributeId = $this->getAttributeId($entityTypeId, $attributeId);
        $table = $this->setup->getTable('eav_entity_attribute');

        $bind = ['attribute_set_id' => $setId, 'attribute_id' => $attributeId];
        $select = $this->setup->getConnection()->select()->from(
            $table
        )->where(
            'attribute_set_id = :attribute_set_id'
        )->where(
            'attribute_id = :attribute_id'
        );
        $result = $this->setup->getConnection()->fetchRow($select, $bind);

        if ($result) {
            if ($result['attribute_group_id'] != $groupId) {
                $where = ['entity_attribute_id =?' => $result['entity_attribute_id']];
                $data = ['attribute_group_id' => $groupId];
                $this->setup->getConnection()->update($table, $data, $where);
            }
        } else {
            $data = [
                'entity_type_id' => $entityTypeId,
                'attribute_set_id' => $setId,
                'attribute_group_id' => $groupId,
                'attribute_id' => $attributeId,
                'sort_order' => $this->getAttributeSortOrder($entityTypeId, $setId, $groupId, $sortOrder),
            ];

            $this->setup->getConnection()->insert($table, $data);
        }

        return $this;
    }

addEntityType()

addEntityType	(		$code,
		array	$params
	)

Add an entity type

If already exists updates the entity type with params data

Parameters

string	$code
array	$params

Returns

$this

Definition at line 184 of file EavSetup.php.

    {
        $data = [
            'entity_type_code' => $code,
            'entity_model' => $params['entity_model'],
            'attribute_model' => $this->_getValue($params, 'attribute_model'),
            'entity_table' => $this->_getValue($params, 'table', 'eav_entity'),
            'value_table_prefix' => $this->_getValue($params, 'table_prefix'),
            'entity_id_field' => $this->_getValue($params, 'id_field'),
            'increment_model' => $this->_getValue($params, 'increment_model'),
            'increment_per_store' => $this->_getValue($params, 'increment_per_store', 0),
            'increment_pad_length' => $this->_getValue($params, 'increment_pad_length', 8),
            'increment_pad_char' => $this->_getValue($params, 'increment_pad_char', 0),
            'additional_attribute_table' => $this->_getValue($params, 'additional_attribute_table'),
            'entity_attribute_collection' => $this->_getValue($params, 'entity_attribute_collection'),
        ];
        if (isset($params['entity_type_id'])) {
            $data['entity_type_id'] = $params['entity_type_id'];
        }

        if ($this->getEntityType($code, 'entity_type_id')) {
            $this->updateEntityType($code, $data);
        } else {
            $this->setup->getConnection()->insert(
                $this->setup->getTable('eav_entity_type'),
                $data
            );
        }

        if (isset($params['entity_type_id'])) {
            $this->addAttributeSet($code, $this->_defaultAttributeSetName, null, $params['entity_type_id']);
        } else {
            $this->addAttributeSet($code, $this->_defaultAttributeSetName);
        }
        $this->addAttributeGroup($code, $this->_defaultGroupName, $this->_generalGroupName);

        return $this;
    }

cleanCache()

cleanCache

(

)

Clean cache

Returns

$this

Definition at line 128 of file EavSetup.php.

    {
        $this->cache->clean([\Magento\Eav\Model\Cache\Type::CACHE_TAG]);
        return $this;
    }

convertToAttributeGroupCode()

convertToAttributeGroupCode

(

$groupName

)

Parameters

string

$groupName

Returns

string

Since

100.1.0

Definition at line 575 of file EavSetup.php.

    {
        return trim(preg_replace('/[^a-z0-9]+/', '-', strtolower($groupName)), '-');
    }

getAllAttributeSetIds()

getAllAttributeSetIds

(

$entityTypeId = null

)

Get identifiers of all attribute sets

Parameters

int | string | null

$entityTypeId

Returns

array

Definition at line 459 of file EavSetup.php.

    {
        $select = $this->setup->getConnection()->select()
            ->from($this->setup->getTable('eav_attribute_set'), 'attribute_set_id');

        $bind = [];
        if ($entityTypeId !== null) {
            $bind['entity_type_id'] = $this->getEntityTypeId($entityTypeId);
            $select->where('entity_type_id = :entity_type_id');
        }

        return $this->setup->getConnection()->fetchCol($select, $bind);
    }

getAttribute()

getAttribute	(		$entityTypeId,
			$id,
			$field = null
	)

Retrieve Attribute Data By Id or Code

Parameters

int | string	$entityTypeId
int | string	$id
string	$field

Returns

mixed

Definition at line 1128 of file EavSetup.php.

    {
        $additionalTable = $this->getEntityType($entityTypeId, 'additional_attribute_table');
        $entityTypeId = $this->getEntityTypeId($entityTypeId);
        $idField = is_numeric($id) ? 'attribute_id' : 'attribute_code';
        if (!$additionalTable) {
            return $this->setup->getTableRow('eav_attribute', $idField, $id, $field, 'entity_type_id', $entityTypeId);
        }

        $mainTable = $this->setup->getTable('eav_attribute');
        $setupCache = $this->setup->getSetupCache();
        if (!$setupCache->has($mainTable, $entityTypeId, $id)) {
            $additionalTable = $this->setup->getTable($additionalTable);
            $bind = ['id' => $id, 'entity_type_id' => $entityTypeId];
            $select = $this->setup->getConnection()->select()->from(
                ['main' => $mainTable]
            )->join(
                ['additional' => $additionalTable],
                'main.attribute_id = additional.attribute_id'
            )->where(
                "main.{$idField} = :id"
            )->where(
                'main.entity_type_id = :entity_type_id'
            );

            $row = $this->setup->getConnection()->fetchRow($select, $bind);
            if (!$row) {
                $setupCache->setRow($mainTable, $entityTypeId, $id, []);
            } else {
                $setupCache->setRow($mainTable, $entityTypeId, $row['attribute_id'], $row);
                $setupCache->setRow($mainTable, $entityTypeId, $row['attribute_code'], $row);
            }
        }

        $row = $setupCache->get($mainTable, $entityTypeId, $id);
        if ($field !== null) {
            return isset($row[$field]) ? $row[$field] : false;
        }

        return $row;
    }

getAttributeGroup()

getAttributeGroup	(		$entityTypeId,
			$setId,
			$id,
			$field = null
	)

Retrieve Attribute Group Data

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$id
string	$field

Returns

mixed

Definition at line 614 of file EavSetup.php.

    {
        if (is_numeric($id)) {
            $searchField = 'attribute_group_id';
        } else {
            $id = $this->convertToAttributeGroupCode($id);
            if (isset($this->defaultGroupIdAssociations[$id])) {
                $searchField = 'default_id';
                $id = $this->defaultGroupIdAssociations[$id];
            } else {
                $searchField = 'attribute_group_code';
            }
        }

        return $this->setup->getTableRow(
            'eav_attribute_group',
            $searchField,
            $id,
            $field,
            'attribute_set_id',
            $this->getAttributeSetId($entityTypeId, $setId)
        );
    }

getAttributeGroupByCode()

getAttributeGroupByCode	(		$entityTypeId,
			$setId,
			$code,
			$field = null
	)

Retrieve Attribute Group Data by Code

Parameters

int | string	$entityTypeId
int | string	$setId
string	$code
string	$field

Returns

mixed

Since

100.1.0

Definition at line 648 of file EavSetup.php.

    {
        return $this->setup->getTableRow(
            'eav_attribute_group',
            'attribute_group_code',
            $code,
            $field,
            'attribute_set_id',
            $this->getAttributeSetId($entityTypeId, $setId)
        );
    }

getAttributeGroupCollectionFactory()

getAttributeGroupCollectionFactory

(

)

Gets attribute group collection factory

Returns

\Magento\Eav\Model\ResourceModel\Entity\Attribute\Group\Collection

Definition at line 118 of file EavSetup.php.

    {
        return $this->attrGroupCollectionFactory->create();
    }

getAttributeGroupId()

getAttributeGroupId	(		$entityTypeId,
			$setId,
			$groupId
	)

Retrieve Attribute Group Id by Id or Name

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$groupId

Returns

$this

Exceptions

LocalizedException

Definition at line 669 of file EavSetup.php.

    {
        if (!is_numeric($groupId)) {
            $groupId = $this->getAttributeGroup($entityTypeId, $setId, $groupId, 'attribute_group_id');
        }

        if (!is_numeric($groupId)) {
            $groupId = $this->getDefaultAttributeGroupId($entityTypeId, $setId);
        }

        if (!is_numeric($groupId)) {
            throw new LocalizedException(__('The attribute group ID is incorrect. Verify the ID and try again.'));
        }
        return $groupId;
    }

getAttributeGroupSortOrder()

getAttributeGroupSortOrder	(		$entityTypeId,
			$setId,
			$sortOrder = null
	)

Retrieve Attribute Group Sort order

Parameters

int | string	$entityTypeId
int | string	$setId
int	$sortOrder

Returns

int

Definition at line 507 of file EavSetup.php.

    {
        if (!is_numeric($sortOrder)) {
            $bind = ['attribute_set_id' => $this->getAttributeSetId($entityTypeId, $setId)];
            $select = $this->setup->getConnection()->select()->from(
                $this->setup->getTable('eav_attribute_group'),
                'MAX(sort_order)'
            )->where(
                'attribute_set_id = :attribute_set_id'
            );

            $sortOrder = $this->setup->getConnection()->fetchOne($select, $bind) + 1;
        }

        return $sortOrder;
    }

getAttributeId()

getAttributeId	(		$entityTypeId,
			$id
	)

Retrieve Attribute Id Data By Id or Code

Parameters

int | string	$entityTypeId
int | string	$id

Returns

int

Definition at line 1177 of file EavSetup.php.

    {
        if (!is_numeric($id)) {
            $id = $this->getAttribute($entityTypeId, $id, 'attribute_id');
        }
        if (!is_numeric($id)) {
            return false;
        }
        return $id;
    }

getAttributeSet()

getAttributeSet	(		$entityTypeId,
			$id,
			$field = null
	)

Retrieve Attribute set data by id or name

Parameters

int | string	$entityTypeId
int | string	$id
string	$field

Returns

mixed

Definition at line 389 of file EavSetup.php.

    {
        return $this->setup->getTableRow(
            'eav_attribute_set',
            is_numeric($id) ? 'attribute_set_id' : 'attribute_set_name',
            $id,
            $field,
            'entity_type_id',
            $this->getEntityTypeId($entityTypeId)
        );
    }

getAttributeSetId()

getAttributeSetId	(		$entityTypeId,
			$setId
	)

Retrieve Attribute Set Id By Id or Name

Parameters

int | string	$entityTypeId
int | string	$setId

Returns

int

Exceptions

LocalizedException

Definition at line 409 of file EavSetup.php.

    {
        if (!is_numeric($setId)) {
            $setId = $this->getAttributeSet($entityTypeId, $setId, 'attribute_set_id');
        }
        if (!is_numeric($setId)) {
            throw new LocalizedException(__('The attribute set ID is incorrect. Verify the ID and try again.'));
        }

        return $setId;
    }

getAttributeSetSortOrder()

getAttributeSetSortOrder	(		$entityTypeId,
			$sortOrder = null
	)

Retrieve Attribute Set Sort order

Parameters

int | string	$entityTypeId
int	$sortOrder

Returns

int

Definition at line 305 of file EavSetup.php.

    {
        if (!is_numeric($sortOrder)) {
            $bind = ['entity_type_id' => $this->getEntityTypeId($entityTypeId)];
            $select = $this->setup->getConnection()->select()->from(
                $this->setup->getTable('eav_attribute_set'),
                'MAX(sort_order)'
            )->where(
                'entity_type_id = :entity_type_id'
            );

            $sortOrder = $this->setup->getConnection()->fetchOne($select, $bind) + 1;
        }

        return $sortOrder;
    }

getAttributesNumberInGroup()

getAttributesNumberInGroup	(		$entityTypeId,
			$setId,
			$groupId
	)

Get number of all attributes in group

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$groupId

Returns

string

Definition at line 740 of file EavSetup.php.

    {
        $select = $this->setup->getConnection()->select()->from(
            $this->setup->getTable('eav_entity_attribute'),
            ['count' => 'COUNT(*)']
        )->where(
            'attribute_group_id = ?',
            $this->getAttributeGroupId($entityTypeId, $setId, $groupId)
        )->where(
            'entity_type_id = ?',
            $entityTypeId
        )->where(
            'attribute_set_id = ?',
            $setId
        );

        return $this->setup->getConnection()->fetchOne($select);
    }

getAttributeSortOrder()

getAttributeSortOrder	(		$entityTypeId,
			$setId,
			$groupId,
			$sortOrder = null
	)

Retrieve Attribute Sort Order

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$groupId
int	$sortOrder

Returns

$this

Definition at line 1258 of file EavSetup.php.

    {
        if (!is_numeric($sortOrder)) {
            $bind = ['attribute_group_id' => $this->getAttributeGroupId($entityTypeId, $setId, $groupId)];
            $select = $this->setup->getConnection()->select()->from(
                $this->setup->getTable('eav_entity_attribute'),
                'MAX(sort_order)'
            )->where(
                'attribute_group_id = :attribute_group_id'
            );

            $sortOrder = $this->setup->getConnection()->fetchOne($select, $bind) + 1;
        }

        return $sortOrder;
    }

getAttributeTable()

getAttributeTable	(		$entityTypeId,
			$id
	)

Return table name for eav attribute

Parameters

int | string	$entityTypeId	Entity Type id or Entity Type code
int | string	$id	Attribute id or Attribute code

Returns

string

Definition at line 1195 of file EavSetup.php.

    {
        $entityKeyName = is_numeric($entityTypeId) ? 'entity_type_id' : 'entity_type_code';
        $attributeKeyName = is_numeric($id) ? 'attribute_id' : 'attribute_code';

        $bind = ['id' => $id, 'entity_type_id' => $entityTypeId];
        $select = $this->setup->getConnection()->select()->from(
            ['entity_type' => $this->setup->getTable('eav_entity_type')],
            ['entity_table']
        )->join(
            ['attribute' => $this->setup->getTable('eav_attribute')],
            'attribute.entity_type_id = entity_type.entity_type_id',
            ['backend_type']
        )->where(
            "entity_type.{$entityKeyName} = :entity_type_id"
        )->where(
            "attribute.{$attributeKeyName} = :id"
        )->limit(
            1
        );

        $result = $this->setup->getConnection()->fetchRow($select, $bind);
        if ($result) {
            $table = $this->setup->getTable($result['entity_table']);
            if ($result['backend_type'] != 'static') {
                $table .= '_' . $result['backend_type'];
            }
            return $table;
        }

        return false;
    }

getDefaultAttributeGroupId()

getDefaultAttributeGroupId	(		$entityType,
			$attributeSetId = null
	)

Retrieve Default Attribute Group Id By Entity Type and Attribute Set

Parameters

string | int	$entityType
int	$attributeSetId

Returns

int

Definition at line 710 of file EavSetup.php.

    {
        $entityType = $this->getEntityTypeId($entityType);
        if (!is_numeric($attributeSetId)) {
            $attributeSetId = $this->getDefaultAttributeSetId($entityType);
        }
        $bind = ['attribute_set_id' => $attributeSetId];
        $select = $this->setup->getConnection()->select()->from(
            $this->setup->getTable('eav_attribute_group'),
            'attribute_group_id'
        )->where(
            'attribute_set_id = :attribute_set_id'
        )->order(
            ['default_id ' . \Magento\Framework\DB\Select::SQL_DESC, 'sort_order']
        )->limit(
            1
        );

        return $this->setup->getConnection()->fetchOne($select, $bind);
    }

getDefaultAttributeSetId()

getDefaultAttributeSetId

(

$entityType

)

Retrieve Default Attribute Set for Entity Type

Parameters

string | int

$entityType

Returns

int

Definition at line 479 of file EavSetup.php.

    {
        $bind = ['entity_type' => $entityType];
        if (is_numeric($entityType)) {
            $where = 'entity_type_id = :entity_type';
        } else {
            $where = 'entity_type_code = :entity_type';
        }
        $select = $this->setup->getConnection()->select()->from(
            $this->setup->getTable('eav_entity_type'),
            'default_attribute_set_id'
        )->where(
            $where
        );

        return $this->setup->getConnection()->fetchOne($select, $bind);
    }

getDefaultEntities()

getDefaultEntities

(

)

Gets default entities and attributes

Returns

array

Definition at line 1403 of file EavSetup.php.

    {
        return [];
    }

getEntityType()

getEntityType	(		$id,
			$field = null
	)

Retrieve Entity Type Data

Parameters

int | string	$id
string	$field

Returns

mixed

Definition at line 250 of file EavSetup.php.

    {
        return $this->setup->getTableRow(
            'eav_entity_type',
            is_numeric($id) ? 'entity_type_id' : 'entity_type_code',
            $id,
            $field
        );
    }

getEntityTypeId()

getEntityTypeId

(

$entityTypeId

)

Retrieve Entity Type Id By Id or Code

Parameters

int | string

$entityTypeId

Returns

int

Exceptions

LocalizedException

Definition at line 267 of file EavSetup.php.

    {
        if (!is_numeric($entityTypeId)) {
            $entityTypeId = $this->getEntityType($entityTypeId, 'entity_type_id');
        }
        if (!is_numeric($entityTypeId)) {
            throw new LocalizedException(__('The entity ID is incorrect. Verify the ID and try again.'));
        }

        return $entityTypeId;
    }

getSetup()

getSetup

(

)

Gets setup model

Deprecated:

Returns

ModuleDataSetupInterface

Definition at line 108 of file EavSetup.php.

    {
        return $this->setup;
    }

installDefaultGroupIds()

installDefaultGroupIds

(

)

Install Default Group Ids

Returns

$this

Definition at line 139 of file EavSetup.php.

    {
        $setIds = $this->getAllAttributeSetIds();
        foreach ($this->defaultGroupIdAssociations as $defaultGroupCode => $defaultGroupId) {
            foreach ($setIds as $set) {
                $groupId = $this->setup->getTableRow(
                    'eav_attribute_group',
                    'attribute_group_code',
                    $defaultGroupCode,
                    'attribute_group_id',
                    'attribute_set_id',
                    $set
                );
                if (!$groupId) {
                    $groupId = $this->setup->getTableRow(
                        'eav_attribute_group',
                        'attribute_set_id',
                        $set,
                        'attribute_group_id'
                    );
                }
                $this->setup->updateTableRow(
                    'eav_attribute_group',
                    'attribute_group_id',
                    $groupId,
                    'default_id',
                    $defaultGroupId
                );
            }
        }

        return $this;
    }

installEntities()

installEntities

(

$entities = null

)

Install entities

Parameters

array

$entities

Returns

$this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 1416 of file EavSetup.php.

    {
        $this->cleanCache();

        if ($entities === null) {
            $entities = $this->getDefaultEntities();
        }

        foreach ($entities as $entityName => $entity) {
            $this->addEntityType($entityName, $entity);

            $frontendPrefix = isset($entity['frontend_prefix']) ? $entity['frontend_prefix'] : '';
            $backendPrefix = isset($entity['backend_prefix']) ? $entity['backend_prefix'] : '';
            $sourcePrefix = isset($entity['source_prefix']) ? $entity['source_prefix'] : '';

            if (is_array($entity['attributes']) && !empty($entity['attributes'])) {
                foreach ($entity['attributes'] as $attrCode => $attr) {
                    if (!empty($attr['backend'])) {
                        if ('_' === $attr['backend']) {
                            $attr['backend'] = $backendPrefix;
                        } elseif ('_' === $attr['backend'][0]) {
                            $attr['backend'] = $backendPrefix . $attr['backend'];
                        }
                    }
                    if (!empty($attr['frontend'])) {
                        if ('_' === $attr['frontend']) {
                            $attr['frontend'] = $frontendPrefix;
                        } elseif ('_' === $attr['frontend'][0]) {
                            $attr['frontend'] = $frontendPrefix . $attr['frontend'];
                        }
                    }
                    if (!empty($attr['source'])) {
                        if ('_' === $attr['source']) {
                            $attr['source'] = $sourcePrefix;
                        } elseif ('_' === $attr['source'][0]) {
                            $attr['source'] = $sourcePrefix . $attr['source'];
                        }
                    }

                    $this->addAttribute($entityName, $attrCode, $attr);
                }
            }
            $this->setDefaultSetToEntityType($entityName);
        }

        return $this;
    }

removeAttribute()

removeAttribute	(		$entityTypeId,
			$code
	)

Remove Attribute

Parameters

int | string	$entityTypeId
int | string	$code

Returns

$this

Definition at line 1235 of file EavSetup.php.

    {
        $mainTable = $this->setup->getTable('eav_attribute');
        $attribute = $this->getAttribute($entityTypeId, $code);
        if ($attribute) {
            $this->setup->deleteTableRow('eav_attribute', 'attribute_id', $attribute['attribute_id']);
            $setupCache = $this->setup->getSetupCache();
            if ($setupCache->has($mainTable, $attribute['entity_type_id'], $attribute['attribute_code'])) {
                $setupCache->remove($mainTable, $attribute['entity_type_id'], $attribute['attribute_code']);
            }
        }
        return $this;
    }

removeAttributeGroup()

removeAttributeGroup	(		$entityTypeId,
			$setId,
			$id
	)

Remove Attribute Group By Id or Name

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$id

Returns

$this

Definition at line 693 of file EavSetup.php.

    {
        $this->setup->deleteTableRow(
            'eav_attribute_group',
            'attribute_group_id',
            $this->getAttributeGroupId($entityTypeId, $setId, $id)
        );
        return $this;
    }

removeAttributeSet()

removeAttributeSet	(		$entityTypeId,
			$id
	)

Remove Attribute Set

Parameters

int | string	$entityTypeId
int | string	$id

Returns

$this

Definition at line 428 of file EavSetup.php.

    {
        $this->setup->deleteTableRow(
            'eav_attribute_set',
            'attribute_set_id',
            $this->getAttributeSetId($entityTypeId, $id)
        );
        return $this;
    }

removeEntityType()

removeEntityType

(

$id

)

Remove entity type by Id or Code

Parameters

int | string

$id

Returns

$this

Definition at line 285 of file EavSetup.php.

    {
        if (is_numeric($id)) {
            $this->setup->deleteTableRow('eav_entity_type', 'entity_type_id', $id);
        } else {
            $this->setup->deleteTableRow('eav_entity_type', 'entity_type_code', (string)$id);
        }

        return $this;
    }

setDefaultSetToEntityType()

setDefaultSetToEntityType	(		$entityType,
			$attributeSet = 'Default'
	)

Set Default Attribute Set to Entity Type

Parameters

int | string	$entityType
string	$attributeSet

Returns

$this

Definition at line 445 of file EavSetup.php.

    {
        $entityTypeId = $this->getEntityTypeId($entityType);
        $setId = $this->getAttributeSetId($entityTypeId, $attributeSet);
        $this->updateEntityType($entityTypeId, 'default_attribute_set_id', $setId);
        return $this;
    }

updateAttribute()

updateAttribute	(		$entityTypeId,
			$id,
			$field,
			$value = null,
			$sortOrder = null
	)

Update Attribute data and Attribute additional data

Parameters

int | string	$entityTypeId
int | string	$id
string | array	$field
mixed	$value
int	$sortOrder

Returns

$this

Definition at line 954 of file EavSetup.php.

    {
        $this->_updateAttribute($entityTypeId, $id, $field, $value, $sortOrder);
        $this->_updateAttributeAdditionalData($entityTypeId, $id, $field, $value);
        return $this;
    }

updateAttributeGroup()

updateAttributeGroup	(		$entityTypeId,
			$setId,
			$id,
			$field,
			$value = null
	)

Update Attribute Group Data

Parameters

int | string	$entityTypeId
int | string	$setId
int | string	$id
string	$field
mixed	$value

Returns

$this

Definition at line 590 of file EavSetup.php.

    {
        $this->setup->updateTableRow(
            'eav_attribute_group',
            'attribute_group_id',
            $this->getAttributeGroupId($entityTypeId, $setId, $id),
            $field,
            $value,
            'attribute_set_id',
            $this->getAttributeSetId($entityTypeId, $setId)
        );

        return $this;
    }

updateAttributeSet()

updateAttributeSet	(		$entityTypeId,
			$id,
			$field,
			$value = null
	)

Update attribute set data

Parameters

int | string	$entityTypeId
int	$id
string	$field
mixed	$value

Returns

$this

Definition at line 367 of file EavSetup.php.

    {
        $this->setup->updateTableRow(
            'eav_attribute_set',
            'attribute_set_id',
            $this->getAttributeSetId($entityTypeId, $id),
            $field,
            $value,
            'entity_type_id',
            $this->getEntityTypeId($entityTypeId)
        );
        return $this;
    }

updateEntityType()

updateEntityType	(		$code,
			$field,
			$value = null
	)

Update entity row

Parameters

string	$code
string	$field
string	$value

Returns

$this

Definition at line 231 of file EavSetup.php.

    {
        $this->setup->updateTableRow(
            'eav_entity_type',
            'entity_type_id',
            $this->getEntityTypeId($code),
            $field,
            $value
        );
        return $this;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-eav/Setup/EavSetup.php