Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/ParamConverter/ParamConverterInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\ParamConverter\ParamConverterInterface.
6	*/
7
8	namespace Drupal\Core\ParamConverter;
9
10	use Symfony\Component\Routing\Route;
11
12	/**
13	* Interface for parameter converters.
14	*
15	* Classes implementing this interface are responsible for converting a path
16	* parameter to the object it represents.
17	*
18	* Here is an example path: /admin/structure/block/manage/{block}
19	*
20	* In this case, '{block}' would be the path parameter which should be turned
21	* into a block object representing the block in question.
22	*
23	* ParamConverters are defined as services tagged with 'paramconverter', and are
24	* managed by the 'paramconverter_manager' service.
25	*
26	* @see menu
27	* @see \Drupal\Core\ParamConverter\ParamConverterManagerInterface
28	* @see \Drupal\Core\ParamConverter\EntityConverter
29	*/
30	interface ParamConverterInterface {
31
32	/**
33	* Converts path variables to their corresponding objects.
34	*
35	* @param mixed $value
36	* The raw value.
37	* @param mixed $definition
38	* The parameter definition provided in the route options.
39	* @param string $name
40	* The name of the parameter.
41	* @param array $defaults
42	* The route defaults array.
43	*
44	* @return mixed\|null
45	* The converted parameter value.
46	*/
47	public function convert($value, $definition, $name, array $defaults);
48
49	/**
50	* Determines if the converter applies to a specific route and variable.
51	*
52	* @param mixed $definition
53	* The parameter definition provided in the route options.
54	* @param string $name
55	* The name of the parameter.
56	* @param \Symfony\Component\Routing\Route $route
57	* The route to consider attaching to.
58	*
59	* @return bool
60	* TRUE if the converter applies to the passed route and parameter, FALSE
61	* otherwise.
62	*/
63	public function applies($definition, $name, Route $route);
64
65	}