3 namespace Drupal\Tests\Core\ParamConverter;
5 use Drupal\Core\ParamConverter\ParamConverterManager;
6 use Drupal\Core\ParamConverter\ParamNotConvertedException;
7 use Drupal\Tests\UnitTestCase;
8 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
9 use Symfony\Component\Routing\Route;
10 use Symfony\Component\Routing\RouteCollection;
13 * @coversDefaultClass \Drupal\Core\ParamConverter\ParamConverterManager
14 * @group ParamConverter
16 class ParamConverterManagerTest extends UnitTestCase {
19 * @var \Drupal\Core\ParamConverter\ParamConverterManager
26 protected function setUp() {
29 $this->manager = new ParamConverterManager();
33 * Tests \Drupal\Core\ParamConverter\ParamConverterManager::getConverter().
35 * @dataProvider providerTestGetConverter
37 * @covers ::getConverter
39 public function testGetConverter($name, $class) {
40 $converter = $this->getMockBuilder('Drupal\Core\ParamConverter\ParamConverterInterface')
41 ->setMockClassName($class)
44 $this->manager->addConverter($converter, $name);
46 $this->assertInstanceOf($class, $this->manager->getConverter($name));
47 // Assert that a second call to getConverter() does not use the container.
48 $this->assertInstanceOf($class, $this->manager->getConverter($name));
52 * Tests \Drupal\Core\ParamConverter\ParamConverterManager::getConverter().
54 * @covers ::getConverter
56 public function testGetConverterException() {
57 $this->setExpectedException(\InvalidArgumentException::class);
58 $this->manager->getConverter('undefined.converter');
62 * Provide data for parameter converter manager tests.
65 * An array of arrays, each containing the input parameters for
66 * providerTestResolvers::testAddConverter().
68 * @see ParamConverterManagerTest::testAddConverter()
70 public function providerTestAddConverter() {
71 $converters[0]['unsorted'] = [
72 ['name' => 'strawberry'],
73 ['name' => 'raspberry'],
76 ['name' => 'pineapple'],
81 $converters[0]['sorted'] = [
82 'strawberry', 'raspberry', 'pear', 'peach',
83 'pineapple', 'banana', 'apple'
86 $converters[1]['unsorted'] = [
87 ['name' => 'giraffe'],
96 $converters[1]['sorted'] = [
97 'giraffe', 'zebra', 'eagle', 'ape',
98 'cat', 'puppy', 'llama'
105 * Provide data for parameter converter manager tests.
108 * An array of arrays, each containing the input parameters for
109 * providerTestResolvers::testGetConverter().
111 * @see ParamConverterManagerTest::testGetConverter()
113 public function providerTestGetConverter() {
115 ['ape', 'ApeConverterClass'],
116 ['cat', 'CatConverterClass'],
117 ['puppy', 'PuppyConverterClass'],
118 ['llama', 'LlamaConverterClass'],
119 ['giraffe', 'GiraffeConverterClass'],
120 ['zebra', 'ZebraConverterClass'],
121 ['eagle', 'EagleConverterClass'],
126 * @covers ::setRouteParameterConverters
128 * @dataProvider providerTestSetRouteParameterConverters
130 public function testSetRouteParameterConverters($path, $parameters = NULL, $expected = NULL) {
131 $converter = $this->getMock('Drupal\Core\ParamConverter\ParamConverterInterface');
132 $converter->expects($this->any())
134 ->with($this->anything(), 'id', $this->anything())
135 ->will($this->returnValue(TRUE));
136 $this->manager->addConverter($converter, 'applied');
138 $route = new Route($path);
140 $route->setOption('parameters', $parameters);
142 $collection = new RouteCollection();
143 $collection->add('test_route', $route);
145 $this->manager->setRouteParameterConverters($collection);
146 foreach ($collection as $route) {
147 $result = $route->getOption('parameters');
149 $this->assertSame($expected, $result['id']['converter']);
152 $this->assertNull($result);
158 * Provides data for testSetRouteParameterConverters().
160 public function providerTestSetRouteParameterConverters() {
163 ['/test/{id}', ['id' => []], 'applied'],
164 ['/test/{id}', ['id' => ['converter' => 'predefined']], 'predefined'],
171 public function testConvert() {
172 $route = new Route('/test/{id}/{literal}/{null}');
175 'converter' => 'test_convert',
180 $route->setOption('parameters', $parameters);
183 RouteObjectInterface::ROUTE_OBJECT => $route,
184 RouteObjectInterface::ROUTE_NAME => 'test_route',
186 'literal' => 'this is a literal',
190 $expected = $defaults;
191 $expected['id'] = 'something_better!';
193 $converter = $this->getMock('Drupal\Core\ParamConverter\ParamConverterInterface');
194 $converter->expects($this->any())
196 ->with(1, $this->isType('array'), 'id', $this->isType('array'))
197 ->will($this->returnValue('something_better!'));
198 $this->manager->addConverter($converter, 'test_convert');
200 $result = $this->manager->convert($defaults);
202 $this->assertEquals($expected, $result);
208 public function testConvertNoConverting() {
209 $route = new Route('/test');
211 RouteObjectInterface::ROUTE_OBJECT => $route,
212 RouteObjectInterface::ROUTE_NAME => 'test_route',
215 $expected = $defaults;
217 $result = $this->manager->convert($defaults);
218 $this->assertEquals($expected, $result);
224 public function testConvertMissingParam() {
225 $route = new Route('/test/{id}');
228 'converter' => 'test_convert',
231 $route->setOption('parameters', $parameters);
234 RouteObjectInterface::ROUTE_OBJECT => $route,
235 RouteObjectInterface::ROUTE_NAME => 'test_route',
239 $converter = $this->getMock('Drupal\Core\ParamConverter\ParamConverterInterface');
240 $converter->expects($this->any())
242 ->with(1, $this->isType('array'), 'id', $this->isType('array'))
243 ->will($this->returnValue(NULL));
244 $this->manager->addConverter($converter, 'test_convert');
246 $this->setExpectedException(ParamNotConvertedException::class, 'The "id" parameter was not converted for the path "/test/{id}" (route name: "test_route")');
247 $this->manager->convert($defaults);