ContextualLinkDefault
class ContextualLinkDefault extends PluginBase implements ContextualLinkInterface (View source)
Provides a common base implementation of a contextual link.
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 |
Methods
Constructs a \Drupal\Component\Plugin\PluginBase object.
Returns the localized title to be shown for this contextual link.
Returns the route name of the contextual link.
Returns the group this contextual link should be rendered in.
Returns the link options passed to the link generator.
Returns the weight of the contextual link.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a \Drupal\Component\Plugin\PluginBase 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.
string
getTitle(Request $request = NULL)
Returns the localized title to be shown for this contextual link.
Subclasses may add optional arguments like NodeInterface $node = NULL that will be supplied by the ControllerResolver.
string
getRouteName()
Returns the route name of the contextual link.
string
getGroup()
Returns the group this contextual link should be rendered in.
A contextual link group is a set of contextual links that are displayed together on a certain page. For example, the 'block' group displays all links related to the block, such as the block instance edit link as well as the views edit link, if it is a view block.
array
getOptions()
Returns the link options passed to the link generator.
int
getWeight()
Returns the weight of the contextual link.
The contextual links in one group are sorted by weight for display.