Breadcrumbs Class Reference

Inheritance diagram for Breadcrumbs:

Public Member Functions
	__construct (Data $catalogData, ScopeConfigInterface $scopeConfig, Json $json=null, Escaper $escaper=null)
	getCategoryUrlSuffix ()
	isCategoryUsedInProductUrl ()
	getProductName ()
	getJsonConfigurationHtmlEscaped ()
	getJsonConfiguration ()
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)

Additional Inherited Members
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Product breadcrumbs view model.

Definition at line 20 of file Breadcrumbs.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Data	$catalogData,
		ScopeConfigInterface	$scopeConfig,
		Json	$json = null,
		Escaper	$escaper = null
	)

Parameters

Data	$catalogData
ScopeConfigInterface	$scopeConfig
Json | null	$json
Escaper | null	$escaper	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 46 of file Breadcrumbs.php.

      {
        parent::__construct();

        $this->catalogData = $catalogData;
        $this->scopeConfig = $scopeConfig;
        $this->escaper = $escaper ?: ObjectManager::getInstance()->get(Escaper::class);
    }

Member Function Documentation

getCategoryUrlSuffix()

getCategoryUrlSuffix

(

)

Returns category URL suffix.

Returns

mixed

Definition at line 64 of file Breadcrumbs.php.

    {
        return $this->scopeConfig->getValue(
            'catalog/seo/category_url_suffix',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getJsonConfiguration()

getJsonConfiguration

(

)

Returns breadcrumb json.

Returns

string

Deprecated:

in favor of new method with name {suffix}Html{postfix}()

Definition at line 122 of file Breadcrumbs.php.

    {
        return $this->getJsonConfigurationHtmlEscaped();
    }

getJsonConfigurationHtmlEscaped()

getJsonConfigurationHtmlEscaped

(

)

Returns breadcrumb json with html escaped names

Returns

string

Definition at line 102 of file Breadcrumbs.php.

                                                      : string
    {
        return json_encode(
            [
                'breadcrumbs' => [
                    'categoryUrlSuffix' => $this->escaper->escapeHtml($this->getCategoryUrlSuffix()),
                    'userCategoryPathInUrl' => (int)$this->isCategoryUsedInProductUrl(),
                    'product' => $this->escaper->escapeHtml($this->getProductName())
                ]
            ],
            JSON_HEX_TAG
        );
    }

getProductName()

getProductName

(

)

Returns product name.

Returns

string

Definition at line 90 of file Breadcrumbs.php.

                                    : string
    {
        return $this->catalogData->getProduct() !== null
            ? $this->catalogData->getProduct()->getName()
            : '';
    }

isCategoryUsedInProductUrl()

isCategoryUsedInProductUrl

(

)

Checks if categories path is used for product URLs.

Returns

bool

Definition at line 77 of file Breadcrumbs.php.

                                                : bool
    {
        return $this->scopeConfig->isSetFlag(
            'catalog/seo/product_use_categories',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

---

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

• vendor/magento/module-catalog/ViewModel/Product/Breadcrumbs.php