class SystemBreadcrumbBlock in Zircon Profile 8

Provides a block to display the breadcrumbs.

Plugin annotation

@Block(
  id = "system_breadcrumb_block",
  admin_label = @Translation("Breadcrumbs")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
    • class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
      • class \Drupal\Core\Block\BlockBase implements BlockPluginInterface uses ContextAwarePluginAssignmentTrait
        • class \Drupal\system\Plugin\Block\SystemBreadcrumbBlock implements ContainerFactoryPluginInterface

File

core/modules/system/src/Plugin/Block/SystemBreadcrumbBlock.php, line 24

Contains \Drupal\system\Plugin\Block\SystemBreadcrumbBlock.

Namespace

Drupal\system\Plugin\Block

class SystemBreadcrumbBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The breadcrumb manager.
   *
   * @var \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
   */
  protected $breadcrumbManager;

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a new SystemBreadcrumbBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface $breadcrumb_manager
   *   The breadcrumb manager.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, BreadcrumbBuilderInterface $breadcrumb_manager, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->breadcrumbManager = $breadcrumb_manager;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('breadcrumb'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return $this->breadcrumbManager
      ->build($this->routeMatch)
      ->toRenderable();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::$transliteration	protected	property	The transliteration service.
BlockBase::access	public	function	Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockBase::blockAccess	protected	function	Indicates whether the block should be shown.	12
BlockBase::blockForm	public	function	Returns the configuration form elements specific to this block plugin. Overrides BlockPluginInterface::blockForm	11
BlockBase::blockSubmit	public	function	Adds block type-specific submission handling for the block form. Overrides BlockPluginInterface::blockSubmit	10
BlockBase::blockValidate	public	function	Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate	1
BlockBase::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Overrides PluginFormInterface::buildConfigurationForm	1
BlockBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration	14
BlockBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration	1
BlockBase::getMachineNameSuggestion	public	function	Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion	1
BlockBase::label	public	function	Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue	public	function	Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration	public	function	Sets the transliteration service.
BlockBase::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration	protected	function	Wraps the transliteration service.
BlockBase::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function		9
ContextAwarePluginBase::getCacheMaxAge	public	function		7
ContextAwarePluginBase::getCacheTags	public	function		4
ContextAwarePluginBase::getContext	public	function	Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
SystemBreadcrumbBlock::$breadcrumbManager	protected	property	The breadcrumb manager.
SystemBreadcrumbBlock::$routeMatch	protected	property	The current route match.
SystemBreadcrumbBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SystemBreadcrumbBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SystemBreadcrumbBlock::__construct	public	function	Constructs a new SystemBreadcrumbBlock object. Overrides BlockBase::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	1
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	1