Refactoring: Adding items to the Sitemap

[avoelkl]

PR #9970 was already an improvement to the sitemap for easier adding of additional items.

@antonkril suggested to refactor the improved behaviour even more:

Expected result

Better approach in this case would be to introduce the reversed extension point: some kind of $ItemResolver dependency that would be called by sitemap (with sitemap id argument) to load custom sitemap items.

This dependency could be implemented as a composite, or just pluginized by third-party developers to add new items to the custom list.

[piotrkwiecinski]

Here is my proposal:

interface SitemapItemResolverInterface {
    /**
      * @return SitemapItemInterface[]
      */
    public function getItems();
}

To create CmsPageSitemapItemResolver,CategorySitemapItemResolver,ProductSitemapItemResolver as implementation of above. In addition create CompositeSitemapItemResolver with constructor parameter SitemapItemResolverInterface $itemResolvers = []

DI preference for SitemapItemResolverInterface would be CompositeSitemapItemResolver

interface SitemapItemInterface {
    public function getUrl();

    public function getPriority();

    public function getChangeFrequency();

    public function getImages();

    public function getUpdatedAt();
}

As method addSitemapItem() was added only to develop and item resolvers are more flexible solution I would prefer to remove it.

I'm happy to work on it.

[vrann]

@piotrekkaminski proposal looks good, go for it!

[avoelkl]

@piotrkwiecinski see last message :) guess the wrong piotr was notified :)

[antonkril]

"Resolver" is not the best name here. "List" or "Provider" would be a better fit.

[magento-team]

Internal ticket to track issue progress: MAGETWO-70872

[piotrkwiecinski]

@antonkril I haven't noticed your comment. I could provide additional PR as a follow up to change resolver to provider. WDYT @vrann?

[magento-team]

Internal ticket to track issue progress: MAGETWO-71372

[magento-engcom-team]

@avoelkl, thank you for your report.
The issue is already fixed in develop branch
But we will consider to backport the fix to patch releases

[magento-engcom-team]

Hi @avoelkl
Can we close this issue or there are some tasks TODO?

[avoelkl]

Hi @magento-engcom-team, sorry I missed the notification. This issue can be closed.