RouterTest.php 114 KB

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