class UserTrackerTab

Same name in other branches
  1. 9 core/modules/tracker/src/Plugin/Menu/UserTrackerTab.php \Drupal\tracker\Plugin\Menu\UserTrackerTab
  2. 10 core/modules/tracker/src/Plugin/Menu/UserTrackerTab.php \Drupal\tracker\Plugin\Menu\UserTrackerTab
  3. 11.x core/modules/tracker/src/Plugin/Menu/UserTrackerTab.php \Drupal\tracker\Plugin\Menu\UserTrackerTab

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

Hierarchy

Expanded class hierarchy of UserTrackerTab

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 11

Namespace

Drupal\tracker\Plugin\Menu
View source 
class UserTrackerTab extends LocalTaskDefault {
    
    /**
     * Current user object.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentUser;
    
    /**
     * Gets the current active user.
     *
     * @todo: https://www.drupal.org/node/2105123 put this method in
     *   \Drupal\Core\Plugin\PluginBase instead.
     *
     * @return \Drupal\Core\Session\AccountInterface
     */
    protected function currentUser() {
        if (!$this->currentUser) {
            $this->currentUser = \Drupal::currentUser();
        }
        return $this->currentUser;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRouteParameters(RouteMatchInterface $route_match) {
        return [
            'user' => $this->currentUser()
                ->Id(),
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
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.
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 public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 6
UserTrackerTab::$currentUser protected property Current user object.
UserTrackerTab::currentUser protected function Gets the current active user.
UserTrackerTab::getRouteParameters public function Returns the route parameters needed to render a link for the local task. Overrides LocalTaskDefault::getRouteParameters

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