blob: 0fe718662c1b6c83c41ca47c6c8690b00cb1b40f (
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
|
<?php
namespace Drupal\Core\ParamConverter;
use Symfony\Component\Routing\Route;
/**
* Interface for parameter converters.
*
* Classes implementing this interface are responsible for converting a path
* parameter to the object it represents.
*
* Here is an example path: /admin/structure/block/manage/{block}
*
* In this case, '{block}' would be the path parameter which should be turned
* into a block object representing the block in question.
*
* ParamConverters are defined as services tagged with 'paramconverter', and are
* managed by the 'paramconverter_manager' service.
*
* @see menu
* @see \Drupal\Core\ParamConverter\ParamConverterManagerInterface
* @see \Drupal\Core\ParamConverter\EntityConverter
*/
interface ParamConverterInterface {
/**
* Converts path variables to their corresponding objects.
*
* @param mixed $value
* The raw value.
* @param mixed $definition
* The parameter definition provided in the route options.
* @param string $name
* The name of the parameter.
* @param array $defaults
* The route defaults array.
*
* @return mixed|null
* The converted parameter value.
*/
public function convert($value, $definition, $name, array $defaults);
/**
* Determines if the converter applies to a specific route and variable.
*
* @param mixed $definition
* The parameter definition provided in the route options.
* @param string $name
* The name of the parameter.
* @param \Symfony\Component\Routing\Route $route
* The route to consider attaching to.
*
* @return bool
* TRUE if the converter applies to the passed route and parameter, FALSE
* otherwise.
*/
public function applies($definition, $name, Route $route);
}
|
