class MenuLinkMock

Same name in other branches
  1. 8.9.x core/tests/Drupal/Tests/Core/Menu/MenuLinkMock.php \Drupal\Tests\Core\Menu\MenuLinkMock
  2. 10 core/tests/Drupal/Tests/Core/Menu/MenuLinkMock.php \Drupal\Tests\Core\Menu\MenuLinkMock
  3. 11.x core/tests/Drupal/Tests/Core/Menu/MenuLinkMock.php \Drupal\Tests\Core\Menu\MenuLinkMock

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

Hierarchy

Expanded class hierarchy of MenuLinkMock

3 files declare their use of MenuLinkMock
MenuLinkTreeTest.php in core/modules/system/tests/src/Unit/Menu/MenuLinkTreeTest.php
MenuLinkTreeTest.php in core/tests/Drupal/KernelTests/Core/Menu/MenuLinkTreeTest.php
SystemMenuBlockTest.php in core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php

File

core/tests/Drupal/Tests/Core/Menu/MenuLinkMock.php, line 11

Namespace

Drupal\Tests\Core\Menu
View source
class MenuLinkMock extends MenuLinkBase {
    protected static $defaults = [
        'menu_name' => 'mock',
        'route_name' => 'MUST BE PROVIDED',
        'route_parameters' => [],
        'url' => '',
        'title' => 'MUST BE PROVIDED',
        'title_arguments' => [],
        'title_context' => '',
        'description' => '',
        'parent' => 'MUST BE PROVIDED',
        'weight' => '0',
        'options' => [],
        'expanded' => '0',
        'enabled' => '1',
        'provider' => 'simpletest',
        'metadata' => [
            'cache_contexts' => [],
            'cache_tags' => [],
            'cache_max_age' => Cache::PERMANENT,
        ],
        'class' => 'Drupal\\Tests\\Core\\Menu\\MenuLinkMock',
        'form_class' => 'Drupal\\Core\\Menu\\Form\\MenuLinkDefaultForm',
        'id' => 'MUST BE PROVIDED',
    ];
    
    /**
     * Create an instance from a definition with at least id, title, route_name.
     */
    public static function create($definition) {
        return new static([], $definition['id'], $definition + static::$defaults);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle() {
        return $this->pluginDefinition['title'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        if ($this->pluginDefinition['description']) {
            return $this->pluginDefinition['description'];
        }
        return '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function updateLink(array $new_definition_values, $persist) {
        // No-op.
        return $this->pluginDefinition;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return $this->pluginDefinition['metadata']['cache_contexts'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return $this->pluginDefinition['metadata']['cache_tags'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        return $this->pluginDefinition['metadata']['cache_max_age'];
    }

}

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
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::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::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::getCacheContexts public function The cache contexts associated with this object. Overrides MenuLinkBase::getCacheContexts 1
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::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle 1
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.