class TopBarItemBase

Base class for top bar item plugins.

Hierarchy

Expanded class hierarchy of TopBarItemBase

2 files declare their use of TopBarItemBase
PageActions.php in core/modules/navigation/src/Plugin/TopBarItem/PageActions.php
TopBarItemInstantiation.php in core/modules/navigation/tests/navigation_test/src/Plugin/TopBarItem/TopBarItemInstantiation.php

File

core/modules/navigation/src/TopBarItemBase.php, line 12

Namespace

Drupal\navigation
View source 
abstract class TopBarItemBase extends PluginBase implements TopBarItemPluginInterface {
    
    /**
     * {@inheritdoc}
     */
    public function label() : string|\Stringable {
        return $this->pluginDefinition['label'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function region() : TopBarRegion {
        return $this->pluginDefinition['region'];
    }
    
    /**
     * {@inheritdoc}
     */
    public abstract function build() : array;

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin.
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
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 8
TopBarItemBase::build abstract public function Builds and returns the renderable array for this top bar item plugin. Overrides TopBarItemPluginInterface::build 2
TopBarItemBase::label public function Returns the translated plugin label. Overrides TopBarItemPluginInterface::label
TopBarItemBase::region public function Returns the plugin region. Overrides TopBarItemPluginInterface::region

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.