2010-06-24 07:46:50 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2010-06-24 07:46:50 +01:00
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
2012-03-28 14:43:52 +01:00
|
|
|
namespace Symfony\Component\Routing\Tests;
|
2010-06-24 07:46:50 +01:00
|
|
|
|
2010-08-20 22:09:55 +01:00
|
|
|
use Symfony\Component\Routing\RouteCollection;
|
|
|
|
use Symfony\Component\Routing\Route;
|
2011-02-10 15:15:51 +00:00
|
|
|
use Symfony\Component\Config\Resource\FileResource;
|
2010-06-24 07:46:50 +01:00
|
|
|
|
|
|
|
class RouteCollectionTest extends \PHPUnit_Framework_TestCase
|
|
|
|
{
|
|
|
|
public function testRoute()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$route = new Route('/foo');
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection->add('foo', $route);
|
|
|
|
$this->assertEquals(array('foo' => $route), $collection->all(), '->add() adds a route');
|
|
|
|
$this->assertEquals($route, $collection->get('foo'), '->get() returns a route by name');
|
|
|
|
$this->assertNull($collection->get('bar'), '->get() returns null if a route does not exist');
|
2010-06-24 07:46:50 +01:00
|
|
|
}
|
|
|
|
|
2010-10-17 19:15:26 +01:00
|
|
|
/**
|
2012-04-01 11:32:28 +01:00
|
|
|
* @expectedException \InvalidArgumentException
|
2010-10-17 19:15:26 +01:00
|
|
|
*/
|
|
|
|
public function testAddInvalidRoute()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$route = new Route('/foo');
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection->add('f o o', $route);
|
2010-10-17 19:15:26 +01:00
|
|
|
}
|
|
|
|
|
2012-07-28 23:02:29 +01:00
|
|
|
public function testOverriddenRoute()
|
2011-09-30 08:20:51 +01:00
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->add('foo', new Route('/foo'));
|
|
|
|
$collection->add('foo', new Route('/foo1'));
|
|
|
|
|
|
|
|
$this->assertEquals('/foo1', $collection->get('foo')->getPattern());
|
|
|
|
}
|
|
|
|
|
2012-07-28 23:02:29 +01:00
|
|
|
public function testDeepOverriddenRoute()
|
2011-09-30 08:20:51 +01:00
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->add('foo', new Route('/foo'));
|
|
|
|
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection1->add('foo', new Route('/foo1'));
|
|
|
|
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection2->add('foo', new Route('/foo2'));
|
|
|
|
|
|
|
|
$collection1->addCollection($collection2);
|
|
|
|
$collection->addCollection($collection1);
|
|
|
|
|
|
|
|
$this->assertEquals('/foo2', $collection1->get('foo')->getPattern());
|
|
|
|
$this->assertEquals('/foo2', $collection->get('foo')->getPattern());
|
|
|
|
}
|
|
|
|
|
2012-07-28 23:02:29 +01:00
|
|
|
public function testIteratorWithOverriddenRoutes()
|
2011-09-30 08:20:51 +01:00
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->add('foo', new Route('/foo'));
|
|
|
|
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection->addCollection($collection1);
|
|
|
|
$collection1->add('foo', new Route('/foo1'));
|
|
|
|
|
|
|
|
$this->assertEquals('/foo1', $this->getFirstNamedRoute($collection, 'foo')->getPattern());
|
|
|
|
}
|
|
|
|
|
2012-06-11 01:37:14 +01:00
|
|
|
public function testCount()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->add('foo', new Route('/foo'));
|
|
|
|
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection->addCollection($collection1);
|
2012-06-25 12:50:03 +01:00
|
|
|
$collection1->add('foo1', new Route('/foo1'));
|
2012-06-11 01:37:14 +01:00
|
|
|
|
|
|
|
$this->assertCount(2, $collection);
|
|
|
|
}
|
|
|
|
|
2011-09-30 08:20:51 +01:00
|
|
|
protected function getFirstNamedRoute(RouteCollection $routeCollection, $name)
|
|
|
|
{
|
|
|
|
foreach ($routeCollection as $key => $route) {
|
|
|
|
if ($route instanceof RouteCollection) {
|
|
|
|
return $this->getFirstNamedRoute($route, $name);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($name === $key) {
|
|
|
|
return $route;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-06-24 07:46:50 +01:00
|
|
|
public function testAddCollection()
|
|
|
|
{
|
2012-03-28 14:43:52 +01:00
|
|
|
if (!class_exists('Symfony\Component\Config\Resource\FileResource')) {
|
|
|
|
$this->markTestSkipped('The "Config" component is not available');
|
|
|
|
}
|
|
|
|
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection = new RouteCollection();
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection->add('foo', $foo = new Route('/foo'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection1 = new RouteCollection();
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection1->add('foo', $foo1 = new Route('/foo1'));
|
|
|
|
$collection1->add('bar', $bar1 = new Route('/bar1'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection->addCollection($collection1);
|
2010-11-23 08:42:19 +00:00
|
|
|
$this->assertEquals(array('foo' => $foo1, 'bar' => $bar1), $collection->all(), '->addCollection() adds routes from another collection');
|
2010-06-24 07:46:50 +01:00
|
|
|
|
|
|
|
$collection = new RouteCollection();
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection->add('foo', $foo = new Route('/foo'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection1 = new RouteCollection();
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection1->add('foo', $foo1 = new Route('/foo1'));
|
2012-04-04 02:35:48 +01:00
|
|
|
$collection->addCollection($collection1, '/{foo}', array('foo' => 'foo'), array('foo' => '\d+'), array('foo' => 'bar'));
|
2011-10-23 10:56:23 +01:00
|
|
|
$this->assertEquals('/{foo}/foo1', $collection->get('foo')->getPattern(), '->addCollection() can add a prefix to all merged routes');
|
|
|
|
$this->assertEquals(array('foo' => 'foo'), $collection->get('foo')->getDefaults(), '->addCollection() can add a prefix to all merged routes');
|
|
|
|
$this->assertEquals(array('foo' => '\d+'), $collection->get('foo')->getRequirements(), '->addCollection() can add a prefix to all merged routes');
|
2012-04-04 02:35:48 +01:00
|
|
|
$this->assertEquals(
|
|
|
|
array('foo' => 'bar', 'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler'),
|
|
|
|
$collection->get('foo')->getOptions(), '->addCollection() can add an option to all merged routes'
|
|
|
|
);
|
2010-06-24 07:46:50 +01:00
|
|
|
|
|
|
|
$collection = new RouteCollection();
|
2010-06-28 08:15:15 +01:00
|
|
|
$collection->addResource($foo = new FileResource(__DIR__.'/Fixtures/foo.xml'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection1 = new RouteCollection();
|
2010-06-28 08:15:15 +01:00
|
|
|
$collection1->addResource($foo1 = new FileResource(__DIR__.'/Fixtures/foo1.xml'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection->addCollection($collection1);
|
|
|
|
$this->assertEquals(array($foo, $foo1), $collection->getResources(), '->addCollection() merges resources');
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testAddPrefix()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
2010-11-23 08:42:19 +00:00
|
|
|
$collection->add('foo', $foo = new Route('/foo'));
|
|
|
|
$collection->add('bar', $bar = new Route('/bar'));
|
2012-04-04 02:35:48 +01:00
|
|
|
$collection->addPrefix('/{admin}', array('admin' => 'admin'), array('admin' => '\d+'), array('foo' => 'bar'));
|
2011-10-23 10:56:23 +01:00
|
|
|
$this->assertEquals('/{admin}/foo', $collection->get('foo')->getPattern(), '->addPrefix() adds a prefix to all routes');
|
|
|
|
$this->assertEquals('/{admin}/bar', $collection->get('bar')->getPattern(), '->addPrefix() adds a prefix to all routes');
|
|
|
|
$this->assertEquals(array('admin' => 'admin'), $collection->get('foo')->getDefaults(), '->addPrefix() adds a prefix to all routes');
|
|
|
|
$this->assertEquals(array('admin' => 'admin'), $collection->get('bar')->getDefaults(), '->addPrefix() adds a prefix to all routes');
|
|
|
|
$this->assertEquals(array('admin' => '\d+'), $collection->get('foo')->getRequirements(), '->addPrefix() adds a prefix to all routes');
|
|
|
|
$this->assertEquals(array('admin' => '\d+'), $collection->get('bar')->getRequirements(), '->addPrefix() adds a prefix to all routes');
|
2012-04-04 02:35:48 +01:00
|
|
|
$this->assertEquals(
|
|
|
|
array('foo' => 'bar', 'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler'),
|
|
|
|
$collection->get('foo')->getOptions(), '->addPrefix() adds an option to all routes'
|
|
|
|
);
|
|
|
|
$this->assertEquals(
|
|
|
|
array('foo' => 'bar', 'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler'),
|
|
|
|
$collection->get('bar')->getOptions(), '->addPrefix() adds an option to all routes'
|
|
|
|
);
|
2012-04-01 11:32:28 +01:00
|
|
|
$collection->addPrefix('0');
|
|
|
|
$this->assertEquals('/0/{admin}', $collection->getPrefix(), '->addPrefix() ensures a prefix must start with a slash and must not end with a slash');
|
2010-06-24 07:46:50 +01:00
|
|
|
}
|
|
|
|
|
2011-10-23 13:45:47 +01:00
|
|
|
public function testAddPrefixOverridesDefaultsAndRequirements()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->add('foo', $foo = new Route('/foo'));
|
|
|
|
$collection->add('bar', $bar = new Route('/bar', array(), array('_scheme' => 'http')));
|
|
|
|
$collection->addPrefix('/admin', array(), array('_scheme' => 'https'));
|
|
|
|
|
|
|
|
$this->assertEquals('https', $collection->get('foo')->getRequirement('_scheme'), '->addPrefix() overrides existing requirements');
|
|
|
|
$this->assertEquals('https', $collection->get('bar')->getRequirement('_scheme'), '->addPrefix() overrides existing requirements');
|
|
|
|
}
|
|
|
|
|
2012-02-02 04:53:43 +00:00
|
|
|
public function testAddCollectionOverridesDefaultsAndRequirements()
|
|
|
|
{
|
|
|
|
$imported = new RouteCollection();
|
|
|
|
$imported->add('foo', $foo = new Route('/foo'));
|
|
|
|
$imported->add('bar', $bar = new Route('/bar', array(), array('_scheme' => 'http')));
|
|
|
|
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
$collection->addCollection($imported, null, array(), array('_scheme' => 'https'));
|
|
|
|
|
|
|
|
$this->assertEquals('https', $collection->get('foo')->getRequirement('_scheme'), '->addCollection() overrides existing requirements');
|
|
|
|
$this->assertEquals('https', $collection->get('bar')->getRequirement('_scheme'), '->addCollection() overrides existing requirements');
|
|
|
|
}
|
|
|
|
|
2010-06-24 07:46:50 +01:00
|
|
|
public function testResource()
|
|
|
|
{
|
2012-03-28 14:43:52 +01:00
|
|
|
if (!class_exists('Symfony\Component\Config\Resource\FileResource')) {
|
|
|
|
$this->markTestSkipped('The "Config" component is not available');
|
|
|
|
}
|
|
|
|
|
2010-06-24 07:46:50 +01:00
|
|
|
$collection = new RouteCollection();
|
2010-06-28 08:15:15 +01:00
|
|
|
$collection->addResource($foo = new FileResource(__DIR__.'/Fixtures/foo.xml'));
|
2010-06-24 07:46:50 +01:00
|
|
|
$this->assertEquals(array($foo), $collection->getResources(), '->addResources() adds a resource');
|
|
|
|
}
|
2012-04-01 11:32:28 +01:00
|
|
|
|
|
|
|
public function testUniqueRouteWithGivenName()
|
|
|
|
{
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection1->add('foo', new Route('/old'));
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection3 = new RouteCollection();
|
|
|
|
$collection3->add('foo', $new = new Route('/new'));
|
|
|
|
|
|
|
|
$collection1->addCollection($collection2);
|
|
|
|
$collection2->addCollection($collection3);
|
|
|
|
|
|
|
|
$collection1->add('stay', new Route('/stay'));
|
|
|
|
|
|
|
|
$iterator = $collection1->getIterator();
|
|
|
|
|
|
|
|
$this->assertSame($new, $collection1->get('foo'), '->get() returns new route that overrode previous one');
|
|
|
|
// size of 2 because collection1 contains collection2 and /stay but not /old anymore
|
|
|
|
$this->assertCount(2, $iterator, '->addCollection() removes previous routes when adding new routes with the same name');
|
|
|
|
$this->assertInstanceOf('Symfony\Component\Routing\RouteCollection', $iterator->current(), '->getIterator returns both Routes and RouteCollections');
|
|
|
|
$iterator->next();
|
|
|
|
$this->assertInstanceOf('Symfony\Component\Routing\Route', $iterator->current(), '->getIterator returns both Routes and RouteCollections');
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testGet()
|
|
|
|
{
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection1->add('a', $a = new Route('/a'));
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection2->add('b', $b = new Route('/b'));
|
|
|
|
$collection1->addCollection($collection2);
|
|
|
|
|
|
|
|
$this->assertSame($b, $collection1->get('b'), '->get() returns correct route in child collection');
|
|
|
|
$this->assertNull($collection2->get('a'), '->get() does not return the route defined in parent collection');
|
|
|
|
$this->assertNull($collection1->get('non-existent'), '->get() returns null when route does not exist');
|
|
|
|
$this->assertNull($collection1->get(0), '->get() does not disclose internal child RouteCollection');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \InvalidArgumentException
|
|
|
|
*/
|
|
|
|
public function testCannotSelfJoinCollection()
|
|
|
|
{
|
|
|
|
$collection = new RouteCollection();
|
|
|
|
|
|
|
|
$collection->addCollection($collection);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \InvalidArgumentException
|
|
|
|
*/
|
|
|
|
public function testCannotAddExistingCollectionToTree()
|
|
|
|
{
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection3 = new RouteCollection();
|
|
|
|
|
|
|
|
$collection1->addCollection($collection2);
|
|
|
|
$collection1->addCollection($collection3);
|
|
|
|
$collection2->addCollection($collection3);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testPatternDoesNotChangeWhenDefinitionOrderChanges()
|
|
|
|
{
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection1->add('a', new Route('/a...'));
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection2->add('b', new Route('/b...'));
|
|
|
|
$collection3 = new RouteCollection();
|
|
|
|
$collection3->add('c', new Route('/c...'));
|
|
|
|
|
|
|
|
$rootCollection_A = new RouteCollection();
|
|
|
|
$collection2->addCollection($collection3, '/c');
|
|
|
|
$collection1->addCollection($collection2, '/b');
|
|
|
|
$rootCollection_A->addCollection($collection1, '/a');
|
|
|
|
|
|
|
|
// above should mean the same as below
|
|
|
|
|
|
|
|
$collection1 = new RouteCollection();
|
|
|
|
$collection1->add('a', new Route('/a...'));
|
|
|
|
$collection2 = new RouteCollection();
|
|
|
|
$collection2->add('b', new Route('/b...'));
|
|
|
|
$collection3 = new RouteCollection();
|
|
|
|
$collection3->add('c', new Route('/c...'));
|
|
|
|
|
|
|
|
$rootCollection_B = new RouteCollection();
|
|
|
|
$collection1->addCollection($collection2, '/b');
|
|
|
|
$collection2->addCollection($collection3, '/c');
|
|
|
|
$rootCollection_B->addCollection($collection1, '/a');
|
|
|
|
|
|
|
|
// test it now
|
|
|
|
|
|
|
|
$this->assertEquals($rootCollection_A, $rootCollection_B);
|
|
|
|
}
|
2010-06-24 07:46:50 +01:00
|
|
|
}
|