Thumbnail Class Reference

Inheritance diagram for Thumbnail:

Public Member Functions
	__construct (ContextInterface $context, UiComponentFactory $uiComponentFactory, \Magento\Catalog\Helper\Image $imageHelper, \Magento\Framework\UrlInterface $urlBuilder, array $components=[], array $data=[])
	prepareDataSource (array $dataSource)
Public Member Functions inherited from Column
	__construct (ContextInterface $context, UiComponentFactory $uiComponentFactory, array $components=[], array $data=[])
	getComponentName ()
	prepare ()
	prepareItems (array & $items)
Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])
	getContext ()
	getName ()
	prepare ()
	toHtml ()
	render ()
	addComponent ($name, UiComponentInterface $component)
	getComponent ($name)
	getChildComponents ()
	renderChildComponent ($name)
	getTemplate ()
	getConfiguration ()
	getJsConfig (UiComponentInterface $component)
	setData ($key, $value=null)
	getData ($key='', $index=null)
	prepareDataSource (array $dataSource)
	getDataSourceData ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Data Fields
const	NAME = 'thumbnail'
const	ALT_FIELD = 'name'
Data Fields inherited from Column
const	NAME = 'column'

Protected Member Functions
	getAlt ($row)
Protected Member Functions inherited from Column
	addFieldToSelect ()
	applySorting ()
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Additional Inherited Members
Protected Attributes inherited from Column
	$wrappedComponent
	$uiComponentFactory
Protected Attributes inherited from AbstractComponent
	$context
	$components
	$componentData = []
	$dataSources = []
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api

Since

100.0.2

Definition at line 15 of file Thumbnail.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ContextInterface	$context,
		UiComponentFactory	$uiComponentFactory,
		\Magento\Catalog\Helper\Image	$imageHelper,
		\Magento\Framework\UrlInterface	$urlBuilder,
		array	$components = [],
		array	$data = []
	)

Parameters

ContextInterface	$context
UiComponentFactory	$uiComponentFactory
\Magento\Catalog\Helper\Image	$imageHelper
\Magento\Framework\UrlInterface	$urlBuilder
array	$components
array	$data

Definition at line 29 of file Thumbnail.php.

      {
        parent::__construct($context, $uiComponentFactory, $components, $data);
        $this->imageHelper = $imageHelper;
        $this->urlBuilder = $urlBuilder;
    }

Member Function Documentation

getAlt()

getAlt (   $row )

protected

Parameters

array

$row

Returns

null|string

Definition at line 74 of file Thumbnail.php.

    {
        $altField = $this->getData('config/altField') ?: self::ALT_FIELD;
        return isset($row[$altField]) ? $row[$altField] : null;
    }

prepareDataSource()

prepareDataSource

(

array

$dataSource

)

Prepare Data Source

Parameters

array

$dataSource

Returns

array

Implements UiComponentInterface.

Definition at line 48 of file Thumbnail.php.

    {
        if (isset($dataSource['data']['items'])) {
            $fieldName = $this->getData('name');
            foreach ($dataSource['data']['items'] as & $item) {
                $product = new \Magento\Framework\DataObject($item);
                $imageHelper = $this->imageHelper->init($product, 'product_listing_thumbnail');
                $item[$fieldName . '_src'] = $imageHelper->getUrl();
                $item[$fieldName . '_alt'] = $this->getAlt($item) ?: $imageHelper->getLabel();
                $item[$fieldName . '_link'] = $this->urlBuilder->getUrl(
                    'catalog/product/edit',
                    ['id' => $product->getEntityId(), 'store' => $this->context->getRequestParam('store')]
                );
                $origImageHelper = $this->imageHelper->init($product, 'product_listing_thumbnail_preview');
                $item[$fieldName . '_orig_src'] = $origImageHelper->getUrl();
            }
        }

        return $dataSource;
    }

Field Documentation

ALT_FIELD

const ALT_FIELD = 'name'

Definition at line 19 of file Thumbnail.php.

NAME

const NAME = 'thumbnail'

Definition at line 17 of file Thumbnail.php.

---

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

• vendor/magento/module-catalog/Ui/Component/Listing/Columns/Thumbnail.php