vendor/sonata-project/seo-bundle/src/Block/Breadcrumb/BaseBreadcrumbMenuBlockService.php line 48

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\SeoBundle\Block\Breadcrumb;
  16. use Knp\Menu\FactoryInterface;
  17. use Knp\Menu\ItemInterface;
  18. use Knp\Menu\Provider\MenuProviderInterface;
  19. use Sonata\BlockBundle\Block\BlockContextInterface;
  20. use Sonata\BlockBundle\Block\Service\MenuBlockService;
  21. use Sonata\SeoBundle\BreadcrumbInterface;
  22. use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
  23. use Symfony\Component\OptionsResolver\OptionsResolver;
  25. /**
  26.  * Abstract class for breadcrumb menu services.
  27.  *
  28.  * @author Sylvain Deloux <sylvain.deloux@ekino.com>
  29.  */
  30. abstract class BaseBreadcrumbMenuBlockService extends MenuBlockService implements BreadcrumbInterface
  31. {
  32.     /**
  33.      * @var string
  34.      */
  35.     private $context;
  37.     /**
  38.      * @var FactoryInterface
  39.      */
  40.     private $factory;
  42.     /**
  43.      * @param string $context
  44.      * @param string $name
  45.      */
  46.     public function __construct($context, $name, EngineInterface $templating, MenuProviderInterface $menuProvider, FactoryInterface $factory)
  47.     {
  48.         parent::__construct($name, $templating, $menuProvider);
  50.         $this->context = $context;
  51.         $this->factory = $factory;
  52.     }
  54.     /**
  55.      * Return true if current BlockService handles the given context.
  56.      *
  57.      * @param string $context
  58.      *
  59.      * @return bool
  60.      */
  61.     public function handleContext($context)
  62.     {
  63.         return $this->context === $context;
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function getName()
  70.     {
  71.         return sprintf('Breadcrumb %s', $this->context);
  72.     }
  74.     /**
  75.      * {@inheritdoc}
  76.      */
  77.     public function configureSettings(OptionsResolver $resolver)
  78.     {
  79.         parent::configureSettings($resolver);
  81.         $resolver->setDefaults([
  82.             'menu_template' => '@SonataSeo/Block/breadcrumb.html.twig',
  83.             'include_homepage_link' => true,
  84.             'context' => false,
  85.         ]);
  86.     }
  88.     /**
  89.      * @return FactoryInterface
  90.      */
  91.     protected function getFactory()
  92.     {
  93.         return $this->factory;
  94.     }
  96.     /**
  97.      * @return string
  98.      */
  99.     protected function getContext()
  100.     {
  101.         return $this->context;
  102.     }
  104.     /**
  105.      * Initialize breadcrumb menu.
  106.      *
  107.      * @return ItemInterface
  108.      */
  109.     protected function getRootMenu(BlockContextInterface $blockContext)
  110.     {
  111.         $settings = $blockContext->getSettings();
  112.         /*
  113.          * @todo : Use the router to get the homepage URI
  114.          */
  116.         $menu = $this->factory->createItem('breadcrumb');
  118.         $menu->setChildrenAttribute('class', 'breadcrumb');
  120.         if (method_exists($menu, 'setCurrentUri')) {
  121.             $menu->setCurrentUri($settings['current_uri']);
  122.         }
  124.         $menu->setCurrent(true);
  125.         $menu->setUri($settings['current_uri']);
  127.         if ($settings['include_homepage_link']) {
  128.             $menu->addChild('sonata_seo_homepage_breadcrumb', ['uri' => '/']);
  129.         }
  131.         return $menu;
  132.     }
  133. }