class DynamicMenuLinkMock
Same name in other branches
- 8.9.x core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php \Drupal\Tests\Core\Menu\DynamicMenuLinkMock
- 10 core/tests/Drupal/Tests/Core/Menu/DynamicMenuLinkMock.php \Drupal\Tests\Core\Menu\DynamicMenuLinkMock
- 11.x 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
- 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\Tests\Core\Menu\MenuLinkMock extends \Drupal\Core\Menu\MenuLinkBase
- class \Drupal\Tests\Core\Menu\DynamicMenuLinkMock extends \Drupal\Tests\Core\Menu\MenuLinkMock
- class \Drupal\Tests\Core\Menu\MenuLinkMock extends \Drupal\Core\Menu\MenuLinkBase
- 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 DynamicMenuLinkMock
See also
\Drupal\user\Plugin\Menu\LoginLogoutMenuLink
File
-
core/
tests/ Drupal/ Tests/ Core/ Menu/ DynamicMenuLinkMock.php, line 15
Namespace
Drupal\Tests\Core\MenuView 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
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 | |
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. | 3 | |
MenuLinkBase::deleteLink | public | function | Deletes a menu link. | Overrides MenuLinkInterface::deleteLink | 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::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::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 |
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 | |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.