annotate core/modules/system/src/Plugin/Block/SystemBreadcrumbBlock.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\system\Plugin\Block;
Chris@0 4
Chris@0 5 use Drupal\Core\Block\BlockBase;
Chris@0 6 use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
Chris@0 7 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
Chris@0 8 use Drupal\Core\Routing\RouteMatchInterface;
Chris@0 9 use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@0 10
Chris@0 11 /**
Chris@0 12 * Provides a block to display the breadcrumbs.
Chris@0 13 *
Chris@0 14 * @Block(
Chris@0 15 * id = "system_breadcrumb_block",
Chris@0 16 * admin_label = @Translation("Breadcrumbs")
Chris@0 17 * )
Chris@0 18 */
Chris@0 19 class SystemBreadcrumbBlock extends BlockBase implements ContainerFactoryPluginInterface {
Chris@0 20
Chris@0 21 /**
Chris@0 22 * The breadcrumb manager.
Chris@0 23 *
Chris@0 24 * @var \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
Chris@0 25 */
Chris@0 26 protected $breadcrumbManager;
Chris@0 27
Chris@0 28 /**
Chris@0 29 * The current route match.
Chris@0 30 *
Chris@0 31 * @var \Drupal\Core\Routing\RouteMatchInterface
Chris@0 32 */
Chris@0 33 protected $routeMatch;
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Constructs a new SystemBreadcrumbBlock object.
Chris@0 37 *
Chris@0 38 * @param array $configuration
Chris@0 39 * A configuration array containing information about the plugin instance.
Chris@0 40 * @param string $plugin_id
Chris@0 41 * The plugin_id for the plugin instance.
Chris@0 42 * @param mixed $plugin_definition
Chris@0 43 * The plugin implementation definition.
Chris@0 44 * @param \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface $breadcrumb_manager
Chris@0 45 * The breadcrumb manager.
Chris@0 46 * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
Chris@0 47 * The current route match.
Chris@0 48 */
Chris@0 49 public function __construct(array $configuration, $plugin_id, $plugin_definition, BreadcrumbBuilderInterface $breadcrumb_manager, RouteMatchInterface $route_match) {
Chris@0 50 parent::__construct($configuration, $plugin_id, $plugin_definition);
Chris@0 51 $this->breadcrumbManager = $breadcrumb_manager;
Chris@0 52 $this->routeMatch = $route_match;
Chris@0 53 }
Chris@0 54
Chris@0 55 /**
Chris@0 56 * {@inheritdoc}
Chris@0 57 */
Chris@0 58 public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
Chris@0 59 return new static(
Chris@0 60 $configuration,
Chris@0 61 $plugin_id,
Chris@0 62 $plugin_definition,
Chris@0 63 $container->get('breadcrumb'),
Chris@0 64 $container->get('current_route_match')
Chris@0 65 );
Chris@0 66 }
Chris@0 67
Chris@0 68 /**
Chris@0 69 * {@inheritdoc}
Chris@0 70 */
Chris@0 71 public function build() {
Chris@0 72 return $this->breadcrumbManager->build($this->routeMatch)->toRenderable();
Chris@0 73 }
Chris@0 74
Chris@0 75 }