class LoginLogoutMenuLink

A menu link that shows "Log in" or "Log out" as appropriate.

Hierarchy

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\Menu
View 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
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
LoginLogoutMenuLink::$currentUser protected property The current user.
LoginLogoutMenuLink::create public static function Overrides MenuLinkDefault::create
LoginLogoutMenuLink::getCacheContexts public function Overrides MenuLinkBase::getCacheContexts
LoginLogoutMenuLink::getRouteName public function Overrides MenuLinkBase::getRouteName
LoginLogoutMenuLink::getTitle public function Overrides MenuLinkDefault::getTitle
LoginLogoutMenuLink::__construct public function Constructs a new LoginLogoutMenuLink. Overrides MenuLinkDefault::__construct
MenuLinkBase::deleteLink public function Overrides MenuLinkInterface::deleteLink 2
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::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::isDeletable public function Overrides MenuLinkInterface::isDeletable 2
MenuLinkBase::isEnabled public function Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded public function Overrides MenuLinkInterface::isExpanded 1
MenuLinkBase::isTranslatable public function Overrides MenuLinkInterface::isTranslatable 1
MenuLinkDefault::$overrideAllowed protected property Overrides MenuLinkBase::$overrideAllowed
MenuLinkDefault::$staticOverride protected property The static menu link service used to store updates to weight/parent etc.
MenuLinkDefault::getDescription public function Overrides MenuLinkInterface::getDescription
MenuLinkDefault::isResettable public function Overrides MenuLinkBase::isResettable
MenuLinkDefault::updateLink public function Overrides MenuLinkInterface::updateLink
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
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 Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.

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