class ViewsMenuLink

Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
  2. 8.9.x core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
  3. 10 core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
  4. 10 core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
  5. 11.x core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
  6. 11.x core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink

Defines menu links provided by views.

Hierarchy

Expanded class hierarchy of ViewsMenuLink

See also

\Drupal\views\Plugin\Derivative\ViewsMenuLink

1 string reference to 'ViewsMenuLink'
views.links.menu.yml in core/modules/views/views.links.menu.yml
core/modules/views/views.links.menu.yml

File

core/modules/views/src/Plugin/Menu/ViewsMenuLink.php, line 16

Namespace

Drupal\views\Plugin\Menu
View source
class ViewsMenuLink extends MenuLinkBase implements ContainerFactoryPluginInterface {
    
    /**
     * {@inheritdoc}
     */
    protected $overrideAllowed = [
        'menu_name' => 1,
        'parent' => 1,
        'weight' => 1,
        'expanded' => 1,
        'enabled' => 1,
        'title' => 1,
        'description' => 1,
    ];
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The view executable factory.
     *
     * @var \Drupal\views\ViewExecutableFactory
     */
    protected $viewExecutableFactory;
    
    /**
     * The view executable of the menu link.
     *
     * @var \Drupal\views\ViewExecutable
     */
    protected $view;
    
    /**
     * Constructs a new ViewsMenuLink.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\views\ViewExecutableFactory $view_executable_factory
     *   The view executable factory
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ViewExecutableFactory $view_executable_factory) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
        $this->viewExecutableFactory = $view_executable_factory;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('views.executable'));
    }
    
    /**
     * Initializes the proper view.
     *
     * @return \Drupal\views\ViewExecutable
     *   The view executable.
     */
    public function loadView() {
        if (empty($this->view)) {
            $metadata = $this->getMetaData();
            $view_id = $metadata['view_id'];
            $display_id = $metadata['display_id'];
            $view_entity = $this->entityTypeManager
                ->getStorage('view')
                ->load($view_id);
            $view = $this->viewExecutableFactory
                ->get($view_entity);
            $view->setDisplay($display_id);
            $view->initDisplay();
            $this->view = $view;
        }
        return $this->view;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle() {
        // @todo Get the translated value from the config without instantiating the
        //   view. https://www.drupal.org/node/2310379
        return $this->loadView()->display_handler
            ->getOption('menu')['title'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->loadView()->display_handler
            ->getOption('menu')['description'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function isExpanded() {
        return (bool) $this->loadView()->display_handler
            ->getOption('menu')['expanded'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function updateLink(array $new_definition_values, $persist) {
        $overrides = array_intersect_key($new_definition_values, $this->overrideAllowed);
        // Update the definition.
        $this->pluginDefinition = $overrides + $this->pluginDefinition;
        if ($persist) {
            $view = $this->loadView();
            $display =& $view->storage
                ->getDisplay($view->current_display);
            // Just save the title to the original view.
            $changed = FALSE;
            foreach ($overrides as $key => $new_definition_value) {
                if (empty($display['display_options']['menu'][$key]) || $display['display_options']['menu'][$key] != $new_definition_value) {
                    $display['display_options']['menu'][$key] = $new_definition_value;
                    $changed = TRUE;
                }
            }
            if ($changed) {
                // @todo Improve this to not trigger a full rebuild of everything, if we
                //   just changed some properties. https://www.drupal.org/node/2310389
                $view->storage
                    ->save();
            }
        }
        return $this->pluginDefinition;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isDeletable() {
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function deleteLink() {
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MenuLinkBase::getCacheContexts public function Overrides CacheableDependencyInterface::getCacheContexts 3
MenuLinkBase::getCacheMaxAge public function Overrides CacheableDependencyInterface::getCacheMaxAge 2
MenuLinkBase::getCacheTags public function Overrides CacheableDependencyInterface::getCacheTags 2
MenuLinkBase::getDeleteRoute public function Overrides MenuLinkInterface::getDeleteRoute 1
MenuLinkBase::getEditRoute public function Overrides MenuLinkInterface::getEditRoute 1
MenuLinkBase::getFormClass public function Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName public function Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData public function Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions public function Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent public function Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider public function Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName public function Overrides MenuLinkInterface::getRouteName 2
MenuLinkBase::getRouteParameters public function Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getTranslateRoute public function Overrides MenuLinkInterface::getTranslateRoute 1
MenuLinkBase::getUrlObject public function Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight public function Overrides MenuLinkInterface::getWeight
MenuLinkBase::isEnabled public function Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isResettable public function Overrides MenuLinkInterface::isResettable 1
MenuLinkBase::isTranslatable public function Overrides MenuLinkInterface::isTranslatable 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ViewsMenuLink::$entityTypeManager protected property The entity type manager.
ViewsMenuLink::$overrideAllowed protected property The list of definition values where an override is allowed. Overrides MenuLinkBase::$overrideAllowed
ViewsMenuLink::$view protected property The view executable of the menu link.
ViewsMenuLink::$viewExecutableFactory protected property The view executable factory.
ViewsMenuLink::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ViewsMenuLink::deleteLink public function Deletes a menu link. Overrides MenuLinkBase::deleteLink
ViewsMenuLink::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
ViewsMenuLink::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
ViewsMenuLink::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkBase::isDeletable
ViewsMenuLink::isExpanded public function Returns whether the child menu links should always been shown. Overrides MenuLinkBase::isExpanded
ViewsMenuLink::loadView public function Initializes the proper view.
ViewsMenuLink::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
ViewsMenuLink::__construct public function Constructs a new ViewsMenuLink.

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