class ViewsMenuLink
Same name in this branch
- 8.9.x core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
Same name in other branches
- 9 core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
- 9 core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
- 10 core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
- 10 core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
- 11.x core/modules/views/src/Plugin/Menu/ViewsMenuLink.php \Drupal\views\Plugin\Menu\ViewsMenuLink
- 11.x core/modules/views/src/Plugin/Derivative/ViewsMenuLink.php \Drupal\views\Plugin\Derivative\ViewsMenuLink
Defines menu links provided by views.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Menu\MenuLinkBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Menu\MenuLinkInterface
- class \Drupal\views\Plugin\Menu\ViewsMenuLink extends \Drupal\Core\Menu\MenuLinkBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
- class \Drupal\Core\Menu\MenuLinkBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Menu\MenuLinkInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
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 17
Namespace
Drupal\views\Plugin\MenuView source
class ViewsMenuLink extends MenuLinkBase implements ContainerFactoryPluginInterface {
use DeprecatedServicePropertyTrait;
/**
* {@inheritdoc}
*/
protected $deprecatedProperties = [
'entityManager' => 'entity.manager',
];
/**
* {@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 |
---|---|---|---|---|---|
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | ||
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 | 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 |
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::$deprecatedProperties | protected | property | |||
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.