Drupal 8  8.0.2
PathProcessorFront Class Reference
Inheritance diagram for PathProcessorFront:

Public Member Functions

 __construct (ConfigFactoryInterface $config)
 
 processInbound ($path, Request $request)
 
 processOutbound ($path, &$options=array(), Request $request=NULL, BubbleableMetadata $bubbleable_metadata=NULL)
 

Protected Attributes

 $config
 

Detailed Description

Processes the inbound path by resolving it to the front page if empty.

Todo:
  • remove ::processOutbound() when we remove UrlGenerator::fromPath().

Constructor & Destructor Documentation

__construct ( ConfigFactoryInterface  $config)

Constructs a PathProcessorFront object.

Parameters
\Drupal\Core\Config\ConfigFactoryInterface$configA config factory for retrieving the site front page configuration.

References Drupal\config().

Here is the call graph for this function:

Member Function Documentation

processInbound (   $path,
Request  $request 
)

{Processes the inbound path.

Parameters
string$pathThe path to process, with a leading slash.
\Symfony\Component\HttpFoundation\Request$requestThe HttpRequest object representing the current request.
Returns
string The processed path.
}

Implements InboundPathProcessorInterface.

References Drupal\config().

Referenced by PathProcessorFrontTest\testProcessInboundBadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

processOutbound (   $path,
$options = array(),
Request  $request = NULL,
BubbleableMetadata  $bubbleable_metadata = NULL 
)

{Processes the outbound path.

Parameters
string$pathThe path to process, with a leading slash.
array$options(optional) An associative array of additional options, with the following elements:
  • 'query': An array of query key/value-pairs (without any URL-encoding) to append to the URL.
  • 'fragment': A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character.
  • 'absolute': Defaults to FALSE. Whether to force the output to be an absolute link (beginning with http:). Useful for links that will be displayed outside the site, such as in an RSS feed.
  • 'language': An optional language object used to look up the alias for the URL. If $options['language'] is omitted, it defaults to the current language for the language type LanguageInterface::TYPE_URL.
  • 'https': Whether this URL should point to a secure location. If not defined, the current scheme is used, so the user stays on HTTP or HTTPS respectively. TRUE enforces HTTPS and FALSE enforces HTTP.
  • 'base_url': Only used internally by a path processor, for example, to modify the base URL when a language dependent URL requires so.
  • 'prefix': Only used internally, to modify the path when a language dependent URL requires so.
  • 'route': The route object for the given path. It will be set by ::generateFromRoute().
\Symfony\Component\HttpFoundation\Request$requestThe HttpRequest object representing the current request.
\Drupal\Core\Render\BubbleableMetadata$bubbleable_metadata(optional) Object to collect path processors' bubbleable metadata.
Returns
string The processed path.
}

Implements OutboundPathProcessorInterface.


The documentation for this class was generated from the following file: