RouterTest.php 113 KB

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