How is the \Magento\CatalogUrlRewrite\Model\Category\CanonicalUrlRewriteGenerator::generate() implemented and used?

dmitry_fedyuk · March 20, 2016, 10:43am

Usage

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/CategoryUrlRewriteGenerator.php#L136-L150


/**
 * Generate list of urls per store
 *
 * @param string $storeId
 * @return \Magento\UrlRewrite\Service\V1\Data\UrlRewrite[]
 */
protected function generateForSpecificStoreView($storeId)
{
    $urls = array_merge(
        $this->canonicalUrlRewriteGenerator->generate($storeId, $this->category),
        $this->childrenUrlRewriteGenerator->generate($storeId, $this->category),
        $this->currentUrlRewritesRegenerator->generate($storeId, $this->category)
    );
    return $urls;
}

Implementation

github.com

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/Category/CanonicalUrlRewriteGenerator.php#L33-L42


/**
 * Generate list based on store view
 *
 * @param int $storeId
 * @param \Magento\Catalog\Model\Category $category
 * @return \Magento\UrlRewrite\Service\V1\Data\UrlRewrite[]
 */
public function generate($storeId, Category $category)
{
    $urlPath = $this->categoryUrlPathGenerator->getUrlPathWithSuffix($category, $storeId);

github.com

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/CategoryUrlPathGenerator.php#L93-L106


/**
 * Get category url path
 *
 * @param \Magento\Catalog\Model\Category $category
 * @param int $storeId
 * @return string
 */
public function getUrlPathWithSuffix($category, $storeId = null)
{
    if ($storeId === null) {
        $storeId = $category->getStoreId();
    }
    return $this->getUrlPath($category) . $this->getCategoryUrlSuffix($storeId);
}

github.com

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/Category/CanonicalUrlRewriteGenerator.php#L42-L42


$urlPath = $this->categoryUrlPathGenerator->getUrlPathWithSuffix($category, $storeId);

github.com

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/CategoryUrlPathGenerator.php#L62-L79


public function getUrlPath($category)
{
    if (in_array($category->getParentId(), [Category::ROOT_CATEGORY_ID, Category::TREE_ROOT_ID])) {
        return '';
    }
    $path = $category->getUrlPath();
    if ($path !== null && !$category->dataHasChangedFor('url_key') && !$category->dataHasChangedFor('parent_id')) {
        return $path;
    }
    $path = $category->getUrlKey();
    if ($path === false) {
        return $category->getUrlPath();
    }
    if ($this->isNeedToGenerateUrlPathForParent($category)) {
        $parentPath = $this->getUrlPath(
            $this->categoryRepository->get($category->getParentId(), $category->getStoreId())
        );
        $path = $parentPath === '' ? $path : $parentPath . '/' . $path;

Bug: an extra leading slash is added to the category URL keys

github.com

magento/magento2/blob/2d82d1/app/code/Magento/CatalogUrlRewrite/Model/Category/CanonicalUrlRewriteGenerator.php#L43-L50


$result = [
    $urlPath . '_' . $storeId => $this->urlRewriteFactory->create()->setStoreId($storeId)
        ->setEntityType(CategoryUrlRewriteGenerator::ENTITY_TYPE)
        ->setEntityId($category->getId())
        ->setRequestPath($urlPath)
        ->setTargetPath($this->categoryUrlPathGenerator->getCanonicalUrlPath($category))
];
return $result;

dmitry_fedyuk · March 20, 2016, 10:51am