ProductUrlPathGenerator Class Reference

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator $categoryUrlPathGenerator, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository)
	getUrlPath ($product, $category=null)
	getUrlPathWithSuffix ($product, $storeId, $category=null)
	getCanonicalUrlPath ($product, $category=null)
	getUrlKey ($product)

Data Fields
const	XML_PATH_PRODUCT_URL_SUFFIX = 'catalog/seo/product_url_suffix'

Protected Member Functions
	prepareProductDefaultUrlKey (\Magento\Catalog\Model\Product $product)
	prepareProductUrlKey (\Magento\Catalog\Model\Product $product)
	getProductUrlSuffix ($storeId=null)

Protected Attributes
	$productUrlSuffix = []
	$storeManager
	$scopeConfig
	$categoryUrlPathGenerator
	$productRepository

Detailed Description

Definition at line 8 of file ProductUrlPathGenerator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator	$categoryUrlPathGenerator,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
CategoryUrlPathGenerator	$categoryUrlPathGenerator
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository

Definition at line 45 of file ProductUrlPathGenerator.php.

      {
        $this->storeManager = $storeManager;
        $this->scopeConfig = $scopeConfig;
        $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
        $this->productRepository = $productRepository;
    }

Member Function Documentation

getCanonicalUrlPath()

getCanonicalUrlPath	(		$product,
			$category = null
	)

Get canonical product url path

Parameters

\Magento\Catalog\Model\Product	$product
\Magento\Catalog\Model\Category | null	$category

Returns

string

Definition at line 111 of file ProductUrlPathGenerator.php.

    {
        $path =  'catalog/product/view/id/' . $product->getId();
        return $category ? $path . '/category/' . $category->getId() : $path;
    }

getProductUrlSuffix()

getProductUrlSuffix (   $storeId = null )

protected

Retrieve product rewrite suffix for store

Parameters

int

$storeId

Returns

string

Definition at line 147 of file ProductUrlPathGenerator.php.

    {
        if ($storeId === null) {
            $storeId = $this->storeManager->getStore()->getId();
        }

        if (!isset($this->productUrlSuffix[$storeId])) {
            $this->productUrlSuffix[$storeId] = $this->scopeConfig->getValue(
                self::XML_PATH_PRODUCT_URL_SUFFIX,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $storeId
            );
        }
        return $this->productUrlSuffix[$storeId];
    }

getUrlKey()

getUrlKey

(

$product

)

Generate product url key based on url_key entered by merchant or product name

Parameters

\Magento\Catalog\Model\Product

$product

Returns

string|null

Definition at line 123 of file ProductUrlPathGenerator.php.

    {
        $generatedProductUrlKey = $this->prepareProductUrlKey($product);
        return ($product->getUrlKey() === false || empty($generatedProductUrlKey)) ? null : $generatedProductUrlKey;
    }

getUrlPath()

getUrlPath	(		$product,
			$category = null
	)

Retrieve Product Url path (with category if exists)

Parameters

\Magento\Catalog\Model\Product	$product
\Magento\Catalog\Model\Category	$category

Returns

string

Definition at line 65 of file ProductUrlPathGenerator.php.

    {
        $path = $product->getData('url_path');
        if ($path === null) {
            $path = $product->getUrlKey()
                ? $this->prepareProductUrlKey($product)
                : $this->prepareProductDefaultUrlKey($product);
        }
        return $category === null
            ? $path
            : $this->categoryUrlPathGenerator->getUrlPath($category) . '/' . $path;
    }

getUrlPathWithSuffix()

getUrlPathWithSuffix	(		$product,
			$storeId,
			$category = null
	)

Retrieve Product Url path with suffix

Parameters

\Magento\Catalog\Model\Product	$product
int	$storeId
\Magento\Catalog\Model\Category	$category

Returns

string

Definition at line 99 of file ProductUrlPathGenerator.php.

    {
        return $this->getUrlPath($product, $category) . $this->getProductUrlSuffix($storeId);
    }

prepareProductDefaultUrlKey()

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

protected

Prepare URL Key with stored product data (fallback for "Use Default Value" logic)

Parameters

\Magento\Catalog\Model\Product

$product

Returns

string

Definition at line 84 of file ProductUrlPathGenerator.php.

    {
        $storedProduct = $this->productRepository->getById($product->getId());
        $storedUrlKey = $storedProduct->getUrlKey();
        return $storedUrlKey ?: $product->formatUrlKey($storedProduct->getName());
    }

prepareProductUrlKey()

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

protected

Prepare url key for product

Parameters

\Magento\Catalog\Model\Product

$product

Returns

string

Definition at line 135 of file ProductUrlPathGenerator.php.

    {
        $urlKey = $product->getUrlKey();
        return $product->formatUrlKey($urlKey === '' || $urlKey === null ? $product->getName() : $urlKey);
    }

Field Documentation

$categoryUrlPathGenerator

$categoryUrlPathGenerator

protected

Definition at line 32 of file ProductUrlPathGenerator.php.

$productRepository

$productRepository

protected

Definition at line 37 of file ProductUrlPathGenerator.php.

$productUrlSuffix

$productUrlSuffix = []

protected

Definition at line 17 of file ProductUrlPathGenerator.php.

$scopeConfig

$scopeConfig

protected

Definition at line 27 of file ProductUrlPathGenerator.php.

$storeManager

$storeManager

protected

Definition at line 22 of file ProductUrlPathGenerator.php.

XML_PATH_PRODUCT_URL_SUFFIX

const XML_PATH_PRODUCT_URL_SUFFIX = 'catalog/seo/product_url_suffix'

Definition at line 10 of file ProductUrlPathGenerator.php.

---

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

• vendor/magento/module-catalog-url-rewrite/Model/ProductUrlPathGenerator.php