class UserTrackerTab in Drupal 9

Provides route parameters needed to link to the current user tracker tab.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Menu\LocalTaskDefault implements CacheableDependencyInterface, LocalTaskInterface uses DependencySerializationTrait
    • class \Drupal\tracker\Plugin\Menu\UserTrackerTab implements ContainerFactoryPluginInterface

1 string reference to 'UserTrackerTab'

tracker.links.task.yml in core/modules/tracker/tracker.links.task.yml

core/modules/tracker/tracker.links.task.yml

File

core/modules/tracker/src/Plugin/Menu/UserTrackerTab.php, line 14

Namespace

Drupal\tracker\Plugin\Menu

class UserTrackerTab extends LocalTaskDefault implements ContainerFactoryPluginInterface {

  /**
   * Current user object.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Construct the UserTrackerTab 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 array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, AccountInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentUser = $current_user;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getRouteParameters(RouteMatchInterface $route_match) {
    return [
      'user' => $this->currentUser
        ->id(),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LocalTaskDefault::$active	protected	property	TRUE if this plugin is forced active for options attributes.
LocalTaskDefault::$routeProvider	protected	property	The route provider to load routes by name.
LocalTaskDefault::getActive	public	function	Gets the active status. Overrides LocalTaskInterface::getActive
LocalTaskDefault::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
LocalTaskDefault::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
LocalTaskDefault::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
LocalTaskDefault::getOptions	public	function	Returns options for rendering a link to the local task. Overrides LocalTaskInterface::getOptions
LocalTaskDefault::getRouteName	public	function	Get the route name from the settings. Overrides LocalTaskInterface::getRouteName
LocalTaskDefault::getTitle	public	function	Returns the localized title to be shown for this tab. Overrides LocalTaskInterface::getTitle	4
LocalTaskDefault::getWeight	public	function	Returns the weight of the local task. Overrides LocalTaskInterface::getWeight
LocalTaskDefault::routeProvider	protected	function	Returns the route provider.
LocalTaskDefault::setActive	public	function	Sets the active status. Overrides LocalTaskInterface::setActive
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
UserTrackerTab::$currentUser	protected	property	Current user object.
UserTrackerTab::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserTrackerTab::getRouteParameters	public	function	Returns the route parameters needed to render a link for the local task. Overrides LocalTaskDefault::getRouteParameters
UserTrackerTab::__construct	public	function	Construct the UserTrackerTab object. Overrides PluginBase::__construct