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

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 Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
  22. use Symfony\Component\OptionsResolver\OptionsResolver;
  24. /**
  25.  * Abstract class for breadcrumb menu services.
  26.  *
  27.  * @author Sylvain Deloux <sylvain.deloux@ekino.com>
  28.  */
  29. abstract class BaseBreadcrumbMenuBlockService extends MenuBlockService
  30. {
  31.     /**
  32.      * @var string
  33.      */
  34.     private $context;
  36.     /**
  37.      * @var FactoryInterface
  38.      */
  39.     private $factory;
  41.     /**
  42.      * @param string $context
  43.      * @param string $name
  44.      */
  45.     public function __construct($context, $name, EngineInterface $templating, MenuProviderInterface $menuProvider, FactoryInterface $factory)
  46.     {
  47.         parent::__construct($name, $templating, $menuProvider);
  49.         $this->context = $context;
  50.         $this->factory = $factory;
  51.     }
  53.     /**
  54.      * Return true if current BlockService handles the given context.
  55.      *
  56.      * @param string $context
  57.      *
  58.      * @return bool
  59.      */
  60.     public function handleContext($context)
  61.     {
  62.         return $this->context === $context;
  63.     }
  65.     /**
  66.      * {@inheritdoc}
  67.      */
  68.     public function getName()
  69.     {
  70.         return sprintf('Breadcrumb %s', $this->context);
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function configureSettings(OptionsResolver $resolver)
  77.     {
  78.         parent::configureSettings($resolver);
  80.         $resolver->setDefaults([
  81.             'menu_template' => '@SonataSeo/Block/breadcrumb.html.twig',
  82.             'include_homepage_link' => true,
  83.             'context' => false,
  84.         ]);
  85.     }
  87.     /**
  88.      * @return FactoryInterface
  89.      */
  90.     protected function getFactory()
  91.     {
  92.         return $this->factory;
  93.     }
  95.     /**
  96.      * @return string
  97.      */
  98.     protected function getContext()
  99.     {
  100.         return $this->context;
  101.     }
  103.     /**
  104.      * Initialize breadcrumb menu.
  105.      *
  106.      * @return ItemInterface
  107.      */
  108.     protected function getRootMenu(BlockContextInterface $blockContext)
  109.     {
  110.         $settings = $blockContext->getSettings();
  111.         /*
  112.          * @todo : Use the router to get the homepage URI
  113.          */
  115.         $menu = $this->factory->createItem('breadcrumb');
  117.         $menu->setChildrenAttribute('class', 'breadcrumb');
  119.         if (method_exists($menu, 'setCurrentUri')) {
  120.             $menu->setCurrentUri($settings['current_uri']);
  121.         }
  123.         if (method_exists($menu, 'setCurrent')) {
  124.             $menu->setCurrent($settings['current_uri']);
  125.         }
  127.         if ($settings['include_homepage_link']) {
  128.             $menu->addChild('sonata_seo_homepage_breadcrumb', ['uri' => '/']);
  129.         }
  131.         return $menu;
  132.     }
  133. }