You are here

class DynamicMenuLinkMock in Drupal 10

Same name and namespace in other branches
  1. 8 core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php \Drupal\Tests\Core\Menu\DynamicMenuLinkMock
  2. 9 core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php \Drupal\Tests\Core\Menu\DynamicMenuLinkMock

Defines a mock implementation of a dynamic menu link used in tests only.

Has a dynamic route and title. This is rather contrived, but there are valid use cases.

Hierarchy

Expanded class hierarchy of DynamicMenuLinkMock

See also

\Drupal\user\Plugin\Menu\LoginLogoutMenuLink

File

core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php, line 15

Namespace

Drupal\Tests\Core\Menu
View source
class DynamicMenuLinkMock extends MenuLinkMock {

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

  /**
   * Sets the current user.
   *
   * Allows the menu link to return the right title and route.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   *
   * @return $this
   */
  public function setCurrentUser(AccountInterface $current_user) {
    $this->currentUser = $current_user;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    if ($this->currentUser
      ->isAuthenticated()) {
      return 'Log out';
    }
    else {
      return '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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DynamicMenuLinkMock::$currentUser protected property The current user.
DynamicMenuLinkMock::getCacheContexts public function The cache contexts associated with this object. Overrides MenuLinkMock::getCacheContexts
DynamicMenuLinkMock::getRouteName public function Returns the route name, if available. Overrides MenuLinkBase::getRouteName
DynamicMenuLinkMock::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkMock::getTitle
DynamicMenuLinkMock::setCurrentUser public function Sets the current user.
MenuLinkBase::$overrideAllowed protected property The list of definition values where an override is allowed.
MenuLinkBase::deleteLink public function
MenuLinkBase::getDeleteRoute public function
MenuLinkBase::getEditRoute public function
MenuLinkBase::getFormClass public function
MenuLinkBase::getMenuName public function
MenuLinkBase::getMetaData public function
MenuLinkBase::getOptions public function
MenuLinkBase::getParent public function
MenuLinkBase::getProvider public function
MenuLinkBase::getRouteParameters public function
MenuLinkBase::getTranslateRoute public function
MenuLinkBase::getUrlObject public function
MenuLinkBase::getWeight public function
MenuLinkBase::isDeletable public function
MenuLinkBase::isEnabled public function
MenuLinkBase::isExpanded public function
MenuLinkBase::isResettable public function
MenuLinkBase::isTranslatable public function
MenuLinkMock::$defaults protected static property
MenuLinkMock::create public static function Create an instance from a definition with at least id, title, route_name.
MenuLinkMock::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides MenuLinkBase::getCacheMaxAge
MenuLinkMock::getCacheTags public function The cache tags associated with this object. Overrides MenuLinkBase::getCacheTags
MenuLinkMock::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
MenuLinkMock::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.