1. trait
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. RedirectDestinationTrait

RedirectDestinationTrait

trait RedirectDestinationTrait (View source)

Wrapper methods for the Redirect Destination.

This utility trait should only be used in application-level code, such as classes that would implement ContainerInjectionInterface. Services registered in the Container should not use this trait but inject the appropriate service directly for easier testing.

Properties

protected RedirectDestinationInterface $redirectDestination

The redirect destination service.

Methods

array
getDestinationArray()

Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.

RedirectDestinationInterface
getRedirectDestination()

Returns the redirect destination service.

$this
setRedirectDestination(RedirectDestinationInterface $redirect_destination)

Sets the redirect destination service.

Details

at line 35
protected array getDestinationArray()

Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.

Return Value

array

An associative array containing the key:

  • destination: The value of the current request's 'destination' query parameter, if present. This can be either a relative or absolute URL. However, for security, redirection to external URLs is not performed. If the query parameter isn't present, then the URL of the current request is returned.

See also

RedirectDestinationInterface::getAsArray

at line 45
protected RedirectDestinationInterface getRedirectDestination()

Returns the redirect destination service.

Return Value

RedirectDestinationInterface

The redirect destination helper.

at line 61
$this setRedirectDestination(RedirectDestinationInterface $redirect_destination)

Sets the redirect destination service.

Parameters

RedirectDestinationInterface $redirect_destination

The redirect destination service.

Return Value

$this