UserTrackerTab
class UserTrackerTab extends LocalTaskDefault implements ContainerFactoryPluginInterface (View source)
Provides route parameters needed to link to the current user tracker tab.
Traits
Provides dependency injection friendly methods for serialization.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected RouteProviderInterface | $routeProvider | The route provider to load routes by name. |
from LocalTaskDefault |
| protected bool | $active | TRUE if this plugin is forced active for options attributes. |
from LocalTaskDefault |
| protected AccountInterface | $currentUser | Current user object. |
Methods
Construct the UserTrackerTab object.
Returns the route parameters needed to render a link for the local task.
Returns the localized title to be shown for this tab.
Returns options for rendering a link to the local task.
Creates an instance of the plugin.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, AccountInterface $current_user)
Construct the UserTrackerTab object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
string
getRouteName()
Get the route name from the settings.
array
getRouteParameters(RouteMatchInterface $route_match)
Returns the route parameters needed to render a link for the local task.
string
getTitle(Request $request = NULL)
Returns the localized title to be shown for this tab.
Subclasses may add optional arguments like NodeInterface $node = NULL that will be supplied by the ControllerResolver.
int|null
getWeight()
Returns the weight of the local task.
array
getOptions(RouteMatchInterface $route_match)
Returns options for rendering a link to the local task.
$this
setActive(bool $active = TRUE)
Sets the active status.
bool
getActive()
Gets the active status.
protected RouteProviderInterface
routeProvider()
Returns the route provider.
string[]
getCacheTags()
The cache tags associated with this object.
When this object is modified, these cache tags will be invalidated.
string[]
getCacheContexts()
The cache contexts associated with this object.
These identify a specific variation/representation of the object.
Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.
int
getCacheMaxAge()
The maximum age for which this object may be cached.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.