Url Class Reference

Inheritance diagram for Url:

Public Member Functions
	__construct (\Magento\Framework\UrlFactory $urlFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Filter\FilterManager $filter, \Magento\Framework\Session\SidResolverInterface $sidResolver, UrlFinderInterface $urlFinder, array $data=[])
	getUrlInStore (\Magento\Catalog\Model\Product $product, $params=[])
	getProductUrl ($product, $useSid=null)
	formatUrlKey ($str)
	getUrl (\Magento\Catalog\Model\Product $product, $params=[])
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)

Protected Attributes
	$urlFactory
	$filter
	$storeManager
	$sidResolver
	$urlFinder
Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

Product Url model

@api

Since

100.0.2

Definition at line 17 of file Url.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\UrlFactory	$urlFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Filter\FilterManager	$filter,
		\Magento\Framework\Session\SidResolverInterface	$sidResolver,
		UrlFinderInterface	$urlFinder,
		array	$data = []
	)

Parameters

\Magento\Framework\UrlFactory	$urlFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Filter\FilterManager	$filter
\Magento\Framework\Session\SidResolverInterface	$sidResolver
UrlFinderInterface	$urlFinder
array	$data

Definition at line 56 of file Url.php.

      {
        parent::__construct($data);
        $this->urlFactory = $urlFactory;
        $this->storeManager = $storeManager;
        $this->filter = $filter;
        $this->sidResolver = $sidResolver;
        $this->urlFinder = $urlFinder;
    }

Member Function Documentation

formatUrlKey()

formatUrlKey

(

$str

)

Format Key for URL

Parameters

string

$str

Returns

string

Definition at line 122 of file Url.php.

    {
        return $this->filter->translitUrl($str);
    }

getProductUrl()

getProductUrl	(		$product,
			$useSid = null
	)

Retrieve Product URL

Parameters

\Magento\Catalog\Model\Product	$product
bool	$useSid	forced SID mode

Returns

string

Definition at line 102 of file Url.php.

    {
        if ($useSid === null) {
            $useSid = $this->sidResolver->getUseSessionInUrl();
        }

        $params = [];
        if (!$useSid) {
            $params['_nosid'] = true;
        }

        return $this->getUrl($product, $params);
    }

getUrl()

getUrl	(	\Magento\Catalog\Model\Product	$product,
			$params = []
	)

Retrieve Product URL using UrlDataObject

Parameters

\Magento\Catalog\Model\Product	$product
array	$params

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 136 of file Url.php.

    {
        $routePath = '';
        $routeParams = $params;

        $storeId = $product->getStoreId();

        $categoryId = null;

        if (!isset($params['_ignore_category']) && $product->getCategoryId() && !$product->getDoNotUseCategoryId()) {
            $categoryId = $product->getCategoryId();
        }

        if ($product->hasUrlDataObject()) {
            $requestPath = $product->getUrlDataObject()->getUrlRewrite();
            $routeParams['_scope'] = $product->getUrlDataObject()->getStoreId();
        } else {
            $requestPath = $product->getRequestPath();
            if (empty($requestPath) && $requestPath !== false) {
                $filterData = [
                    UrlRewrite::ENTITY_ID => $product->getId(),
                    UrlRewrite::ENTITY_TYPE => \Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator::ENTITY_TYPE,
                    UrlRewrite::STORE_ID => $storeId,
                ];
                if ($categoryId) {
                    $filterData[UrlRewrite::METADATA]['category_id'] = $categoryId;
                }
                $rewrite = $this->urlFinder->findOneByData($filterData);
                if ($rewrite) {
                    $requestPath = $rewrite->getRequestPath();
                    $product->setRequestPath($requestPath);
                } else {
                    $product->setRequestPath(false);
                }
            }
        }

        if (isset($routeParams['_scope'])) {
            $storeId = $this->storeManager->getStore($routeParams['_scope'])->getId();
        }

        if ($storeId != $this->storeManager->getStore()->getId()) {
            $routeParams['_scope_to_url'] = true;
        }

        if (!empty($requestPath)) {
            $routeParams['_direct'] = $requestPath;
        } else {
            $routePath = 'catalog/product/view';
            $routeParams['id'] = $product->getId();
            $routeParams['s'] = $product->getUrlKey();
            if ($categoryId) {
                $routeParams['category'] = $categoryId;
            }
        }

        // reset cached URL instance GET query params
        if (!isset($routeParams['_query'])) {
            $routeParams['_query'] = [];
        }

        return $this->getUrlInstance()->setScope($storeId)->getUrl($routePath, $routeParams);
    }

getUrlInStore()

getUrlInStore	(	\Magento\Catalog\Model\Product	$product,
			$params = []
	)

Retrieve URL in current store

Parameters

\Magento\Catalog\Model\Product	$product
array	$params	the URL route params

Returns

string

Definition at line 89 of file Url.php.

    {
        $params['_scope_to_url'] = true;
        return $this->getUrl($product, $params);
    }

Field Documentation

$filter

$filter

protected

Definition at line 29 of file Url.php.

$sidResolver

$sidResolver

protected

Definition at line 41 of file Url.php.

$storeManager

$storeManager

protected

Definition at line 36 of file Url.php.

$urlFactory

$urlFactory

protected

Definition at line 24 of file Url.php.

$urlFinder

$urlFinder

protected

Definition at line 46 of file Url.php.

---

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

• vendor/magento/module-catalog/Model/Product/Url.php