Documentation

CompiledUrlMatcher extends UrlMatcher
in package
Uses CompiledUrlMatcherTrait

Matches URLs based on rules dumped by CompiledUrlMatcherDumper.

Tags
author

Nicolas Grekas p@tchwork.com

Table of Contents

REQUIREMENT_MATCH  = 0
REQUIREMENT_MISMATCH  = 1
ROUTE_MATCH  = 2
$allow  : mixed
Collects HTTP methods that would be allowed for the request.
$context  : RequestContext
$expressionLanguage  : mixed
$expressionLanguageProviders  : array<string|int, ExpressionFunctionProviderInterface>
$request  : mixed
$routes  : mixed
__construct()  : mixed
addExpressionLanguageProvider()  : mixed
getContext()  : mixed
{@inheritdoc}
match()  : array<string|int, mixed>
Tries to match a URL path with a set of routes.
matchRequest()  : array<string|int, mixed>
Tries to match a request with a set of routes.
setContext()  : mixed
{@inheritdoc}
getAttributes()  : array<string|int, mixed>
Returns an array of values to use as request attributes.
getExpressionLanguage()  : mixed
handleRouteRequirements()  : array<string|int, mixed>
Handles specific route requirements.
matchCollection()  : array<string|int, mixed>
Tries to match a URL with a set of routes.
mergeDefaults()  : array<string|int, mixed>
Get merged default parameters.

Constants

REQUIREMENT_MATCH

public mixed REQUIREMENT_MATCH = 0

REQUIREMENT_MISMATCH

public mixed REQUIREMENT_MISMATCH = 1

Properties

$allow

Collects HTTP methods that would be allowed for the request.

protected mixed $allow = []

$expressionLanguage

protected mixed $expressionLanguage

Methods

getContext()

{@inheritdoc}

public getContext() : mixed
Return values
mixed —

match()

Tries to match a URL path with a set of routes.

public match(string $pathinfo) : array<string|int, mixed>
Parameters
$pathinfo : string

The path info to be parsed (raw format, i.e. not urldecoded)

Return values
array<string|int, mixed> —

matchRequest()

Tries to match a request with a set of routes.

public matchRequest(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed> —

getAttributes()

Returns an array of values to use as request attributes.

protected getAttributes(Route $route, string $name, array<string|int, mixed> $attributes) : array<string|int, mixed>

As this method requires the Route object, it is not available in matchers that do not have access to the matched Route instance (like the PHP and Apache matcher dumpers).

Parameters
$route : Route
$name : string
$attributes : array<string|int, mixed>
Return values
array<string|int, mixed> —

getExpressionLanguage()

protected getExpressionLanguage() : mixed
Return values
mixed —

handleRouteRequirements()

Handles specific route requirements.

protected handleRouteRequirements(string $pathinfo, string $name, Route $route) : array<string|int, mixed>
Parameters
$pathinfo : string
$name : string
$route : Route
Return values
array<string|int, mixed> —

The first element represents the status, the second contains additional information

matchCollection()

Tries to match a URL with a set of routes.

protected matchCollection(string $pathinfo, RouteCollection $routes) : array<string|int, mixed>
Parameters
$pathinfo : string

The path info to be parsed

$routes : RouteCollection
Tags
throws
NoConfigurationException

If no routing configuration could be found

throws
ResourceNotFoundException

If the resource could not be found

throws
MethodNotAllowedException

If the resource was found but the request method is not allowed

Return values
array<string|int, mixed> —

mergeDefaults()

Get merged default parameters.

protected mergeDefaults(array<string|int, mixed> $params, array<string|int, mixed> $defaults) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
$defaults : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results