1. class
  2. Drupal
  3. \
  4. config_translation
  5. \
  6. Plugin
  7. \
  8. Menu
  9. \
  10. ContextualLink
  11. \
  12. ConfigTranslationContextualLink

ConfigTranslationContextualLink

class ConfigTranslationContextualLink extends ContextualLinkDefault (View source)

Defines a contextual link plugin with a dynamic title.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

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 TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected ConfigMapperManagerInterface $mapperManager

The mapper plugin discovery service.

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a \Drupal\Component\Plugin\PluginBase object.

from  PluginBase
string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginBase
string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  PluginBase
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  PluginBase
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
string
getTitle(Request $request = NULL)

Returns the localized title to be shown for this contextual link.

string
getRouteName()

Returns the route name of the contextual link.

from  ContextualLinkDefault
string
getGroup()

Returns the group this contextual link should be rendered in.

from  ContextualLinkDefault
array
getOptions()

Returns the link options passed to the link generator.

from  ContextualLinkDefault
int
getWeight()

Returns the weight of the contextual link.

from  ContextualLinkDefault
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
ConfigMapperManagerInterface
mapperManager()

Gets the mapper manager.

Details

in PluginBase at line 53
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a \Drupal\Component\Plugin\PluginBase object.

Parameters

array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin_id for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.

in PluginBase at line 66
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 73
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 84
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in PluginBase at line 96
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in PluginBase at line 106
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

at line 25
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.

Parameters

Request $request

Return Value

string

The title to be shown for this action.

in ContextualLinkDefault at line 24
string getRouteName()

Returns the route name of the contextual link.

Return Value

string

The name of the route this contextual link links to.

in ContextualLinkDefault at line 31
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.

Return Value

string

The contextual links group name.

in ContextualLinkDefault at line 38
array getOptions()

Returns the link options passed to the link generator.

Return Value

array

An associative array of options.

in ContextualLinkDefault at line 45
int getWeight()

Returns the weight of the contextual link.

The contextual links in one group are sorted by weight for display.

Return Value

int

The weight as positive/negative integer.

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 40
protected ConfigMapperManagerInterface mapperManager()

Gets the mapper manager.

Return Value

ConfigMapperManagerInterface

The mapper manager.