Inheritance diagram for NewWidget:

Public Member Functions
	__construct (\Magento\Catalog\Block\Product\Context $context, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory, \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility, \Magento\Framework\App\Http\Context $httpContext, array $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)

	getCurrentPage ()

	getCacheKeyInfo ()

	getDisplayType ()

	getProductsCount ()

	getProductsPerPage ()

	showPager ()

	getPagerHtml ()

Public Member Functions inherited from NewProduct
	__construct (\Magento\Catalog\Block\Product\Context $context, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory, \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility, \Magento\Framework\App\Http\Context $httpContext, array $data=[])

	getCacheKeyInfo ()

	setProductsCount ($count)

	getProductsCount ()

	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 ()

Public Member Functions inherited from BlockInterface
	addData (array $arr)

	setData ($key, $value=null)

Data Fields
const	DISPLAY_TYPE_ALL_PRODUCTS = 'all_products'

const	DISPLAY_TYPE_NEW_PRODUCTS = 'new_products'

const	DEFAULT_SHOW_PAGER = false

const	DEFAULT_PRODUCTS_PER_PAGE = 5

const	PAGE_VAR_NAME = 'np'

Data Fields inherited from NewProduct
const	DEFAULT_PRODUCTS_COUNT = 10

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_'

Protected Member Functions
	_getProductCollection ()

	getPageSize ()

Protected Member Functions inherited from NewProduct
	_construct ()

	_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
	$_pager

Protected Attributes inherited from NewProduct
	$_productsCount

	$httpContext

	$_catalogProductVisibility

	$_productCollectionFactory

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)

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

Detailed Description

New products widget

Definition at line 11 of file NewWidget.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Block\Product\Context	$context,
		\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory,
		\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility,
		\Magento\Framework\App\Http\Context	$httpContext,
		array	$data = `[]`,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = `null`
	)

NewWidget constructor.

Parameters

\Magento\Catalog\Block\Product\Context	$context
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory
\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility
\Magento\Framework\App\Http\Context	$httpContext
array	$data
\Magento\Framework\Serialize\Serializer\Json \| null	$serializer

Definition at line 62 of file NewWidget.php.

       {
         parent::__construct(
             $context,
             $productCollectionFactory,
             $catalogProductVisibility,
             $httpContext,
             $data
         );
         $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
     }

Member Function Documentation

◆ _getProductCollection()

_getProductCollection ( )

protected

Product collection initialize process

Returns: \Magento\Catalog\Model\ResourceModel\Product\Collection|Object|\Magento\Framework\Data\Collection

Definition at line 86 of file NewWidget.php.

     {
         switch ($this->getDisplayType()) {
             case self::DISPLAY_TYPE_NEW_PRODUCTS:
                 $collection = parent::_getProductCollection()
                     ->setPageSize($this->getPageSize())
                     ->setCurPage($this->getCurrentPage());
                 break;
             default:
                 $collection = $this->_getRecentlyAddedProductsCollection();
                 break;
         }
         return $collection;
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get key pieces for caching block content

Returns: array

Definition at line 135 of file NewWidget.php.

     {
         return array_merge(
             parent::getCacheKeyInfo(),
             [
                 $this->getDisplayType(),
                 $this->getProductsPerPage(),
                 intval($this->getRequest()->getParam($this->getData('page_var_name'), 1)),
                 $this->serializer->serialize($this->getRequest()->getParams())
             ]
         );
     }

◆ getCurrentPage()

getCurrentPage ( )

Get number of current page based on query value

Returns: int

Definition at line 125 of file NewWidget.php.

     {
         return abs((int)$this->getRequest()->getParam($this->getData('page_var_name')));
     }

◆ getDisplayType()

getDisplayType ( )

Retrieve display type for products

Returns: string

Definition at line 153 of file NewWidget.php.

     {
         if (!$this->hasData('display_type')) {
             $this->setData('display_type', self::DISPLAY_TYPE_ALL_PRODUCTS);
         }
         return $this->getData('display_type');
     }

◆ getPagerHtml()

getPagerHtml ( )

Render pagination HTML

Returns: string

Definition at line 215 of file NewWidget.php.

     {
         if ($this->showPager()) {
             if (!$this->_pager) {
                 $this->_pager = $this->getLayout()->createBlock(
                     \Magento\Catalog\Block\Product\Widget\Html\Pager::class,
                     'widget.new.product.list.pager'
                 );
 
                 $this->_pager->setUseContainer(true)
                     ->setShowAmounts(true)
                     ->setShowPerPage(false)
                     ->setPageVarName($this->getData('page_var_name'))
                     ->setLimit($this->getProductsPerPage())
                     ->setTotalLimit($this->getProductsCount())
                     ->setCollection($this->getProductCollection());
             }
             if ($this->_pager instanceof \Magento\Framework\View\Element\AbstractBlock) {
                 return $this->_pager->toHtml();
             }
         }
         return '';
     }

◆ getPageSize()

getPageSize ( )

protected

Retrieve how many products should be displayed on page

Returns: int

Definition at line 205 of file NewWidget.php.

     {
         return $this->showPager() ? $this->getProductsPerPage() : $this->getProductsCount();
     }

◆ getProductsCount()

getProductsCount ( )

Retrieve how many products should be displayed

Returns: int

Definition at line 166 of file NewWidget.php.

     {
         if (!$this->hasData('products_count')) {
             return parent::getProductsCount();
         }
         return $this->getData('products_count');
     }

◆ getProductsPerPage()

getProductsPerPage ( )

Retrieve how many products should be displayed

Returns: int

Definition at line 179 of file NewWidget.php.

     {
         if (!$this->hasData('products_per_page')) {
             $this->setData('products_per_page', self::DEFAULT_PRODUCTS_PER_PAGE);
         }
         return $this->getData('products_per_page');
     }

◆ showPager()

showPager ( )

Return flag whether pager need to be shown or not

Returns: bool

Definition at line 192 of file NewWidget.php.

     {
         if (!$this->hasData('show_pager')) {
             $this->setData('show_pager', self::DEFAULT_SHOW_PAGER);
         }
         return (bool)$this->getData('show_pager');
     }

Field Documentation

◆ $_pager

$_pager

protected

Definition at line 45 of file NewWidget.php.

◆ DEFAULT_PRODUCTS_PER_PAGE

const DEFAULT_PRODUCTS_PER_PAGE = 5

Default value for products per page

Definition at line 31 of file NewWidget.php.

◆ DEFAULT_SHOW_PAGER

const DEFAULT_SHOW_PAGER = false

Default value whether show pager or not

Definition at line 26 of file NewWidget.php.

◆ DISPLAY_TYPE_ALL_PRODUCTS

const DISPLAY_TYPE_ALL_PRODUCTS = 'all_products'

Display products type - all products

Definition at line 16 of file NewWidget.php.

◆ DISPLAY_TYPE_NEW_PRODUCTS

const DISPLAY_TYPE_NEW_PRODUCTS = 'new_products'

Display products type - new products

Definition at line 21 of file NewWidget.php.

◆ PAGE_VAR_NAME

const PAGE_VAR_NAME = 'np'

Name of request parameter for page number value

Deprecated:

Definition at line 38 of file NewWidget.php.

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

vendor/magento/module-catalog/Block/Product/Widget/NewWidget.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getProductCollection()

◆ getCacheKeyInfo()

◆ getCurrentPage()

◆ getDisplayType()

◆ getPagerHtml()

◆ getPageSize()

◆ getProductsCount()

◆ getProductsPerPage()

◆ showPager()

Field Documentation

◆ $_pager

◆ DEFAULT_PRODUCTS_PER_PAGE

◆ DEFAULT_SHOW_PAGER

◆ DISPLAY_TYPE_ALL_PRODUCTS

◆ DISPLAY_TYPE_NEW_PRODUCTS

◆ PAGE_VAR_NAME