class ViewsMenuLink in Zircon Profile 8

Defines menu links provided by views.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
      • class \Drupal\views\Plugin\Menu\ViewsMenuLink implements ContainerFactoryPluginInterface

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 21

Contains \Drupal\views\Plugin\Menu\ViewsMenuLink.

Namespace

Drupal\views\Plugin\Menu

class ViewsMenuLink extends MenuLinkBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  protected $overrideAllowed = array(
    'menu_name' => 1,
    'parent' => 1,
    'weight' => 1,
    'expanded' => 1,
    'enabled' => 1,
    'title' => 1,
    'description' => 1,
    'metadata' => 1,
  );

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * 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\EntityManagerInterface $entity_manager
   *   The entity manager
   * @param \Drupal\views\ViewExecutableFactory $view_executable_factory
   *   The view executable factory
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager, ViewExecutableFactory $view_executable_factory) {
    $this->configuration = $configuration;
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
    $this->entityManager = $entity_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.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->entityManager
        ->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 ($new_definition_values as $key => $new_definition_value) {
        if (isset($display['display_options']['menu'][$key]) && $display['display_options']['menu'][$key] != $new_definition_values[$key]) {
          $display['display_options']['menu'][$key] = $new_definition_values[$key];
          $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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MenuLinkBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	3
MenuLinkBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	2
MenuLinkBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	2
MenuLinkBase::getDeleteRoute	public	function	Returns route information for a route to delete the menu link. Overrides MenuLinkInterface::getDeleteRoute	1
MenuLinkBase::getEditRoute	public	function	Returns route information for a custom edit form for the menu link. Overrides MenuLinkInterface::getEditRoute	1
MenuLinkBase::getFormClass	public	function	Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName	public	function	Returns the menu name of the menu link. Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData	public	function	Returns any metadata for this link. Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions	public	function	Returns the options for this link. Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent	public	function	Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider	public	function	Returns the provider (module name) of the menu link. Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName	public	function	Returns the route name, if available. Overrides MenuLinkInterface::getRouteName	2
MenuLinkBase::getRouteParameters	public	function	Returns the route parameters, if available. Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getTranslateRoute	public	function	Returns route information for a route to translate the menu link. Overrides MenuLinkInterface::getTranslateRoute	1
MenuLinkBase::getUrlObject	public	function	Returns a URL object containing either the external path or route. Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight	public	function	Returns the weight of the menu link. Overrides MenuLinkInterface::getWeight
MenuLinkBase::isEnabled	public	function	Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isResettable	public	function	Returns whether this link can be reset. Overrides MenuLinkInterface::isResettable	1
MenuLinkBase::isTranslatable	public	function	Returns whether this link can be translated. Overrides MenuLinkInterface::isTranslatable	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.
ViewsMenuLink::$entityManager	protected	property	The entity 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. Overrides PluginBase::__construct