null, 'prefixes' => []]); Router::fullBaseUrl(''); Configure::write('App.fullBaseUrl', 'http://localhost'); } /** * tearDown method * * @return void */ public function tearDown() { parent::tearDown(); $this->clearPlugins(); Router::reload(); Router::defaultRouteClass('Cake\Routing\Route\Route'); } /** * testFullBaseUrl method * * @return void */ public function testBaseUrl() { $this->assertRegExp('/^http(s)?:\/\//', Router::url('/', true)); $this->assertRegExp('/^http(s)?:\/\//', Router::url(null, true)); $this->assertRegExp('/^http(s)?:\/\//', Router::url(['controller' => 'test', '_full' => true])); } /** * Tests that the base URL can be changed at runtime. * * @return void */ public function testFullBaseURL() { Router::fullBaseUrl('http://example.com'); $this->assertEquals('http://example.com/', Router::url('/', true)); $this->assertEquals('http://example.com', Configure::read('App.fullBaseUrl')); Router::fullBaseUrl('https://example.com'); $this->assertEquals('https://example.com/', Router::url('/', true)); $this->assertEquals('https://example.com', Configure::read('App.fullBaseUrl')); } /** * Test that Router uses App.base to build URL's when there are no stored * request objects. * * @return void */ public function testBaseUrlWithBasePath() { Configure::write('App.base', '/cakephp'); Router::fullBaseUrl('http://example.com'); $this->assertEquals('http://example.com/cakephp/tasks', Router::url('/tasks', true)); } /** * Test that Router uses App.base to build URL's when there are no stored * request objects. * * @return void */ public function testBaseUrlWithBasePathArrayUrl() { Configure::write('App.base', '/cakephp'); Router::fullBaseUrl('http://example.com'); Router::scope('/', function (RouteBuilder $routes) { $routes->get('/:controller/:action', []); }); $out = Router::url([ 'controller' => 'tasks', 'action' => 'index', ], true); $this->assertEquals('http://example.com/cakephp/tasks', $out); $out = Router::url([ 'controller' => 'tasks', 'action' => 'index', '_base' => false, ], true); $this->assertEquals('http://example.com/tasks', $out); } /** * Test that Router uses the correct url including base path for requesting the current actions. * * @return void */ public function testCurrentUrlWithBasePath() { Router::fullBaseUrl('http://example.com'); $request = new ServerRequest([ 'params' => [ 'action' => 'view', 'plugin' => null, 'controller' => 'pages', 'pass' => ['1'], ], 'here' => '/cakephp', 'url' => '/cakephp/pages/view/1', ]); Router::setRequestInfo($request); $this->assertEquals('http://example.com/cakephp/pages/view/1', Router::url(null, true)); $this->assertEquals('/cakephp/pages/view/1', Router::url()); } /** * testRouteExists method * * @return void */ public function testRouteExists() { Router::connect('/posts/:action', ['controller' => 'posts']); $this->assertTrue(Router::routeExists(['controller' => 'posts', 'action' => 'view'])); $this->assertFalse(Router::routeExists(['action' => 'view', 'controller' => 'users', 'plugin' => 'test'])); } /** * testMapResources method * * @group deprecated * @return void */ public function testMapResources() { $this->deprecated(function () { Router::mapResources('Posts'); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', '_method' => 'GET', '_matchedRoute' => '/posts', ]; $result = Router::parse('/posts', 'GET'); $this->assertEquals($expected, $result); $expected = [ 'pass' => ['13'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'view', 'id' => '13', '_method' => 'GET', '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/13', 'GET'); $this->assertEquals($expected, $result); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'Posts', 'action' => 'add', '_method' => 'POST', '_matchedRoute' => '/posts', ]; $result = Router::parse('/posts', 'POST'); $this->assertEquals($expected, $result); $expected = [ 'pass' => ['13'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'edit', 'id' => '13', '_method' => ['PUT', 'PATCH'], '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/13', 'PUT'); $this->assertEquals($expected, $result); $expected = [ 'pass' => ['475acc39-a328-44d3-95fb-015000000000'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'edit', 'id' => '475acc39-a328-44d3-95fb-015000000000', '_method' => ['PUT', 'PATCH'], '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/475acc39-a328-44d3-95fb-015000000000', 'PUT'); $this->assertEquals($expected, $result); $expected = [ 'pass' => ['13'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'delete', 'id' => '13', '_method' => 'DELETE', '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/13', 'DELETE'); $this->assertEquals($expected, $result); Router::reload(); Router::mapResources('Posts', ['id' => '[a-z0-9_]+']); $expected = [ 'pass' => ['add'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'view', 'id' => 'add', '_method' => 'GET', '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/add', 'GET'); $this->assertEquals($expected, $result); $expected = [ 'pass' => ['name'], 'plugin' => null, 'controller' => 'Posts', 'action' => 'edit', 'id' => 'name', '_method' => ['PUT', 'PATCH'], '_matchedRoute' => '/posts/:id', ]; $result = Router::parse('/posts/name', 'PUT'); $this->assertEquals($expected, $result); }); } /** * testMapResources with plugin controllers. * * @group deprecated * @return void */ public function testPluginMapResources() { $this->deprecated(function () { Router::mapResources('TestPlugin.TestPlugin'); $result = Router::parse('/test_plugin/test_plugin', 'GET'); $expected = [ 'pass' => [], 'plugin' => 'TestPlugin', 'controller' => 'TestPlugin', 'action' => 'index', '_method' => 'GET', '_matchedRoute' => '/test_plugin/test_plugin', ]; $this->assertEquals($expected, $result); $result = Router::parse('/test_plugin/test_plugin/13', 'GET'); $expected = [ 'pass' => ['13'], 'plugin' => 'TestPlugin', 'controller' => 'TestPlugin', 'action' => 'view', 'id' => '13', '_method' => 'GET', '_matchedRoute' => '/test_plugin/test_plugin/:id', ]; $this->assertEquals($expected, $result); }); } /** * Test mapResources with a prefix. * * @group deprecated * @return void */ public function testMapResourcesWithPrefix() { $this->deprecated(function () { Router::mapResources('Posts', ['prefix' => 'api']); $result = Router::parse('/api/posts', 'GET'); $expected = [ 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', 'pass' => [], 'prefix' => 'api', '_method' => 'GET', '_matchedRoute' => '/api/posts', ]; $this->assertEquals($expected, $result); }); } /** * Test mapResources with a default extension. * * @group deprecated * @return void */ public function testMapResourcesWithExtension() { $this->deprecated(function () { Router::extensions(['json', 'xml'], false); Router::mapResources('Posts', ['_ext' => 'json']); $expected = [ 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', 'pass' => [], '_method' => 'GET', '_matchedRoute' => '/posts', ]; $result = Router::parse('/posts', 'GET'); $this->assertEquals($expected, $result); $result = Router::parse('/posts.json', 'GET'); $expected['_ext'] = 'json'; $this->assertEquals($expected, $result); $result = Router::parse('/posts.xml', 'GET'); $this->assertArrayNotHasKey('_method', $result, 'Not an extension/resource route.'); }); } /** * testMapResources with custom connectOptions * * @group deprecated */ public function testMapResourcesConnectOptions() { $this->deprecated(function () { Plugin::load('TestPlugin'); Router::mapResources('Posts', [ 'connectOptions' => [ 'routeClass' => 'TestPlugin.TestRoute', 'foo' => '^(bar)$', ], ]); $routes = Router::routes(); $route = $routes[0]; $this->assertInstanceOf('TestPlugin\Routing\Route\TestRoute', $route); $this->assertEquals('^(bar)$', $route->options['foo']); }); } /** * Test mapResources with a plugin and prefix. * * @group deprecated * @return void */ public function testPluginMapResourcesWithPrefix() { $this->deprecated(function () { Router::mapResources('TestPlugin.TestPlugin', ['prefix' => 'api']); $result = Router::parse('/api/test_plugin/test_plugin', 'GET'); $expected = [ 'pass' => [], 'plugin' => 'TestPlugin', 'controller' => 'TestPlugin', 'prefix' => 'api', 'action' => 'index', '_method' => 'GET', '_matchedRoute' => '/api/test_plugin/test_plugin', ]; $this->assertEquals($expected, $result); $resources = Router::mapResources('Posts', ['prefix' => 'api']); $result = Router::parse('/api/posts', 'GET'); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', '_method' => 'GET', 'prefix' => 'api', '_matchedRoute' => '/api/posts', ]; $this->assertEquals($expected, $result); }); } /** * testMultipleResourceRoute method * * @return void */ public function testMultipleResourceRoute() { Router::connect('/:controller', ['action' => 'index', '_method' => ['GET', 'POST']]); $result = Router::parseRequest($this->makeRequest('/posts', 'GET')); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'posts', 'action' => 'index', '_method' => ['GET', 'POST'], '_matchedRoute' => '/:controller', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/posts', 'POST')); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'posts', 'action' => 'index', '_method' => ['GET', 'POST'], '_matchedRoute' => '/:controller', ]; $this->assertEquals($expected, $result); } /** * testGenerateUrlResourceRoute method * * @group deprecated * @return void */ public function testGenerateUrlResourceRoute() { $this->deprecated(function () { Router::mapResources('Posts'); $result = Router::url([ 'controller' => 'Posts', 'action' => 'index', '_method' => 'GET', ]); $expected = '/posts'; $this->assertEquals($expected, $result); $result = Router::url([ 'controller' => 'Posts', 'action' => 'view', '_method' => 'GET', 'id' => 10, ]); $expected = '/posts/10'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'Posts', 'action' => 'add', '_method' => 'POST']); $expected = '/posts'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'Posts', 'action' => 'edit', '_method' => 'PUT', 'id' => 10]); $expected = '/posts/10'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'Posts', 'action' => 'delete', '_method' => 'DELETE', 'id' => 10]); $expected = '/posts/10'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'Posts', 'action' => 'edit', '_method' => 'PATCH', 'id' => 10]); $expected = '/posts/10'; $this->assertEquals($expected, $result); }); } /** * testUrlNormalization method * * @return void */ public function testUrlNormalization() { Router::connect('/:controller/:action'); $expected = '/users/logout'; $result = Router::normalize('/users/logout/'); $this->assertEquals($expected, $result); $result = Router::normalize('//users//logout//'); $this->assertEquals($expected, $result); $result = Router::normalize('users/logout'); $this->assertEquals($expected, $result); $result = Router::normalize(['controller' => 'users', 'action' => 'logout']); $this->assertEquals($expected, $result); $result = Router::normalize('/'); $this->assertEquals('/', $result); $result = Router::normalize('http://google.com/'); $this->assertEquals('http://google.com/', $result); $result = Router::normalize('http://google.com//'); $this->assertEquals('http://google.com//', $result); $result = Router::normalize('/users/login/scope://foo'); $this->assertEquals('/users/login/scope:/foo', $result); $result = Router::normalize('/recipe/recipes/add'); $this->assertEquals('/recipe/recipes/add', $result); $request = new ServerRequest(['base' => '/us']); Router::setRequestInfo($request); $result = Router::normalize('/us/users/logout/'); $this->assertEquals('/users/logout', $result); Router::reload(); $request = new ServerRequest(['base' => '/cake_12']); Router::setRequestInfo($request); $result = Router::normalize('/cake_12/users/logout/'); $this->assertEquals('/users/logout', $result); Router::reload(); $_back = Configure::read('App.fullBaseUrl'); Configure::write('App.fullBaseUrl', '/'); $request = new ServerRequest(); Router::setRequestInfo($request); $result = Router::normalize('users/login'); $this->assertEquals('/users/login', $result); Configure::write('App.fullBaseUrl', $_back); Router::reload(); $request = new ServerRequest(['base' => 'beer']); Router::setRequestInfo($request); $result = Router::normalize('beer/admin/beers_tags/add'); $this->assertEquals('/admin/beers_tags/add', $result); $result = Router::normalize('/admin/beers_tags/add'); $this->assertEquals('/admin/beers_tags/add', $result); } /** * Test generating urls with base paths. * * @return void */ public function testUrlGenerationWithBasePath() { Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'params' => [ 'action' => 'index', 'plugin' => null, 'controller' => 'subscribe', ], 'url' => '/subscribe', 'base' => '/magazine', 'webroot' => '/magazine/', ]); Router::pushRequest($request); $result = Router::url(); $this->assertEquals('/magazine/subscribe', $result); $result = Router::url([]); $this->assertEquals('/magazine/subscribe', $result); $result = Router::url('/'); $this->assertEquals('/magazine/', $result); $result = Router::url('/articles/'); $this->assertEquals('/magazine/articles/', $result); $result = Router::url('/articles/view'); $this->assertEquals('/magazine/articles/view', $result); $result = Router::url(['controller' => 'articles', 'action' => 'view', 1]); $this->assertEquals('/magazine/articles/view/1', $result); } /** * Test url() with _host option routes with request context * * @return void */ public function testUrlGenerationHostOptionRequestContext() { $server = [ 'HTTP_HOST' => 'foo.example.com', 'DOCUMENT_ROOT' => '/Users/markstory/Sites', 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php', 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1', 'REQUEST_URI' => '/subdir/articles/view/1', 'QUERY_STRING' => '', 'SERVER_PORT' => 80, ]; Router::connect('/fallback', ['controller' => 'Articles'], ['_host' => '*.example.com']); $request = ServerRequestFactory::fromGlobals($server); Router::setRequestContext($request); $result = Router::url(['controller' => 'Articles', 'action' => 'index']); $this->assertEquals('http://foo.example.com/subdir/fallback', $result); $result = Router::url(['controller' => 'Articles', 'action' => 'index'], true); $this->assertEquals('http://foo.example.com/subdir/fallback', $result); } /** * Test that catch all routes work with a variety of falsey inputs. * * @return void */ public function testUrlCatchAllRoute() { Router::connect('/*', ['controller' => 'categories', 'action' => 'index']); $result = Router::url(['controller' => 'categories', 'action' => 'index', '0']); $this->assertEquals('/0', $result); $expected = [ 'plugin' => null, 'controller' => 'categories', 'action' => 'index', 'pass' => ['0'], '_matchedRoute' => '/*', ]; $result = Router::parseRequest($this->makeRequest('/0', 'GET')); $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('0', 'GET')); $this->assertEquals($expected, $result); } /** * test generation of basic urls. * * @return void */ public function testUrlGenerationBasic() { extract(Router::getNamedExpressions()); Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']); $out = Router::url(['controller' => 'pages', 'action' => 'display', 'home']); $this->assertEquals('/', $out); Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']); $result = Router::url(['controller' => 'pages', 'action' => 'display', 'about']); $expected = '/pages/about'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:plugin/:id/*', ['controller' => 'posts', 'action' => 'view'], ['id' => $ID]); $result = Router::url([ 'plugin' => 'cake_plugin', 'controller' => 'posts', 'action' => 'view', 'id' => '1', ]); $expected = '/cake_plugin/1'; $this->assertEquals($expected, $result); $result = Router::url([ 'plugin' => 'cake_plugin', 'controller' => 'posts', 'action' => 'view', 'id' => '1', '0', ]); $expected = '/cake_plugin/1/0'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:controller/:action/:id', [], ['id' => $ID]); $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']); $expected = '/posts/view/1'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:controller/:id', ['action' => 'view']); $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']); $expected = '/posts/1'; $this->assertEquals($expected, $result); Router::connect('/view/*', ['controller' => 'posts', 'action' => 'view']); $result = Router::url(['controller' => 'posts', 'action' => 'view', '1']); $expected = '/view/1'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:controller/:action'); $request = new ServerRequest([ 'params' => [ 'action' => 'index', 'plugin' => null, 'controller' => 'users', ], ]); Router::setRequestInfo($request); $result = Router::url(['action' => 'login']); $expected = '/users/login'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/contact/:action', ['plugin' => 'contact', 'controller' => 'contact']); $result = Router::url([ 'plugin' => 'contact', 'controller' => 'contact', 'action' => 'me', ]); $expected = '/contact/me'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:controller', ['action' => 'index']); $request = new ServerRequest([ 'params' => [ 'action' => 'index', 'plugin' => 'myplugin', 'controller' => 'mycontroller', ], ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'myothercontroller']); $expected = '/myothercontroller'; $this->assertEquals($expected, $result); } /** * Test that generated names for routes are case-insensitive. * * @return void */ public function testRouteNameCasing() { Router::connect('/articles/:id', ['controller' => 'Articles', 'action' => 'view']); Router::connect('/:controller/:action/*', [], ['routeClass' => 'InflectedRoute']); $result = Router::url(['controller' => 'Articles', 'action' => 'view', 'id' => 10]); $expected = '/articles/10'; $this->assertEquals($expected, $result); } /** * Test generation of routes with query string parameters. * * @return void */ public function testUrlGenerationWithQueryStrings() { Router::connect('/:controller/:action/*'); $result = Router::url([ 'controller' => 'posts', '0', '?' => ['var' => 'test', 'var2' => 'test2'], ]); $expected = '/posts/index/0?var=test&var2=test2'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'posts', '0', '?' => ['var' => null]]); $this->assertEquals('/posts/index/0', $result); $result = Router::url([ 'controller' => 'posts', '0', '?' => [ 'var' => 'test', 'var2' => 'test2', ], '#' => 'unencoded string %', ]); $expected = '/posts/index/0?var=test&var2=test2#unencoded string %'; $this->assertEquals($expected, $result); } /** * test that regex validation of keyed route params is working. * * @return void */ public function testUrlGenerationWithRegexQualifiedParams() { Router::connect( ':language/galleries', ['controller' => 'galleries', 'action' => 'index'], ['language' => '[a-z]{3}'] ); Router::connect( '/:language/:admin/:controller/:action/*', ['admin' => 'admin'], ['language' => '[a-z]{3}', 'admin' => 'admin'] ); Router::connect( '/:language/:controller/:action/*', [], ['language' => '[a-z]{3}'] ); $result = Router::url(['admin' => false, 'language' => 'dan', 'action' => 'index', 'controller' => 'galleries']); $expected = '/dan/galleries'; $this->assertEquals($expected, $result); $result = Router::url(['admin' => false, 'language' => 'eng', 'action' => 'index', 'controller' => 'galleries']); $expected = '/eng/galleries'; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/:language/pages', ['controller' => 'pages', 'action' => 'index'], ['language' => '[a-z]{3}'] ); Router::connect('/:language/:controller/:action/*', [], ['language' => '[a-z]{3}']); $result = Router::url(['language' => 'eng', 'action' => 'index', 'controller' => 'pages']); $expected = '/eng/pages'; $this->assertEquals($expected, $result); $result = Router::url(['language' => 'eng', 'controller' => 'pages']); $this->assertEquals($expected, $result); $result = Router::url(['language' => 'eng', 'controller' => 'pages', 'action' => 'add']); $expected = '/eng/pages/add'; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/forestillinger/:month/:year/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'], ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}'] ); $result = Router::url([ 'plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'month' => 10, 'year' => 2007, 'min-forestilling', ]); $expected = '/forestillinger/10/2007/min-forestilling'; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/kalender/:month/:year/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'], ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}'] ); Router::connect('/kalender/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar']); $result = Router::url(['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'min-forestilling']); $expected = '/kalender/min-forestilling'; $this->assertEquals($expected, $result); $result = Router::url([ 'plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'year' => 2007, 'month' => 10, 'min-forestilling', ]); $expected = '/kalender/10/2007/min-forestilling'; $this->assertEquals($expected, $result); } /** * Test URL generation with an admin prefix * * @return void */ public function testUrlGenerationWithPrefix() { Router::reload(); Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']); Router::connect('/reset/*', ['admin' => true, 'controller' => 'users', 'action' => 'reset']); Router::connect('/tests', ['controller' => 'tests', 'action' => 'index']); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); Router::extensions('rss', false); $request = new ServerRequest([ 'params' => [ 'controller' => 'registrations', 'action' => 'admin_index', 'plugin' => null, 'prefix' => 'admin', '_ext' => 'html', ], 'url' => '/admin/registrations/index', ]); Router::setRequestInfo($request); $result = Router::url([]); $expected = '/admin/registrations/index'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/subscriptions/:action/*', ['controller' => 'subscribe', 'prefix' => 'admin']); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'action' => 'index', 'plugin' => null, 'controller' => 'subscribe', 'prefix' => 'admin', ], 'webroot' => '/magazine/', 'base' => '/magazine', 'url' => '/admin/subscriptions/edit/1', ]); Router::setRequestInfo($request); $result = Router::url(['action' => 'edit', 1]); $expected = '/magazine/admin/subscriptions/edit/1'; $this->assertEquals($expected, $result); $result = Router::url(['prefix' => 'admin', 'controller' => 'users', 'action' => 'login']); $expected = '/magazine/admin/users/login'; $this->assertEquals($expected, $result); Router::reload(); $request = new ServerRequest([ 'params' => [ 'prefix' => 'admin', 'action' => 'index', 'plugin' => null, 'controller' => 'users', ], 'webroot' => '/', 'url' => '/admin/users/index', ]); Router::setRequestInfo($request); Router::connect('/page/*', ['controller' => 'pages', 'action' => 'view', 'prefix' => 'admin']); $result = Router::url(['prefix' => 'admin', 'controller' => 'pages', 'action' => 'view', 'my-page']); $expected = '/page/my-page'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'pages', 'action' => 'add', 'prefix' => 'admin', ], 'webroot' => '/', 'url' => '/admin/pages/add', ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]); $expected = '/admin/pages/add'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'pages', 'action' => 'add', 'prefix' => 'admin', ], 'webroot' => '/', 'url' => '/admin/pages/add', ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]); $expected = '/admin/pages/add'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/:controller/:action/:id', ['prefix' => 'admin'], ['id' => '[0-9]+']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'pass' => ['284'], 'prefix' => 'admin', ], 'url' => '/admin/pages/edit/284', ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'id' => '284']); $expected = '/admin/pages/edit/284'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'pages', 'action' => 'add', 'prefix' => 'admin', ], 'url' => '/admin/pages/add', ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]); $expected = '/admin/pages/add'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'prefix' => 'admin', ], 'url' => '/admin/pages/edit/284', ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 284]); $expected = '/admin/pages/edit/284'; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/admin/posts/*', ['controller' => 'posts', 'action' => 'index', 'prefix' => 'admin']); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'prefix' => 'admin', 'pass' => ['284'], ], 'url' => '/admin/pages/edit/284', ]); Router::setRequestInfo($request); $result = Router::url(['all']); $expected = '/admin/posts/all'; $this->assertEquals($expected, $result); } /** * Test URL generation inside a prefixed plugin. * * @return void */ public function testUrlGenerationPrefixedPlugin() { Router::prefix('admin', function (RouteBuilder $routes) { $routes->plugin('MyPlugin', function (RouteBuilder $routes) { $routes->fallbacks('InflectedRoute'); }); }); $result = Router::url(['prefix' => 'admin', 'plugin' => 'MyPlugin', 'controller' => 'Forms', 'action' => 'edit', 2]); $expected = '/admin/my_plugin/forms/edit/2'; $this->assertEquals($expected, $result); } /** * Test URL generation with multiple prefixes. * * @return void */ public function testUrlGenerationMultiplePrefixes() { Router::prefix('admin', function (RouteBuilder $routes) { $routes->prefix('backoffice', function (RouteBuilder $routes) { $routes->fallbacks('InflectedRoute'); }); }); $result = Router::url([ 'prefix' => 'admin/backoffice', 'controller' => 'Dashboards', 'action' => 'home', ]); $expected = '/admin/backoffice/dashboards/home'; $this->assertEquals($expected, $result); } /** * testUrlGenerationWithExtensions method * * @return void */ public function testUrlGenerationWithExtensions() { Router::connect('/:controller', ['action' => 'index']); Router::connect('/:controller/:action'); $result = Router::url([ 'plugin' => null, 'controller' => 'articles', 'action' => 'add', 'id' => null, '_ext' => 'json', ]); $expected = '/articles/add.json'; $this->assertEquals($expected, $result); $result = Router::url([ 'plugin' => null, 'controller' => 'articles', 'action' => 'add', '_ext' => 'json', ]); $expected = '/articles/add.json'; $this->assertEquals($expected, $result); $result = Router::url([ 'plugin' => null, 'controller' => 'articles', 'action' => 'index', 'id' => null, '_ext' => 'json', ]); $expected = '/articles.json'; $this->assertEquals($expected, $result); $result = Router::url([ 'plugin' => null, 'controller' => 'articles', 'action' => 'index', 'id' => 'testing', '_ext' => 'json', ]); $expected = '/articles.json?id=testing'; $this->assertEquals($expected, $result); } /** * test url() when the current request has an extension. * * @return void */ public function testUrlGenerationWithExtensionInCurrentRequest() { Router::extensions('rss'); Router::scope('/', function ($r) { $r->fallbacks('InflectedRoute'); }); $request = new ServerRequest([ 'params' => ['plugin' => null, 'controller' => 'Tasks', 'action' => 'index', '_ext' => 'rss'], ]); Router::pushRequest($request); $result = Router::url([ 'controller' => 'Tasks', 'action' => 'view', 1, ]); $expected = '/tasks/view/1'; $this->assertEquals($expected, $result); $result = Router::url([ 'controller' => 'Tasks', 'action' => 'view', 1, '_ext' => 'json', ]); $expected = '/tasks/view/1.json'; $this->assertEquals($expected, $result); } /** * Test url generation with named routes. */ public function testUrlGenerationNamedRoute() { Router::connect( '/users', ['controller' => 'users', 'action' => 'index'], ['_name' => 'users-index'] ); Router::connect( '/users/:name', ['controller' => 'users', 'action' => 'view'], ['_name' => 'test'] ); Router::connect( '/view/*', ['action' => 'view'], ['_name' => 'Articles::view'] ); $url = Router::url(['_name' => 'test', 'name' => 'mark']); $this->assertEquals('/users/mark', $url); $url = Router::url([ '_name' => 'test', 'name' => 'mark', 'page' => 1, 'sort' => 'title', 'dir' => 'desc', ]); $this->assertEquals('/users/mark?page=1&sort=title&dir=desc', $url); $url = Router::url(['_name' => 'Articles::view']); $this->assertEquals('/view/', $url); $url = Router::url(['_name' => 'Articles::view', '1']); $this->assertEquals('/view/1', $url); $url = Router::url(['_name' => 'Articles::view', '_full' => true, '1']); $this->assertEquals('http://localhost/view/1', $url); $url = Router::url(['_name' => 'Articles::view', '1', '#' => 'frag']); $this->assertEquals('/view/1#frag', $url); } /** * Test that using invalid names causes exceptions. * * @return void */ public function testNamedRouteException() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); Router::connect( '/users/:name', ['controller' => 'users', 'action' => 'view'], ['_name' => 'test'] ); $url = Router::url(['_name' => 'junk', 'name' => 'mark']); } /** * Test that using duplicate names causes exceptions. * * @return void */ public function testDuplicateNamedRouteException() { $this->expectException(\Cake\Routing\Exception\DuplicateNamedRouteException::class); Router::connect( '/users/:name', ['controller' => 'users', 'action' => 'view'], ['_name' => 'test'] ); Router::connect( '/users/:name', ['controller' => 'users', 'action' => 'view'], ['_name' => 'otherName'] ); Router::connect( '/users/:name', ['controller' => 'users', 'action' => 'view'], ['_name' => 'test'] ); } /** * Test that url filters are applied to url params. * * @return void */ public function testUrlGenerationWithUrlFilter() { Router::connect('/:lang/:controller/:action/*'); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'lang' => 'en', 'controller' => 'posts', 'action' => 'index', ], ]); Router::pushRequest($request); $calledCount = 0; Router::addUrlFilter(function ($url, $request) use (&$calledCount) { $calledCount++; $url['lang'] = $request->getParam('lang'); return $url; }); Router::addUrlFilter(function ($url, $request) use (&$calledCount) { $calledCount++; $url[] = '1234'; return $url; }); $result = Router::url(['controller' => 'tasks', 'action' => 'edit']); $this->assertEquals('/en/tasks/edit/1234', $result); $this->assertEquals(2, $calledCount); } /** * Test that url filter failure gives better errors * * @return void */ public function testUrlGenerationWithUrlFilterFailureClosure() { $this->expectException(RuntimeException::class); $this->expectExceptionMessageRegExp( '/URL filter defined in .*RouterTest\.php on line \d+ could not be applied\.' . ' The filter failed with: nope/' ); Router::connect('/:lang/:controller/:action/*'); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'lang' => 'en', 'controller' => 'posts', 'action' => 'index', ], ]); Router::pushRequest($request); Router::addUrlFilter(function ($url, $request) { throw new RuntimeException('nope'); }); Router::url(['controller' => 'posts', 'action' => 'index', 'lang' => 'en']); } /** * Test that url filter failure gives better errors * * @return void */ public function testUrlGenerationWithUrlFilterFailureMethod() { $this->expectException(RuntimeException::class); $this->expectExceptionMessageRegExp( '/URL filter defined in .*RouterTest\.php on line \d+ could not be applied\.' . ' The filter failed with: /' ); Router::connect('/:lang/:controller/:action/*'); $request = new ServerRequest([ 'params' => [ 'plugin' => null, 'lang' => 'en', 'controller' => 'posts', 'action' => 'index', ], ]); Router::pushRequest($request); Router::addUrlFilter([$this, 'badFilter']); Router::url(['controller' => 'posts', 'action' => 'index', 'lang' => 'en']); } /** * Testing stub for broken URL filters. * * @throws \RuntimeException */ public function badFilter() { throw new RuntimeException('nope'); } /** * Test url param persistence. * * @return void */ public function testUrlParamPersistence() { Router::connect('/:lang/:controller/:action/*', [], ['persist' => ['lang']]); $request = new ServerRequest([ 'url' => '/en/posts/index', 'params' => [ 'plugin' => null, 'lang' => 'en', 'controller' => 'posts', 'action' => 'index', ], ]); Router::pushRequest($request); $result = Router::url(['controller' => 'tasks', 'action' => 'edit', '1234']); $this->assertEquals('/en/tasks/edit/1234', $result); } /** * Test that plain strings urls work * * @return void */ public function testUrlGenerationPlainString() { $mailto = 'mailto:mark@example.com'; $result = Router::url($mailto); $this->assertEquals($mailto, $result); $js = 'javascript:alert("hi")'; $result = Router::url($js); $this->assertEquals($js, $result); $hash = '#first'; $result = Router::url($hash); $this->assertEquals($hash, $result); } /** * test that you can leave active plugin routes with plugin = null * * @return void */ public function testCanLeavePlugin() { Router::connect('/admin/:controller', ['action' => 'index', 'prefix' => 'admin']); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); $request = new ServerRequest([ 'url' => '/admin/this/interesting/index', 'params' => [ 'pass' => [], 'prefix' => 'admin', 'plugin' => 'this', 'action' => 'index', 'controller' => 'interesting', ], ]); Router::setRequestInfo($request); $result = Router::url(['plugin' => null, 'controller' => 'posts', 'action' => 'index']); $this->assertEquals('/admin/posts', $result); } /** * testUrlParsing method * * @return void */ public function testUrlParsing() { extract(Router::getNamedExpressions()); Router::connect( '/posts/:value/:somevalue/:othervalue/*', ['controller' => 'Posts', 'action' => 'view'], ['value', 'somevalue', 'othervalue'] ); $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET')); $expected = [ 'value' => '2007', 'somevalue' => '08', 'othervalue' => '01', 'controller' => 'Posts', 'action' => 'view', 'plugin' => null, 'pass' => ['0' => 'title-of-post-here'], '_matchedRoute' => '/posts/:value/:somevalue/:othervalue/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:year/:month/:day/*', ['controller' => 'posts', 'action' => 'view'], ['year' => $Year, 'month' => $Month, 'day' => $Day] ); $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET')); $expected = [ 'year' => '2007', 'month' => '08', 'day' => '01', 'controller' => 'posts', 'action' => 'view', 'plugin' => null, 'pass' => ['0' => 'title-of-post-here'], '_matchedRoute' => '/posts/:year/:month/:day/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:day/:year/:month/*', ['controller' => 'posts', 'action' => 'view'], ['year' => $Year, 'month' => $Month, 'day' => $Day] ); $result = Router::parseRequest($this->makeRequest('/posts/01/2007/08/title-of-post-here', 'GET')); $expected = [ 'day' => '01', 'year' => '2007', 'month' => '08', 'controller' => 'posts', 'action' => 'view', 'plugin' => null, 'pass' => ['0' => 'title-of-post-here'], '_matchedRoute' => '/posts/:day/:year/:month/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:month/:day/:year/*', ['controller' => 'posts', 'action' => 'view'], ['year' => $Year, 'month' => $Month, 'day' => $Day] ); $result = Router::parseRequest($this->makeRequest('/posts/08/01/2007/title-of-post-here', 'GET')); $expected = [ 'month' => '08', 'day' => '01', 'year' => '2007', 'controller' => 'posts', 'action' => 'view', 'plugin' => null, 'pass' => ['0' => 'title-of-post-here'], '_matchedRoute' => '/posts/:month/:day/:year/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:year/:month/:day/*', ['controller' => 'posts', 'action' => 'view'] ); $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET')); $expected = [ 'year' => '2007', 'month' => '08', 'day' => '01', 'controller' => 'posts', 'action' => 'view', 'plugin' => null, 'pass' => ['0' => 'title-of-post-here'], '_matchedRoute' => '/posts/:year/:month/:day/*', ]; $this->assertEquals($expected, $result); Router::reload(); $this->_connectDefaultRoutes(); $result = Router::parseRequest($this->makeRequest('/pages/display/home', 'GET')); $expected = [ 'plugin' => null, 'pass' => ['home'], 'controller' => 'Pages', 'action' => 'display', '_matchedRoute' => '/{controller}/{action}/*', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('pages/display/home/', 'GET')); $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('pages/display/home', 'GET')); $this->assertEquals($expected, $result); Router::reload(); Router::connect('/page/*', ['controller' => 'test']); $result = Router::parseRequest($this->makeRequest('/page/my-page', 'GET')); $expected = [ 'pass' => ['my-page'], 'plugin' => null, 'controller' => 'test', 'action' => 'index', '_matchedRoute' => '/page/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/:language/contact', ['language' => 'eng', 'plugin' => 'contact', 'controller' => 'contact', 'action' => 'index'], ['language' => '[a-z]{3}'] ); $result = Router::parseRequest($this->makeRequest('/eng/contact', 'GET')); $expected = [ 'pass' => [], 'language' => 'eng', 'plugin' => 'contact', 'controller' => 'contact', 'action' => 'index', '_matchedRoute' => '/:language/contact', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/forestillinger/:month/:year/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'], ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}'] ); $result = Router::parseRequest($this->makeRequest('/forestillinger/10/2007/min-forestilling', 'GET')); $expected = [ 'pass' => ['min-forestilling'], 'plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'year' => 2007, 'month' => 10, '_matchedRoute' => '/forestillinger/:month/:year/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/:controller/:action/*'); Router::connect('/', ['plugin' => 'pages', 'controller' => 'pages', 'action' => 'display']); $result = Router::parseRequest($this->makeRequest('/', 'GET')); $expected = [ 'pass' => [], 'controller' => 'pages', 'action' => 'display', 'plugin' => 'pages', '_matchedRoute' => '/', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/posts/edit/0', 'GET')); $expected = [ 'pass' => [0], 'controller' => 'posts', 'action' => 'edit', 'plugin' => null, '_matchedRoute' => '/:controller/:action/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:id::url_title', ['controller' => 'posts', 'action' => 'view'], ['pass' => ['id', 'url_title'], 'id' => '[\d]+'] ); $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title', 'GET')); $expected = [ 'pass' => ['5', 'sample-post-title'], 'id' => 5, 'url_title' => 'sample-post-title', 'plugin' => null, 'controller' => 'posts', 'action' => 'view', '_matchedRoute' => '/posts/:id::url_title', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:id::url_title/*', ['controller' => 'posts', 'action' => 'view'], ['pass' => ['id', 'url_title'], 'id' => '[\d]+'] ); $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title/other/params/4', 'GET')); $expected = [ 'pass' => ['5', 'sample-post-title', 'other', 'params', '4'], 'id' => 5, 'url_title' => 'sample-post-title', 'plugin' => null, 'controller' => 'posts', 'action' => 'view', '_matchedRoute' => '/posts/:id::url_title/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']); $result = Router::parseRequest($this->makeRequest('/posts/view/10?id=123&tab=abc', 'GET')); $expected = [ 'pass' => [10], 'plugin' => null, 'controller' => 'posts', 'action' => 'view', '?' => ['id' => '123', 'tab' => 'abc'], '_matchedRoute' => '/posts/view/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/posts/:url_title-(uuid::id)', ['controller' => 'posts', 'action' => 'view'], ['pass' => ['id', 'url_title'], 'id' => $UUID] ); $result = Router::parseRequest($this->makeRequest('/posts/sample-post-title-(uuid:47fc97a9-019c-41d1-a058-1fa3cbdd56cb)', 'GET')); $expected = [ 'pass' => ['47fc97a9-019c-41d1-a058-1fa3cbdd56cb', 'sample-post-title'], 'id' => '47fc97a9-019c-41d1-a058-1fa3cbdd56cb', 'url_title' => 'sample-post-title', 'plugin' => null, 'controller' => 'posts', 'action' => 'view', '_matchedRoute' => '/posts/:url_title-(uuid::id)', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']); $result = Router::parseRequest($this->makeRequest('/posts/view/foo:bar/routing:fun', 'GET')); $expected = [ 'pass' => ['foo:bar', 'routing:fun'], 'plugin' => null, 'controller' => 'posts', 'action' => 'view', '_matchedRoute' => '/posts/view/*', ]; $this->assertEquals($expected, $result); } /** * test parseRequest * * @return void */ public function testParseRequest() { Router::connect('/articles/:action/*', ['controller' => 'Articles']); $request = new ServerRequest(['url' => '/articles/view/1']); $result = Router::parseRequest($request); $expected = [ 'pass' => ['1'], 'plugin' => null, 'controller' => 'Articles', 'action' => 'view', '_matchedRoute' => '/articles/:action/*', ]; $this->assertEquals($expected, $result); } /** * testUuidRoutes method * * @return void */ public function testUuidRoutes() { Router::connect( '/subjects/add/:category_id', ['controller' => 'subjects', 'action' => 'add'], ['category_id' => '\w{8}-\w{4}-\w{4}-\w{4}-\w{12}'] ); $result = Router::parseRequest($this->makeRequest('/subjects/add/4795d601-19c8-49a6-930e-06a8b01d17b7', 'GET')); $expected = [ 'pass' => [], 'category_id' => '4795d601-19c8-49a6-930e-06a8b01d17b7', 'plugin' => null, 'controller' => 'subjects', 'action' => 'add', '_matchedRoute' => '/subjects/add/:category_id', ]; $this->assertEquals($expected, $result); } /** * testRouteSymmetry method * * @return void */ public function testRouteSymmetry() { Router::connect( '/:extra/page/:slug/*', ['controller' => 'pages', 'action' => 'view', 'extra' => null], ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+', 'action' => 'view'] ); $result = Router::parseRequest($this->makeRequest('/some_extra/page/this_is_the_slug', 'GET')); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'pages', 'action' => 'view', 'slug' => 'this_is_the_slug', 'extra' => 'some_extra', '_matchedRoute' => '/:extra/page/:slug/*', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/page/this_is_the_slug', 'GET')); $expected = [ 'pass' => [], 'plugin' => null, 'controller' => 'pages', 'action' => 'view', 'slug' => 'this_is_the_slug', 'extra' => null, '_matchedRoute' => '/:extra/page/:slug/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect( '/:extra/page/:slug/*', ['controller' => 'pages', 'action' => 'view', 'extra' => null], ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+'] ); $result = Router::url([ 'admin' => null, 'plugin' => null, 'controller' => 'pages', 'action' => 'view', 'slug' => 'this_is_the_slug', 'extra' => null, ]); $expected = '/page/this_is_the_slug'; $this->assertEquals($expected, $result); $result = Router::url([ 'admin' => null, 'plugin' => null, 'controller' => 'pages', 'action' => 'view', 'slug' => 'this_is_the_slug', 'extra' => 'some_extra', ]); $expected = '/some_extra/page/this_is_the_slug'; $this->assertEquals($expected, $result); } /** * Test exceptions when parsing fails. */ public function testParseError() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); Router::connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']); Router::parseRequest($this->makeRequest('/nope', 'GET')); } /** * Test deprecated behavior * * @group deprecated * @return void */ public function testParseMethodCondition() { $this->deprecated(function () { Router::connect('/posts', ['controller' => 'Posts', '_method' => 'POST']); $_SERVER['REQUEST_METHOD'] = 'POST'; $this->assertNotEmpty(Router::parse('/posts')); }); } /** * Test parse and reverse symmetry * * @return void * @dataProvider parseReverseSymmetryData */ public function testParseReverseSymmetry($url) { $this->_connectDefaultRoutes(); $this->assertSame($url, Router::reverse(Router::parseRequest($this->makeRequest($url, 'GET')) + ['url' => []])); } /** * Data for parse and reverse test * * @return array */ public function parseReverseSymmetryData() { return [ ['/controller/action'], ['/controller/action/param'], ['/controller/action?param1=value1¶m2=value2'], ['/controller/action/param?param1=value1'], ]; } /** * testSetExtensions method * * @return void */ public function testSetExtensions() { Router::extensions('rss', false); $this->assertContains('rss', Router::extensions()); $this->_connectDefaultRoutes(); $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET')); $this->assertEquals('rss', $result['_ext']); $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET')); $this->assertArrayNotHasKey('_ext', $result); Router::extensions(['xml']); } /** * Test that route builders propagate extensions to the top. * * @return void */ public function testExtensionsWithScopedRoutes() { Router::extensions(['json']); Router::scope('/', function (RouteBuilder $routes) { $routes->setExtensions('rss'); $routes->connect('/', ['controller' => 'Pages', 'action' => 'index']); $routes->scope('/api', function (RouteBuilder $routes) { $routes->setExtensions('xml'); $routes->connect('/docs', ['controller' => 'ApiDocs', 'action' => 'index']); }); }); $this->assertEquals(['json', 'rss', 'xml'], array_values(Router::extensions())); } /** * Test connecting resources. * * @return void */ public function testResourcesInScope() { Router::scope('/api', ['prefix' => 'api'], function (RouteBuilder $routes) { $routes->setExtensions(['json']); $routes->resources('Articles'); }); $url = Router::url([ 'prefix' => 'api', 'controller' => 'Articles', 'action' => 'edit', '_method' => 'PUT', 'id' => 99, ]); $this->assertEquals('/api/articles/99', $url); $url = Router::url([ 'prefix' => 'api', 'controller' => 'Articles', 'action' => 'edit', '_method' => 'PUT', '_ext' => 'json', 'id' => 99, ]); $this->assertEquals('/api/articles/99.json', $url); } /** * testExtensionParsing method * * @return void */ public function testExtensionParsing() { Router::extensions('rss', false); $this->_connectDefaultRoutes(); $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET')); $expected = [ 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', '_ext' => 'rss', 'pass' => [], '_matchedRoute' => '/{controller}', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss', 'GET')); $expected = [ 'plugin' => null, 'controller' => 'Posts', 'action' => 'view', 'pass' => ['1'], '_ext' => 'rss', '_matchedRoute' => '/{controller}/{action}/*', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss?query=test', 'GET')); $expected['?'] = ['query' => 'test']; $this->assertEquals($expected, $result); Router::reload(); Router::extensions(['rss', 'xml'], false); $this->_connectDefaultRoutes(); $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET')); $expected = [ 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', '_ext' => 'xml', 'pass' => [], '_matchedRoute' => '/{controller}', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/posts.atom?hello=goodbye', 'GET')); $expected = [ 'plugin' => null, 'controller' => 'Posts.atom', 'action' => 'index', 'pass' => [], '?' => ['hello' => 'goodbye'], '_matchedRoute' => '/{controller}', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']); $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET')); $expected = [ 'controller' => 'controller', 'action' => 'action', 'plugin' => null, '_ext' => 'rss', 'pass' => [], '_matchedRoute' => '/controller/action', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']); $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET')); $expected = [ 'controller' => 'controller', 'action' => 'action', 'plugin' => null, '_ext' => 'rss', 'pass' => [], '_matchedRoute' => '/controller/action', ]; $this->assertEquals($expected, $result); Router::reload(); Router::extensions('rss', false); Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']); $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET')); $expected = [ 'controller' => 'controller', 'action' => 'action', 'plugin' => null, '_ext' => 'rss', 'pass' => [], '_matchedRoute' => '/controller/action', ]; $this->assertEquals($expected, $result); } /** * Test newer style automatically generated prefix routes. * * @return void * @see testUrlGenerationWithAutoPrefixes */ public function testUrlGenerationWithAutoPrefixes() { Router::reload(); Router::connect('/protected/:controller/:action/*', ['prefix' => 'protected']); Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']); Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'url' => '/images/index', 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => null, 'protected' => false, 'url' => ['url' => 'images/index'], ], ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'images', 'action' => 'add']); $expected = '/images/add'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']); $expected = '/protected/images/add'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'images', 'action' => 'add_protected_test', 'prefix' => 'protected']); $expected = '/protected/images/add_protected_test'; $this->assertEquals($expected, $result); $result = Router::url(['action' => 'edit', 1]); $expected = '/images/edit/1'; $this->assertEquals($expected, $result); $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']); $expected = '/protected/images/edit/1'; $this->assertEquals($expected, $result); $result = Router::url(['action' => 'protectededit', 1, 'prefix' => 'protected']); $expected = '/protected/images/protectededit/1'; $this->assertEquals($expected, $result); $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']); $expected = '/protected/images/edit/1'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'others', 'action' => 'edit', 1]); $expected = '/others/edit/1'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'others', 'action' => 'edit', 1, 'prefix' => 'protected']); $expected = '/protected/others/edit/1'; $this->assertEquals($expected, $result); } /** * Test that the ssl option works. * * @return void */ public function testGenerationWithSslOption() { Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'url' => '/images/index', 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', ], 'environment' => ['HTTP_HOST' => 'localhost'], ]); Router::pushRequest($request); $result = Router::url([ '_ssl' => true, ]); $this->assertEquals('https://localhost/images/index', $result); $result = Router::url([ '_ssl' => false, ]); $this->assertEquals('http://localhost/images/index', $result); } /** * Test that the _ssl + _full options work together. * * @return void */ public function testGenerationWithSslAndFullOption() { Configure::write('App.fullBaseUrl', 'http://app.localhost'); Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'environment' => ['HTTP_HOST' => 'localhost'], ]); Router::pushRequest($request); $result = Router::url([ 'controller' => 'images', 'action' => 'index', '_ssl' => true, '_full' => true, ]); $this->assertEquals('https://app.localhost/images/index', $result); $result = Router::url([ 'controller' => 'images', 'action' => 'index', '_ssl' => false, '_full' => true, ]); $this->assertEquals('http://app.localhost/images/index', $result); $result = Router::url([ 'controller' => 'images', 'action' => 'index', '_full' => false, '_ssl' => false, ]); $this->assertEquals('http://localhost/images/index', $result); } /** * Test ssl option when the current request is ssl. * * @return void */ public function testGenerateWithSslInSsl() { Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'url' => '/images/index', 'environment' => ['HTTP_HOST' => 'localhost', 'HTTPS' => 'on'], 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', ], ]); Router::pushRequest($request); $result = Router::url([ '_ssl' => false, ]); $this->assertEquals('http://localhost/images/index', $result); $result = Router::url([ '_ssl' => true, ]); $this->assertEquals('https://localhost/images/index', $result); } /** * test that prefix routes persist when they are in the current request. * * @return void */ public function testPrefixRoutePersistence() { Router::reload(); Router::connect('/protected/:controller/:action', ['prefix' => 'protected']); Router::connect('/:controller/:action'); $request = new ServerRequest([ 'url' => '/protected/images/index', 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected', ], ]); Router::setRequestInfo($request); $result = Router::url(['prefix' => 'protected', 'controller' => 'images', 'action' => 'add']); $expected = '/protected/images/add'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'images', 'action' => 'add']); $expected = '/protected/images/add'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => false]); $expected = '/images/add'; $this->assertEquals($expected, $result); } /** * test that setting a prefix override the current one * * @return void */ public function testPrefixOverride() { Router::connect('/admin/:controller/:action', ['prefix' => 'admin']); Router::connect('/protected/:controller/:action', ['prefix' => 'protected']); $request = new ServerRequest([ 'url' => '/protected/images/index', 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected', ], ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'admin']); $expected = '/admin/images/add'; $this->assertEquals($expected, $result); $request = new ServerRequest([ 'url' => '/admin/images/index', 'params' => [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'admin', ], ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']); $expected = '/protected/images/add'; $this->assertEquals($expected, $result); } /** * Test that well known route parameters are passed through. * * @return void */ public function testRouteParamDefaults() { Router::connect('/cache/*', ['prefix' => false, 'plugin' => true, 'controller' => 0, 'action' => 1]); $url = Router::url(['prefix' => 0, 'plugin' => 1, 'controller' => 0, 'action' => 1, 'test']); $expected = '/cache/test'; $this->assertEquals($expected, $url); try { Router::url(['controller' => 0, 'action' => 1, 'test']); $this->fail('No exception raised'); } catch (\Exception $e) { $this->assertTrue(true, 'Exception was raised'); } try { Router::url(['prefix' => 1, 'controller' => 0, 'action' => 1, 'test']); $this->fail('No exception raised'); } catch (\Exception $e) { $this->assertTrue(true, 'Exception was raised'); } } /** * testRemoveBase method * * @return void */ public function testRemoveBase() { Router::connect('/:controller/:action'); $request = new ServerRequest([ 'url' => '/', 'base' => '/base', 'params' => [ 'plugin' => null, 'controller' => 'controller', 'action' => 'index', ], ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action']); $expected = '/base/my_controller/my_action'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action', '_base' => false]); $expected = '/my_controller/my_action'; $this->assertEquals($expected, $result); } /** * testPagesUrlParsing method * * @return void */ public function testPagesUrlParsing() { Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']); Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']); $result = Router::parseRequest($this->makeRequest('/', 'GET')); $expected = [ 'pass' => ['home'], 'plugin' => null, 'controller' => 'pages', 'action' => 'display', '_matchedRoute' => '/', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/pages/home/', 'GET')); $expected = [ 'pass' => ['home'], 'plugin' => null, 'controller' => 'pages', 'action' => 'display', '_matchedRoute' => '/pages/*', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']); $result = Router::parseRequest($this->makeRequest('/', 'GET')); $expected = [ 'pass' => ['home'], 'plugin' => null, 'controller' => 'pages', 'action' => 'display', '_matchedRoute' => '/', ]; $this->assertEquals($expected, $result); Router::reload(); Router::connect('/', ['controller' => 'posts', 'action' => 'index']); Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']); $result = Router::parseRequest($this->makeRequest('/pages/contact/', 'GET')); $expected = [ 'pass' => ['contact'], 'plugin' => null, 'controller' => 'pages', 'action' => 'display', '_matchedRoute' => '/pages/*', ]; $this->assertEquals($expected, $result); } /** * test that requests with a trailing dot don't loose the do. * * @return void */ public function testParsingWithTrailingPeriod() { Router::reload(); Router::connect('/:controller/:action/*'); $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET')); $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off'); $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET')); $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off'); } /** * test that requests with a trailing dot don't loose the do. * * @return void */ public function testParsingWithTrailingPeriodAndParseExtensions() { Router::reload(); Router::connect('/:controller/:action/*'); $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET')); $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off'); $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET')); $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off'); } /** * test that patterns work for :action * * @return void */ public function testParsingWithPatternOnAction() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); Router::connect( '/blog/:action/*', ['controller' => 'blog_posts'], ['action' => 'other|actions'] ); $result = Router::parseRequest($this->makeRequest('/blog/other', 'GET')); $expected = [ 'plugin' => null, 'controller' => 'blog_posts', 'action' => 'other', 'pass' => [], '_matchedRoute' => '/blog/:action/*', ]; $this->assertEquals($expected, $result); Router::parseRequest($this->makeRequest('/blog/foobar', 'GET')); } /** * Test url() works with patterns on :action * * @return void */ public function testUrlPatternOnAction() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); Router::connect( '/blog/:action/*', ['controller' => 'blog_posts'], ['action' => 'other|actions'] ); $result = Router::url(['controller' => 'blog_posts', 'action' => 'actions']); $this->assertEquals('/blog/actions', $result); $result = Router::url(['controller' => 'blog_posts', 'action' => 'foo']); $this->assertEquals('/', $result); } /** * testParsingWithLiteralPrefixes method * * @return void */ public function testParsingWithLiteralPrefixes() { Router::reload(); $adminParams = ['prefix' => 'admin']; Router::connect('/admin/:controller', $adminParams); Router::connect('/admin/:controller/:action/*', $adminParams); $request = new ServerRequest([ 'url' => '/', 'base' => '/base', 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'], ]); Router::setRequestInfo($request); $result = Router::parseRequest($this->makeRequest('/admin/posts/', 'GET')); $expected = [ 'pass' => [], 'prefix' => 'admin', 'plugin' => null, 'controller' => 'posts', 'action' => 'index', '_matchedRoute' => '/admin/:controller', ]; $this->assertEquals($expected, $result); $result = Router::parseRequest($this->makeRequest('/admin/posts', 'GET')); $this->assertEquals($expected, $result); $result = Router::url(['prefix' => 'admin', 'controller' => 'posts']); $expected = '/base/admin/posts'; $this->assertEquals($expected, $result); Router::reload(); $prefixParams = ['prefix' => 'members']; Router::connect('/members/:controller', $prefixParams); Router::connect('/members/:controller/:action', $prefixParams); Router::connect('/members/:controller/:action/*', $prefixParams); $request = new ServerRequest([ 'url' => '/', 'base' => '/base', 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'], ]); Router::setRequestInfo($request); $result = Router::parseRequest($this->makeRequest('/members/posts/index', 'GET')); $expected = [ 'pass' => [], 'prefix' => 'members', 'plugin' => null, 'controller' => 'posts', 'action' => 'index', '_matchedRoute' => '/members/:controller/:action', ]; $this->assertEquals($expected, $result); $result = Router::url(['prefix' => 'members', 'controller' => 'users', 'action' => 'add']); $expected = '/base/members/users/add'; $this->assertEquals($expected, $result); } /** * Tests URL generation with flags and prefixes in and out of context * * @return void */ public function testUrlWritingWithPrefixes() { Router::connect('/company/:controller/:action/*', ['prefix' => 'company']); Router::connect('/:action', ['controller' => 'users']); $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => 'company']); $expected = '/company/users/login'; $this->assertEquals($expected, $result); $request = new ServerRequest([ 'url' => '/', 'params' => [ 'plugin' => null, 'controller' => 'users', 'action' => 'login', 'prefix' => 'company', ], ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => false]); $expected = '/login'; $this->assertEquals($expected, $result); } /** * test url generation with prefixes and custom routes * * @return void */ public function testUrlWritingWithPrefixesAndCustomRoutes() { Router::connect( '/admin/login', ['controller' => 'users', 'action' => 'login', 'prefix' => 'admin'] ); $request = new ServerRequest([ 'url' => '/', 'params' => [ 'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'prefix' => 'admin', ], 'webroot' => '/', ]); Router::setRequestInfo($request); $result = Router::url(['controller' => 'users', 'action' => 'login']); $this->assertEquals('/admin/login', $result); $result = Router::url(['controller' => 'users', 'action' => 'login']); $this->assertEquals('/admin/login', $result); } /** * testPassedArgsOrder method * * @return void */ public function testPassedArgsOrder() { Router::connect('/test-passed/*', ['controller' => 'pages', 'action' => 'display', 'home']); Router::connect('/test2/*', ['controller' => 'pages', 'action' => 'display', 2]); Router::connect('/test/*', ['controller' => 'pages', 'action' => 'display', 1]); $result = Router::url(['controller' => 'pages', 'action' => 'display', 1, 'whatever']); $expected = '/test/whatever'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'pages', 'action' => 'display', 2, 'whatever']); $expected = '/test2/whatever'; $this->assertEquals($expected, $result); $result = Router::url(['controller' => 'pages', 'action' => 'display', 'home', 'whatever']); $expected = '/test-passed/whatever'; $this->assertEquals($expected, $result); } /** * testRegexRouteMatching method * * @return void */ public function testRegexRouteMatching() { Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']); $result = Router::parseRequest($this->makeRequest('/eng/test/test_action', 'GET')); $expected = [ 'pass' => [], 'locale' => 'eng', 'controller' => 'test', 'action' => 'test_action', 'plugin' => null, '_matchedRoute' => '/:locale/:controller/:action/*', ]; $this->assertEquals($expected, $result); } /** * testRegexRouteMatching error * * @group deprecated * @return void */ public function testRegexRouteMatchingError() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); $this->deprecated(function () { Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']); Router::parse('/badness/test/test_action', 'GET'); }); } /** * testRegexRouteMatching method * * @return void */ public function testRegexRouteMatchUrl() { $this->expectException(\Cake\Routing\Exception\MissingRouteException::class); Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']); $request = new ServerRequest([ 'url' => '/test/test_action', 'params' => [ 'plugin' => null, 'controller' => 'test', 'action' => 'index', ], 'webroot' => '/', ]); Router::setRequestInfo($request); $result = Router::url(['action' => 'test_another_action', 'locale' => 'eng']); $expected = '/eng/test/test_another_action'; $this->assertEquals($expected, $result); $result = Router::url(['action' => 'test_another_action']); $expected = '/'; $this->assertEquals($expected, $result); } /** * test using a custom route class for route connection * * @return void */ public function testUsingCustomRouteClass() { $this->loadPlugins(['TestPlugin']); Router::connect( '/:slug', ['plugin' => 'TestPlugin', 'action' => 'index'], ['routeClass' => 'PluginShortRoute', 'slug' => '[a-z_-]+'] ); $result = Router::parseRequest($this->makeRequest('/the-best', 'GET')); $expected = [ 'plugin' => 'TestPlugin', 'controller' => 'TestPlugin', 'action' => 'index', 'slug' => 'the-best', 'pass' => [], '_matchedRoute' => '/:slug', ]; $this->assertEquals($expected, $result); } /** * test using custom route class in PluginDot notation * * @return void */ public function testUsingCustomRouteClassPluginDotSyntax() { $this->loadPlugins(['TestPlugin']); Router::connect( '/:slug', ['controller' => 'posts', 'action' => 'view'], ['routeClass' => 'TestPlugin.TestRoute', 'slug' => '[a-z_-]+'] ); $this->assertTrue(true); // Just to make sure the connect do not throw exception $this->removePlugins(['TestPlugin']); } /** * test that route classes must extend \Cake\Routing\Route\Route * * @return void */ public function testCustomRouteException() { $this->expectException(\InvalidArgumentException::class); Router::connect('/:controller', [], ['routeClass' => 'Object']); } /** * test reversing parameter arrays back into strings. * * Mark the router as initialized so it doesn't auto-load routes * * @return void */ public function testReverseToken() { Router::connect('/:controller/:action/*'); $params = [ 'controller' => 'posts', 'action' => 'view', 'pass' => [1], 'url' => [], 'autoRender' => 1, 'bare' => 1, 'return' => 1, 'requested' => 1, '_Token' => ['key' => 'sekret'], '_csrfToken' => 'foo', 'isAjax' => true, ]; $result = Router::reverse($params); $this->assertEquals('/posts/view/1', $result); } public function testReverseLocalized() { Router::reload(); Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']); $params = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [1], 'url' => ['url' => 'eng/posts/view/1'], ]; $result = Router::reverse($params); $this->assertEquals('/eng/posts/view/1', $result); } public function testReverseArrayQuery() { Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']); $params = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 1, '?' => ['foo' => 'bar'], ]; $result = Router::reverse($params); $this->assertEquals('/eng/posts/view/1?foo=bar', $result); $params = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [1], 'url' => ['url' => 'eng/posts/view/1', 'foo' => 'bar', 'baz' => 'quu'], 'paging' => [], 'models' => [], ]; $result = Router::reverse($params); $this->assertEquals('/eng/posts/view/1?foo=bar&baz=quu', $result); } public function testReverseCakeRequestQuery() { Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']); $request = new ServerRequest([ 'url' => '/eng/posts/view/1', 'params' => [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [1], ], 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'], ]); $result = Router::reverse($request); $expected = '/eng/posts/view/1?test=value'; $this->assertEquals($expected, $result); } public function testReverseFull() { $params = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [1], 'url' => ['url' => 'eng/posts/view/1'], ]; $result = Router::reverse($params, true); $this->assertRegExp('/^http(s)?:\/\//', $result); } /** * Test that extensions work with Router::reverse() * * @return void */ public function testReverseWithExtension() { Router::connect('/:controller/:action/*'); Router::extensions('json', false); $request = new ServerRequest([ 'url' => '/posts/view/1.json', 'params' => [ 'controller' => 'posts', 'action' => 'view', 'pass' => [1], '_ext' => 'json', ], ]); $result = Router::reverse($request); $expected = '/posts/view/1.json'; $this->assertEquals($expected, $result); } public function testReverseToArrayQuery() { Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']); $params = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [123], 'url' => ['url' => 'eng/posts/view/123', 'foo' => 'bar', 'baz' => 'quu'], 'paging' => [], 'models' => [], ]; $actual = Router::reverseToArray($params); $expected = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 123, '?' => ['foo' => 'bar', 'baz' => 'quu'], ]; $this->assertEquals($expected, $actual); } public function testReverseToArrayRequestQuery() { Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']); $request = new ServerRequest([ 'url' => '/eng/posts/view/1', 'params' => [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 'pass' => [123], ], 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'], ]); $actual = Router::reverseToArray($request); $expected = [ 'lang' => 'eng', 'controller' => 'posts', 'action' => 'view', 123, '?' => [ 'test' => 'value', ], ]; $this->assertEquals($expected, $actual); } /** * test that setRequestInfo can accept arrays and turn that into a Request object. * * @group deprecated * @return void */ public function testSetRequestInfoLegacy() { $this->deprecated(function () { Router::setRequestInfo([ [ 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'url' => ['url' => 'protected/images/index'], ], [ 'base' => '', 'here' => '/protected/images/index', 'webroot' => '/', ], ]); $result = Router::getRequest(); $this->assertEquals('images', $result->getParam('controller')); $this->assertEquals('index', $result->getParam('action')); $this->assertEquals('', $result->getAttribute('base')); $this->assertEquals('', $result->base); $this->assertEquals('/protected/images/index', $result->getRequestTarget()); $this->assertEquals('/protected/images/index', $result->here); $this->assertEquals('/', $result->getAttribute('webroot')); $this->assertEquals('/', $result->webroot); }); } /** * test get request. * * @return void */ public function testGetRequest() { $requestA = new ServerRequest('/'); $requestB = new ServerRequest('/posts'); Router::pushRequest($requestA); Router::pushRequest($requestB); $this->assertSame($requestA, Router::getRequest(false)); $this->assertSame($requestB, Router::getRequest(true)); } /** * Test that Router::url() uses the first request */ public function testUrlWithRequestAction() { Router::connect('/:controller', ['action' => 'index']); Router::connect('/:controller/:action'); $firstRequest = new ServerRequest([ 'url' => '/posts/index', 'params' => [ 'plugin' => null, 'controller' => 'posts', 'action' => 'index', ], ]); $secondRequest = new ServerRequest([ 'url' => '/posts/index', 'params' => [ 'requested' => 1, 'plugin' => null, 'controller' => 'comments', 'action' => 'listing', ], ]); Router::setRequestInfo($firstRequest); Router::setRequestInfo($secondRequest); $result = Router::url(['_base' => false]); $this->assertEquals('/comments/listing', $result, 'with second requests, the last should win.'); Router::popRequest(); $result = Router::url(['_base' => false]); $this->assertEquals('/posts', $result, 'with second requests, the last should win.'); // Make sure that popping an empty request doesn't fail. Router::popRequest(); } /** * test that a route object returning a full URL is not modified. * * @return void */ public function testUrlFullUrlReturnFromRoute() { $url = 'http://example.com/posts/view/1'; $route = $this->getMockBuilder('Cake\Routing\Route\Route') ->setMethods(['match']) ->setConstructorArgs(['/:controller/:action/*']) ->getMock(); $route->expects($this->any()) ->method('match') ->will($this->returnValue($url)); Router::connect($route); $result = Router::url(['controller' => 'posts', 'action' => 'view', 1]); $this->assertEquals($url, $result); } /** * test protocol in url * * @return void */ public function testUrlProtocol() { $url = 'http://example.com'; $this->assertEquals($url, Router::url($url)); $url = 'ed2k://example.com'; $this->assertEquals($url, Router::url($url)); $url = 'svn+ssh://example.com'; $this->assertEquals($url, Router::url($url)); $url = '://example.com'; $this->assertEquals($url, Router::url($url)); $url = '//example.com'; $this->assertEquals($url, Router::url($url)); $url = 'javascript:void(0)'; $this->assertEquals($url, Router::url($url)); $url = 'tel:012345-678'; $this->assertEquals($url, Router::url($url)); $url = 'sms:012345-678'; $this->assertEquals($url, Router::url($url)); $url = '#here'; $this->assertEquals($url, Router::url($url)); $url = '?param=0'; $this->assertEquals($url, Router::url($url)); $url = '/posts/index#here'; $expected = Configure::read('App.fullBaseUrl') . '/posts/index#here'; $this->assertEquals($expected, Router::url($url, true)); } /** * Testing that patterns on the :action param work properly. * * @return void */ public function testPatternOnAction() { $route = new Route( '/blog/:action/*', ['controller' => 'blog_posts'], ['action' => 'other|actions'] ); $result = $route->match(['controller' => 'blog_posts', 'action' => 'foo']); $this->assertFalse($result); $result = $route->match(['controller' => 'blog_posts', 'action' => 'actions']); $this->assertEquals('/blog/actions/', $result); $result = $route->parseRequest($this->makeRequest('/blog/other', 'GET')); $expected = [ 'controller' => 'blog_posts', 'action' => 'other', 'pass' => [], '_matchedRoute' => '/blog/:action/*', ]; $this->assertEquals($expected, $result); $result = $route->parseRequest($this->makeRequest('/blog/foobar', 'GET')); $this->assertFalse($result); } /** * Test that redirect() works. * * @group deprecated * @return void */ public function testRedirect() { $this->deprecated(function () { Router::redirect('/mobile', '/', ['status' => 301]); $routes = Router::routes(); $route = $routes[0]; $this->assertInstanceOf('Cake\Routing\Route\RedirectRoute', $route); }); } /** * Test that redirect() works with another route class. * * @group deprecated * @return void */ public function testRedirectWithAnotherRouteClass() { $this->deprecated(function () { $route1 = $this->getMockBuilder('Cake\Routing\Route\RedirectRoute') ->setConstructorArgs(['/mobile\'']) ->setMethods(['parse']) ->getMock(); $class = '\\' . get_class($route1); Router::redirect('/mobile', '/', [ 'status' => 301, 'routeClass' => $class, ]); $routes = Router::routes(); $route = $routes[0]; $this->assertInstanceOf($class, $route); }); } /** * Test that the compatibility method for incoming urls works. * * @group deprecated * @return void */ public function testParseNamedParameters() { $this->deprecated(function () { $request = new ServerRequest(); $request->addParams([ 'controller' => 'posts', 'action' => 'index', ]); $result = Router::parseNamedParams($request); $this->assertSame([], $result->params['named']); $request = new ServerRequest(); $request->addParams([ 'controller' => 'posts', 'action' => 'index', 'pass' => ['home', 'one:two', 'three:four', 'five[nested][0]:six', 'five[nested][1]:seven'], ]); $request = Router::parseNamedParams($request); $expected = [ 'plugin' => null, 'controller' => 'posts', 'action' => 'index', '_ext' => null, 'pass' => ['home'], 'named' => [ 'one' => 'two', 'three' => 'four', 'five' => [ 'nested' => ['six', 'seven'], ], ], ]; $this->assertEquals($expected, $request->params); }); } /** * Test the scope() method * * @return void */ public function testScope() { Router::scope('/path', ['param' => 'value'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/path', $routes->path()); $this->assertEquals(['param' => 'value'], $routes->params()); $this->assertEquals('', $routes->namePrefix()); $routes->connect('/articles', ['controller' => 'Articles']); }); } /** * Test the scope() method * * @return void */ public function testScopeError() { $this->expectException(\InvalidArgumentException::class); Router::scope('/path', 'derpy'); } /** * Test to ensure that extensions defined in scopes don't leak. * And that global extensions are propagated. * * @return void */ public function testScopeExtensionsContained() { Router::extensions(['json']); Router::scope('/', function (RouteBuilder $routes) { $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.'); $routes->setExtensions(['rss']); $this->assertEquals( ['rss'], $routes->getExtensions(), 'Should include new extensions.' ); $routes->connect('/home', []); }); $this->assertEquals(['json', 'rss'], array_values(Router::extensions())); Router::scope('/api', function (RouteBuilder $routes) { $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.'); $routes->setExtensions(['json', 'csv']); $routes->connect('/export', []); $routes->scope('/v1', function (RouteBuilder $routes) { $this->assertEquals(['json', 'csv'], $routes->getExtensions()); }); }); $this->assertEquals(['json', 'rss', 'csv'], array_values(Router::extensions())); } /** * Test the scope() options * * @return void */ public function testScopeOptions() { $options = ['param' => 'value', 'routeClass' => 'InflectedRoute', 'extensions' => ['json']]; Router::scope('/path', $options, function (RouteBuilder $routes) { $this->assertSame('InflectedRoute', $routes->getRouteClass()); $this->assertSame(['json'], $routes->getExtensions()); $this->assertEquals('/path', $routes->path()); $this->assertEquals(['param' => 'value'], $routes->params()); }); } /** * Test the scope() method * * @return void */ public function testScopeNamePrefix() { Router::scope('/path', ['param' => 'value', '_namePrefix' => 'path:'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/path', $routes->path()); $this->assertEquals(['param' => 'value'], $routes->params()); $this->assertEquals('path:', $routes->namePrefix()); $routes->connect('/articles', ['controller' => 'Articles']); }); } /** * Test that prefix() creates a scope. * * @return void */ public function testPrefix() { Router::prefix('admin', function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/admin', $routes->path()); $this->assertEquals(['prefix' => 'admin'], $routes->params()); }); Router::prefix('admin', ['_namePrefix' => 'admin:'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('admin:', $routes->namePrefix()); $this->assertEquals(['prefix' => 'admin'], $routes->params()); }); } /** * Test that prefix() accepts options * * @return void */ public function testPrefixOptions() { Router::prefix('admin', ['param' => 'value'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/admin', $routes->path()); $this->assertEquals(['prefix' => 'admin', 'param' => 'value'], $routes->params()); }); Router::prefix('CustomPath', ['path' => '/custom-path'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/custom-path', $routes->path()); $this->assertEquals(['prefix' => 'custom_path'], $routes->params()); }); } /** * Test that plugin() creates a scope. * * @return void */ public function testPlugin() { Router::plugin('DebugKit', function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/debug_kit', $routes->path()); $this->assertEquals(['plugin' => 'DebugKit'], $routes->params()); }); } /** * Test that plugin() accepts options * * @return void */ public function testPluginOptions() { Router::plugin('DebugKit', ['path' => '/debugger'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('/debugger', $routes->path()); $this->assertEquals(['plugin' => 'DebugKit'], $routes->params()); }); Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function (RouteBuilder $routes) { $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes); $this->assertEquals('contacts:', $routes->namePrefix()); }); } /** * Test setting default route class. * * @return void */ public function testDefaultRouteClass() { Router::connect('/:controller', ['action' => 'index']); $result = Router::url(['controller' => 'FooBar', 'action' => 'index']); $this->assertEquals('/FooBar', $result); // This is needed because tests/boostrap.php sets App.namespace to 'App' static::setAppNamespace(); Router::defaultRouteClass('DashedRoute'); Router::connect('/cake/:controller', ['action' => 'cake']); $result = Router::url(['controller' => 'FooBar', 'action' => 'cake']); $this->assertEquals('/cake/foo-bar', $result); $result = Router::url(['controller' => 'FooBar', 'action' => 'index']); $this->assertEquals('/FooBar', $result); Router::reload(); Router::defaultRouteClass('DashedRoute'); Router::scope('/', function (RouteBuilder $routes) { $routes->fallbacks(); }); $result = Router::url(['controller' => 'FooBar', 'action' => 'index']); $this->assertEquals('/foo-bar', $result); } /** * Test generation of routes with collisions between the query string * and other url params * * @return void */ public function testUrlWithCollidingQueryString() { Router::connect('/:controller/:action/:id'); $query = ['controller' => 'Foo', 'action' => 'bar', 'id' => 100]; $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]); $this->assertEquals('/posts/view/1?controller=Foo&action=bar&id=100', $result); $query = ['_host' => 'foo.bar', '_ssl' => 0, '_scheme' => 'ftp://', '_base' => 'baz', '_port' => '15']; $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]); $this->assertEquals('/posts/view/1?_host=foo.bar&_ssl=0&_scheme=ftp%3A%2F%2F&_base=baz&_port=15', $result); } /** * Test setting the request context. * * @return void */ public function testSetRequestContextCakePHP() { Router::connect('/:controller/:action/*'); $request = new ServerRequest([ 'base' => '/subdir', 'url' => 'articles/view/1', ]); Router::setRequestContext($request); $result = Router::url(['controller' => 'things', 'action' => 'add']); $this->assertEquals('/subdir/things/add', $result); $result = Router::url(['controller' => 'things', 'action' => 'add'], true); $this->assertEquals('http://localhost/subdir/things/add', $result); $result = Router::url('/pages/home'); $this->assertEquals('/subdir/pages/home', $result); } /** * Test setting the request context. * * @return void */ public function testSetRequestContextPsr() { $server = [ 'DOCUMENT_ROOT' => '/Users/markstory/Sites', 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php', 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1', 'REQUEST_URI' => '/subdir/articles/view/1', 'QUERY_STRING' => '', 'SERVER_PORT' => 80, ]; Router::connect('/:controller/:action/*'); $request = ServerRequestFactory::fromGlobals($server); Router::setRequestContext($request); $result = Router::url(['controller' => 'things', 'action' => 'add']); $this->assertEquals('/subdir/things/add', $result); $result = Router::url(['controller' => 'things', 'action' => 'add'], true); $this->assertEquals('http://localhost/subdir/things/add', $result); $result = Router::url('/pages/home'); $this->assertEquals('/subdir/pages/home', $result); } /** * Test getting the route collection * * @return void */ public function testGetRouteCollection() { $collection = Router::getRouteCollection(); $this->assertInstanceOf(RouteCollection::class, $collection); $this->assertCount(0, $collection->routes()); } /** * Test getting a route builder instance. * * @return void */ public function testCreateRouteBuilder() { $builder = Router::createRouteBuilder('/api'); $this->assertInstanceOf(RouteBuilder::class, $builder); $this->assertSame('/api', $builder->path()); $builder = Router::createRouteBuilder('/', [ 'routeClass' => 'InflectedRoute', 'extensions' => ['json'], ]); $this->assertInstanceOf(RouteBuilder::class, $builder); $this->assertSame(['json'], $builder->getExtensions()); } /** * test connect() with short string syntax * * @return void */ public function testConnectShortStringSyntax() { Router::connect('/admin/articles/view', 'Admin/Articles::view'); $result = Router::parseRequest($this->makeRequest('/admin/articles/view', 'GET')); $expected = [ 'pass' => [], 'prefix' => 'admin', 'controller' => 'Articles', 'action' => 'view', 'plugin' => null, '_matchedRoute' => '/admin/articles/view', ]; $this->assertEquals($result, $expected); } /** * Connect some fallback routes for testing router behavior. * * @return void */ protected function _connectDefaultRoutes() { Router::scope('/', function (RouteBuilder $routes) { $routes->fallbacks('InflectedRoute'); }); } /** * Helper to create a request for a given URL and method. * * @param string $url The URL to create a request for * @param string $method The HTTP method to use. * @return \Cake\Http\ServerRequest */ protected function makeRequest($url, $method) { $request = new ServerRequest([ 'url' => $url, 'environment' => ['REQUEST_METHOD' => $method], ]); return $request; } }