RouterTest.php 112 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 1.2.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Test\TestCase\Routing;
  16. use Cake\Core\Configure;
  17. use Cake\Core\Plugin;
  18. use Cake\Http\ServerRequest;
  19. use Cake\Http\ServerRequestFactory;
  20. use Cake\Routing\RouteBuilder;
  21. use Cake\Routing\RouteCollection;
  22. use Cake\Routing\Router;
  23. use Cake\Routing\Route\Route;
  24. use Cake\TestSuite\TestCase;
  25. /**
  26. * RouterTest class
  27. */
  28. class RouterTest extends TestCase
  29. {
  30. /**
  31. * setUp method
  32. *
  33. * @return void
  34. */
  35. public function setUp()
  36. {
  37. parent::setUp();
  38. Configure::write('Routing', ['admin' => null, 'prefixes' => []]);
  39. Router::fullBaseUrl('');
  40. Configure::write('App.fullBaseUrl', 'http://localhost');
  41. }
  42. /**
  43. * tearDown method
  44. *
  45. * @return void
  46. */
  47. public function tearDown()
  48. {
  49. parent::tearDown();
  50. Plugin::unload();
  51. Router::reload();
  52. Router::defaultRouteClass('Cake\Routing\Route\Route');
  53. }
  54. /**
  55. * testFullBaseUrl method
  56. *
  57. * @return void
  58. */
  59. public function testbaseUrl()
  60. {
  61. $this->assertRegExp('/^http(s)?:\/\//', Router::url('/', true));
  62. $this->assertRegExp('/^http(s)?:\/\//', Router::url(null, true));
  63. $this->assertRegExp('/^http(s)?:\/\//', Router::url(['_full' => true]));
  64. }
  65. /**
  66. * Tests that the base URL can be changed at runtime.
  67. *
  68. * @return void
  69. */
  70. public function testfullBaseURL()
  71. {
  72. Router::fullBaseUrl('http://example.com');
  73. $this->assertEquals('http://example.com/', Router::url('/', true));
  74. $this->assertEquals('http://example.com', Configure::read('App.fullBaseUrl'));
  75. Router::fullBaseUrl('https://example.com');
  76. $this->assertEquals('https://example.com/', Router::url('/', true));
  77. $this->assertEquals('https://example.com', Configure::read('App.fullBaseUrl'));
  78. }
  79. /**
  80. * Test that Router uses App.base to build URL's when there are no stored
  81. * request objects.
  82. *
  83. * @return void
  84. */
  85. public function testBaseUrlWithBasePath()
  86. {
  87. Configure::write('App.base', '/cakephp');
  88. Router::fullBaseUrl('http://example.com');
  89. $this->assertEquals('http://example.com/cakephp/tasks', Router::url('/tasks', true));
  90. }
  91. /**
  92. * Test that Router uses the correct url including base path for requesting the current actions.
  93. *
  94. * @return void
  95. */
  96. public function testCurrentUrlWithBasePath()
  97. {
  98. Router::fullBaseUrl('http://example.com');
  99. $request = new ServerRequest();
  100. $request->addParams([
  101. 'action' => 'view',
  102. 'plugin' => null,
  103. 'controller' => 'pages',
  104. 'pass' => ['1']
  105. ]);
  106. $request->base = '/cakephp';
  107. $request->here = '/cakephp/pages/view/1';
  108. Router::setRequestInfo($request);
  109. $this->assertEquals('http://example.com/cakephp/pages/view/1', Router::url(null, true));
  110. $this->assertEquals('/cakephp/pages/view/1', Router::url());
  111. }
  112. /**
  113. * testRouteDefaultParams method
  114. *
  115. * @return void
  116. */
  117. public function testRouteDefaultParams()
  118. {
  119. Router::connect('/:controller', ['controller' => 'posts']);
  120. $this->assertEquals(Router::url(['action' => 'index']), '/');
  121. }
  122. /**
  123. * testMapResources method
  124. *
  125. * @group deprecated
  126. * @return void
  127. */
  128. public function testMapResources()
  129. {
  130. $this->deprecated(function () {
  131. Router::mapResources('Posts');
  132. $expected = [
  133. 'pass' => [],
  134. 'plugin' => null,
  135. 'controller' => 'Posts',
  136. 'action' => 'index',
  137. '_method' => 'GET',
  138. '_matchedRoute' => '/posts',
  139. ];
  140. $result = Router::parse('/posts', 'GET');
  141. $this->assertEquals($expected, $result);
  142. $expected = [
  143. 'pass' => ['13'],
  144. 'plugin' => null,
  145. 'controller' => 'Posts',
  146. 'action' => 'view',
  147. 'id' => '13',
  148. '_method' => 'GET',
  149. '_matchedRoute' => '/posts/:id',
  150. ];
  151. $result = Router::parse('/posts/13', 'GET');
  152. $this->assertEquals($expected, $result);
  153. $expected = [
  154. 'pass' => [],
  155. 'plugin' => null,
  156. 'controller' => 'Posts',
  157. 'action' => 'add',
  158. '_method' => 'POST',
  159. '_matchedRoute' => '/posts',
  160. ];
  161. $result = Router::parse('/posts', 'POST');
  162. $this->assertEquals($expected, $result);
  163. $expected = [
  164. 'pass' => ['13'],
  165. 'plugin' => null,
  166. 'controller' => 'Posts',
  167. 'action' => 'edit',
  168. 'id' => '13',
  169. '_method' => ['PUT', 'PATCH'],
  170. '_matchedRoute' => '/posts/:id',
  171. ];
  172. $result = Router::parse('/posts/13', 'PUT');
  173. $this->assertEquals($expected, $result);
  174. $expected = [
  175. 'pass' => ['475acc39-a328-44d3-95fb-015000000000'],
  176. 'plugin' => null,
  177. 'controller' => 'Posts',
  178. 'action' => 'edit',
  179. 'id' => '475acc39-a328-44d3-95fb-015000000000',
  180. '_method' => ['PUT', 'PATCH'],
  181. '_matchedRoute' => '/posts/:id',
  182. ];
  183. $result = Router::parse('/posts/475acc39-a328-44d3-95fb-015000000000', 'PUT');
  184. $this->assertEquals($expected, $result);
  185. $expected = [
  186. 'pass' => ['13'],
  187. 'plugin' => null,
  188. 'controller' => 'Posts',
  189. 'action' => 'delete',
  190. 'id' => '13',
  191. '_method' => 'DELETE',
  192. '_matchedRoute' => '/posts/:id',
  193. ];
  194. $result = Router::parse('/posts/13', 'DELETE');
  195. $this->assertEquals($expected, $result);
  196. Router::reload();
  197. Router::mapResources('Posts', ['id' => '[a-z0-9_]+']);
  198. $expected = [
  199. 'pass' => ['add'],
  200. 'plugin' => null,
  201. 'controller' => 'Posts',
  202. 'action' => 'view',
  203. 'id' => 'add',
  204. '_method' => 'GET',
  205. '_matchedRoute' => '/posts/:id',
  206. ];
  207. $result = Router::parse('/posts/add', 'GET');
  208. $this->assertEquals($expected, $result);
  209. $expected = [
  210. 'pass' => ['name'],
  211. 'plugin' => null,
  212. 'controller' => 'Posts',
  213. 'action' => 'edit',
  214. 'id' => 'name',
  215. '_method' => ['PUT', 'PATCH'],
  216. '_matchedRoute' => '/posts/:id',
  217. ];
  218. $result = Router::parse('/posts/name', 'PUT');
  219. $this->assertEquals($expected, $result);
  220. });
  221. }
  222. /**
  223. * testMapResources with plugin controllers.
  224. *
  225. * @group deprecated
  226. * @return void
  227. */
  228. public function testPluginMapResources()
  229. {
  230. $this->deprecated(function () {
  231. Router::mapResources('TestPlugin.TestPlugin');
  232. $result = Router::parse('/test_plugin/test_plugin', 'GET');
  233. $expected = [
  234. 'pass' => [],
  235. 'plugin' => 'TestPlugin',
  236. 'controller' => 'TestPlugin',
  237. 'action' => 'index',
  238. '_method' => 'GET',
  239. '_matchedRoute' => '/test_plugin/test_plugin',
  240. ];
  241. $this->assertEquals($expected, $result);
  242. $result = Router::parse('/test_plugin/test_plugin/13', 'GET');
  243. $expected = [
  244. 'pass' => ['13'],
  245. 'plugin' => 'TestPlugin',
  246. 'controller' => 'TestPlugin',
  247. 'action' => 'view',
  248. 'id' => '13',
  249. '_method' => 'GET',
  250. '_matchedRoute' => '/test_plugin/test_plugin/:id',
  251. ];
  252. $this->assertEquals($expected, $result);
  253. });
  254. }
  255. /**
  256. * Test mapResources with a prefix.
  257. *
  258. * @group deprecated
  259. * @return void
  260. */
  261. public function testMapResourcesWithPrefix()
  262. {
  263. $this->deprecated(function () {
  264. Router::mapResources('Posts', ['prefix' => 'api']);
  265. $result = Router::parse('/api/posts', 'GET');
  266. $expected = [
  267. 'plugin' => null,
  268. 'controller' => 'Posts',
  269. 'action' => 'index',
  270. 'pass' => [],
  271. 'prefix' => 'api',
  272. '_method' => 'GET',
  273. '_matchedRoute' => '/api/posts',
  274. ];
  275. $this->assertEquals($expected, $result);
  276. });
  277. }
  278. /**
  279. * Test mapResources with a default extension.
  280. *
  281. * @group deprecated
  282. * @return void
  283. */
  284. public function testMapResourcesWithExtension()
  285. {
  286. $this->deprecated(function () {
  287. Router::extensions(['json', 'xml'], false);
  288. Router::mapResources('Posts', ['_ext' => 'json']);
  289. $expected = [
  290. 'plugin' => null,
  291. 'controller' => 'Posts',
  292. 'action' => 'index',
  293. 'pass' => [],
  294. '_method' => 'GET',
  295. '_matchedRoute' => '/posts',
  296. ];
  297. $result = Router::parse('/posts', 'GET');
  298. $this->assertEquals($expected, $result);
  299. $result = Router::parse('/posts.json', 'GET');
  300. $expected['_ext'] = 'json';
  301. $this->assertEquals($expected, $result);
  302. $result = Router::parse('/posts.xml', 'GET');
  303. $this->assertArrayNotHasKey('_method', $result, 'Not an extension/resource route.');
  304. });
  305. }
  306. /**
  307. * testMapResources with custom connectOptions
  308. *
  309. * @group deprecated
  310. */
  311. public function testMapResourcesConnectOptions()
  312. {
  313. $this->deprecated(function () {
  314. Plugin::load('TestPlugin');
  315. Router::mapResources('Posts', [
  316. 'connectOptions' => [
  317. 'routeClass' => 'TestPlugin.TestRoute',
  318. 'foo' => '^(bar)$',
  319. ],
  320. ]);
  321. $routes = Router::routes();
  322. $route = $routes[0];
  323. $this->assertInstanceOf('TestPlugin\Routing\Route\TestRoute', $route);
  324. $this->assertEquals('^(bar)$', $route->options['foo']);
  325. });
  326. }
  327. /**
  328. * Test mapResources with a plugin and prefix.
  329. *
  330. * @group deprecated
  331. * @return void
  332. */
  333. public function testPluginMapResourcesWithPrefix()
  334. {
  335. $this->deprecated(function () {
  336. Router::mapResources('TestPlugin.TestPlugin', ['prefix' => 'api']);
  337. $result = Router::parse('/api/test_plugin/test_plugin', 'GET');
  338. $expected = [
  339. 'pass' => [],
  340. 'plugin' => 'TestPlugin',
  341. 'controller' => 'TestPlugin',
  342. 'prefix' => 'api',
  343. 'action' => 'index',
  344. '_method' => 'GET',
  345. '_matchedRoute' => '/api/test_plugin/test_plugin',
  346. ];
  347. $this->assertEquals($expected, $result);
  348. $resources = Router::mapResources('Posts', ['prefix' => 'api']);
  349. $result = Router::parse('/api/posts', 'GET');
  350. $expected = [
  351. 'pass' => [],
  352. 'plugin' => null,
  353. 'controller' => 'Posts',
  354. 'action' => 'index',
  355. '_method' => 'GET',
  356. 'prefix' => 'api',
  357. '_matchedRoute' => '/api/posts',
  358. ];
  359. $this->assertEquals($expected, $result);
  360. });
  361. }
  362. /**
  363. * testMultipleResourceRoute method
  364. *
  365. * @return void
  366. */
  367. public function testMultipleResourceRoute()
  368. {
  369. Router::connect('/:controller', ['action' => 'index', '_method' => ['GET', 'POST']]);
  370. $result = Router::parseRequest($this->makeRequest('/posts', 'GET'));
  371. $expected = [
  372. 'pass' => [],
  373. 'plugin' => null,
  374. 'controller' => 'posts',
  375. 'action' => 'index',
  376. '_method' => ['GET', 'POST'],
  377. '_matchedRoute' => '/:controller',
  378. ];
  379. $this->assertEquals($expected, $result);
  380. $result = Router::parseRequest($this->makeRequest('/posts', 'POST'));
  381. $expected = [
  382. 'pass' => [],
  383. 'plugin' => null,
  384. 'controller' => 'posts',
  385. 'action' => 'index',
  386. '_method' => ['GET', 'POST'],
  387. '_matchedRoute' => '/:controller',
  388. ];
  389. $this->assertEquals($expected, $result);
  390. }
  391. /**
  392. * testGenerateUrlResourceRoute method
  393. *
  394. * @group deprecated
  395. * @return void
  396. */
  397. public function testGenerateUrlResourceRoute()
  398. {
  399. $this->deprecated(function () {
  400. Router::mapResources('Posts');
  401. $result = Router::url([
  402. 'controller' => 'Posts',
  403. 'action' => 'index',
  404. '_method' => 'GET'
  405. ]);
  406. $expected = '/posts';
  407. $this->assertEquals($expected, $result);
  408. $result = Router::url([
  409. 'controller' => 'Posts',
  410. 'action' => 'view',
  411. '_method' => 'GET',
  412. 'id' => 10
  413. ]);
  414. $expected = '/posts/10';
  415. $this->assertEquals($expected, $result);
  416. $result = Router::url(['controller' => 'Posts', 'action' => 'add', '_method' => 'POST']);
  417. $expected = '/posts';
  418. $this->assertEquals($expected, $result);
  419. $result = Router::url(['controller' => 'Posts', 'action' => 'edit', '_method' => 'PUT', 'id' => 10]);
  420. $expected = '/posts/10';
  421. $this->assertEquals($expected, $result);
  422. $result = Router::url(['controller' => 'Posts', 'action' => 'delete', '_method' => 'DELETE', 'id' => 10]);
  423. $expected = '/posts/10';
  424. $this->assertEquals($expected, $result);
  425. $result = Router::url(['controller' => 'Posts', 'action' => 'edit', '_method' => 'PATCH', 'id' => 10]);
  426. $expected = '/posts/10';
  427. $this->assertEquals($expected, $result);
  428. });
  429. }
  430. /**
  431. * testUrlNormalization method
  432. *
  433. * @return void
  434. */
  435. public function testUrlNormalization()
  436. {
  437. Router::connect('/:controller/:action');
  438. $expected = '/users/logout';
  439. $result = Router::normalize('/users/logout/');
  440. $this->assertEquals($expected, $result);
  441. $result = Router::normalize('//users//logout//');
  442. $this->assertEquals($expected, $result);
  443. $result = Router::normalize('users/logout');
  444. $this->assertEquals($expected, $result);
  445. $result = Router::normalize(['controller' => 'users', 'action' => 'logout']);
  446. $this->assertEquals($expected, $result);
  447. $result = Router::normalize('/');
  448. $this->assertEquals('/', $result);
  449. $result = Router::normalize('http://google.com/');
  450. $this->assertEquals('http://google.com/', $result);
  451. $result = Router::normalize('http://google.com//');
  452. $this->assertEquals('http://google.com//', $result);
  453. $result = Router::normalize('/users/login/scope://foo');
  454. $this->assertEquals('/users/login/scope:/foo', $result);
  455. $result = Router::normalize('/recipe/recipes/add');
  456. $this->assertEquals('/recipe/recipes/add', $result);
  457. $request = new ServerRequest();
  458. $request->base = '/us';
  459. Router::setRequestInfo($request);
  460. $result = Router::normalize('/us/users/logout/');
  461. $this->assertEquals('/users/logout', $result);
  462. Router::reload();
  463. $request = new ServerRequest();
  464. $request->base = '/cake_12';
  465. Router::setRequestInfo($request);
  466. $result = Router::normalize('/cake_12/users/logout/');
  467. $this->assertEquals('/users/logout', $result);
  468. Router::reload();
  469. $_back = Configure::read('App.fullBaseUrl');
  470. Configure::write('App.fullBaseUrl', '/');
  471. $request = new ServerRequest();
  472. $request->base = '/';
  473. Router::setRequestInfo($request);
  474. $result = Router::normalize('users/login');
  475. $this->assertEquals('/users/login', $result);
  476. Configure::write('App.fullBaseUrl', $_back);
  477. Router::reload();
  478. $request = new ServerRequest();
  479. $request->base = 'beer';
  480. Router::setRequestInfo($request);
  481. $result = Router::normalize('beer/admin/beers_tags/add');
  482. $this->assertEquals('/admin/beers_tags/add', $result);
  483. $result = Router::normalize('/admin/beers_tags/add');
  484. $this->assertEquals('/admin/beers_tags/add', $result);
  485. }
  486. /**
  487. * Test generating urls with base paths.
  488. *
  489. * @return void
  490. */
  491. public function testUrlGenerationWithBasePath()
  492. {
  493. Router::connect('/:controller/:action/*');
  494. $request = new ServerRequest();
  495. $request->addParams([
  496. 'action' => 'index',
  497. 'plugin' => null,
  498. 'controller' => 'subscribe',
  499. ]);
  500. $request->base = '/magazine';
  501. $request->here = '/magazine/';
  502. $request->webroot = '/magazine/';
  503. Router::pushRequest($request);
  504. $result = Router::url();
  505. $this->assertEquals('/magazine/', $result);
  506. $result = Router::url('/');
  507. $this->assertEquals('/magazine/', $result);
  508. $result = Router::url('/articles/');
  509. $this->assertEquals('/magazine/articles/', $result);
  510. $result = Router::url('/articles/view');
  511. $this->assertEquals('/magazine/articles/view', $result);
  512. $result = Router::url(['controller' => 'articles', 'action' => 'view', 1]);
  513. $this->assertEquals('/magazine/articles/view/1', $result);
  514. }
  515. /**
  516. * Test url() with _host option routes with request context
  517. *
  518. * @return void
  519. */
  520. public function testUrlGenerationHostOptionRequestContext()
  521. {
  522. $server = [
  523. 'HTTP_HOST' => 'foo.example.com',
  524. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  525. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  526. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  527. 'REQUEST_URI' => '/subdir/articles/view/1',
  528. 'QUERY_STRING' => '',
  529. 'SERVER_PORT' => 80,
  530. ];
  531. Router::connect('/fallback', ['controller' => 'Articles'], ['_host' => '*.example.com']);
  532. $request = ServerRequestFactory::fromGlobals($server);
  533. Router::setRequestContext($request);
  534. $result = Router::url(['controller' => 'Articles', 'action' => 'index']);
  535. $this->assertEquals('http://foo.example.com/subdir/fallback', $result);
  536. $result = Router::url(['controller' => 'Articles', 'action' => 'index'], true);
  537. $this->assertEquals('http://foo.example.com/subdir/fallback', $result);
  538. }
  539. /**
  540. * Test that catch all routes work with a variety of falsey inputs.
  541. *
  542. * @return void
  543. */
  544. public function testUrlCatchAllRoute()
  545. {
  546. Router::connect('/*', ['controller' => 'categories', 'action' => 'index']);
  547. $result = Router::url(['controller' => 'categories', 'action' => 'index', '0']);
  548. $this->assertEquals('/0', $result);
  549. $expected = [
  550. 'plugin' => null,
  551. 'controller' => 'categories',
  552. 'action' => 'index',
  553. 'pass' => ['0'],
  554. '_matchedRoute' => '/*',
  555. ];
  556. $result = Router::parseRequest($this->makeRequest('/0', 'GET'));
  557. $this->assertEquals($expected, $result);
  558. $result = Router::parseRequest($this->makeRequest('0', 'GET'));
  559. $this->assertEquals($expected, $result);
  560. }
  561. /**
  562. * test generation of basic urls.
  563. *
  564. * @return void
  565. */
  566. public function testUrlGenerationBasic()
  567. {
  568. extract(Router::getNamedExpressions());
  569. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  570. $out = Router::url(['controller' => 'pages', 'action' => 'display', 'home']);
  571. $this->assertEquals('/', $out);
  572. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  573. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'about']);
  574. $expected = '/pages/about';
  575. $this->assertEquals($expected, $result);
  576. Router::reload();
  577. Router::connect('/:plugin/:id/*', ['controller' => 'posts', 'action' => 'view'], ['id' => $ID]);
  578. $result = Router::url([
  579. 'plugin' => 'cake_plugin',
  580. 'controller' => 'posts',
  581. 'action' => 'view',
  582. 'id' => '1'
  583. ]);
  584. $expected = '/cake_plugin/1';
  585. $this->assertEquals($expected, $result);
  586. $result = Router::url([
  587. 'plugin' => 'cake_plugin',
  588. 'controller' => 'posts',
  589. 'action' => 'view',
  590. 'id' => '1',
  591. '0'
  592. ]);
  593. $expected = '/cake_plugin/1/0';
  594. $this->assertEquals($expected, $result);
  595. Router::reload();
  596. Router::connect('/:controller/:action/:id', [], ['id' => $ID]);
  597. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']);
  598. $expected = '/posts/view/1';
  599. $this->assertEquals($expected, $result);
  600. Router::reload();
  601. Router::connect('/:controller/:id', ['action' => 'view']);
  602. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']);
  603. $expected = '/posts/1';
  604. $this->assertEquals($expected, $result);
  605. Router::connect('/view/*', ['controller' => 'posts', 'action' => 'view']);
  606. $result = Router::url(['controller' => 'posts', 'action' => 'view', '1']);
  607. $expected = '/view/1';
  608. $this->assertEquals($expected, $result);
  609. Router::reload();
  610. Router::connect('/:controller/:action');
  611. $request = new ServerRequest();
  612. $request->addParams([
  613. 'action' => 'index',
  614. 'plugin' => null,
  615. 'controller' => 'users',
  616. ]);
  617. $request->base = '/';
  618. $request->here = '/';
  619. $request->webroot = '/';
  620. Router::setRequestInfo($request);
  621. $result = Router::url(['action' => 'login']);
  622. $expected = '/users/login';
  623. $this->assertEquals($expected, $result);
  624. Router::reload();
  625. Router::connect('/contact/:action', ['plugin' => 'contact', 'controller' => 'contact']);
  626. $result = Router::url([
  627. 'plugin' => 'contact',
  628. 'controller' => 'contact',
  629. 'action' => 'me'
  630. ]);
  631. $expected = '/contact/me';
  632. $this->assertEquals($expected, $result);
  633. Router::reload();
  634. Router::connect('/:controller', ['action' => 'index']);
  635. $request = new ServerRequest();
  636. $request->addParams([
  637. 'action' => 'index',
  638. 'plugin' => 'myplugin',
  639. 'controller' => 'mycontroller',
  640. ]);
  641. $request->base = '/';
  642. $request->here = '/';
  643. $request->webroot = '/';
  644. Router::setRequestInfo($request);
  645. $result = Router::url(['plugin' => null, 'controller' => 'myothercontroller']);
  646. $expected = '/myothercontroller';
  647. $this->assertEquals($expected, $result);
  648. }
  649. /**
  650. * Test that generated names for routes are case-insensitive.
  651. *
  652. * @return void
  653. */
  654. public function testRouteNameCasing()
  655. {
  656. Router::connect('/articles/:id', ['controller' => 'Articles', 'action' => 'view']);
  657. Router::connect('/:controller/:action/*', [], ['routeClass' => 'InflectedRoute']);
  658. $result = Router::url(['controller' => 'Articles', 'action' => 'view', 'id' => 10]);
  659. $expected = '/articles/10';
  660. $this->assertEquals($expected, $result);
  661. }
  662. /**
  663. * Test generation of routes with query string parameters.
  664. *
  665. * @return void
  666. */
  667. public function testUrlGenerationWithQueryStrings()
  668. {
  669. Router::connect('/:controller/:action/*');
  670. $result = Router::url([
  671. 'controller' => 'posts',
  672. '0',
  673. '?' => ['var' => 'test', 'var2' => 'test2']
  674. ]);
  675. $expected = '/posts/index/0?var=test&var2=test2';
  676. $this->assertEquals($expected, $result);
  677. $result = Router::url(['controller' => 'posts', '0', '?' => ['var' => null]]);
  678. $this->assertEquals('/posts/index/0', $result);
  679. $result = Router::url([
  680. 'controller' => 'posts',
  681. '0',
  682. '?' => [
  683. 'var' => 'test',
  684. 'var2' => 'test2'
  685. ],
  686. '#' => 'unencoded string %'
  687. ]);
  688. $expected = '/posts/index/0?var=test&var2=test2#unencoded string %';
  689. $this->assertEquals($expected, $result);
  690. }
  691. /**
  692. * test that regex validation of keyed route params is working.
  693. *
  694. * @return void
  695. */
  696. public function testUrlGenerationWithRegexQualifiedParams()
  697. {
  698. Router::connect(
  699. ':language/galleries',
  700. ['controller' => 'galleries', 'action' => 'index'],
  701. ['language' => '[a-z]{3}']
  702. );
  703. Router::connect(
  704. '/:language/:admin/:controller/:action/*',
  705. ['admin' => 'admin'],
  706. ['language' => '[a-z]{3}', 'admin' => 'admin']
  707. );
  708. Router::connect(
  709. '/:language/:controller/:action/*',
  710. [],
  711. ['language' => '[a-z]{3}']
  712. );
  713. $result = Router::url(['admin' => false, 'language' => 'dan', 'action' => 'index', 'controller' => 'galleries']);
  714. $expected = '/dan/galleries';
  715. $this->assertEquals($expected, $result);
  716. $result = Router::url(['admin' => false, 'language' => 'eng', 'action' => 'index', 'controller' => 'galleries']);
  717. $expected = '/eng/galleries';
  718. $this->assertEquals($expected, $result);
  719. Router::reload();
  720. Router::connect(
  721. '/:language/pages',
  722. ['controller' => 'pages', 'action' => 'index'],
  723. ['language' => '[a-z]{3}']
  724. );
  725. Router::connect('/:language/:controller/:action/*', [], ['language' => '[a-z]{3}']);
  726. $result = Router::url(['language' => 'eng', 'action' => 'index', 'controller' => 'pages']);
  727. $expected = '/eng/pages';
  728. $this->assertEquals($expected, $result);
  729. $result = Router::url(['language' => 'eng', 'controller' => 'pages']);
  730. $this->assertEquals($expected, $result);
  731. $result = Router::url(['language' => 'eng', 'controller' => 'pages', 'action' => 'add']);
  732. $expected = '/eng/pages/add';
  733. $this->assertEquals($expected, $result);
  734. Router::reload();
  735. Router::connect(
  736. '/forestillinger/:month/:year/*',
  737. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  738. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  739. );
  740. $result = Router::url([
  741. 'plugin' => 'shows',
  742. 'controller' => 'shows',
  743. 'action' => 'calendar',
  744. 'month' => 10,
  745. 'year' => 2007,
  746. 'min-forestilling'
  747. ]);
  748. $expected = '/forestillinger/10/2007/min-forestilling';
  749. $this->assertEquals($expected, $result);
  750. Router::reload();
  751. Router::connect(
  752. '/kalender/:month/:year/*',
  753. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  754. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  755. );
  756. Router::connect('/kalender/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar']);
  757. $result = Router::url(['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'min-forestilling']);
  758. $expected = '/kalender/min-forestilling';
  759. $this->assertEquals($expected, $result);
  760. $result = Router::url([
  761. 'plugin' => 'shows',
  762. 'controller' => 'shows',
  763. 'action' => 'calendar',
  764. 'year' => 2007,
  765. 'month' => 10,
  766. 'min-forestilling'
  767. ]);
  768. $expected = '/kalender/10/2007/min-forestilling';
  769. $this->assertEquals($expected, $result);
  770. }
  771. /**
  772. * Test URL generation with an admin prefix
  773. *
  774. * @return void
  775. */
  776. public function testUrlGenerationWithPrefix()
  777. {
  778. Router::reload();
  779. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  780. Router::connect('/reset/*', ['admin' => true, 'controller' => 'users', 'action' => 'reset']);
  781. Router::connect('/tests', ['controller' => 'tests', 'action' => 'index']);
  782. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  783. Router::extensions('rss', false);
  784. $request = new ServerRequest();
  785. $request->addParams([
  786. 'controller' => 'registrations',
  787. 'action' => 'admin_index',
  788. 'plugin' => null,
  789. 'prefix' => 'admin',
  790. '_ext' => 'html'
  791. ]);
  792. $request->base = '';
  793. $request->here = '/admin/registrations/index';
  794. $request->webroot = '/';
  795. Router::setRequestInfo($request);
  796. $result = Router::url([]);
  797. $expected = '/admin/registrations/index';
  798. $this->assertEquals($expected, $result);
  799. Router::reload();
  800. Router::connect('/admin/subscriptions/:action/*', ['controller' => 'subscribe', 'prefix' => 'admin']);
  801. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  802. $request = new ServerRequest();
  803. $request->addParams([
  804. 'action' => 'index',
  805. 'plugin' => null,
  806. 'controller' => 'subscribe',
  807. 'prefix' => 'admin',
  808. ]);
  809. $request->base = '/magazine';
  810. $request->here = '/magazine/admin/subscriptions/edit/1';
  811. $request->webroot = '/magazine/';
  812. Router::setRequestInfo($request);
  813. $result = Router::url(['action' => 'edit', 1]);
  814. $expected = '/magazine/admin/subscriptions/edit/1';
  815. $this->assertEquals($expected, $result);
  816. $result = Router::url(['prefix' => 'admin', 'controller' => 'users', 'action' => 'login']);
  817. $expected = '/magazine/admin/users/login';
  818. $this->assertEquals($expected, $result);
  819. Router::reload();
  820. $request = new ServerRequest();
  821. $request->addParams([
  822. 'prefix' => 'admin',
  823. 'action' => 'index',
  824. 'plugin' => null,
  825. 'controller' => 'users',
  826. ]);
  827. $request->base = '/';
  828. $request->here = '/';
  829. $request->webroot = '/';
  830. Router::setRequestInfo($request);
  831. Router::connect('/page/*', ['controller' => 'pages', 'action' => 'view', 'prefix' => 'admin']);
  832. $result = Router::url(['prefix' => 'admin', 'controller' => 'pages', 'action' => 'view', 'my-page']);
  833. $expected = '/page/my-page';
  834. $this->assertEquals($expected, $result);
  835. Router::reload();
  836. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  837. $request = new ServerRequest();
  838. $request->addParams([
  839. 'plugin' => null,
  840. 'controller' => 'pages',
  841. 'action' => 'add',
  842. 'prefix' => 'admin'
  843. ]);
  844. $request->base = '';
  845. $request->here = '/admin/pages/add';
  846. $request->webroot = '/';
  847. Router::setRequestInfo($request);
  848. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  849. $expected = '/admin/pages/add';
  850. $this->assertEquals($expected, $result);
  851. Router::reload();
  852. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  853. $request = new ServerRequest();
  854. $request->addParams([
  855. 'plugin' => null,
  856. 'controller' => 'pages',
  857. 'action' => 'add',
  858. 'prefix' => 'admin'
  859. ]);
  860. $request->base = '';
  861. $request->here = '/admin/pages/add';
  862. $request->webroot = '/';
  863. Router::setRequestInfo($request);
  864. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  865. $expected = '/admin/pages/add';
  866. $this->assertEquals($expected, $result);
  867. Router::reload();
  868. Router::connect('/admin/:controller/:action/:id', ['prefix' => 'admin'], ['id' => '[0-9]+']);
  869. $request = new ServerRequest();
  870. Router::setRequestInfo(
  871. $request->addParams([
  872. 'plugin' => null,
  873. 'controller' => 'pages',
  874. 'action' => 'edit',
  875. 'pass' => ['284'],
  876. 'prefix' => 'admin'
  877. ])->addPaths([
  878. 'base' => '',
  879. 'here' => '/admin/pages/edit/284',
  880. 'webroot' => '/'
  881. ])
  882. );
  883. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'id' => '284']);
  884. $expected = '/admin/pages/edit/284';
  885. $this->assertEquals($expected, $result);
  886. Router::reload();
  887. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  888. $request = new ServerRequest();
  889. Router::setRequestInfo(
  890. $request->addParams([
  891. 'plugin' => null, 'controller' => 'pages', 'action' => 'add', 'prefix' => 'admin',
  892. ])->addPaths([
  893. 'base' => '', 'here' => '/admin/pages/add', 'webroot' => '/'
  894. ])
  895. );
  896. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  897. $expected = '/admin/pages/add';
  898. $this->assertEquals($expected, $result);
  899. Router::reload();
  900. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  901. $request = new ServerRequest();
  902. Router::setRequestInfo(
  903. $request->addParams([
  904. 'plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'prefix' => 'admin',
  905. 'pass' => ['284']
  906. ])->addPaths([
  907. 'base' => '', 'here' => '/admin/pages/edit/284', 'webroot' => '/'
  908. ])
  909. );
  910. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 284]);
  911. $expected = '/admin/pages/edit/284';
  912. $this->assertEquals($expected, $result);
  913. Router::reload();
  914. Router::connect('/admin/posts/*', ['controller' => 'posts', 'action' => 'index', 'prefix' => 'admin']);
  915. Router::setRequestInfo(
  916. $request->addParams([
  917. 'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'prefix' => 'admin',
  918. 'pass' => ['284']
  919. ])->addPaths([
  920. 'base' => '', 'here' => '/admin/posts', 'webroot' => '/'
  921. ])
  922. );
  923. $result = Router::url(['all']);
  924. $expected = '/admin/posts/all';
  925. $this->assertEquals($expected, $result);
  926. }
  927. /**
  928. * Test URL generation inside a prefixed plugin.
  929. *
  930. * @return void
  931. */
  932. public function testUrlGenerationPrefixedPlugin()
  933. {
  934. Router::prefix('admin', function ($routes) {
  935. $routes->plugin('MyPlugin', function ($routes) {
  936. $routes->fallbacks('InflectedRoute');
  937. });
  938. });
  939. $result = Router::url(['prefix' => 'admin', 'plugin' => 'MyPlugin', 'controller' => 'Forms', 'action' => 'edit', 2]);
  940. $expected = '/admin/my_plugin/forms/edit/2';
  941. $this->assertEquals($expected, $result);
  942. }
  943. /**
  944. * Test URL generation with multiple prefixes.
  945. *
  946. * @return void
  947. */
  948. public function testUrlGenerationMultiplePrefixes()
  949. {
  950. Router::prefix('admin', function ($routes) {
  951. $routes->prefix('backoffice', function ($routes) {
  952. $routes->fallbacks('InflectedRoute');
  953. });
  954. });
  955. $result = Router::url([
  956. 'prefix' => 'admin/backoffice',
  957. 'controller' => 'Dashboards',
  958. 'action' => 'home'
  959. ]);
  960. $expected = '/admin/backoffice/dashboards/home';
  961. $this->assertEquals($expected, $result);
  962. }
  963. /**
  964. * testUrlGenerationWithExtensions method
  965. *
  966. * @return void
  967. */
  968. public function testUrlGenerationWithExtensions()
  969. {
  970. Router::connect('/:controller', ['action' => 'index']);
  971. Router::connect('/:controller/:action');
  972. $result = Router::url([
  973. 'plugin' => null,
  974. 'controller' => 'articles',
  975. 'action' => 'add',
  976. 'id' => null,
  977. '_ext' => 'json'
  978. ]);
  979. $expected = '/articles/add.json';
  980. $this->assertEquals($expected, $result);
  981. $result = Router::url([
  982. 'plugin' => null,
  983. 'controller' => 'articles',
  984. 'action' => 'add',
  985. '_ext' => 'json'
  986. ]);
  987. $expected = '/articles/add.json';
  988. $this->assertEquals($expected, $result);
  989. $result = Router::url([
  990. 'plugin' => null,
  991. 'controller' => 'articles',
  992. 'action' => 'index',
  993. 'id' => null,
  994. '_ext' => 'json'
  995. ]);
  996. $expected = '/articles.json';
  997. $this->assertEquals($expected, $result);
  998. $result = Router::url([
  999. 'plugin' => null,
  1000. 'controller' => 'articles',
  1001. 'action' => 'index',
  1002. 'id' => 'testing',
  1003. '_ext' => 'json'
  1004. ]);
  1005. $expected = '/articles.json?id=testing';
  1006. $this->assertEquals($expected, $result);
  1007. }
  1008. /**
  1009. * test url() when the current request has an extension.
  1010. *
  1011. * @return void
  1012. */
  1013. public function testUrlGenerationWithExtensionInCurrentRequest()
  1014. {
  1015. Router::extensions('rss');
  1016. Router::scope('/', function ($r) {
  1017. $r->fallbacks('InflectedRoute');
  1018. });
  1019. $request = new ServerRequest();
  1020. $request->addParams(['controller' => 'Tasks', 'action' => 'index', '_ext' => 'rss']);
  1021. Router::pushRequest($request);
  1022. $result = Router::url([
  1023. 'controller' => 'Tasks',
  1024. 'action' => 'view',
  1025. 1
  1026. ]);
  1027. $expected = '/tasks/view/1';
  1028. $this->assertEquals($expected, $result);
  1029. $result = Router::url([
  1030. 'controller' => 'Tasks',
  1031. 'action' => 'view',
  1032. 1,
  1033. '_ext' => 'json'
  1034. ]);
  1035. $expected = '/tasks/view/1.json';
  1036. $this->assertEquals($expected, $result);
  1037. }
  1038. /**
  1039. * Test url generation with named routes.
  1040. */
  1041. public function testUrlGenerationNamedRoute()
  1042. {
  1043. Router::connect(
  1044. '/users',
  1045. ['controller' => 'users', 'action' => 'index'],
  1046. ['_name' => 'users-index']
  1047. );
  1048. Router::connect(
  1049. '/users/:name',
  1050. ['controller' => 'users', 'action' => 'view'],
  1051. ['_name' => 'test']
  1052. );
  1053. Router::connect(
  1054. '/view/*',
  1055. ['action' => 'view'],
  1056. ['_name' => 'Articles::view']
  1057. );
  1058. $url = Router::url(['_name' => 'test', 'name' => 'mark']);
  1059. $this->assertEquals('/users/mark', $url);
  1060. $url = Router::url([
  1061. '_name' => 'test', 'name' => 'mark',
  1062. 'page' => 1, 'sort' => 'title', 'dir' => 'desc'
  1063. ]);
  1064. $this->assertEquals('/users/mark?page=1&sort=title&dir=desc', $url);
  1065. $url = Router::url(['_name' => 'Articles::view']);
  1066. $this->assertEquals('/view/', $url);
  1067. $url = Router::url(['_name' => 'Articles::view', '1']);
  1068. $this->assertEquals('/view/1', $url);
  1069. $url = Router::url(['_name' => 'Articles::view', '_full' => true, '1']);
  1070. $this->assertEquals('http://localhost/view/1', $url);
  1071. $url = Router::url(['_name' => 'Articles::view', '1', '#' => 'frag']);
  1072. $this->assertEquals('/view/1#frag', $url);
  1073. }
  1074. /**
  1075. * Test that using invalid names causes exceptions.
  1076. *
  1077. * @return void
  1078. */
  1079. public function testNamedRouteException()
  1080. {
  1081. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1082. Router::connect(
  1083. '/users/:name',
  1084. ['controller' => 'users', 'action' => 'view'],
  1085. ['_name' => 'test']
  1086. );
  1087. $url = Router::url(['_name' => 'junk', 'name' => 'mark']);
  1088. }
  1089. /**
  1090. * Test that using duplicate names causes exceptions.
  1091. *
  1092. * @return void
  1093. */
  1094. public function testDuplicateNamedRouteException()
  1095. {
  1096. $this->expectException(\Cake\Routing\Exception\DuplicateNamedRouteException::class);
  1097. Router::connect(
  1098. '/users/:name',
  1099. ['controller' => 'users', 'action' => 'view'],
  1100. ['_name' => 'test']
  1101. );
  1102. Router::connect(
  1103. '/users/:name',
  1104. ['controller' => 'users', 'action' => 'view'],
  1105. ['_name' => 'otherName']
  1106. );
  1107. Router::connect(
  1108. '/users/:name',
  1109. ['controller' => 'users', 'action' => 'view'],
  1110. ['_name' => 'test']
  1111. );
  1112. }
  1113. /**
  1114. * Test that url filters are applied to url params.
  1115. *
  1116. * @return void
  1117. */
  1118. public function testUrlGenerationWithUrlFilter()
  1119. {
  1120. Router::connect('/:lang/:controller/:action/*');
  1121. $request = new ServerRequest();
  1122. $request->addParams([
  1123. 'lang' => 'en',
  1124. 'controller' => 'posts',
  1125. 'action' => 'index'
  1126. ])->addPaths([
  1127. 'base' => '',
  1128. 'here' => '/'
  1129. ]);
  1130. Router::pushRequest($request);
  1131. $calledCount = 0;
  1132. Router::addUrlFilter(function ($url, $request) use (&$calledCount) {
  1133. $calledCount++;
  1134. $url['lang'] = $request->getParam('lang');
  1135. return $url;
  1136. });
  1137. Router::addUrlFilter(function ($url, $request) use (&$calledCount) {
  1138. $calledCount++;
  1139. $url[] = '1234';
  1140. return $url;
  1141. });
  1142. $result = Router::url(['controller' => 'tasks', 'action' => 'edit']);
  1143. $this->assertEquals('/en/tasks/edit/1234', $result);
  1144. $this->assertEquals(2, $calledCount);
  1145. }
  1146. /**
  1147. * Test url param persistence.
  1148. *
  1149. * @return void
  1150. */
  1151. public function testUrlParamPersistence()
  1152. {
  1153. Router::connect('/:lang/:controller/:action/*', [], ['persist' => ['lang']]);
  1154. $request = new ServerRequest();
  1155. $request->addParams([
  1156. 'lang' => 'en',
  1157. 'controller' => 'posts',
  1158. 'action' => 'index'
  1159. ])->addPaths([
  1160. 'base' => '',
  1161. 'here' => '/'
  1162. ]);
  1163. Router::pushRequest($request);
  1164. $result = Router::url(['controller' => 'tasks', 'action' => 'edit', '1234']);
  1165. $this->assertEquals('/en/tasks/edit/1234', $result);
  1166. }
  1167. /**
  1168. * Test that plain strings urls work
  1169. *
  1170. * @return void
  1171. */
  1172. public function testUrlGenerationPlainString()
  1173. {
  1174. $mailto = 'mailto:mark@example.com';
  1175. $result = Router::url($mailto);
  1176. $this->assertEquals($mailto, $result);
  1177. $js = 'javascript:alert("hi")';
  1178. $result = Router::url($js);
  1179. $this->assertEquals($js, $result);
  1180. $hash = '#first';
  1181. $result = Router::url($hash);
  1182. $this->assertEquals($hash, $result);
  1183. }
  1184. /**
  1185. * test that you can leave active plugin routes with plugin = null
  1186. *
  1187. * @return void
  1188. */
  1189. public function testCanLeavePlugin()
  1190. {
  1191. Router::connect('/admin/:controller', ['action' => 'index', 'prefix' => 'admin']);
  1192. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  1193. $request = new ServerRequest();
  1194. Router::setRequestInfo(
  1195. $request->addParams([
  1196. 'pass' => [],
  1197. 'prefix' => 'admin',
  1198. 'plugin' => 'this',
  1199. 'action' => 'index',
  1200. 'controller' => 'interesting',
  1201. ])->addPaths([
  1202. 'base' => '',
  1203. 'here' => '/admin/this/interesting/index',
  1204. 'webroot' => '/',
  1205. ])
  1206. );
  1207. $result = Router::url(['plugin' => null, 'controller' => 'posts', 'action' => 'index']);
  1208. $this->assertEquals('/admin/posts', $result);
  1209. }
  1210. /**
  1211. * testUrlParsing method
  1212. *
  1213. * @return void
  1214. */
  1215. public function testUrlParsing()
  1216. {
  1217. extract(Router::getNamedExpressions());
  1218. Router::connect(
  1219. '/posts/:value/:somevalue/:othervalue/*',
  1220. ['controller' => 'Posts', 'action' => 'view'],
  1221. ['value', 'somevalue', 'othervalue']
  1222. );
  1223. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1224. $expected = [
  1225. 'value' => '2007',
  1226. 'somevalue' => '08',
  1227. 'othervalue' => '01',
  1228. 'controller' => 'Posts',
  1229. 'action' => 'view',
  1230. 'plugin' => null,
  1231. 'pass' => ['0' => 'title-of-post-here'],
  1232. '_matchedRoute' => '/posts/:value/:somevalue/:othervalue/*',
  1233. ];
  1234. $this->assertEquals($expected, $result);
  1235. Router::reload();
  1236. Router::connect(
  1237. '/posts/:year/:month/:day/*',
  1238. ['controller' => 'posts', 'action' => 'view'],
  1239. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1240. );
  1241. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1242. $expected = [
  1243. 'year' => '2007',
  1244. 'month' => '08',
  1245. 'day' => '01',
  1246. 'controller' => 'posts',
  1247. 'action' => 'view',
  1248. 'plugin' => null,
  1249. 'pass' => ['0' => 'title-of-post-here'],
  1250. '_matchedRoute' => '/posts/:year/:month/:day/*',
  1251. ];
  1252. $this->assertEquals($expected, $result);
  1253. Router::reload();
  1254. Router::connect(
  1255. '/posts/:day/:year/:month/*',
  1256. ['controller' => 'posts', 'action' => 'view'],
  1257. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1258. );
  1259. $result = Router::parseRequest($this->makeRequest('/posts/01/2007/08/title-of-post-here', 'GET'));
  1260. $expected = [
  1261. 'day' => '01',
  1262. 'year' => '2007',
  1263. 'month' => '08',
  1264. 'controller' => 'posts',
  1265. 'action' => 'view',
  1266. 'plugin' => null,
  1267. 'pass' => ['0' => 'title-of-post-here'],
  1268. '_matchedRoute' => '/posts/:day/:year/:month/*',
  1269. ];
  1270. $this->assertEquals($expected, $result);
  1271. Router::reload();
  1272. Router::connect(
  1273. '/posts/:month/:day/:year/*',
  1274. ['controller' => 'posts', 'action' => 'view'],
  1275. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1276. );
  1277. $result = Router::parseRequest($this->makeRequest('/posts/08/01/2007/title-of-post-here', 'GET'));
  1278. $expected = [
  1279. 'month' => '08',
  1280. 'day' => '01',
  1281. 'year' => '2007',
  1282. 'controller' => 'posts',
  1283. 'action' => 'view',
  1284. 'plugin' => null,
  1285. 'pass' => ['0' => 'title-of-post-here'],
  1286. '_matchedRoute' => '/posts/:month/:day/:year/*'
  1287. ];
  1288. $this->assertEquals($expected, $result);
  1289. Router::reload();
  1290. Router::connect(
  1291. '/posts/:year/:month/:day/*',
  1292. ['controller' => 'posts', 'action' => 'view']
  1293. );
  1294. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1295. $expected = [
  1296. 'year' => '2007',
  1297. 'month' => '08',
  1298. 'day' => '01',
  1299. 'controller' => 'posts',
  1300. 'action' => 'view',
  1301. 'plugin' => null,
  1302. 'pass' => ['0' => 'title-of-post-here'],
  1303. '_matchedRoute' => '/posts/:year/:month/:day/*',
  1304. ];
  1305. $this->assertEquals($expected, $result);
  1306. Router::reload();
  1307. $this->_connectDefaultRoutes();
  1308. $result = Router::parseRequest($this->makeRequest('/pages/display/home', 'GET'));
  1309. $expected = [
  1310. 'plugin' => null,
  1311. 'pass' => ['home'],
  1312. 'controller' => 'Pages',
  1313. 'action' => 'display',
  1314. '_matchedRoute' => '/:controller/:action/*',
  1315. ];
  1316. $this->assertEquals($expected, $result);
  1317. $result = Router::parseRequest($this->makeRequest('pages/display/home/', 'GET'));
  1318. $this->assertEquals($expected, $result);
  1319. $result = Router::parseRequest($this->makeRequest('pages/display/home', 'GET'));
  1320. $this->assertEquals($expected, $result);
  1321. Router::reload();
  1322. Router::connect('/page/*', ['controller' => 'test']);
  1323. $result = Router::parseRequest($this->makeRequest('/page/my-page', 'GET'));
  1324. $expected = [
  1325. 'pass' => ['my-page'],
  1326. 'plugin' => null,
  1327. 'controller' => 'test',
  1328. 'action' => 'index',
  1329. '_matchedRoute' => '/page/*',
  1330. ];
  1331. $this->assertEquals($expected, $result);
  1332. Router::reload();
  1333. Router::connect(
  1334. '/:language/contact',
  1335. ['language' => 'eng', 'plugin' => 'contact', 'controller' => 'contact', 'action' => 'index'],
  1336. ['language' => '[a-z]{3}']
  1337. );
  1338. $result = Router::parseRequest($this->makeRequest('/eng/contact', 'GET'));
  1339. $expected = [
  1340. 'pass' => [],
  1341. 'language' => 'eng',
  1342. 'plugin' => 'contact',
  1343. 'controller' => 'contact',
  1344. 'action' => 'index',
  1345. '_matchedRoute' => '/:language/contact',
  1346. ];
  1347. $this->assertEquals($expected, $result);
  1348. Router::reload();
  1349. Router::connect(
  1350. '/forestillinger/:month/:year/*',
  1351. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  1352. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  1353. );
  1354. $result = Router::parseRequest($this->makeRequest('/forestillinger/10/2007/min-forestilling', 'GET'));
  1355. $expected = [
  1356. 'pass' => ['min-forestilling'],
  1357. 'plugin' => 'shows',
  1358. 'controller' => 'shows',
  1359. 'action' => 'calendar',
  1360. 'year' => 2007,
  1361. 'month' => 10,
  1362. '_matchedRoute' => '/forestillinger/:month/:year/*'
  1363. ];
  1364. $this->assertEquals($expected, $result);
  1365. Router::reload();
  1366. Router::connect('/:controller/:action/*');
  1367. Router::connect('/', ['plugin' => 'pages', 'controller' => 'pages', 'action' => 'display']);
  1368. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  1369. $expected = [
  1370. 'pass' => [],
  1371. 'controller' => 'pages',
  1372. 'action' => 'display',
  1373. 'plugin' => 'pages',
  1374. '_matchedRoute' => '/',
  1375. ];
  1376. $this->assertEquals($expected, $result);
  1377. $result = Router::parseRequest($this->makeRequest('/posts/edit/0', 'GET'));
  1378. $expected = [
  1379. 'pass' => [0],
  1380. 'controller' => 'posts',
  1381. 'action' => 'edit',
  1382. 'plugin' => null,
  1383. '_matchedRoute' => '/:controller/:action/*',
  1384. ];
  1385. $this->assertEquals($expected, $result);
  1386. Router::reload();
  1387. Router::connect(
  1388. '/posts/:id::url_title',
  1389. ['controller' => 'posts', 'action' => 'view'],
  1390. ['pass' => ['id', 'url_title'], 'id' => '[\d]+']
  1391. );
  1392. $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title', 'GET'));
  1393. $expected = [
  1394. 'pass' => ['5', 'sample-post-title'],
  1395. 'id' => 5,
  1396. 'url_title' => 'sample-post-title',
  1397. 'plugin' => null,
  1398. 'controller' => 'posts',
  1399. 'action' => 'view',
  1400. '_matchedRoute' => '/posts/:id::url_title',
  1401. ];
  1402. $this->assertEquals($expected, $result);
  1403. Router::reload();
  1404. Router::connect(
  1405. '/posts/:id::url_title/*',
  1406. ['controller' => 'posts', 'action' => 'view'],
  1407. ['pass' => ['id', 'url_title'], 'id' => '[\d]+']
  1408. );
  1409. $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title/other/params/4', 'GET'));
  1410. $expected = [
  1411. 'pass' => ['5', 'sample-post-title', 'other', 'params', '4'],
  1412. 'id' => 5,
  1413. 'url_title' => 'sample-post-title',
  1414. 'plugin' => null,
  1415. 'controller' => 'posts',
  1416. 'action' => 'view',
  1417. '_matchedRoute' => '/posts/:id::url_title/*',
  1418. ];
  1419. $this->assertEquals($expected, $result);
  1420. Router::reload();
  1421. Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']);
  1422. $result = Router::parseRequest($this->makeRequest('/posts/view/10?id=123&tab=abc', 'GET'));
  1423. $expected = [
  1424. 'pass' => [10],
  1425. 'plugin' => null,
  1426. 'controller' => 'posts',
  1427. 'action' => 'view',
  1428. '?' => ['id' => '123', 'tab' => 'abc'],
  1429. '_matchedRoute' => '/posts/view/*',
  1430. ];
  1431. $this->assertEquals($expected, $result);
  1432. Router::reload();
  1433. Router::connect(
  1434. '/posts/:url_title-(uuid::id)',
  1435. ['controller' => 'posts', 'action' => 'view'],
  1436. ['pass' => ['id', 'url_title'], 'id' => $UUID]
  1437. );
  1438. $result = Router::parseRequest($this->makeRequest('/posts/sample-post-title-(uuid:47fc97a9-019c-41d1-a058-1fa3cbdd56cb)', 'GET'));
  1439. $expected = [
  1440. 'pass' => ['47fc97a9-019c-41d1-a058-1fa3cbdd56cb', 'sample-post-title'],
  1441. 'id' => '47fc97a9-019c-41d1-a058-1fa3cbdd56cb',
  1442. 'url_title' => 'sample-post-title',
  1443. 'plugin' => null,
  1444. 'controller' => 'posts',
  1445. 'action' => 'view',
  1446. '_matchedRoute' => '/posts/:url_title-(uuid::id)',
  1447. ];
  1448. $this->assertEquals($expected, $result);
  1449. Router::reload();
  1450. Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']);
  1451. $result = Router::parseRequest($this->makeRequest('/posts/view/foo:bar/routing:fun', 'GET'));
  1452. $expected = [
  1453. 'pass' => ['foo:bar', 'routing:fun'],
  1454. 'plugin' => null,
  1455. 'controller' => 'posts',
  1456. 'action' => 'view',
  1457. '_matchedRoute' => '/posts/view/*',
  1458. ];
  1459. $this->assertEquals($expected, $result);
  1460. }
  1461. /**
  1462. * test parseRequest
  1463. *
  1464. * @return void
  1465. */
  1466. public function testParseRequest()
  1467. {
  1468. Router::connect('/articles/:action/*', ['controller' => 'Articles']);
  1469. $request = new ServerRequest(['url' => '/articles/view/1']);
  1470. $result = Router::parseRequest($request);
  1471. $expected = [
  1472. 'pass' => ['1'],
  1473. 'plugin' => null,
  1474. 'controller' => 'Articles',
  1475. 'action' => 'view',
  1476. '_matchedRoute' => '/articles/:action/*',
  1477. ];
  1478. $this->assertEquals($expected, $result);
  1479. }
  1480. /**
  1481. * testUuidRoutes method
  1482. *
  1483. * @return void
  1484. */
  1485. public function testUuidRoutes()
  1486. {
  1487. Router::connect(
  1488. '/subjects/add/:category_id',
  1489. ['controller' => 'subjects', 'action' => 'add'],
  1490. ['category_id' => '\w{8}-\w{4}-\w{4}-\w{4}-\w{12}']
  1491. );
  1492. $result = Router::parseRequest($this->makeRequest('/subjects/add/4795d601-19c8-49a6-930e-06a8b01d17b7', 'GET'));
  1493. $expected = [
  1494. 'pass' => [],
  1495. 'category_id' => '4795d601-19c8-49a6-930e-06a8b01d17b7',
  1496. 'plugin' => null,
  1497. 'controller' => 'subjects',
  1498. 'action' => 'add',
  1499. '_matchedRoute' => '/subjects/add/:category_id'
  1500. ];
  1501. $this->assertEquals($expected, $result);
  1502. }
  1503. /**
  1504. * testRouteSymmetry method
  1505. *
  1506. * @return void
  1507. */
  1508. public function testRouteSymmetry()
  1509. {
  1510. Router::connect(
  1511. '/:extra/page/:slug/*',
  1512. ['controller' => 'pages', 'action' => 'view', 'extra' => null],
  1513. ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+', 'action' => 'view']
  1514. );
  1515. $result = Router::parseRequest($this->makeRequest('/some_extra/page/this_is_the_slug', 'GET'));
  1516. $expected = [
  1517. 'pass' => [],
  1518. 'plugin' => null,
  1519. 'controller' => 'pages',
  1520. 'action' => 'view',
  1521. 'slug' => 'this_is_the_slug',
  1522. 'extra' => 'some_extra',
  1523. '_matchedRoute' => '/:extra/page/:slug/*'
  1524. ];
  1525. $this->assertEquals($expected, $result);
  1526. $result = Router::parseRequest($this->makeRequest('/page/this_is_the_slug', 'GET'));
  1527. $expected = [
  1528. 'pass' => [],
  1529. 'plugin' => null,
  1530. 'controller' => 'pages',
  1531. 'action' => 'view',
  1532. 'slug' => 'this_is_the_slug',
  1533. 'extra' => null,
  1534. '_matchedRoute' => '/:extra/page/:slug/*'
  1535. ];
  1536. $this->assertEquals($expected, $result);
  1537. Router::reload();
  1538. Router::connect(
  1539. '/:extra/page/:slug/*',
  1540. ['controller' => 'pages', 'action' => 'view', 'extra' => null],
  1541. ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+']
  1542. );
  1543. $result = Router::url([
  1544. 'admin' => null,
  1545. 'plugin' => null,
  1546. 'controller' => 'pages',
  1547. 'action' => 'view',
  1548. 'slug' => 'this_is_the_slug',
  1549. 'extra' => null
  1550. ]);
  1551. $expected = '/page/this_is_the_slug';
  1552. $this->assertEquals($expected, $result);
  1553. $result = Router::url([
  1554. 'admin' => null,
  1555. 'plugin' => null,
  1556. 'controller' => 'pages',
  1557. 'action' => 'view',
  1558. 'slug' => 'this_is_the_slug',
  1559. 'extra' => 'some_extra'
  1560. ]);
  1561. $expected = '/some_extra/page/this_is_the_slug';
  1562. $this->assertEquals($expected, $result);
  1563. }
  1564. /**
  1565. * Test exceptions when parsing fails.
  1566. *
  1567. */
  1568. public function testParseError()
  1569. {
  1570. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1571. Router::connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']);
  1572. Router::parseRequest($this->makeRequest('/nope', 'GET'));
  1573. }
  1574. /**
  1575. * Test deprecated behavior
  1576. *
  1577. * @group deprecated
  1578. * @return void
  1579. */
  1580. public function testParseMethodCondition()
  1581. {
  1582. $this->deprecated(function () {
  1583. Router::connect('/posts', ['controller' => 'Posts', '_method' => 'POST']);
  1584. $_SERVER['REQUEST_METHOD'] = 'POST';
  1585. $this->assertNotEmpty(Router::parse('/posts'));
  1586. });
  1587. }
  1588. /**
  1589. * Test parse and reverse symmetry
  1590. *
  1591. * @return void
  1592. * @dataProvider parseReverseSymmetryData
  1593. */
  1594. public function testParseReverseSymmetry($url)
  1595. {
  1596. $this->_connectDefaultRoutes();
  1597. $this->assertSame($url, Router::reverse(Router::parseRequest($this->makeRequest($url, 'GET')) + ['url' => []]));
  1598. }
  1599. /**
  1600. * Data for parse and reverse test
  1601. *
  1602. * @return array
  1603. */
  1604. public function parseReverseSymmetryData()
  1605. {
  1606. return [
  1607. ['/controller/action'],
  1608. ['/controller/action/param'],
  1609. ['/controller/action?param1=value1&param2=value2'],
  1610. ['/controller/action/param?param1=value1'],
  1611. ];
  1612. }
  1613. /**
  1614. * testSetExtensions method
  1615. *
  1616. * @return void
  1617. */
  1618. public function testSetExtensions()
  1619. {
  1620. Router::extensions('rss', false);
  1621. $this->assertContains('rss', Router::extensions());
  1622. $this->_connectDefaultRoutes();
  1623. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1624. $this->assertEquals('rss', $result['_ext']);
  1625. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1626. $this->assertFalse(isset($result['_ext']));
  1627. Router::extensions(['xml']);
  1628. }
  1629. /**
  1630. * Test that route builders propagate extensions to the top.
  1631. *
  1632. * @return void
  1633. */
  1634. public function testExtensionsWithScopedRoutes()
  1635. {
  1636. Router::extensions(['json']);
  1637. Router::scope('/', function ($routes) {
  1638. $routes->setExtensions('rss');
  1639. $routes->connect('/', ['controller' => 'Pages', 'action' => 'index']);
  1640. $routes->scope('/api', function ($routes) {
  1641. $routes->setExtensions('xml');
  1642. $routes->connect('/docs', ['controller' => 'ApiDocs', 'action' => 'index']);
  1643. });
  1644. });
  1645. $this->assertEquals(['json', 'rss', 'xml'], array_values(Router::extensions()));
  1646. }
  1647. /**
  1648. * Test connecting resources.
  1649. *
  1650. * @return void
  1651. */
  1652. public function testResourcesInScope()
  1653. {
  1654. Router::scope('/api', ['prefix' => 'api'], function ($routes) {
  1655. $routes->setExtensions(['json']);
  1656. $routes->resources('Articles');
  1657. });
  1658. $url = Router::url([
  1659. 'prefix' => 'api',
  1660. 'controller' => 'Articles',
  1661. 'action' => 'edit',
  1662. '_method' => 'PUT',
  1663. 'id' => 99
  1664. ]);
  1665. $this->assertEquals('/api/articles/99', $url);
  1666. $url = Router::url([
  1667. 'prefix' => 'api',
  1668. 'controller' => 'Articles',
  1669. 'action' => 'edit',
  1670. '_method' => 'PUT',
  1671. '_ext' => 'json',
  1672. 'id' => 99
  1673. ]);
  1674. $this->assertEquals('/api/articles/99.json', $url);
  1675. }
  1676. /**
  1677. * testExtensionParsing method
  1678. *
  1679. * @return void
  1680. */
  1681. public function testExtensionParsing()
  1682. {
  1683. Router::extensions('rss', false);
  1684. $this->_connectDefaultRoutes();
  1685. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1686. $expected = [
  1687. 'plugin' => null,
  1688. 'controller' => 'Posts',
  1689. 'action' => 'index',
  1690. '_ext' => 'rss',
  1691. 'pass' => [],
  1692. '_matchedRoute' => '/:controller'
  1693. ];
  1694. $this->assertEquals($expected, $result);
  1695. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss', 'GET'));
  1696. $expected = [
  1697. 'plugin' => null,
  1698. 'controller' => 'Posts',
  1699. 'action' => 'view',
  1700. 'pass' => ['1'],
  1701. '_ext' => 'rss',
  1702. '_matchedRoute' => '/:controller/:action/*'
  1703. ];
  1704. $this->assertEquals($expected, $result);
  1705. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss?query=test', 'GET'));
  1706. $expected['?'] = ['query' => 'test'];
  1707. $this->assertEquals($expected, $result);
  1708. Router::reload();
  1709. Router::extensions(['rss', 'xml'], false);
  1710. $this->_connectDefaultRoutes();
  1711. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1712. $expected = [
  1713. 'plugin' => null,
  1714. 'controller' => 'Posts',
  1715. 'action' => 'index',
  1716. '_ext' => 'xml',
  1717. 'pass' => [],
  1718. '_matchedRoute' => '/:controller'
  1719. ];
  1720. $this->assertEquals($expected, $result);
  1721. $result = Router::parseRequest($this->makeRequest('/posts.atom?hello=goodbye', 'GET'));
  1722. $expected = [
  1723. 'plugin' => null,
  1724. 'controller' => 'Posts.atom',
  1725. 'action' => 'index',
  1726. 'pass' => [],
  1727. '?' => ['hello' => 'goodbye'],
  1728. '_matchedRoute' => '/:controller'
  1729. ];
  1730. $this->assertEquals($expected, $result);
  1731. Router::reload();
  1732. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1733. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1734. $expected = [
  1735. 'controller' => 'controller',
  1736. 'action' => 'action',
  1737. 'plugin' => null,
  1738. '_ext' => 'rss',
  1739. 'pass' => [],
  1740. '_matchedRoute' => '/controller/action'
  1741. ];
  1742. $this->assertEquals($expected, $result);
  1743. Router::reload();
  1744. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1745. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1746. $expected = [
  1747. 'controller' => 'controller',
  1748. 'action' => 'action',
  1749. 'plugin' => null,
  1750. '_ext' => 'rss',
  1751. 'pass' => [],
  1752. '_matchedRoute' => '/controller/action'
  1753. ];
  1754. $this->assertEquals($expected, $result);
  1755. Router::reload();
  1756. Router::extensions('rss', false);
  1757. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1758. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1759. $expected = [
  1760. 'controller' => 'controller',
  1761. 'action' => 'action',
  1762. 'plugin' => null,
  1763. '_ext' => 'rss',
  1764. 'pass' => [],
  1765. '_matchedRoute' => '/controller/action'
  1766. ];
  1767. $this->assertEquals($expected, $result);
  1768. }
  1769. /**
  1770. * Test newer style automatically generated prefix routes.
  1771. *
  1772. * @return void
  1773. * @see testUrlGenerationWithAutoPrefixes
  1774. */
  1775. public function testUrlGenerationWithAutoPrefixes()
  1776. {
  1777. Router::reload();
  1778. Router::connect('/protected/:controller/:action/*', ['prefix' => 'protected']);
  1779. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  1780. Router::connect('/:controller/:action/*');
  1781. $request = new ServerRequest();
  1782. Router::setRequestInfo(
  1783. $request->addParams([
  1784. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  1785. 'prefix' => null, 'protected' => false, 'url' => ['url' => 'images/index']
  1786. ])->addPaths([
  1787. 'base' => '',
  1788. 'here' => '/images/index',
  1789. 'webroot' => '/',
  1790. ])
  1791. );
  1792. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1793. $expected = '/images/add';
  1794. $this->assertEquals($expected, $result);
  1795. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1796. $expected = '/protected/images/add';
  1797. $this->assertEquals($expected, $result);
  1798. $result = Router::url(['controller' => 'images', 'action' => 'add_protected_test', 'prefix' => 'protected']);
  1799. $expected = '/protected/images/add_protected_test';
  1800. $this->assertEquals($expected, $result);
  1801. $result = Router::url(['action' => 'edit', 1]);
  1802. $expected = '/images/edit/1';
  1803. $this->assertEquals($expected, $result);
  1804. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1805. $expected = '/protected/images/edit/1';
  1806. $this->assertEquals($expected, $result);
  1807. $result = Router::url(['action' => 'protectededit', 1, 'prefix' => 'protected']);
  1808. $expected = '/protected/images/protectededit/1';
  1809. $this->assertEquals($expected, $result);
  1810. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1811. $expected = '/protected/images/edit/1';
  1812. $this->assertEquals($expected, $result);
  1813. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1]);
  1814. $expected = '/others/edit/1';
  1815. $this->assertEquals($expected, $result);
  1816. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1, 'prefix' => 'protected']);
  1817. $expected = '/protected/others/edit/1';
  1818. $this->assertEquals($expected, $result);
  1819. }
  1820. /**
  1821. * Test that the ssl option works.
  1822. *
  1823. * @return void
  1824. */
  1825. public function testGenerationWithSslOption()
  1826. {
  1827. Router::connect('/:controller/:action/*');
  1828. $request = new ServerRequest([
  1829. 'environment' => ['HTTP_HOST' => 'localhost']
  1830. ]);
  1831. Router::pushRequest(
  1832. $request->addParams([
  1833. 'plugin' => null, 'controller' => 'images', 'action' => 'index'
  1834. ])->addPaths([
  1835. 'base' => '',
  1836. 'here' => '/images/index',
  1837. 'webroot' => '/',
  1838. ])
  1839. );
  1840. $result = Router::url([
  1841. '_ssl' => true
  1842. ]);
  1843. $this->assertEquals('https://localhost/images/index', $result);
  1844. $result = Router::url([
  1845. '_ssl' => false
  1846. ]);
  1847. $this->assertEquals('http://localhost/images/index', $result);
  1848. }
  1849. /**
  1850. * Test ssl option when the current request is ssl.
  1851. *
  1852. * @return void
  1853. */
  1854. public function testGenerateWithSslInSsl()
  1855. {
  1856. Router::connect('/:controller/:action/*');
  1857. $request = new ServerRequest([
  1858. 'environment' => ['HTTP_HOST' => 'localhost', 'HTTPS' => 'on']
  1859. ]);
  1860. Router::pushRequest(
  1861. $request->addParams([
  1862. 'plugin' => null,
  1863. 'controller' => 'images',
  1864. 'action' => 'index'
  1865. ])->addPaths([
  1866. 'base' => '',
  1867. 'here' => '/images/index',
  1868. 'webroot' => '/',
  1869. ])
  1870. );
  1871. $result = Router::url([
  1872. '_ssl' => false
  1873. ]);
  1874. $this->assertEquals('http://localhost/images/index', $result);
  1875. $result = Router::url([
  1876. '_ssl' => true
  1877. ]);
  1878. $this->assertEquals('https://localhost/images/index', $result);
  1879. }
  1880. /**
  1881. * test that prefix routes persist when they are in the current request.
  1882. *
  1883. * @return void
  1884. */
  1885. public function testPrefixRoutePersistence()
  1886. {
  1887. Router::reload();
  1888. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1889. Router::connect('/:controller/:action');
  1890. $request = new ServerRequest();
  1891. Router::setRequestInfo(
  1892. $request->addParams([
  1893. 'plugin' => null,
  1894. 'controller' => 'images',
  1895. 'action' => 'index',
  1896. 'prefix' => 'protected',
  1897. ])->addPaths([
  1898. 'base' => '',
  1899. 'here' => '/protected/images/index',
  1900. 'webroot' => '/',
  1901. ])
  1902. );
  1903. $result = Router::url(['prefix' => 'protected', 'controller' => 'images', 'action' => 'add']);
  1904. $expected = '/protected/images/add';
  1905. $this->assertEquals($expected, $result);
  1906. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1907. $expected = '/protected/images/add';
  1908. $this->assertEquals($expected, $result);
  1909. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => false]);
  1910. $expected = '/images/add';
  1911. $this->assertEquals($expected, $result);
  1912. }
  1913. /**
  1914. * test that setting a prefix override the current one
  1915. *
  1916. * @return void
  1917. */
  1918. public function testPrefixOverride()
  1919. {
  1920. Router::connect('/admin/:controller/:action', ['prefix' => 'admin']);
  1921. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1922. $request = new ServerRequest();
  1923. Router::setRequestInfo(
  1924. $request->addParams([
  1925. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected',
  1926. ])->addPaths([
  1927. 'base' => '',
  1928. 'here' => '/protected/images/index',
  1929. 'webroot' => '/',
  1930. ])
  1931. );
  1932. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'admin']);
  1933. $expected = '/admin/images/add';
  1934. $this->assertEquals($expected, $result);
  1935. $request = new ServerRequest();
  1936. Router::setRequestInfo(
  1937. $request->addParams([
  1938. 'plugin' => null,
  1939. 'controller' => 'images',
  1940. 'action' => 'index',
  1941. 'prefix' => 'admin',
  1942. ])->addPaths([
  1943. 'base' => '',
  1944. 'here' => '/admin/images/index',
  1945. 'webroot' => '/',
  1946. ])
  1947. );
  1948. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1949. $expected = '/protected/images/add';
  1950. $this->assertEquals($expected, $result);
  1951. }
  1952. /**
  1953. * Test that well known route parameters are passed through.
  1954. *
  1955. * @return void
  1956. */
  1957. public function testRouteParamDefaults()
  1958. {
  1959. Router::connect('/cache/*', ['prefix' => false, 'plugin' => true, 'controller' => 0, 'action' => 1]);
  1960. $url = Router::url(['prefix' => 0, 'plugin' => 1, 'controller' => 0, 'action' => 1, 'test']);
  1961. $expected = '/cache/test';
  1962. $this->assertEquals($expected, $url);
  1963. try {
  1964. Router::url(['controller' => 0, 'action' => 1, 'test']);
  1965. $this->fail('No exception raised');
  1966. } catch (\Exception $e) {
  1967. $this->assertTrue(true, 'Exception was raised');
  1968. }
  1969. try {
  1970. Router::url(['prefix' => 1, 'controller' => 0, 'action' => 1, 'test']);
  1971. $this->fail('No exception raised');
  1972. } catch (\Exception $e) {
  1973. $this->assertTrue(true, 'Exception was raised');
  1974. }
  1975. }
  1976. /**
  1977. * testRemoveBase method
  1978. *
  1979. * @return void
  1980. */
  1981. public function testRemoveBase()
  1982. {
  1983. Router::connect('/:controller/:action');
  1984. $request = new ServerRequest();
  1985. Router::setRequestInfo(
  1986. $request->addParams([
  1987. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  1988. ])->addPaths([
  1989. 'base' => '/base',
  1990. 'here' => '/',
  1991. 'webroot' => '/base/',
  1992. ])
  1993. );
  1994. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action']);
  1995. $expected = '/base/my_controller/my_action';
  1996. $this->assertEquals($expected, $result);
  1997. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action', '_base' => false]);
  1998. $expected = '/my_controller/my_action';
  1999. $this->assertEquals($expected, $result);
  2000. }
  2001. /**
  2002. * testPagesUrlParsing method
  2003. *
  2004. * @return void
  2005. */
  2006. public function testPagesUrlParsing()
  2007. {
  2008. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  2009. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  2010. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  2011. $expected = [
  2012. 'pass' => ['home'],
  2013. 'plugin' => null,
  2014. 'controller' => 'pages',
  2015. 'action' => 'display',
  2016. '_matchedRoute' => '/'
  2017. ];
  2018. $this->assertEquals($expected, $result);
  2019. $result = Router::parseRequest($this->makeRequest('/pages/home/', 'GET'));
  2020. $expected = [
  2021. 'pass' => ['home'],
  2022. 'plugin' => null,
  2023. 'controller' => 'pages',
  2024. 'action' => 'display',
  2025. '_matchedRoute' => '/pages/*'
  2026. ];
  2027. $this->assertEquals($expected, $result);
  2028. Router::reload();
  2029. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  2030. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  2031. $expected = [
  2032. 'pass' => ['home'],
  2033. 'plugin' => null,
  2034. 'controller' => 'pages',
  2035. 'action' => 'display',
  2036. '_matchedRoute' => '/'
  2037. ];
  2038. $this->assertEquals($expected, $result);
  2039. Router::reload();
  2040. Router::connect('/', ['controller' => 'posts', 'action' => 'index']);
  2041. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  2042. $result = Router::parseRequest($this->makeRequest('/pages/contact/', 'GET'));
  2043. $expected = [
  2044. 'pass' => ['contact'],
  2045. 'plugin' => null,
  2046. 'controller' => 'pages',
  2047. 'action' => 'display',
  2048. '_matchedRoute' => '/pages/*'
  2049. ];
  2050. $this->assertEquals($expected, $result);
  2051. }
  2052. /**
  2053. * test that requests with a trailing dot don't loose the do.
  2054. *
  2055. * @return void
  2056. */
  2057. public function testParsingWithTrailingPeriod()
  2058. {
  2059. Router::reload();
  2060. Router::connect('/:controller/:action/*');
  2061. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  2062. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2063. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  2064. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2065. }
  2066. /**
  2067. * test that requests with a trailing dot don't loose the do.
  2068. *
  2069. * @return void
  2070. */
  2071. public function testParsingWithTrailingPeriodAndParseExtensions()
  2072. {
  2073. Router::reload();
  2074. Router::connect('/:controller/:action/*');
  2075. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  2076. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2077. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  2078. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2079. }
  2080. /**
  2081. * test that patterns work for :action
  2082. *
  2083. * @return void
  2084. */
  2085. public function testParsingWithPatternOnAction()
  2086. {
  2087. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2088. Router::connect(
  2089. '/blog/:action/*',
  2090. ['controller' => 'blog_posts'],
  2091. ['action' => 'other|actions']
  2092. );
  2093. $result = Router::parseRequest($this->makeRequest('/blog/other', 'GET'));
  2094. $expected = [
  2095. 'plugin' => null,
  2096. 'controller' => 'blog_posts',
  2097. 'action' => 'other',
  2098. 'pass' => [],
  2099. '_matchedRoute' => '/blog/:action/*'
  2100. ];
  2101. $this->assertEquals($expected, $result);
  2102. Router::parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  2103. }
  2104. /**
  2105. * Test url() works with patterns on :action
  2106. *
  2107. * @return void
  2108. */
  2109. public function testUrlPatternOnAction()
  2110. {
  2111. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2112. Router::connect(
  2113. '/blog/:action/*',
  2114. ['controller' => 'blog_posts'],
  2115. ['action' => 'other|actions']
  2116. );
  2117. $result = Router::url(['controller' => 'blog_posts', 'action' => 'actions']);
  2118. $this->assertEquals('/blog/actions', $result);
  2119. $result = Router::url(['controller' => 'blog_posts', 'action' => 'foo']);
  2120. $this->assertEquals('/', $result);
  2121. }
  2122. /**
  2123. * testParsingWithLiteralPrefixes method
  2124. *
  2125. * @return void
  2126. */
  2127. public function testParsingWithLiteralPrefixes()
  2128. {
  2129. Router::reload();
  2130. $adminParams = ['prefix' => 'admin'];
  2131. Router::connect('/admin/:controller', $adminParams);
  2132. Router::connect('/admin/:controller/:action/*', $adminParams);
  2133. $request = new ServerRequest();
  2134. Router::setRequestInfo(
  2135. $request->addParams([
  2136. 'plugin' => null, 'controller' => 'controller', 'action' => 'index'
  2137. ])->addPaths([
  2138. 'base' => '/base',
  2139. 'here' => '/',
  2140. 'webroot' => '/base/',
  2141. ])
  2142. );
  2143. $result = Router::parseRequest($this->makeRequest('/admin/posts/', 'GET'));
  2144. $expected = [
  2145. 'pass' => [],
  2146. 'prefix' => 'admin',
  2147. 'plugin' => null,
  2148. 'controller' => 'posts',
  2149. 'action' => 'index',
  2150. '_matchedRoute' => '/admin/:controller'
  2151. ];
  2152. $this->assertEquals($expected, $result);
  2153. $result = Router::parseRequest($this->makeRequest('/admin/posts', 'GET'));
  2154. $this->assertEquals($expected, $result);
  2155. $result = Router::url(['prefix' => 'admin', 'controller' => 'posts']);
  2156. $expected = '/base/admin/posts';
  2157. $this->assertEquals($expected, $result);
  2158. Router::reload();
  2159. $prefixParams = ['prefix' => 'members'];
  2160. Router::connect('/members/:controller', $prefixParams);
  2161. Router::connect('/members/:controller/:action', $prefixParams);
  2162. Router::connect('/members/:controller/:action/*', $prefixParams);
  2163. $request = new ServerRequest();
  2164. Router::setRequestInfo(
  2165. $request->addParams([
  2166. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  2167. ])->addPaths([
  2168. 'base' => '/base',
  2169. 'here' => '/',
  2170. 'webroot' => '/',
  2171. ])
  2172. );
  2173. $result = Router::parseRequest($this->makeRequest('/members/posts/index', 'GET'));
  2174. $expected = [
  2175. 'pass' => [],
  2176. 'prefix' => 'members',
  2177. 'plugin' => null,
  2178. 'controller' => 'posts',
  2179. 'action' => 'index',
  2180. '_matchedRoute' => '/members/:controller/:action'
  2181. ];
  2182. $this->assertEquals($expected, $result);
  2183. $result = Router::url(['prefix' => 'members', 'controller' => 'users', 'action' => 'add']);
  2184. $expected = '/base/members/users/add';
  2185. $this->assertEquals($expected, $result);
  2186. }
  2187. /**
  2188. * Tests URL generation with flags and prefixes in and out of context
  2189. *
  2190. * @return void
  2191. */
  2192. public function testUrlWritingWithPrefixes()
  2193. {
  2194. Router::connect('/company/:controller/:action/*', ['prefix' => 'company']);
  2195. Router::connect('/:action', ['controller' => 'users']);
  2196. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => 'company']);
  2197. $expected = '/company/users/login';
  2198. $this->assertEquals($expected, $result);
  2199. $request = new ServerRequest();
  2200. Router::setRequestInfo(
  2201. $request->addParams([
  2202. 'plugin' => null,
  2203. 'controller' => 'users',
  2204. 'action' => 'login',
  2205. 'prefix' => 'company'
  2206. ])->addPaths([
  2207. 'base' => '/',
  2208. 'here' => '/',
  2209. 'webroot' => '/base/',
  2210. ])
  2211. );
  2212. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => false]);
  2213. $expected = '/login';
  2214. $this->assertEquals($expected, $result);
  2215. }
  2216. /**
  2217. * test url generation with prefixes and custom routes
  2218. *
  2219. * @return void
  2220. */
  2221. public function testUrlWritingWithPrefixesAndCustomRoutes()
  2222. {
  2223. Router::connect(
  2224. '/admin/login',
  2225. ['controller' => 'users', 'action' => 'login', 'prefix' => 'admin']
  2226. );
  2227. $request = new ServerRequest();
  2228. Router::setRequestInfo(
  2229. $request->addParams([
  2230. 'plugin' => null, 'controller' => 'posts', 'action' => 'index',
  2231. 'prefix' => 'admin'
  2232. ])->addPaths([
  2233. 'base' => '/',
  2234. 'here' => '/',
  2235. 'webroot' => '/',
  2236. ])
  2237. );
  2238. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2239. $this->assertEquals('/admin/login', $result);
  2240. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2241. $this->assertEquals('/admin/login', $result);
  2242. }
  2243. /**
  2244. * testPassedArgsOrder method
  2245. *
  2246. * @return void
  2247. */
  2248. public function testPassedArgsOrder()
  2249. {
  2250. Router::connect('/test-passed/*', ['controller' => 'pages', 'action' => 'display', 'home']);
  2251. Router::connect('/test2/*', ['controller' => 'pages', 'action' => 'display', 2]);
  2252. Router::connect('/test/*', ['controller' => 'pages', 'action' => 'display', 1]);
  2253. $result = Router::url(['controller' => 'pages', 'action' => 'display', 1, 'whatever']);
  2254. $expected = '/test/whatever';
  2255. $this->assertEquals($expected, $result);
  2256. $result = Router::url(['controller' => 'pages', 'action' => 'display', 2, 'whatever']);
  2257. $expected = '/test2/whatever';
  2258. $this->assertEquals($expected, $result);
  2259. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'home', 'whatever']);
  2260. $expected = '/test-passed/whatever';
  2261. $this->assertEquals($expected, $result);
  2262. }
  2263. /**
  2264. * testRegexRouteMatching method
  2265. *
  2266. * @return void
  2267. */
  2268. public function testRegexRouteMatching()
  2269. {
  2270. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2271. $result = Router::parseRequest($this->makeRequest('/eng/test/test_action', 'GET'));
  2272. $expected = [
  2273. 'pass' => [],
  2274. 'locale' => 'eng',
  2275. 'controller' => 'test',
  2276. 'action' => 'test_action',
  2277. 'plugin' => null,
  2278. '_matchedRoute' => '/:locale/:controller/:action/*'
  2279. ];
  2280. $this->assertEquals($expected, $result);
  2281. }
  2282. /**
  2283. * testRegexRouteMatching error
  2284. *
  2285. * @group deprecated
  2286. * @return void
  2287. */
  2288. public function testRegexRouteMatchingError()
  2289. {
  2290. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2291. $this->deprecated(function () {
  2292. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2293. Router::parse('/badness/test/test_action', 'GET');
  2294. });
  2295. }
  2296. /**
  2297. * testRegexRouteMatching method
  2298. *
  2299. * @return void
  2300. */
  2301. public function testRegexRouteMatchUrl()
  2302. {
  2303. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2304. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2305. $request = new ServerRequest();
  2306. Router::setRequestInfo(
  2307. $request->addParams([
  2308. 'plugin' => null,
  2309. 'controller' => 'test',
  2310. 'action' => 'index',
  2311. 'url' => ['url' => 'test/test_action']
  2312. ])->addPaths([
  2313. 'base' => '',
  2314. 'here' => '/test/test_action',
  2315. 'webroot' => '/',
  2316. ])
  2317. );
  2318. $result = Router::url(['action' => 'test_another_action', 'locale' => 'eng']);
  2319. $expected = '/eng/test/test_another_action';
  2320. $this->assertEquals($expected, $result);
  2321. $result = Router::url(['action' => 'test_another_action']);
  2322. $expected = '/';
  2323. $this->assertEquals($expected, $result);
  2324. }
  2325. /**
  2326. * test using a custom route class for route connection
  2327. *
  2328. * @return void
  2329. */
  2330. public function testUsingCustomRouteClass()
  2331. {
  2332. Plugin::load('TestPlugin');
  2333. Router::connect(
  2334. '/:slug',
  2335. ['plugin' => 'TestPlugin', 'action' => 'index'],
  2336. ['routeClass' => 'PluginShortRoute', 'slug' => '[a-z_-]+']
  2337. );
  2338. $result = Router::parseRequest($this->makeRequest('/the-best', 'GET'));
  2339. $expected = [
  2340. 'plugin' => 'TestPlugin',
  2341. 'controller' => 'TestPlugin',
  2342. 'action' => 'index',
  2343. 'slug' => 'the-best',
  2344. 'pass' => [],
  2345. '_matchedRoute' => '/:slug',
  2346. ];
  2347. $this->assertEquals($expected, $result);
  2348. }
  2349. /**
  2350. * test using custom route class in PluginDot notation
  2351. *
  2352. * @return void
  2353. */
  2354. public function testUsingCustomRouteClassPluginDotSyntax()
  2355. {
  2356. Plugin::load('TestPlugin');
  2357. Router::connect(
  2358. '/:slug',
  2359. ['controller' => 'posts', 'action' => 'view'],
  2360. ['routeClass' => 'TestPlugin.TestRoute', 'slug' => '[a-z_-]+']
  2361. );
  2362. $this->assertTrue(true); // Just to make sure the connect do not throw exception
  2363. Plugin::unload('TestPlugin');
  2364. }
  2365. /**
  2366. * test that route classes must extend \Cake\Routing\Route\Route
  2367. *
  2368. * @return void
  2369. */
  2370. public function testCustomRouteException()
  2371. {
  2372. $this->expectException(\InvalidArgumentException::class);
  2373. Router::connect('/:controller', [], ['routeClass' => 'Object']);
  2374. }
  2375. /**
  2376. * test reversing parameter arrays back into strings.
  2377. *
  2378. * Mark the router as initialized so it doesn't auto-load routes
  2379. *
  2380. * @return void
  2381. */
  2382. public function testReverseToken()
  2383. {
  2384. Router::connect('/:controller/:action/*');
  2385. $params = [
  2386. 'controller' => 'posts',
  2387. 'action' => 'view',
  2388. 'pass' => [1],
  2389. 'url' => [],
  2390. 'autoRender' => 1,
  2391. 'bare' => 1,
  2392. 'return' => 1,
  2393. 'requested' => 1,
  2394. '_Token' => ['key' => 'sekret']
  2395. ];
  2396. $result = Router::reverse($params);
  2397. $this->assertEquals('/posts/view/1', $result);
  2398. }
  2399. public function testReverseLocalized()
  2400. {
  2401. Router::reload();
  2402. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2403. $params = [
  2404. 'lang' => 'eng',
  2405. 'controller' => 'posts',
  2406. 'action' => 'view',
  2407. 'pass' => [1],
  2408. 'url' => ['url' => 'eng/posts/view/1']
  2409. ];
  2410. $result = Router::reverse($params);
  2411. $this->assertEquals('/eng/posts/view/1', $result);
  2412. }
  2413. public function testReverseArrayQuery()
  2414. {
  2415. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2416. $params = [
  2417. 'lang' => 'eng',
  2418. 'controller' => 'posts',
  2419. 'action' => 'view',
  2420. 1,
  2421. '?' => ['foo' => 'bar']
  2422. ];
  2423. $result = Router::reverse($params);
  2424. $this->assertEquals('/eng/posts/view/1?foo=bar', $result);
  2425. $params = [
  2426. 'lang' => 'eng',
  2427. 'controller' => 'posts',
  2428. 'action' => 'view',
  2429. 'pass' => [1],
  2430. 'url' => ['url' => 'eng/posts/view/1', 'foo' => 'bar', 'baz' => 'quu'],
  2431. 'paging' => [],
  2432. 'models' => []
  2433. ];
  2434. $result = Router::reverse($params);
  2435. $this->assertEquals('/eng/posts/view/1?foo=bar&baz=quu', $result);
  2436. }
  2437. public function testReverseCakeRequestQuery()
  2438. {
  2439. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2440. $request = new ServerRequest('/eng/posts/view/1');
  2441. $request->addParams([
  2442. 'lang' => 'eng',
  2443. 'controller' => 'posts',
  2444. 'action' => 'view',
  2445. 'pass' => [1],
  2446. ]);
  2447. $request->query = ['url' => 'eng/posts/view/1', 'test' => 'value'];
  2448. $result = Router::reverse($request);
  2449. $expected = '/eng/posts/view/1?test=value';
  2450. $this->assertEquals($expected, $result);
  2451. }
  2452. public function testReverseFull()
  2453. {
  2454. $params = [
  2455. 'lang' => 'eng',
  2456. 'controller' => 'posts',
  2457. 'action' => 'view',
  2458. 'pass' => [1],
  2459. 'url' => ['url' => 'eng/posts/view/1']
  2460. ];
  2461. $result = Router::reverse($params, true);
  2462. $this->assertRegExp('/^http(s)?:\/\//', $result);
  2463. }
  2464. /**
  2465. * Test that extensions work with Router::reverse()
  2466. *
  2467. * @return void
  2468. */
  2469. public function testReverseWithExtension()
  2470. {
  2471. Router::connect('/:controller/:action/*');
  2472. Router::extensions('json', false);
  2473. $request = new ServerRequest('/posts/view/1.json');
  2474. $request->addParams([
  2475. 'controller' => 'posts',
  2476. 'action' => 'view',
  2477. 'pass' => [1],
  2478. '_ext' => 'json',
  2479. ]);
  2480. $request->query = [];
  2481. $result = Router::reverse($request);
  2482. $expected = '/posts/view/1.json';
  2483. $this->assertEquals($expected, $result);
  2484. }
  2485. public function testReverseToArrayQuery()
  2486. {
  2487. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2488. $params = [
  2489. 'lang' => 'eng',
  2490. 'controller' => 'posts',
  2491. 'action' => 'view',
  2492. 'pass' => [123],
  2493. 'url' => ['url' => 'eng/posts/view/123', 'foo' => 'bar', 'baz' => 'quu'],
  2494. 'paging' => [],
  2495. 'models' => [],
  2496. ];
  2497. $actual = Router::reverseToArray($params);
  2498. $expected = [
  2499. 'lang' => 'eng',
  2500. 'controller' => 'posts',
  2501. 'action' => 'view',
  2502. 123,
  2503. '?' => ['foo' => 'bar', 'baz' => 'quu'],
  2504. ];
  2505. $this->assertEquals($expected, $actual);
  2506. }
  2507. public function testReverseToArrayRequestQuery()
  2508. {
  2509. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2510. $request = new ServerRequest('/eng/posts/view/1');
  2511. $request->addParams([
  2512. 'lang' => 'eng',
  2513. 'controller' => 'posts',
  2514. 'action' => 'view',
  2515. 'pass' => [123],
  2516. ]);
  2517. $request->query = ['url' => 'eng/posts/view/1', 'test' => 'value'];
  2518. $actual = Router::reverseToArray($request);
  2519. $expected = [
  2520. 'lang' => 'eng',
  2521. 'plugin' => null,
  2522. 'controller' => 'posts',
  2523. 'action' => 'view',
  2524. 123,
  2525. '_ext' => null,
  2526. '?' => [
  2527. 'test' => 'value',
  2528. ],
  2529. ];
  2530. $this->assertEquals($expected, $actual);
  2531. }
  2532. /**
  2533. * test that setRequestInfo can accept arrays and turn that into a Request object.
  2534. *
  2535. * @group deprecated
  2536. * @return void
  2537. */
  2538. public function testSetRequestInfoLegacy()
  2539. {
  2540. $this->deprecated(function () {
  2541. Router::setRequestInfo([
  2542. [
  2543. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  2544. 'url' => ['url' => 'protected/images/index']
  2545. ],
  2546. [
  2547. 'base' => '',
  2548. 'here' => '/protected/images/index',
  2549. 'webroot' => '/',
  2550. ]
  2551. ]);
  2552. $result = Router::getRequest();
  2553. $this->assertEquals('images', $result->getParam('controller'));
  2554. $this->assertEquals('index', $result->getParam('action'));
  2555. $this->assertEquals('', $result->getAttribute('base'));
  2556. $this->assertEquals('', $result->base);
  2557. $this->assertEquals('/protected/images/index', $result->getRequestTarget());
  2558. $this->assertEquals('/protected/images/index', $result->here);
  2559. $this->assertEquals('/', $result->getAttribute('webroot'));
  2560. $this->assertEquals('/', $result->webroot);
  2561. });
  2562. }
  2563. /**
  2564. * test get request.
  2565. *
  2566. * @return void
  2567. */
  2568. public function testGetRequest()
  2569. {
  2570. $requestA = new ServerRequest('/');
  2571. $requestB = new ServerRequest('/posts');
  2572. Router::pushRequest($requestA);
  2573. Router::pushRequest($requestB);
  2574. $this->assertSame($requestA, Router::getRequest(false));
  2575. $this->assertSame($requestB, Router::getRequest(true));
  2576. }
  2577. /**
  2578. * Test that Router::url() uses the first request
  2579. */
  2580. public function testUrlWithRequestAction()
  2581. {
  2582. Router::connect('/:controller', ['action' => 'index']);
  2583. Router::connect('/:controller/:action');
  2584. $firstRequest = new ServerRequest('/posts/index');
  2585. $firstRequest->addParams([
  2586. 'plugin' => null,
  2587. 'controller' => 'posts',
  2588. 'action' => 'index'
  2589. ])->addPaths(['base' => '']);
  2590. $secondRequest = new ServerRequest('/posts/index');
  2591. $secondRequest->addParams([
  2592. 'requested' => 1,
  2593. 'plugin' => null,
  2594. 'controller' => 'comments',
  2595. 'action' => 'listing'
  2596. ])->addPaths(['base' => '']);
  2597. Router::setRequestInfo($firstRequest);
  2598. Router::setRequestInfo($secondRequest);
  2599. $result = Router::url(['_base' => false]);
  2600. $this->assertEquals('/comments/listing', $result, 'with second requests, the last should win.');
  2601. Router::popRequest();
  2602. $result = Router::url(['_base' => false]);
  2603. $this->assertEquals('/posts', $result, 'with second requests, the last should win.');
  2604. // Make sure that popping an empty request doesn't fail.
  2605. Router::popRequest();
  2606. }
  2607. /**
  2608. * test that a route object returning a full URL is not modified.
  2609. *
  2610. * @return void
  2611. */
  2612. public function testUrlFullUrlReturnFromRoute()
  2613. {
  2614. $url = 'http://example.com/posts/view/1';
  2615. $route = $this->getMockBuilder('Cake\Routing\Route\Route')
  2616. ->setMethods(['match'])
  2617. ->setConstructorArgs(['/:controller/:action/*'])
  2618. ->getMock();
  2619. $route->expects($this->any())
  2620. ->method('match')
  2621. ->will($this->returnValue($url));
  2622. Router::connect($route);
  2623. $result = Router::url(['controller' => 'posts', 'action' => 'view', 1]);
  2624. $this->assertEquals($url, $result);
  2625. }
  2626. /**
  2627. * test protocol in url
  2628. *
  2629. * @return void
  2630. */
  2631. public function testUrlProtocol()
  2632. {
  2633. $url = 'http://example.com';
  2634. $this->assertEquals($url, Router::url($url));
  2635. $url = 'ed2k://example.com';
  2636. $this->assertEquals($url, Router::url($url));
  2637. $url = 'svn+ssh://example.com';
  2638. $this->assertEquals($url, Router::url($url));
  2639. $url = '://example.com';
  2640. $this->assertEquals($url, Router::url($url));
  2641. $url = '//example.com';
  2642. $this->assertEquals($url, Router::url($url));
  2643. $url = 'javascript:void(0)';
  2644. $this->assertEquals($url, Router::url($url));
  2645. $url = 'tel:012345-678';
  2646. $this->assertEquals($url, Router::url($url));
  2647. $url = 'sms:012345-678';
  2648. $this->assertEquals($url, Router::url($url));
  2649. $url = '#here';
  2650. $this->assertEquals($url, Router::url($url));
  2651. $url = '?param=0';
  2652. $this->assertEquals($url, Router::url($url));
  2653. $url = '/posts/index#here';
  2654. $expected = Configure::read('App.fullBaseUrl') . '/posts/index#here';
  2655. $this->assertEquals($expected, Router::url($url, true));
  2656. }
  2657. /**
  2658. * Testing that patterns on the :action param work properly.
  2659. *
  2660. * @return void
  2661. */
  2662. public function testPatternOnAction()
  2663. {
  2664. $route = new Route(
  2665. '/blog/:action/*',
  2666. ['controller' => 'blog_posts'],
  2667. ['action' => 'other|actions']
  2668. );
  2669. $result = $route->match(['controller' => 'blog_posts', 'action' => 'foo']);
  2670. $this->assertFalse($result);
  2671. $result = $route->match(['controller' => 'blog_posts', 'action' => 'actions']);
  2672. $this->assertEquals('/blog/actions/', $result);
  2673. $result = $route->parseRequest($this->makeRequest('/blog/other', 'GET'));
  2674. $expected = [
  2675. 'controller' => 'blog_posts',
  2676. 'action' => 'other',
  2677. 'pass' => [],
  2678. '_matchedRoute' => '/blog/:action/*',
  2679. ];
  2680. $this->assertEquals($expected, $result);
  2681. $result = $route->parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  2682. $this->assertFalse($result);
  2683. }
  2684. /**
  2685. * Test that redirect() works.
  2686. *
  2687. * @group deprecated
  2688. * @return void
  2689. */
  2690. public function testRedirect()
  2691. {
  2692. $this->deprecated(function () {
  2693. Router::redirect('/mobile', '/', ['status' => 301]);
  2694. $routes = Router::routes();
  2695. $route = $routes[0];
  2696. $this->assertInstanceOf('Cake\Routing\Route\RedirectRoute', $route);
  2697. });
  2698. }
  2699. /**
  2700. * Test that redirect() works with another route class.
  2701. *
  2702. * @group deprecated
  2703. * @return void
  2704. */
  2705. public function testRedirectWithAnotherRouteClass()
  2706. {
  2707. $this->deprecated(function () {
  2708. $route1 = $this->getMockBuilder('Cake\Routing\Route\RedirectRoute')
  2709. ->setConstructorArgs(['/mobile\''])
  2710. ->setMethods(['parse'])
  2711. ->getMock();
  2712. $class = '\\' . get_class($route1);
  2713. Router::redirect('/mobile', '/', [
  2714. 'status' => 301,
  2715. 'routeClass' => $class
  2716. ]);
  2717. $routes = Router::routes();
  2718. $route = $routes[0];
  2719. $this->assertInstanceOf($class, $route);
  2720. });
  2721. }
  2722. /**
  2723. * Test that the compatibility method for incoming urls works.
  2724. *
  2725. * @group deprecated
  2726. * @return void
  2727. */
  2728. public function testParseNamedParameters()
  2729. {
  2730. $this->deprecated(function () {
  2731. $request = new ServerRequest();
  2732. $request->addParams([
  2733. 'controller' => 'posts',
  2734. 'action' => 'index',
  2735. ]);
  2736. $result = Router::parseNamedParams($request);
  2737. $this->assertSame([], $result->params['named']);
  2738. $request = new ServerRequest();
  2739. $request->addParams([
  2740. 'controller' => 'posts',
  2741. 'action' => 'index',
  2742. 'pass' => ['home', 'one:two', 'three:four', 'five[nested][0]:six', 'five[nested][1]:seven']
  2743. ]);
  2744. Router::parseNamedParams($request);
  2745. $expected = [
  2746. 'plugin' => null,
  2747. 'controller' => 'posts',
  2748. 'action' => 'index',
  2749. '_ext' => null,
  2750. 'pass' => ['home'],
  2751. 'named' => [
  2752. 'one' => 'two',
  2753. 'three' => 'four',
  2754. 'five' => [
  2755. 'nested' => ['six', 'seven']
  2756. ]
  2757. ]
  2758. ];
  2759. $this->assertEquals($expected, $request->params);
  2760. });
  2761. }
  2762. /**
  2763. * Test the scope() method
  2764. *
  2765. * @return void
  2766. */
  2767. public function testScope()
  2768. {
  2769. Router::scope('/path', ['param' => 'value'], function ($routes) {
  2770. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2771. $this->assertEquals('/path', $routes->path());
  2772. $this->assertEquals(['param' => 'value'], $routes->params());
  2773. $this->assertEquals('', $routes->namePrefix());
  2774. $routes->connect('/articles', ['controller' => 'Articles']);
  2775. });
  2776. }
  2777. /**
  2778. * Test the scope() method
  2779. *
  2780. * @return void
  2781. */
  2782. public function testScopeError()
  2783. {
  2784. $this->expectException(\InvalidArgumentException::class);
  2785. Router::scope('/path', 'derpy');
  2786. }
  2787. /**
  2788. * Test to ensure that extensions defined in scopes don't leak.
  2789. * And that global extensions are propagated.
  2790. *
  2791. * @return void
  2792. */
  2793. public function testScopeExtensionsContained()
  2794. {
  2795. Router::extensions(['json']);
  2796. Router::scope('/', function ($routes) {
  2797. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2798. $routes->setExtensions(['rss']);
  2799. $this->assertEquals(
  2800. ['rss'],
  2801. $routes->getExtensions(),
  2802. 'Should include new extensions.'
  2803. );
  2804. $routes->connect('/home', []);
  2805. });
  2806. $this->assertEquals(['json', 'rss'], array_values(Router::extensions()));
  2807. Router::scope('/api', function ($routes) {
  2808. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2809. $routes->setExtensions(['json', 'csv']);
  2810. $routes->connect('/export', []);
  2811. $routes->scope('/v1', function ($routes) {
  2812. $this->assertEquals(['json', 'csv'], $routes->getExtensions());
  2813. });
  2814. });
  2815. $this->assertEquals(['json', 'rss', 'csv'], array_values(Router::extensions()));
  2816. }
  2817. /**
  2818. * Test the scope() options
  2819. *
  2820. * @return void
  2821. */
  2822. public function testScopeOptions()
  2823. {
  2824. $options = ['param' => 'value', 'routeClass' => 'InflectedRoute', 'extensions' => ['json']];
  2825. Router::scope('/path', $options, function ($routes) {
  2826. $this->assertSame('InflectedRoute', $routes->getRouteClass());
  2827. $this->assertSame(['json'], $routes->getExtensions());
  2828. $this->assertEquals('/path', $routes->path());
  2829. $this->assertEquals(['param' => 'value'], $routes->params());
  2830. });
  2831. }
  2832. /**
  2833. * Test the scope() method
  2834. *
  2835. * @return void
  2836. */
  2837. public function testScopeNamePrefix()
  2838. {
  2839. Router::scope('/path', ['param' => 'value', '_namePrefix' => 'path:'], function ($routes) {
  2840. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2841. $this->assertEquals('/path', $routes->path());
  2842. $this->assertEquals(['param' => 'value'], $routes->params());
  2843. $this->assertEquals('path:', $routes->namePrefix());
  2844. $routes->connect('/articles', ['controller' => 'Articles']);
  2845. });
  2846. }
  2847. /**
  2848. * Test that prefix() creates a scope.
  2849. *
  2850. * @return void
  2851. */
  2852. public function testPrefix()
  2853. {
  2854. Router::prefix('admin', function ($routes) {
  2855. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2856. $this->assertEquals('/admin', $routes->path());
  2857. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2858. });
  2859. Router::prefix('admin', ['_namePrefix' => 'admin:'], function ($routes) {
  2860. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2861. $this->assertEquals('admin:', $routes->namePrefix());
  2862. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2863. });
  2864. }
  2865. /**
  2866. * Test that prefix() accepts options
  2867. *
  2868. * @return void
  2869. */
  2870. public function testPrefixOptions()
  2871. {
  2872. Router::prefix('admin', ['param' => 'value'], function ($routes) {
  2873. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2874. $this->assertEquals('/admin', $routes->path());
  2875. $this->assertEquals(['prefix' => 'admin', 'param' => 'value'], $routes->params());
  2876. });
  2877. Router::prefix('CustomPath', ['path' => '/custom-path'], function ($routes) {
  2878. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2879. $this->assertEquals('/custom-path', $routes->path());
  2880. $this->assertEquals(['prefix' => 'custom_path'], $routes->params());
  2881. });
  2882. }
  2883. /**
  2884. * Test that plugin() creates a scope.
  2885. *
  2886. * @return void
  2887. */
  2888. public function testPlugin()
  2889. {
  2890. Router::plugin('DebugKit', function ($routes) {
  2891. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2892. $this->assertEquals('/debug_kit', $routes->path());
  2893. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2894. });
  2895. }
  2896. /**
  2897. * Test that plugin() accepts options
  2898. *
  2899. * @return void
  2900. */
  2901. public function testPluginOptions()
  2902. {
  2903. Router::plugin('DebugKit', ['path' => '/debugger'], function ($routes) {
  2904. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2905. $this->assertEquals('/debugger', $routes->path());
  2906. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2907. });
  2908. Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function ($routes) {
  2909. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2910. $this->assertEquals('contacts:', $routes->namePrefix());
  2911. });
  2912. }
  2913. /**
  2914. * Test setting default route class.
  2915. *
  2916. * @return void
  2917. */
  2918. public function testDefaultRouteClass()
  2919. {
  2920. Router::connect('/:controller', ['action' => 'index']);
  2921. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2922. $this->assertEquals('/FooBar', $result);
  2923. // This is needed because tests/boostrap.php sets App.namespace to 'App'
  2924. static::setAppNamespace();
  2925. Router::defaultRouteClass('DashedRoute');
  2926. Router::connect('/cake/:controller', ['action' => 'cake']);
  2927. $result = Router::url(['controller' => 'FooBar', 'action' => 'cake']);
  2928. $this->assertEquals('/cake/foo-bar', $result);
  2929. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2930. $this->assertEquals('/FooBar', $result);
  2931. Router::reload();
  2932. Router::defaultRouteClass('DashedRoute');
  2933. Router::scope('/', function ($routes) {
  2934. $routes->fallbacks();
  2935. });
  2936. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2937. $this->assertEquals('/foo-bar', $result);
  2938. }
  2939. /**
  2940. * Test generation of routes with collisions between the query string
  2941. * and other url params
  2942. *
  2943. * @return void
  2944. */
  2945. public function testUrlWithCollidingQueryString()
  2946. {
  2947. Router::connect('/:controller/:action/:id');
  2948. $query = ['controller' => 'Foo', 'action' => 'bar', 'id' => 100];
  2949. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  2950. $this->assertEquals('/posts/view/1?controller=Foo&action=bar&id=100', $result);
  2951. $query = ['_host' => 'foo.bar', '_ssl' => 0, '_scheme' => 'ftp://', '_base' => 'baz', '_port' => '15'];
  2952. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  2953. $this->assertEquals('/posts/view/1?_host=foo.bar&_ssl=0&_scheme=ftp%3A%2F%2F&_base=baz&_port=15', $result);
  2954. }
  2955. /**
  2956. * Test setting the request context.
  2957. *
  2958. * @return void
  2959. */
  2960. public function testSetRequestContextCakePHP()
  2961. {
  2962. Router::connect('/:controller/:action/*');
  2963. $request = new ServerRequest([
  2964. 'base' => '/subdir',
  2965. 'url' => 'articles/view/1'
  2966. ]);
  2967. Router::setRequestContext($request);
  2968. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2969. $this->assertEquals('/subdir/things/add', $result);
  2970. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2971. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2972. $result = Router::url('/pages/home');
  2973. $this->assertEquals('/subdir/pages/home', $result);
  2974. }
  2975. /**
  2976. * Test setting the request context.
  2977. *
  2978. * @return void
  2979. */
  2980. public function testSetRequestContextPsr()
  2981. {
  2982. $server = [
  2983. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  2984. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  2985. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  2986. 'REQUEST_URI' => '/subdir/articles/view/1',
  2987. 'QUERY_STRING' => '',
  2988. 'SERVER_PORT' => 80,
  2989. ];
  2990. Router::connect('/:controller/:action/*');
  2991. $request = ServerRequestFactory::fromGlobals($server);
  2992. Router::setRequestContext($request);
  2993. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2994. $this->assertEquals('/subdir/things/add', $result);
  2995. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2996. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2997. $result = Router::url('/pages/home');
  2998. $this->assertEquals('/subdir/pages/home', $result);
  2999. }
  3000. /**
  3001. * Test getting the route collection
  3002. *
  3003. * @return void
  3004. */
  3005. public function testGetRouteCollection()
  3006. {
  3007. $collection = Router::getRouteCollection();
  3008. $this->assertInstanceOf(RouteCollection::class, $collection);
  3009. $this->assertCount(0, $collection->routes());
  3010. }
  3011. /**
  3012. * Test getting a route builder instance.
  3013. *
  3014. * @return void
  3015. */
  3016. public function testCreateRouteBuilder()
  3017. {
  3018. $builder = Router::createRouteBuilder('/api');
  3019. $this->assertInstanceOf(RouteBuilder::class, $builder);
  3020. $this->assertSame('/api', $builder->path());
  3021. $builder = Router::createRouteBuilder('/', [
  3022. 'routeClass' => 'InflectedRoute',
  3023. 'extensions' => ['json']
  3024. ]);
  3025. $this->assertInstanceOf(RouteBuilder::class, $builder);
  3026. $this->assertSame(['json'], $builder->getExtensions());
  3027. }
  3028. /**
  3029. * Connect some fallback routes for testing router behavior.
  3030. *
  3031. * @return void
  3032. */
  3033. protected function _connectDefaultRoutes()
  3034. {
  3035. Router::scope('/', function ($routes) {
  3036. $routes->fallbacks('InflectedRoute');
  3037. });
  3038. }
  3039. /**
  3040. * Helper to create a request for a given URL and method.
  3041. *
  3042. * @param string $url The URL to create a request for
  3043. * @param string $method The HTTP method to use.
  3044. * @return \Cake\Http\ServerRequest
  3045. */
  3046. protected function makeRequest($url, $method)
  3047. {
  3048. $request = new ServerRequest([
  3049. 'url' => $url,
  3050. 'environment' => ['REQUEST_METHOD' => $method],
  3051. ]);
  3052. return $request;
  3053. }
  3054. }