class ConfigTranslationContextualLink

Same name in other branches
  1. 9 core/modules/config_translation/src/Plugin/Menu/ContextualLink/ConfigTranslationContextualLink.php \Drupal\config_translation\Plugin\Menu\ContextualLink\ConfigTranslationContextualLink
  2. 8.9.x core/modules/config_translation/src/Plugin/Menu/ContextualLink/ConfigTranslationContextualLink.php \Drupal\config_translation\Plugin\Menu\ContextualLink\ConfigTranslationContextualLink
  3. 11.x core/modules/config_translation/src/Plugin/Menu/ContextualLink/ConfigTranslationContextualLink.php \Drupal\config_translation\Plugin\Menu\ContextualLink\ConfigTranslationContextualLink

Defines a contextual link plugin with a dynamic title.

Hierarchy

Expanded class hierarchy of ConfigTranslationContextualLink

File

core/modules/config_translation/src/Plugin/Menu/ContextualLink/ConfigTranslationContextualLink.php, line 12

Namespace

Drupal\config_translation\Plugin\Menu\ContextualLink
View source
class ConfigTranslationContextualLink extends ContextualLinkDefault {
    use StringTranslationTrait;
    
    /**
     * The mapper plugin discovery service.
     *
     * @var \Drupal\config_translation\ConfigMapperManagerInterface
     */
    protected $mapperManager;
    
    /**
     * {@inheritdoc}
     */
    public function getTitle(?Request $request = NULL) {
        // Use the custom 'config_translation_plugin_id' plugin definition key to
        // retrieve the title. We need to retrieve a runtime title (as opposed to
        // storing the title on the plugin definition for the link) because it
        // contains translated parts that we need in the runtime language.
        $type_name = mb_strtolower($this->mapperManager()
            ->createInstance($this->pluginDefinition['config_translation_plugin_id'])
            ->getTypeLabel());
        return $this->t('Translate @type_name', [
            '@type_name' => $type_name,
        ]);
    }
    
    /**
     * Gets the mapper manager.
     *
     * @return \Drupal\config_translation\ConfigMapperManagerInterface
     *   The mapper manager.
     */
    protected function mapperManager() {
        if (!$this->mapperManager) {
            $this->mapperManager = \Drupal::service('plugin.manager.config_translation.mapper');
        }
        return $this->mapperManager;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigTranslationContextualLink::$mapperManager protected property The mapper plugin discovery service.
ConfigTranslationContextualLink::getTitle public function Returns the localized title to be shown for this contextual link. Overrides ContextualLinkDefault::getTitle
ConfigTranslationContextualLink::mapperManager protected function Gets the mapper manager.
ContextualLinkDefault::getGroup public function Returns the group this contextual link should be rendered in. Overrides ContextualLinkInterface::getGroup
ContextualLinkDefault::getOptions public function Returns the link options passed to the link generator. Overrides ContextualLinkInterface::getOptions
ContextualLinkDefault::getRouteName public function Returns the route name of the contextual link. Overrides ContextualLinkInterface::getRouteName
ContextualLinkDefault::getWeight public function Returns the weight of the contextual link. Overrides ContextualLinkInterface::getWeight
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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