class LocalActionWithDestination

Modifies the local action to add a destination.

Hierarchy

Expanded class hierarchy of LocalActionWithDestination

2 files declare their use of LocalActionWithDestination
MenuLinkAdd.php in core/modules/menu_ui/src/Plugin/Menu/LocalAction/MenuLinkAdd.php
MenuLinkAddTest.php in core/modules/menu_ui/tests/src/Kernel/MenuLinkAddTest.php
1 string reference to 'LocalActionWithDestination'
menu_ui.links.action.yml in core/modules/menu_ui/menu_ui.links.action.yml
core/modules/menu_ui/menu_ui.links.action.yml

File

core/lib/Drupal/Core/Menu/LocalActionWithDestination.php, line 13

Namespace

Drupal\Core\Menu
View source 
class LocalActionWithDestination extends LocalActionDefault {
    public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, RedirectDestinationInterface $redirectDestination) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('router.route_provider'), $container->get('redirect.destination'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOptions(RouteMatchInterface $route_match) {
        $options = parent::getOptions($route_match);
        // Append the current path or destination to the query string.
        $options['query']['destination'] = $this->redirectDestination
            ->get();
        return $options;
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
LocalActionDefault::$routeProvider protected property The route provider to load routes by name.
LocalActionDefault::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
LocalActionDefault::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
LocalActionDefault::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
LocalActionDefault::getRouteName public function Get the route name from the settings. Overrides LocalActionInterface::getRouteName
LocalActionDefault::getRouteParameters public function Returns the route parameters needed to render a link for the local action. Overrides LocalActionInterface::getRouteParameters
LocalActionDefault::getTitle public function Returns the localized title to be shown for this action. Overrides LocalActionInterface::getTitle 4
LocalActionDefault::getWeight public function Returns the weight for the local action. Overrides LocalActionInterface::getWeight
LocalActionWithDestination::create public static function Creates an instance of the plugin. Overrides LocalActionDefault::create
LocalActionWithDestination::getOptions public function Returns options for rendering a link for the local action. Overrides LocalActionDefault::getOptions
LocalActionWithDestination::__construct public function Constructs a LocalActionDefault object. Overrides LocalActionDefault::__construct 1
PluginBase::$configuration protected property Configuration information passed into the plugin.
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 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
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.

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