You are here

class SignupMenuLink in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  2. 8.2 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  3. 8.3 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  4. 8.4 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  5. 8.5 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  6. 8.6 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  7. 8.7 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  8. 8.8 modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  9. 10.3.x modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  10. 10.0.x modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  11. 10.1.x modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink
  12. 10.2.x modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php \Drupal\social_user\Plugin\Menu\SignupMenuLink

A menu link that shows "Sign up" in the user account menu.

Hierarchy

Expanded class hierarchy of SignupMenuLink

1 string reference to 'SignupMenuLink'
social_user.links.menu.yml in modules/social_features/social_user/social_user.links.menu.yml
modules/social_features/social_user/social_user.links.menu.yml

File

modules/social_features/social_user/src/Plugin/Menu/SignupMenuLink.php, line 13

Namespace

Drupal\social_user\Plugin\Menu
View source
class SignupMenuLink extends MenuLinkDefault {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Constructs a new SignupMenuLink.
   *
   * @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 isEnabled() {
    if ($this->currentUser
      ->isAuthenticated()) {
      return FALSE;
    }
    else {
      return parent::isEnabled();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [
      'user.roles:authenticated',
    ];
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
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::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::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkInterface::isDeletable 2
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::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle 1
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
SignupMenuLink::$currentUser protected property The current user.
SignupMenuLink::create public static function Creates an instance of the plugin. Overrides MenuLinkDefault::create
SignupMenuLink::getCacheContexts public function The cache contexts associated with this object. Overrides MenuLinkBase::getCacheContexts
SignupMenuLink::isEnabled public function Returns whether the menu link is enabled (not hidden). Overrides MenuLinkBase::isEnabled
SignupMenuLink::__construct public function Constructs a new SignupMenuLink. Overrides MenuLinkDefault::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.