class LoginLogoutMenuLink
Same name in other branches
- 9 core/modules/user/src/Plugin/Menu/LoginLogoutMenuLink.php \Drupal\user\Plugin\Menu\LoginLogoutMenuLink
- 8.9.x core/modules/user/src/Plugin/Menu/LoginLogoutMenuLink.php \Drupal\user\Plugin\Menu\LoginLogoutMenuLink
- 10 core/modules/user/src/Plugin/Menu/LoginLogoutMenuLink.php \Drupal\user\Plugin\Menu\LoginLogoutMenuLink
A menu link that shows "Log in" or "Log out" as appropriate.
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\Core\Menu\MenuLinkDefault extends \Drupal\Core\Menu\MenuLinkBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\user\Plugin\Menu\LoginLogoutMenuLink extends \Drupal\Core\Menu\MenuLinkDefault
- class \Drupal\Core\Menu\MenuLinkDefault extends \Drupal\Core\Menu\MenuLinkBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- 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 LoginLogoutMenuLink
1 string reference to 'LoginLogoutMenuLink'
- user.links.menu.yml in core/
modules/ user/ user.links.menu.yml - core/modules/user/user.links.menu.yml
File
-
core/
modules/ user/ src/ Plugin/ Menu/ LoginLogoutMenuLink.php, line 13
Namespace
Drupal\user\Plugin\MenuView source
class LoginLogoutMenuLink extends MenuLinkDefault {
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* Constructs a new LoginLogoutMenuLink.
*
* @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\Menu\StaticMenuLinkOverridesInterface $static_override
* The static override storage.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, StaticMenuLinkOverridesInterface $static_override, AccountInterface $current_user) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $static_override);
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('menu_link.static.overrides'), $container->get('current_user'));
}
/**
* {@inheritdoc}
*/
public function getTitle() {
if ($this->currentUser
->isAuthenticated()) {
return $this->t('Log out');
}
else {
return $this->t('Log in');
}
}
/**
* {@inheritdoc}
*/
public function getRouteName() {
if ($this->currentUser
->isAuthenticated()) {
return 'user.logout';
}
else {
return 'user.login';
}
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
return [
'user.roles:authenticated',
];
}
}
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 | |
LoginLogoutMenuLink::$currentUser | protected | property | The current user. | ||
LoginLogoutMenuLink::create | public static | function | Creates an instance of the plugin. | Overrides MenuLinkDefault::create | |
LoginLogoutMenuLink::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides MenuLinkBase::getCacheContexts | |
LoginLogoutMenuLink::getRouteName | public | function | Returns the route name, if available. | Overrides MenuLinkBase::getRouteName | |
LoginLogoutMenuLink::getTitle | public | function | Returns the localized title to be shown for this link. | Overrides MenuLinkDefault::getTitle | |
LoginLogoutMenuLink::__construct | public | function | Constructs a new LoginLogoutMenuLink. | Overrides MenuLinkDefault::__construct | |
MenuLinkBase::deleteLink | public | function | Deletes a menu link. | Overrides MenuLinkInterface::deleteLink | 2 |
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::getOperations | public | function | Provides an array of information to build a list of operation links. | Overrides MenuLinkInterface::getOperations | 1 |
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::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::isDeletable | public | function | Returns whether this link can be deleted. | Overrides MenuLinkInterface::isDeletable | 2 |
MenuLinkBase::isEnabled | public | function | Returns whether the menu link is enabled (not hidden). | Overrides MenuLinkInterface::isEnabled | |
MenuLinkBase::isExpanded | public | function | Returns whether the child menu links should always been shown. | Overrides MenuLinkInterface::isExpanded | 1 |
MenuLinkBase::isTranslatable | public | function | Returns whether this link can be translated. | Overrides MenuLinkInterface::isTranslatable | 1 |
MenuLinkDefault::$overrideAllowed | protected | property | The list of definition values where an override is allowed. | Overrides MenuLinkBase::$overrideAllowed | |
MenuLinkDefault::$staticOverride | protected | property | The static menu link service used to store updates to weight/parent etc. | ||
MenuLinkDefault::getDescription | public | function | Returns the description of the menu link. | Overrides MenuLinkInterface::getDescription | |
MenuLinkDefault::getResetRoute | public | function | Returns route information for a route to reset the menu link. | Overrides MenuLinkBase::getResetRoute | |
MenuLinkDefault::isResettable | public | function | Returns whether this link can be reset. | Overrides MenuLinkBase::isResettable | |
MenuLinkDefault::updateLink | public | function | Updates the definition values for a menu link. | Overrides MenuLinkInterface::updateLink | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.