blob: 7e8113c1928afa855f18798b9ee4a11cb028e2ef (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?php
namespace Drupal\Core\Routing;
/**
* Provides an interface for classes representing the result of routing.
*
* Routing is the process of selecting the best matching candidate from a
* collection of routes for an incoming request. The relevant properties of a
* request include the path as well as a list of raw parameter values derived
* from the URL. If an appropriate route is found, raw parameter values will be
* upcast automatically if possible.
*
* The route match object contains useful information about the selected route
* as well as the raw and upcast parameters derived from the incoming
* request.
*
* @ingroup routing
*/
interface RouteMatchInterface {
/**
* Returns the route name.
*
* @return string|null
* The route name. NULL if no route is matched.
*/
public function getRouteName();
/**
* Returns the route object.
*
* @return \Symfony\Component\Routing\Route|null
* The route object. NULL if no route is matched.
*/
public function getRouteObject();
/**
* Returns the processed value of a named route parameter.
*
* Raw URL parameters are processed by the parameter conversion system, which
* does operations such as converting entity ID parameters to fully-loaded
* entities. For example, the path node/12345 would have a raw node ID
* parameter value of 12345, while the processed parameter value would be the
* corresponding loaded node object.
*
* @param string $parameter_name
* The parameter name.
*
* @return mixed|null
* The parameter value. NULL if the route doesn't define the parameter or
* if the parameter value can't be determined from the request.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getRawParameter()
*/
public function getParameter($parameter_name);
/**
* Returns the bag of all processed route parameters.
*
* Raw URL parameters are processed by the parameter conversion system, which
* does operations such as converting entity ID parameters to fully-loaded
* entities. For example, the path node/12345 would have a raw node ID
* parameter value of 12345, while the processed parameter value would be the
* corresponding loaded node object.
*
* @return \Symfony\Component\HttpFoundation\ParameterBag
* The parameter bag.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getRawParameters()
*/
public function getParameters();
/**
* Returns the raw value of a named route parameter.
*
* @param string $parameter_name
* The parameter name.
*
* @return string|null
* The raw (non-upcast) parameter value. NULL if the route doesn't define
* the parameter or if the raw parameter value can't be determined from the
* request.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getParameter()
*/
public function getRawParameter($parameter_name);
/**
* Returns the bag of all raw route parameters.
*
* @return \Symfony\Component\HttpFoundation\ParameterBag
* The parameter bag.
*
* @see \Drupal\Core\Routing\RouteMatchInterface::getParameters()
*/
public function getRawParameters();
}
|
