Gallery Class Reference

Inheritance diagram for Gallery:

Public Member Functions
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Magento\Framework\EntityManager\MetadataPool $metadataPool, $connectionName=null)
	getConnection ()
	loadDataFromTableByValueId ( $tableNameAlias, array $ids, $storeId=null, array $cols=null, array $leftJoinTables=[], $whereCondition=null)
	loadProductGalleryByAttributeId ($product, $attributeId)
	createBatchBaseSelect ($storeId, $attributeId)
	getMainTableAlias ()
	bindValueToEntity ($valueId, $entityId)
	saveDataRow ($table, array $data, array $fields=[])
	insertGallery ($data)
	deleteGallery ($valueId)
	insertGalleryValueInStore ($data)
	deleteGalleryValueInStore ($valueId, $entityId, $storeId)
	duplicate ($attributeId, $newFiles, $originalProductId, $newProductId)
	getProductImages ($product, $storeIds)
	countImageUses ($image)
Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)
	__sleep ()
	__wakeup ()
	getIdFieldName ()
	getMainTable ()
	getTable ($tableName)
	getConnection ()
	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)
	save (\Magento\Framework\Model\AbstractModel $object)
	delete (\Magento\Framework\Model\AbstractModel $object)
	addUniqueField ($field)
	resetUniqueField ()
	unserializeFields (\Magento\Framework\Model\AbstractModel $object)
	getUniqueFields ()
	hasDataChanged ($object)
	getChecksum ($table)
	afterLoad (\Magento\Framework\DataObject $object)
	beforeSave (\Magento\Framework\DataObject $object)
	afterSave (\Magento\Framework\DataObject $object)
	beforeDelete (\Magento\Framework\DataObject $object)
	afterDelete (\Magento\Framework\DataObject $object)
	serializeFields (\Magento\Framework\Model\AbstractModel $object)
Public Member Functions inherited from AbstractResource
	__construct ()
	getConnection ()
	beginTransaction ()
	addCommitCallback ($callback)
	commit ()
	rollBack ()
	getValidationRulesBeforeSave ()

Data Fields
const	GALLERY_TABLE = 'catalog_product_entity_media_gallery'
const	GALLERY_VALUE_TABLE = 'catalog_product_entity_media_gallery_value'
const	GALLERY_VALUE_TO_ENTITY_TABLE = 'catalog_product_entity_media_gallery_value_to_entity'

Protected Member Functions
	_construct ()
	createBaseLoadSelect ($entityId, $storeId, $attributeId)
	removeDuplicates (&$result)
Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)
	_setResource ($connections, $tables=null)
	_setMainTable ($mainTable, $idFieldName=null)
	_getConnection ($resourceName)
	_getLoadSelect ($field, $value, $object)
	_initUniqueFields ()
	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)
	_prepareValueForSave ($value, $type)
	_checkUnique (\Magento\Framework\Model\AbstractModel $object)
	_afterLoad (\Magento\Framework\Model\AbstractModel $object)
	_beforeSave (\Magento\Framework\Model\AbstractModel $object)
	_afterSave (\Magento\Framework\Model\AbstractModel $object)
	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)
	_afterDelete (\Magento\Framework\Model\AbstractModel $object)
	_serializeFields (\Magento\Framework\Model\AbstractModel $object)
	prepareDataForUpdate ($object)
	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)
	saveNewObject (\Magento\Framework\Model\AbstractModel $object)
	updateObject (\Magento\Framework\Model\AbstractModel $object)
	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)
	isModified (\Magento\Framework\Model\AbstractModel $object)
	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)
Protected Member Functions inherited from AbstractResource
	_construct ()
	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)
	_unserializeField (DataObject $object, $field, $defaultValue=null)
	_prepareDataForTable (DataObject $object, $table)
	_prepareTableValueForSave ($value, $type)
	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)
	getSerializer ()

Protected Attributes
	$metadata
Protected Attributes inherited from AbstractDb
	$_resources
	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION
	$_connections = []
	$_resourceModel
	$_tables = []
	$_mainTable
	$_idFieldName
	$_isPkAutoIncrement = true
	$_useIsObjectNew = false
	$_mainTableFields
	$_uniqueFields = null
	$_serializableFields = []
	$transactionManager
	$objectRelationProcessor
Protected Attributes inherited from AbstractResource
	$serializer
	$_logger

Detailed Description

Catalog product media gallery resource model.

@api

Since

101.0.0

Definition at line 16 of file Gallery.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\ResourceModel\Db\Context	$context,
		\Magento\Framework\EntityManager\MetadataPool	$metadataPool,
			$connectionName = null
	)

Parameters

\Magento\Framework\Model\ResourceModel\Db\Context	$context
\Magento\Framework\EntityManager\MetadataPool	$metadataPool
string	$connectionName

Definition at line 39 of file Gallery.php.

      {
        $this->metadata = $metadataPool->getMetadata(
            \Magento\Catalog\Api\Data\ProductInterface::class
        );

        parent::__construct($context, $connectionName);
    }

Member Function Documentation

_construct()

_construct ( )

protected

{}

Since

101.0.0

Definition at line 55 of file Gallery.php.

    {
        $this->_init(self::GALLERY_TABLE, 'value_id');
    }

bindValueToEntity()

bindValueToEntity	(		$valueId,
			$entityId
	)

Parameters

int	$valueId
int	$entityId

Returns

int

Since

101.0.0

Definition at line 257 of file Gallery.php.

    {
        return $this->saveDataRow(
            self::GALLERY_VALUE_TO_ENTITY_TABLE,
            [
                'value_id' => $valueId,
                $this->metadata->getLinkField() => $entityId
            ]
        );
    }

countImageUses()

countImageUses

(

$image

)

Counts uses of this image.

Parameters

string

$image

Returns

int

Since

101.0.8

Definition at line 482 of file Gallery.php.

    {
        $select = $this->getConnection()->select()
            ->from([$this->getMainTableAlias() => $this->getMainTable()])
            ->where(
                'value = ?',
                $image
            );
        return count($this->getConnection()->fetchAll($select));
    }

createBaseLoadSelect()

createBaseLoadSelect (   $entityId,   $storeId,   $attributeId  )

protected

Parameters

int	$entityId
int	$storeId
int	$attributeId

Returns

\Magento\Framework\DB\Select

Exceptions

Definition at line 142 of file Gallery.php.

    {
        $select =  $this->createBatchBaseSelect($storeId, $attributeId);

        $select = $select->where(
            'entity.' . $this->metadata->getLinkField() . ' = ?',
            $entityId
        );
        return $select;
    }

createBatchBaseSelect()

createBatchBaseSelect	(		$storeId,
			$attributeId
	)

Parameters

int	$storeId
int	$attributeId

Returns

\Magento\Framework\DB\Select

Exceptions

Definition at line 160 of file Gallery.php.

    {
        $linkField = $this->metadata->getLinkField();

        $positionCheckSql = $this->getConnection()->getCheckSql(
            'value.position IS NULL',
            'default_value.position',
            'value.position'
        );

        $mainTableAlias = $this->getMainTableAlias();

        $select = $this->getConnection()->select()->from(
            [$mainTableAlias => $this->getMainTable()],
            [
                'value_id',
                'file' => 'value',
                'media_type'
            ]
        )->joinInner(
            ['entity' => $this->getTable(self::GALLERY_VALUE_TO_ENTITY_TABLE)],
            $mainTableAlias . '.value_id = entity.value_id',
            [$linkField]
        )->joinLeft(
            ['value' => $this->getTable(self::GALLERY_VALUE_TABLE)],
            implode(
                ' AND ',
                [
                    $mainTableAlias . '.value_id = value.value_id',
                    $this->getConnection()->quoteInto('value.store_id = ?', (int)$storeId),
                    'value.' . $linkField . ' = entity.' . $linkField,
                ]
            ),
            ['label', 'position', 'disabled']
        )->joinLeft(
            ['default_value' => $this->getTable(self::GALLERY_VALUE_TABLE)],
            implode(
                ' AND ',
                [
                    $mainTableAlias . '.value_id = default_value.value_id',
                    $this->getConnection()->quoteInto('default_value.store_id = ?', Store::DEFAULT_STORE_ID),
                    'default_value.' . $linkField . ' = entity.' . $linkField,
                ]
            ),
            ['label_default' => 'label', 'position_default' => 'position', 'disabled_default' => 'disabled']
        )->where(
            $mainTableAlias . '.attribute_id = ?',
            $attributeId
        )->where(
            $mainTableAlias . '.disabled = 0'
        )->order(
            $positionCheckSql . ' ' . \Magento\Framework\DB\Select::SQL_ASC
        );

        return $select;
    }

deleteGallery()

deleteGallery

(

$valueId

)

Deletes gallery value in Db.

Parameters

array | integer

$valueId

Returns

$this

Since

101.0.0

Definition at line 307 of file Gallery.php.

    {
        if (is_array($valueId) && count($valueId) > 0) {
            $condition = $this->getConnection()->quoteInto('value_id IN(?) ', $valueId);
        } elseif (!is_array($valueId)) {
            $condition = $this->getConnection()->quoteInto('value_id = ? ', $valueId);
        } else {
            return $this;
        }

        $this->getConnection()->delete($this->getMainTable(), $condition);

        return $this;
    }

deleteGalleryValueInStore()

deleteGalleryValueInStore	(		$valueId,
			$entityId,
			$storeId
	)

Deletes gallery value for store in DB.

Parameters

int	$valueId
int	$entityId
int	$storeId

Returns

$this

Since

101.0.0

Definition at line 353 of file Gallery.php.

    {
        $conditions = implode(
            ' AND ',
            [
                $this->getConnection()->quoteInto('value_id = ?', (int) $valueId),
                $this->getConnection()->quoteInto($this->metadata->getLinkField() . ' = ?', (int) $entityId),
                $this->getConnection()->quoteInto('store_id = ?', (int) $storeId)
            ]
        );

        $this->getConnection()->delete(
            $this->getTable(self::GALLERY_VALUE_TABLE),
            $conditions
        );

        return $this;
    }

duplicate()

duplicate	(		$attributeId,
			$newFiles,
			$originalProductId,
			$newProductId
	)

Duplicates gallery DB values.

Parameters

int	$attributeId
array	$newFiles
int	$originalProductId
int	$newProductId

Returns

array

Since

101.0.0

Definition at line 382 of file Gallery.php.

    {
        $linkField = $this->metadata->getLinkField();

        $select = $this->getConnection()->select()->from(
            [$this->getMainTableAlias() => $this->getMainTable()],
            ['value_id', 'value']
        )->joinInner(
            ['entity' => $this->getTable(self::GALLERY_VALUE_TO_ENTITY_TABLE)],
            $this->getMainTableAlias() . '.value_id = entity.value_id',
            [$linkField]
        )->where(
            'attribute_id = ?',
            $attributeId
        )->where(
            'entity.' . $linkField . ' = ?',
            $originalProductId
        );

        $valueIdMap = [];

        // Duplicate main entries of gallery
        foreach ($this->getConnection()->fetchAll($select) as $row) {
            $data = [
                'attribute_id' => $attributeId,
                'value' => isset($newFiles[$row['value_id']]) ? $newFiles[$row['value_id']] : $row['value'],
            ];

            $valueIdMap[$row['value_id']] = $this->insertGallery($data);
            $this->bindValueToEntity($valueIdMap[$row['value_id']], $newProductId);
        }

        if (count($valueIdMap) == 0) {
            return [];
        }

        // Duplicate per store gallery values
        $select = $this->getConnection()->select()->from(
            $this->getTable(self::GALLERY_VALUE_TABLE)
        )->where(
            'value_id IN(?)',
            array_keys($valueIdMap)
        );

        foreach ($this->getConnection()->fetchAll($select) as $row) {
            unset($row['record_id']);

            $row[$linkField] = $newProductId;
            $row['value_id'] = $valueIdMap[$row['value_id']];

            $this->insertGalleryValueInStore($row);
        }

        return $valueIdMap;
    }

getConnection()

getConnection

(

)

{}

Since

101.0.0

Definition at line 64 of file Gallery.php.

    {
        return $this->metadata->getEntityConnection();
    }

getMainTableAlias()

getMainTableAlias

(

)

Returns

string

Since

101.0.0

Definition at line 246 of file Gallery.php.

    {
        return 'main';
    }

getProductImages()

getProductImages	(		$product,
			$storeIds
	)

Returns product images in specific stores.

Parameters

\Magento\Catalog\Model\Product	$product
int | array	$storeIds

Returns

array

Since

101.0.0

Definition at line 446 of file Gallery.php.

    {
        if (!is_array($storeIds)) {
            $storeIds = [$storeIds];
        }

        $mainTable = $product->getResource()->getAttribute('image')->getBackend()->getTable();

        $select = $this->getConnection()->select()->from(
            ['images' => $mainTable],
            ['value as filepath', 'store_id']
        )->joinLeft(
            ['attr' => $this->getTable('eav_attribute')],
            'images.attribute_id = attr.attribute_id',
            ['attribute_code']
        )->where(
            $this->metadata->getLinkField() . ' = ?',
            $product->getData($this->metadata->getLinkField())
        )->where(
            'store_id IN (?)',
            $storeIds
        )->where(
            'attribute_code IN (?)',
            ['small_image', 'thumbnail', 'image']
        );

        return $this->getConnection()->fetchAll($select);
    }

insertGallery()

insertGallery

(

$data

)

Inserts gallery value to DB and retrieve last Id.

Parameters

array

$data

Returns

int

Since

101.0.0

Definition at line 288 of file Gallery.php.

    {
        $data = $this->_prepareDataForTable(
            new \Magento\Framework\DataObject($data),
            $this->getMainTable()
        );

        $this->getConnection()->insert($this->getMainTable(), $data);

        return $this->getConnection()->lastInsertId($this->getMainTable());
    }

insertGalleryValueInStore()

insertGalleryValueInStore

(

$data

)

Inserts gallery value for store to Db.

Parameters

array

$data

Returns

$this

Since

101.0.0

Definition at line 329 of file Gallery.php.

    {
        $data = $this->_prepareDataForTable(
            new \Magento\Framework\DataObject($data),
            $this->getTable(self::GALLERY_VALUE_TABLE)
        );

        $this->getConnection()->insert(
            $this->getTable(self::GALLERY_VALUE_TABLE),
            $data
        );

        return $this;
    }

loadDataFromTableByValueId()

loadDataFromTableByValueId	(		$tableNameAlias,
		array	$ids,
			$storeId = null,
		array	$cols = null,
		array	$leftJoinTables = [],
			$whereCondition = null
	)

Parameters

string	$tableNameAlias
array	$ids
int | null	$storeId
array | null	$cols
array	$leftJoinTables
string	$whereCondition

Returns

array

Since

101.0.0

Definition at line 79 of file Gallery.php.

      {
        if (null == $cols) {
            $cols = '*';
        }
        $mainTableAlias = $this->getMainTableAlias();
        $select = $this->getConnection()->select()
            ->from(
                [$mainTableAlias => $this->getTable($tableNameAlias)],
                $cols
            )->where(
                $mainTableAlias . '.value_id IN(?)',
                $ids
            );
        if (null !== $storeId) {
            $select->where($mainTableAlias . '.store_id = ?', $storeId);
        }
        if (null !== $whereCondition) {
            $select->where($whereCondition);
        }
        foreach ($leftJoinTables as $joinParameters) {
            $select->joinLeft($joinParameters[0], $joinParameters[1], $joinParameters[2]);
        }
        $result = $this->getConnection()->fetchAll($select);

        return $result;
    }

loadProductGalleryByAttributeId()

loadProductGalleryByAttributeId	(		$product,
			$attributeId
	)

Parameters

\Magento\Catalog\Model\Product	$product
int	$attributeId

Returns

array

Since

101.0.0

Definition at line 119 of file Gallery.php.

    {
        $select = $this->createBaseLoadSelect(
            $product->getData($this->metadata->getLinkField()),
            $product->getStoreId(),
            $attributeId
        );

        $result = $this->getConnection()->fetchAll($select);

        $this->removeDuplicates($result);

        return $result;
    }

removeDuplicates()

removeDuplicates ( &  $result )

protected

Removes duplicates.

Parameters

array

&$result

Returns

$this

Since

101.0.0

Definition at line 224 of file Gallery.php.

    {
        $fileToId = [];

        foreach (array_keys($result) as $index) {
            if (!isset($fileToId[$result[$index]['file']])) {
                $fileToId[$result[$index]['file']] = $result[$index]['value_id'];
            } elseif ($fileToId[$result[$index]['file']] != $result[$index]['value_id']) {
                $this->deleteGallery($result[$index]['value_id']);
                unset($result[$index]);
            }
        }

        $result = array_values($result);

        return $this;
    }

saveDataRow()

saveDataRow	(		$table,
		array	$data,
		array	$fields = []
	)

Parameters

string	$table
array	$data
array	$fields

Returns

int

Since

101.0.0

Definition at line 275 of file Gallery.php.

    {
        $table = $this->getTable($table);
        return $this->getConnection()->insertOnDuplicate($table, $data, $fields);
    }

Field Documentation

$metadata

$metadata

protected

Definition at line 32 of file Gallery.php.

GALLERY_TABLE

const GALLERY_TABLE = 'catalog_product_entity_media_gallery'

#+ Constants defined for keys of data array

Definition at line 21 of file Gallery.php.

GALLERY_VALUE_TABLE

const GALLERY_VALUE_TABLE = 'catalog_product_entity_media_gallery_value'

Definition at line 23 of file Gallery.php.

GALLERY_VALUE_TO_ENTITY_TABLE

const GALLERY_VALUE_TO_ENTITY_TABLE = 'catalog_product_entity_media_gallery_value_to_entity'

Definition at line 25 of file Gallery.php.

---

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

• vendor/magento/module-catalog/Model/ResourceModel/Product/Gallery.php