You are here

class MenuLinkPluginConverter in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/ParamConverter/MenuLinkPluginConverter.php \Drupal\Core\ParamConverter\MenuLinkPluginConverter
  2. 9 core/lib/Drupal/Core/ProxyClass/ParamConverter/MenuLinkPluginConverter.php \Drupal\Core\ProxyClass\ParamConverter\MenuLinkPluginConverter
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/ParamConverter/MenuLinkPluginConverter.php \Drupal\Core\ParamConverter\MenuLinkPluginConverter

Parameter converter for upcasting entity ids to full objects.

Hierarchy

Expanded class hierarchy of MenuLinkPluginConverter

1 string reference to 'MenuLinkPluginConverter'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses MenuLinkPluginConverter
paramconverter.menu_link in core/core.services.yml
Drupal\Core\ParamConverter\MenuLinkPluginConverter

File

core/lib/Drupal/Core/ParamConverter/MenuLinkPluginConverter.php, line 12

Namespace

Drupal\Core\ParamConverter
View source
class MenuLinkPluginConverter implements ParamConverterInterface {

  /**
   * Plugin manager which creates the instance from the value.
   *
   * @var \Drupal\Core\Menu\MenuLinkManagerInterface
   */
  protected $menuLinkManager;

  /**
   * Constructs a new MenuLinkPluginConverter.
   *
   * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
   *   The menu link plugin manager.
   */
  public function __construct(MenuLinkManagerInterface $menu_link_manager) {
    $this->menuLinkManager = $menu_link_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function convert($value, $definition, $name, array $defaults) {
    if ($value) {
      try {
        return $this->menuLinkManager
          ->createInstance($value);
      } catch (PluginException $e) {

        // Suppress the error.
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function applies($definition, $name, Route $route) {
    return !empty($definition['type']) && $definition['type'] === 'menu_link_plugin';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MenuLinkPluginConverter::$menuLinkManager protected property Plugin manager which creates the instance from the value.
MenuLinkPluginConverter::applies public function Determines if the converter applies to a specific route and variable. Overrides ParamConverterInterface::applies
MenuLinkPluginConverter::convert public function Converts path variables to their corresponding objects. Overrides ParamConverterInterface::convert
MenuLinkPluginConverter::__construct public function Constructs a new MenuLinkPluginConverter.