Inheritance diagram for Upsell:

Public Member Functions
	__construct (\Magento\Catalog\Block\Product\Context $context, \Magento\Checkout\Model\ResourceModel\Cart $checkoutCart, \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Framework\Module\Manager $moduleManager, array $data=[])

	getItemCollection ()

	getItems ()

	getRowCount ()

	setColumnCount ($columns)

	getColumnCount ()

	resetItemsIterator ()

	getIterableItem ()

	setItemLimit ($type, $limit)

	getItemLimit ($type='')

	getIdentities ()

Public Member Functions inherited from AbstractProduct
	__construct (\Magento\Catalog\Block\Product\Context $context, array $data=[])

	getAddToCartUrl ($product, $additional=[])

	getSubmitUrl ($product, $additional=[])

	getAddToWishlistParams ($product)

	getAddToCompareUrl ()

	getMinimalQty ($product)

	getReviewsSummaryHtml (\Magento\Catalog\Model\Product $product, $templateType=false, $displayIfNoReviews=false)

	getProduct ()

	getProductUrl ($product, $additional=[])

	hasProductUrl ($product)

	getColumnCount ()

	addColumnCountLayoutDepend ($pageLayout, $columnCount)

	removeColumnCountLayoutDepend ($pageLayout)

	getColumnCountLayoutDepend ($pageLayout)

	getPageLayout ()

	getCanShowProductPrice ($product)

	displayProductStockStatus ()

	getRandomString ($length, $chars=null)

	getProductPrice (\Magento\Catalog\Model\Product $product)

	isRedirectToCartEnabled ()

	getProductDetailsHtml (\Magento\Catalog\Model\Product $product)

	getDetailsRenderer ($type=null)

	getImage ($product, $imageId, $attributes=[])

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

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)

Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_prepareData ()

	_beforeToHtml ()

Protected Member Functions inherited from AbstractProduct
	_addProductAttributesAndPrices (\Magento\Catalog\Model\ResourceModel\Product\Collection $collection)

	getDetailsRendererList ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_columnCount = 4

	$_items

	$_itemCollection

	$_itemLimits = []

	$_checkoutSession

	$_catalogProductVisibility

	$_checkoutCart

	$moduleManager

Protected Attributes inherited from AbstractProduct
	$_priceBlock = []

	$_useLinkForAsLowAs = true

	$_defaultColumnCount = 3

	$_columnCountLayoutDepend = []

	$_coreRegistry

	$_taxData

	$_catalogConfig

	$_mathRandom

	$_cartHelper

	$_wishlistHelper

	$_compareProduct

	$_imageHelper

	$reviewRenderer

	$stockRegistry

	$imageBuilder

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog product upsell items block

@api @SuppressWarnings(PHPMD.LongVariable)

Since: 100.0.2

Definition at line 18 of file Upsell.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Block\Product\Context	$context,
		\Magento\Checkout\Model\ResourceModel\Cart	$checkoutCart,
		\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Framework\Module\Manager	$moduleManager,
		array	$data = `[]`
	)

Parameters

\Magento\Catalog\Block\Product\Context	$context
\Magento\Checkout\Model\ResourceModel\Cart	$checkoutCart
\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Framework\Module\Manager	$moduleManager
array	$data

Definition at line 75 of file Upsell.php.

       {
         $this->_checkoutCart = $checkoutCart;
         $this->_catalogProductVisibility = $catalogProductVisibility;
         $this->_checkoutSession = $checkoutSession;
         $this->moduleManager = $moduleManager;
         parent::__construct(
             $context,
             $data
         );
     }

Member Function Documentation

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Returns: $this

Definition at line 126 of file Upsell.php.

     {
         $this->_prepareData();
         return parent::_beforeToHtml();
     }

◆ _prepareData()

_prepareData ( )

protected

Returns: $this

Updating collection with desired items

Definition at line 96 of file Upsell.php.

     {
         $product = $this->_coreRegistry->registry('product');
         /* @var $product \Magento\Catalog\Model\Product */
         $this->_itemCollection = $product->getUpSellProductCollection()->setPositionOrder()->addStoreFilter();
         if ($this->moduleManager->isEnabled('Magento_Checkout')) {
             $this->_addProductAttributesAndPrices($this->_itemCollection);
         }
         $this->_itemCollection->setVisibility($this->_catalogProductVisibility->getVisibleInCatalogIds());
 
         $this->_itemCollection->load();
 
         $this->_eventManager->dispatch(
             'catalog_product_upsell',
             ['product' => $product, 'collection' => $this->_itemCollection, 'limit' => null]
         );
 
         foreach ($this->_itemCollection as $product) {
             $product->setDoNotUseCategoryId(true);
         }
 
         return $this;
     }

◆ getColumnCount()

getColumnCount ( )

Returns: int

Definition at line 181 of file Upsell.php.

     {
         return $this->_columnCount;
     }

◆ getIdentities()

getIdentities ( )

Return identifiers for produced content

Returns: array

Implements IdentityInterface.

Definition at line 242 of file Upsell.php.

     {
         $identities = [];
         foreach ($this->getItems() as $item) {
             $identities = array_merge($identities, $item->getIdentities());
         }
         return $identities;
     }

◆ getItemCollection()

getItemCollection ( )

Returns: Collection

getIdentities() depends on _itemCollection populated, but it can be empty if the block is hidden

See also: https://github.com/magento/magento2/issues/5897

Definition at line 135 of file Upsell.php.

     {
         if ($this->_itemCollection === null) {
             $this->_prepareData();
         }
         return $this->_itemCollection;
     }

◆ getItemLimit()

getItemLimit ( $type = '' )

Parameters

string $type

Returns: array|int

Definition at line 225 of file Upsell.php.

     {
         if ($type == '') {
             return $this->_itemLimits;
         }
         if (isset($this->_itemLimits[$type])) {
             return $this->_itemLimits[$type];
         } else {
             return 0;
         }
     }

◆ getItems()

getItems ( )

Returns: \Magento\Framework\DataObject[]

Definition at line 150 of file Upsell.php.

     {
         if ($this->_items === null) {
             $this->_items = $this->getItemCollection()->getItems();
         }
         return $this->_items;
     }

◆ getIterableItem()

getIterableItem ( )

Returns: mixed

Definition at line 198 of file Upsell.php.

     {
         $item = current($this->_items);
         next($this->_items);
         return $item;
     }

◆ getRowCount()

getRowCount ( )

Returns: float

Definition at line 161 of file Upsell.php.

     {
         return ceil(count($this->getItemCollection()->getItems()) / $this->getColumnCount());
     }

◆ resetItemsIterator()

resetItemsIterator ( )

Returns: void

Definition at line 189 of file Upsell.php.

     {
         $this->getItems();
         reset($this->_items);
     }

◆ setColumnCount()

setColumnCount ( $columns )

Parameters

string $columns

Returns: $this

Definition at line 170 of file Upsell.php.

     {
         if ((int) $columns > 0) {
             $this->_columnCount = (int) $columns;
         }
         return $this;
     }

◆ setItemLimit()

setItemLimit	(	$type,
		$limit
	)

Set how many items we need to show in upsell block Notice: this parameter will be also applied

Parameters

string	$type
int	$limit

Returns: \Magento\Catalog\Block\Product\ProductList\Upsell

Definition at line 213 of file Upsell.php.

     {
         if ((int) $limit > 0) {
             $this->_itemLimits[$type] = (int) $limit;
         }
         return $this;
     }

Field Documentation

◆ $_catalogProductVisibility

$_catalogProductVisibility

protected

Definition at line 53 of file Upsell.php.

◆ $_checkoutCart

$_checkoutCart

protected

Definition at line 60 of file Upsell.php.

◆ $_checkoutSession

$_checkoutSession

protected

Definition at line 46 of file Upsell.php.

◆ $_columnCount

$_columnCount = 4

protected

Definition at line 24 of file Upsell.php.

◆ $_itemCollection

$_itemCollection

protected

Definition at line 34 of file Upsell.php.

◆ $_itemLimits

$_itemLimits = []

protected

Definition at line 39 of file Upsell.php.

◆ $_items

$_items

protected

Definition at line 29 of file Upsell.php.

◆ $moduleManager

$moduleManager

protected

Definition at line 65 of file Upsell.php.

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

vendor/magento/module-catalog/Block/Product/ProductList/Upsell.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _beforeToHtml()

◆ _prepareData()

◆ getColumnCount()

◆ getIdentities()

◆ getItemCollection()

◆ getItemLimit()

◆ getItems()

◆ getIterableItem()

◆ getRowCount()

◆ resetItemsIterator()

◆ setColumnCount()

◆ setItemLimit()

Field Documentation

◆ $_catalogProductVisibility

◆ $_checkoutCart

◆ $_checkoutSession

◆ $_columnCount

◆ $_itemCollection

◆ $_itemLimits

◆ $_items

◆ $moduleManager