RouterTest.php 109 KB

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