MenuLinkAdd
class MenuLinkAdd extends LocalActionDefault (View source)
Modifies the 'Add link' local action to add a destination.
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 LocalActionDefault |
Methods
Constructs a MenuLinkAdd object.
Creates an instance of the plugin.
Returns the localized title to be shown for this action.
Returns the route parameters needed to render a link for the local action.
Returns options for rendering a link for the local action.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, RouteProviderInterface $route_provider, RedirectDestinationInterface $redirect_destination)
Constructs a MenuLinkAdd 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}
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
string
getRouteName()
Get the route name from the settings.
string
getTitle(Request $request = NULL)
Returns the localized title to be shown for this action.
Subclasses may add optional arguments like NodeInterface $node = NULL that will be supplied by the ControllerResolver.
int
getWeight()
Returns the weight for the local action.
array
getRouteParameters(RouteMatchInterface $route_match)
Returns the route parameters needed to render a link for the local action.
array
getOptions(RouteMatchInterface $route_match)
Returns options for rendering a link for the local action.
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.