class WithDestination in Group 8

Modifies the local action to add a destination.

Will either append the already present destination parameter or use the current route's path as the destination parameter.

@todo Follow up on https://www.drupal.org/node/2762131.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Menu\LocalActionDefault implements CacheableDependencyInterface, LocalActionInterface, ContainerFactoryPluginInterface uses DependencySerializationTrait
    • class \Drupal\group\Plugin\Menu\LocalAction\WithDestination

1 string reference to 'WithDestination'

group.links.action.yml in ./group.links.action.yml

group.links.action.yml

File

src/Plugin/Menu/LocalAction/WithDestination.php, line 19

Namespace

Drupal\group\Plugin\Menu\LocalAction

class WithDestination extends LocalActionDefault {

  /**
   * The redirect destination.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  private $redirectDestination;

  /**
   * Constructs a WithDestination object.
   *
   * @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\Routing\RouteProviderInterface $route_provider
   *   The route provider to load routes by name.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The redirect destination.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, RedirectDestinationInterface $redirect_destination) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider);
    $this->redirectDestination = $redirect_destination;
  }

  /**
   * {@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);
    $options['query']['destination'] = $this->redirectDestination
      ->get();
    return $options;
  }

}

Members

Name	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
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
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.
WithDestination::$redirectDestination	private	property	The redirect destination.
WithDestination::create	public static	function	Creates an instance of the plugin. Overrides LocalActionDefault::create
WithDestination::getOptions	public	function	Returns options for rendering a link for the local action. Overrides LocalActionDefault::getOptions
WithDestination::__construct	public	function	Constructs a WithDestination object. Overrides LocalActionDefault::__construct