BitBagCommerce / SyliusCmsPlugin

src/SitemapProvider/PageUrlProvider.php

<?php

/*
 * This file was created by developers working at BitBag
 * Do you need more information about us and what we do? Visit our https://bitbag.io website!
 * We are hiring developers from all over the world. Join us and start your new, exciting adventure and become part of us: https://bitbag.io/career
*/

declare(strict_types=1);

namespace BitBag\SyliusCmsPlugin\SitemapProvider;

use BitBag\SyliusCmsPlugin\Entity\PageInterface;
use BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface;
use BitBag\SyliusCmsPlugin\Repository\PageRepositoryInterface;
use Doctrine\Common\Collections\Collection;
use SitemapPlugin\Factory\UrlFactoryInterface;

The type SitemapPlugin\Factory\UrlFactoryInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use SitemapPlugin\Model\AlternativeUrl;

The type SitemapPlugin\Model\AlternativeUrl was not found. Maybe you did not declare it correctly or list all dependencies?

use SitemapPlugin\Model\ChangeFrequency;

The type SitemapPlugin\Model\ChangeFrequency was not found. Maybe you did not declare it correctly or list all dependencies?

use SitemapPlugin\Model\UrlInterface;

The type SitemapPlugin\Model\UrlInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use SitemapPlugin\Provider\UrlProviderInterface;

The type SitemapPlugin\Provider\UrlProviderInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Sylius\Component\Channel\Context\ChannelContextInterface;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Locale\Context\LocaleContextInterface;
use Sylius\Component\Locale\Model\LocaleInterface;
use Sylius\Component\Resource\Model\TranslationInterface;
use Symfony\Component\Routing\RouterInterface;

final class PageUrlProvider implements UrlProviderInterface
{
    /** @var PageRepositoryInterface */
    private $pageRepository;

    /** @var RouterInterface */
    private $router;

    /** @var UrlFactoryInterface */
    private $sitemapUrlFactory;

    /** @var LocaleContextInterface */
    private $localeContext;

    /** @var ChannelContextInterface */
    private $channelContext;

    public function __construct(
        PageRepositoryInterface $pageRepository,
        RouterInterface $router,
        UrlFactoryInterface $sitemapUrlFactory,
        LocaleContextInterface $localeContext,
        ChannelContextInterface $channelContext
    ) {
        $this->pageRepository = $pageRepository;
        $this->router = $router;
        $this->sitemapUrlFactory = $sitemapUrlFactory;
        $this->localeContext = $localeContext;
        $this->channelContext = $channelContext;
    }

    public function getName(): string
    {
        return 'cms_pages';
    }

    public function generate(ChannelInterface $channel): iterable
    {
        $urls = [];

        foreach ($this->getPages() as $page) {
            $urls[] = $this->createPageUrl($page);
        }

        return $urls;
    }

    private function getTranslations(PageInterface $page): Collection
    {
        return $page->getTranslations()->filter(function (TranslationInterface $translation) {
            return $this->localeInLocaleCodes($translation);
        });
    }

    private function localeInLocaleCodes(TranslationInterface $translation): bool
    {
        return in_array($translation->getLocale(), $this->getLocaleCodes());
    }

    private function getPages(): iterable
    {
        return $this->pageRepository->findEnabled(true);
    }

    private function getLocaleCodes(): array
    {
        /** @var ChannelInterface $channel */
        $channel = $this->channelContext->getChannel();

        return $channel->getLocales()->map(function (LocaleInterface $locale) {
            return $locale->getCode();
        })->toArray();
    }

    private function createPageUrl(PageInterface $page): UrlInterface
    {
        $location = $this->router->generate('bitbag_sylius_cms_plugin_shop_page_show', [
            'slug' => $page->getTranslation($this->localeContext->getLocaleCode())->getSlug(),

The method getSlug() does not exist on Sylius\Component\Resource\Model\TranslationInterface. It seems like you code against a sub-type of Sylius\Component\Resource\Model\TranslationInterface such as Sylius\Component\Product\Model\ProductTranslationInterface or BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface or Sylius\Component\Taxonomy\Model\TaxonTranslationInterface or Sylius\Component\Taxonomy\Model\TaxonTranslation or BitBag\SyliusCmsPlugin\Entity\PageTranslation or Sylius\Component\Product\Model\ProductTranslation.

            '_locale' => $this->localeContext->getLocaleCode(),
        ]);

        $pageUrl = $this->sitemapUrlFactory->createNew($location);

        $pageUrl->setChangeFrequency(ChangeFrequency::daily());
        $pageUrl->setPriority(0.7);

        if ($page->getUpdatedAt()) {
            $pageUrl->setLastModification($page->getUpdatedAt());
        } elseif ($page->getCreatedAt()) {
            $pageUrl->setLastModification($page->getCreatedAt());
        }

        /** @var PageTranslationInterface $translation */
        foreach ($this->getTranslations($page) as $translation) {
            if (!$translation->getLocale() || !$this->localeInLocaleCodes($translation) || $translation->getLocale() === $this->localeContext->getLocaleCode()) {
                continue;
            }

            $location = $this->router->generate('bitbag_sylius_cms_plugin_shop_page_show', [
                'slug' => $translation->getSlug(),
                '_locale' => $translation->getLocale(),
            ]);

            $pageUrl->addAlternative(new AlternativeUrl($location, $translation->getLocale()));
        }

        return $pageUrl;
    }
}