RouterTest.php 108 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389
  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 ssl option when the current request is ssl.
  1826. *
  1827. * @return void
  1828. */
  1829. public function testGenerateWithSslInSsl()
  1830. {
  1831. Router::connect('/:controller/:action/*');
  1832. $request = new ServerRequest([
  1833. 'environment' => ['HTTP_HOST' => 'localhost', 'HTTPS' => 'on']
  1834. ]);
  1835. Router::pushRequest(
  1836. $request->addParams([
  1837. 'plugin' => null,
  1838. 'controller' => 'images',
  1839. 'action' => 'index'
  1840. ])->addPaths([
  1841. 'base' => '',
  1842. 'here' => '/images/index',
  1843. 'webroot' => '/',
  1844. ])
  1845. );
  1846. $result = Router::url([
  1847. '_ssl' => false
  1848. ]);
  1849. $this->assertEquals('http://localhost/images/index', $result);
  1850. $result = Router::url([
  1851. '_ssl' => true
  1852. ]);
  1853. $this->assertEquals('https://localhost/images/index', $result);
  1854. }
  1855. /**
  1856. * test that prefix routes persist when they are in the current request.
  1857. *
  1858. * @return void
  1859. */
  1860. public function testPrefixRoutePersistence()
  1861. {
  1862. Router::reload();
  1863. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1864. Router::connect('/:controller/:action');
  1865. $request = new ServerRequest();
  1866. Router::setRequestInfo(
  1867. $request->addParams([
  1868. 'plugin' => null,
  1869. 'controller' => 'images',
  1870. 'action' => 'index',
  1871. 'prefix' => 'protected',
  1872. ])->addPaths([
  1873. 'base' => '',
  1874. 'here' => '/protected/images/index',
  1875. 'webroot' => '/',
  1876. ])
  1877. );
  1878. $result = Router::url(['prefix' => 'protected', 'controller' => 'images', 'action' => 'add']);
  1879. $expected = '/protected/images/add';
  1880. $this->assertEquals($expected, $result);
  1881. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1882. $expected = '/protected/images/add';
  1883. $this->assertEquals($expected, $result);
  1884. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => false]);
  1885. $expected = '/images/add';
  1886. $this->assertEquals($expected, $result);
  1887. }
  1888. /**
  1889. * test that setting a prefix override the current one
  1890. *
  1891. * @return void
  1892. */
  1893. public function testPrefixOverride()
  1894. {
  1895. Router::connect('/admin/:controller/:action', ['prefix' => 'admin']);
  1896. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1897. $request = new ServerRequest();
  1898. Router::setRequestInfo(
  1899. $request->addParams([
  1900. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected',
  1901. ])->addPaths([
  1902. 'base' => '',
  1903. 'here' => '/protected/images/index',
  1904. 'webroot' => '/',
  1905. ])
  1906. );
  1907. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'admin']);
  1908. $expected = '/admin/images/add';
  1909. $this->assertEquals($expected, $result);
  1910. $request = new ServerRequest();
  1911. Router::setRequestInfo(
  1912. $request->addParams([
  1913. 'plugin' => null,
  1914. 'controller' => 'images',
  1915. 'action' => 'index',
  1916. 'prefix' => 'admin',
  1917. ])->addPaths([
  1918. 'base' => '',
  1919. 'here' => '/admin/images/index',
  1920. 'webroot' => '/',
  1921. ])
  1922. );
  1923. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1924. $expected = '/protected/images/add';
  1925. $this->assertEquals($expected, $result);
  1926. }
  1927. /**
  1928. * Test that well known route parameters are passed through.
  1929. *
  1930. * @return void
  1931. */
  1932. public function testRouteParamDefaults()
  1933. {
  1934. Router::connect('/cache/*', ['prefix' => false, 'plugin' => true, 'controller' => 0, 'action' => 1]);
  1935. $url = Router::url(['prefix' => 0, 'plugin' => 1, 'controller' => 0, 'action' => 1, 'test']);
  1936. $expected = '/cache/test';
  1937. $this->assertEquals($expected, $url);
  1938. try {
  1939. Router::url(['controller' => 0, 'action' => 1, 'test']);
  1940. $this->fail('No exception raised');
  1941. } catch (\Exception $e) {
  1942. $this->assertTrue(true, 'Exception was raised');
  1943. }
  1944. try {
  1945. Router::url(['prefix' => 1, 'controller' => 0, 'action' => 1, 'test']);
  1946. $this->fail('No exception raised');
  1947. } catch (\Exception $e) {
  1948. $this->assertTrue(true, 'Exception was raised');
  1949. }
  1950. }
  1951. /**
  1952. * testRemoveBase method
  1953. *
  1954. * @return void
  1955. */
  1956. public function testRemoveBase()
  1957. {
  1958. Router::connect('/:controller/:action');
  1959. $request = new ServerRequest();
  1960. Router::setRequestInfo(
  1961. $request->addParams([
  1962. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  1963. ])->addPaths([
  1964. 'base' => '/base',
  1965. 'here' => '/',
  1966. 'webroot' => '/base/',
  1967. ])
  1968. );
  1969. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action']);
  1970. $expected = '/base/my_controller/my_action';
  1971. $this->assertEquals($expected, $result);
  1972. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action', '_base' => false]);
  1973. $expected = '/my_controller/my_action';
  1974. $this->assertEquals($expected, $result);
  1975. }
  1976. /**
  1977. * testPagesUrlParsing method
  1978. *
  1979. * @return void
  1980. */
  1981. public function testPagesUrlParsing()
  1982. {
  1983. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  1984. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  1985. $result = Router::parse('/', 'GET');
  1986. $expected = [
  1987. 'pass' => ['home'],
  1988. 'plugin' => null,
  1989. 'controller' => 'pages',
  1990. 'action' => 'display',
  1991. '_matchedRoute' => '/'
  1992. ];
  1993. $this->assertEquals($expected, $result);
  1994. $result = Router::parse('/pages/home/', 'GET');
  1995. $expected = [
  1996. 'pass' => ['home'],
  1997. 'plugin' => null,
  1998. 'controller' => 'pages',
  1999. 'action' => 'display',
  2000. '_matchedRoute' => '/pages/*'
  2001. ];
  2002. $this->assertEquals($expected, $result);
  2003. Router::reload();
  2004. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  2005. $result = Router::parse('/', 'GET');
  2006. $expected = [
  2007. 'pass' => ['home'],
  2008. 'plugin' => null,
  2009. 'controller' => 'pages',
  2010. 'action' => 'display',
  2011. '_matchedRoute' => '/'
  2012. ];
  2013. $this->assertEquals($expected, $result);
  2014. Router::reload();
  2015. Router::connect('/', ['controller' => 'posts', 'action' => 'index']);
  2016. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  2017. $result = Router::parse('/pages/contact/', 'GET');
  2018. $expected = [
  2019. 'pass' => ['contact'],
  2020. 'plugin' => null,
  2021. 'controller' => 'pages',
  2022. 'action' => 'display',
  2023. '_matchedRoute' => '/pages/*'
  2024. ];
  2025. $this->assertEquals($expected, $result);
  2026. }
  2027. /**
  2028. * test that requests with a trailing dot don't loose the do.
  2029. *
  2030. * @return void
  2031. */
  2032. public function testParsingWithTrailingPeriod()
  2033. {
  2034. Router::reload();
  2035. Router::connect('/:controller/:action/*');
  2036. $result = Router::parse('/posts/view/something.', 'GET');
  2037. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2038. $result = Router::parse('/posts/view/something. . .', 'GET');
  2039. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2040. }
  2041. /**
  2042. * test that requests with a trailing dot don't loose the do.
  2043. *
  2044. * @return void
  2045. */
  2046. public function testParsingWithTrailingPeriodAndParseExtensions()
  2047. {
  2048. Router::reload();
  2049. Router::connect('/:controller/:action/*');
  2050. Router::extensions('json', false);
  2051. $result = Router::parse('/posts/view/something.', 'GET');
  2052. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2053. $result = Router::parse('/posts/view/something. . .', 'GET');
  2054. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2055. }
  2056. /**
  2057. * test that patterns work for :action
  2058. *
  2059. * @return void
  2060. */
  2061. public function testParsingWithPatternOnAction()
  2062. {
  2063. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2064. Router::connect(
  2065. '/blog/:action/*',
  2066. ['controller' => 'blog_posts'],
  2067. ['action' => 'other|actions']
  2068. );
  2069. $result = Router::parse('/blog/other', 'GET');
  2070. $expected = [
  2071. 'plugin' => null,
  2072. 'controller' => 'blog_posts',
  2073. 'action' => 'other',
  2074. 'pass' => [],
  2075. '_matchedRoute' => '/blog/:action/*'
  2076. ];
  2077. $this->assertEquals($expected, $result);
  2078. Router::parse('/blog/foobar', 'GET');
  2079. }
  2080. /**
  2081. * Test url() works with patterns on :action
  2082. *
  2083. * @return void
  2084. */
  2085. public function testUrlPatternOnAction()
  2086. {
  2087. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2088. Router::connect(
  2089. '/blog/:action/*',
  2090. ['controller' => 'blog_posts'],
  2091. ['action' => 'other|actions']
  2092. );
  2093. $result = Router::url(['controller' => 'blog_posts', 'action' => 'actions']);
  2094. $this->assertEquals('/blog/actions', $result);
  2095. $result = Router::url(['controller' => 'blog_posts', 'action' => 'foo']);
  2096. $this->assertEquals('/', $result);
  2097. }
  2098. /**
  2099. * testParsingWithLiteralPrefixes method
  2100. *
  2101. * @return void
  2102. */
  2103. public function testParsingWithLiteralPrefixes()
  2104. {
  2105. Router::reload();
  2106. $adminParams = ['prefix' => 'admin'];
  2107. Router::connect('/admin/:controller', $adminParams);
  2108. Router::connect('/admin/:controller/:action/*', $adminParams);
  2109. $request = new ServerRequest();
  2110. Router::setRequestInfo(
  2111. $request->addParams([
  2112. 'plugin' => null, 'controller' => 'controller', 'action' => 'index'
  2113. ])->addPaths([
  2114. 'base' => '/base',
  2115. 'here' => '/',
  2116. 'webroot' => '/base/',
  2117. ])
  2118. );
  2119. $result = Router::parse('/admin/posts/', 'GET');
  2120. $expected = [
  2121. 'pass' => [],
  2122. 'prefix' => 'admin',
  2123. 'plugin' => null,
  2124. 'controller' => 'posts',
  2125. 'action' => 'index',
  2126. '_matchedRoute' => '/admin/:controller'
  2127. ];
  2128. $this->assertEquals($expected, $result);
  2129. $result = Router::parse('/admin/posts', 'GET');
  2130. $this->assertEquals($expected, $result);
  2131. $result = Router::url(['prefix' => 'admin', 'controller' => 'posts']);
  2132. $expected = '/base/admin/posts';
  2133. $this->assertEquals($expected, $result);
  2134. Router::reload();
  2135. $prefixParams = ['prefix' => 'members'];
  2136. Router::connect('/members/:controller', $prefixParams);
  2137. Router::connect('/members/:controller/:action', $prefixParams);
  2138. Router::connect('/members/:controller/:action/*', $prefixParams);
  2139. $request = new ServerRequest();
  2140. Router::setRequestInfo(
  2141. $request->addParams([
  2142. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  2143. ])->addPaths([
  2144. 'base' => '/base',
  2145. 'here' => '/',
  2146. 'webroot' => '/',
  2147. ])
  2148. );
  2149. $result = Router::parse('/members/posts/index', 'GET');
  2150. $expected = [
  2151. 'pass' => [],
  2152. 'prefix' => 'members',
  2153. 'plugin' => null,
  2154. 'controller' => 'posts',
  2155. 'action' => 'index',
  2156. '_matchedRoute' => '/members/:controller/:action'
  2157. ];
  2158. $this->assertEquals($expected, $result);
  2159. $result = Router::url(['prefix' => 'members', 'controller' => 'users', 'action' => 'add']);
  2160. $expected = '/base/members/users/add';
  2161. $this->assertEquals($expected, $result);
  2162. }
  2163. /**
  2164. * Tests URL generation with flags and prefixes in and out of context
  2165. *
  2166. * @return void
  2167. */
  2168. public function testUrlWritingWithPrefixes()
  2169. {
  2170. Router::connect('/company/:controller/:action/*', ['prefix' => 'company']);
  2171. Router::connect('/:action', ['controller' => 'users']);
  2172. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => 'company']);
  2173. $expected = '/company/users/login';
  2174. $this->assertEquals($expected, $result);
  2175. $request = new ServerRequest();
  2176. Router::setRequestInfo(
  2177. $request->addParams([
  2178. 'plugin' => null,
  2179. 'controller' => 'users',
  2180. 'action' => 'login',
  2181. 'prefix' => 'company'
  2182. ])->addPaths([
  2183. 'base' => '/',
  2184. 'here' => '/',
  2185. 'webroot' => '/base/',
  2186. ])
  2187. );
  2188. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => false]);
  2189. $expected = '/login';
  2190. $this->assertEquals($expected, $result);
  2191. }
  2192. /**
  2193. * test url generation with prefixes and custom routes
  2194. *
  2195. * @return void
  2196. */
  2197. public function testUrlWritingWithPrefixesAndCustomRoutes()
  2198. {
  2199. Router::connect(
  2200. '/admin/login',
  2201. ['controller' => 'users', 'action' => 'login', 'prefix' => 'admin']
  2202. );
  2203. $request = new ServerRequest();
  2204. Router::setRequestInfo(
  2205. $request->addParams([
  2206. 'plugin' => null, 'controller' => 'posts', 'action' => 'index',
  2207. 'prefix' => 'admin'
  2208. ])->addPaths([
  2209. 'base' => '/',
  2210. 'here' => '/',
  2211. 'webroot' => '/',
  2212. ])
  2213. );
  2214. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2215. $this->assertEquals('/admin/login', $result);
  2216. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2217. $this->assertEquals('/admin/login', $result);
  2218. }
  2219. /**
  2220. * testPassedArgsOrder method
  2221. *
  2222. * @return void
  2223. */
  2224. public function testPassedArgsOrder()
  2225. {
  2226. Router::connect('/test-passed/*', ['controller' => 'pages', 'action' => 'display', 'home']);
  2227. Router::connect('/test2/*', ['controller' => 'pages', 'action' => 'display', 2]);
  2228. Router::connect('/test/*', ['controller' => 'pages', 'action' => 'display', 1]);
  2229. $result = Router::url(['controller' => 'pages', 'action' => 'display', 1, 'whatever']);
  2230. $expected = '/test/whatever';
  2231. $this->assertEquals($expected, $result);
  2232. $result = Router::url(['controller' => 'pages', 'action' => 'display', 2, 'whatever']);
  2233. $expected = '/test2/whatever';
  2234. $this->assertEquals($expected, $result);
  2235. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'home', 'whatever']);
  2236. $expected = '/test-passed/whatever';
  2237. $this->assertEquals($expected, $result);
  2238. }
  2239. /**
  2240. * testRegexRouteMatching method
  2241. *
  2242. * @return void
  2243. */
  2244. public function testRegexRouteMatching()
  2245. {
  2246. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2247. $result = Router::parse('/eng/test/test_action', 'GET');
  2248. $expected = [
  2249. 'pass' => [],
  2250. 'locale' => 'eng',
  2251. 'controller' => 'test',
  2252. 'action' => 'test_action',
  2253. 'plugin' => null,
  2254. '_matchedRoute' => '/:locale/:controller/:action/*'
  2255. ];
  2256. $this->assertEquals($expected, $result);
  2257. }
  2258. /**
  2259. * testRegexRouteMatching error
  2260. *
  2261. * @return void
  2262. */
  2263. public function testRegexRouteMatchingError()
  2264. {
  2265. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2266. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2267. Router::parse('/badness/test/test_action', 'GET');
  2268. }
  2269. /**
  2270. * testRegexRouteMatching method
  2271. *
  2272. * @return void
  2273. */
  2274. public function testRegexRouteMatchUrl()
  2275. {
  2276. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2277. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2278. $request = new ServerRequest();
  2279. Router::setRequestInfo(
  2280. $request->addParams([
  2281. 'plugin' => null,
  2282. 'controller' => 'test',
  2283. 'action' => 'index',
  2284. 'url' => ['url' => 'test/test_action']
  2285. ])->addPaths([
  2286. 'base' => '',
  2287. 'here' => '/test/test_action',
  2288. 'webroot' => '/',
  2289. ])
  2290. );
  2291. $result = Router::url(['action' => 'test_another_action', 'locale' => 'eng']);
  2292. $expected = '/eng/test/test_another_action';
  2293. $this->assertEquals($expected, $result);
  2294. $result = Router::url(['action' => 'test_another_action']);
  2295. $expected = '/';
  2296. $this->assertEquals($expected, $result);
  2297. }
  2298. /**
  2299. * test using a custom route class for route connection
  2300. *
  2301. * @return void
  2302. */
  2303. public function testUsingCustomRouteClass()
  2304. {
  2305. Plugin::load('TestPlugin');
  2306. Router::connect(
  2307. '/:slug',
  2308. ['plugin' => 'TestPlugin', 'action' => 'index'],
  2309. ['routeClass' => 'PluginShortRoute', 'slug' => '[a-z_-]+']
  2310. );
  2311. $result = Router::parse('/the-best', 'GET');
  2312. $expected = [
  2313. 'plugin' => 'TestPlugin',
  2314. 'controller' => 'TestPlugin',
  2315. 'action' => 'index',
  2316. 'slug' => 'the-best',
  2317. 'pass' => [],
  2318. '_matchedRoute' => '/:slug',
  2319. ];
  2320. $this->assertEquals($expected, $result);
  2321. }
  2322. /**
  2323. * test using custom route class in PluginDot notation
  2324. *
  2325. * @return void
  2326. */
  2327. public function testUsingCustomRouteClassPluginDotSyntax()
  2328. {
  2329. Plugin::load('TestPlugin');
  2330. Router::connect(
  2331. '/:slug',
  2332. ['controller' => 'posts', 'action' => 'view'],
  2333. ['routeClass' => 'TestPlugin.TestRoute', 'slug' => '[a-z_-]+']
  2334. );
  2335. $this->assertTrue(true); // Just to make sure the connect do not throw exception
  2336. Plugin::unload('TestPlugin');
  2337. }
  2338. /**
  2339. * test that route classes must extend \Cake\Routing\Route\Route
  2340. *
  2341. * @return void
  2342. */
  2343. public function testCustomRouteException()
  2344. {
  2345. $this->expectException(\InvalidArgumentException::class);
  2346. Router::connect('/:controller', [], ['routeClass' => 'Object']);
  2347. }
  2348. /**
  2349. * test reversing parameter arrays back into strings.
  2350. *
  2351. * Mark the router as initialized so it doesn't auto-load routes
  2352. *
  2353. * @return void
  2354. */
  2355. public function testReverseToken()
  2356. {
  2357. Router::connect('/:controller/:action/*');
  2358. $params = [
  2359. 'controller' => 'posts',
  2360. 'action' => 'view',
  2361. 'pass' => [1],
  2362. 'url' => [],
  2363. 'autoRender' => 1,
  2364. 'bare' => 1,
  2365. 'return' => 1,
  2366. 'requested' => 1,
  2367. '_Token' => ['key' => 'sekret']
  2368. ];
  2369. $result = Router::reverse($params);
  2370. $this->assertEquals('/posts/view/1', $result);
  2371. }
  2372. public function testReverseLocalized()
  2373. {
  2374. Router::reload();
  2375. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2376. $params = [
  2377. 'lang' => 'eng',
  2378. 'controller' => 'posts',
  2379. 'action' => 'view',
  2380. 'pass' => [1],
  2381. 'url' => ['url' => 'eng/posts/view/1']
  2382. ];
  2383. $result = Router::reverse($params);
  2384. $this->assertEquals('/eng/posts/view/1', $result);
  2385. }
  2386. public function testReverseArrayQuery()
  2387. {
  2388. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2389. $params = [
  2390. 'lang' => 'eng',
  2391. 'controller' => 'posts',
  2392. 'action' => 'view',
  2393. 1,
  2394. '?' => ['foo' => 'bar']
  2395. ];
  2396. $result = Router::reverse($params);
  2397. $this->assertEquals('/eng/posts/view/1?foo=bar', $result);
  2398. $params = [
  2399. 'lang' => 'eng',
  2400. 'controller' => 'posts',
  2401. 'action' => 'view',
  2402. 'pass' => [1],
  2403. 'url' => ['url' => 'eng/posts/view/1', 'foo' => 'bar', 'baz' => 'quu'],
  2404. 'paging' => [],
  2405. 'models' => []
  2406. ];
  2407. $result = Router::reverse($params);
  2408. $this->assertEquals('/eng/posts/view/1?foo=bar&baz=quu', $result);
  2409. }
  2410. public function testReverseCakeRequestQuery()
  2411. {
  2412. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2413. $request = new ServerRequest('/eng/posts/view/1');
  2414. $request->addParams([
  2415. 'lang' => 'eng',
  2416. 'controller' => 'posts',
  2417. 'action' => 'view',
  2418. 'pass' => [1],
  2419. ]);
  2420. $request->query = ['url' => 'eng/posts/view/1', 'test' => 'value'];
  2421. $result = Router::reverse($request);
  2422. $expected = '/eng/posts/view/1?test=value';
  2423. $this->assertEquals($expected, $result);
  2424. }
  2425. public function testReverseFull()
  2426. {
  2427. $params = [
  2428. 'lang' => 'eng',
  2429. 'controller' => 'posts',
  2430. 'action' => 'view',
  2431. 'pass' => [1],
  2432. 'url' => ['url' => 'eng/posts/view/1']
  2433. ];
  2434. $result = Router::reverse($params, true);
  2435. $this->assertRegExp('/^http(s)?:\/\//', $result);
  2436. }
  2437. /**
  2438. * Test that extensions work with Router::reverse()
  2439. *
  2440. * @return void
  2441. */
  2442. public function testReverseWithExtension()
  2443. {
  2444. Router::connect('/:controller/:action/*');
  2445. Router::extensions('json', false);
  2446. $request = new ServerRequest('/posts/view/1.json');
  2447. $request->addParams([
  2448. 'controller' => 'posts',
  2449. 'action' => 'view',
  2450. 'pass' => [1],
  2451. '_ext' => 'json',
  2452. ]);
  2453. $request->query = [];
  2454. $result = Router::reverse($request);
  2455. $expected = '/posts/view/1.json';
  2456. $this->assertEquals($expected, $result);
  2457. }
  2458. public function testReverseToArrayQuery()
  2459. {
  2460. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2461. $params = [
  2462. 'lang' => 'eng',
  2463. 'controller' => 'posts',
  2464. 'action' => 'view',
  2465. 'pass' => [123],
  2466. 'url' => ['url' => 'eng/posts/view/123', 'foo' => 'bar', 'baz' => 'quu'],
  2467. 'paging' => [],
  2468. 'models' => [],
  2469. ];
  2470. $actual = Router::reverseToArray($params);
  2471. $expected = [
  2472. 'lang' => 'eng',
  2473. 'controller' => 'posts',
  2474. 'action' => 'view',
  2475. 123,
  2476. '?' => ['foo' => 'bar', 'baz' => 'quu'],
  2477. ];
  2478. $this->assertEquals($expected, $actual);
  2479. }
  2480. public function testReverseToArrayRequestQuery()
  2481. {
  2482. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2483. $request = new ServerRequest('/eng/posts/view/1');
  2484. $request->addParams([
  2485. 'lang' => 'eng',
  2486. 'controller' => 'posts',
  2487. 'action' => 'view',
  2488. 'pass' => [123],
  2489. ]);
  2490. $request->query = ['url' => 'eng/posts/view/1', 'test' => 'value'];
  2491. $actual = Router::reverseToArray($request);
  2492. $expected = [
  2493. 'lang' => 'eng',
  2494. 'plugin' => null,
  2495. 'controller' => 'posts',
  2496. 'action' => 'view',
  2497. 123,
  2498. '_ext' => null,
  2499. '?' => [
  2500. 'test' => 'value',
  2501. ],
  2502. ];
  2503. $this->assertEquals($expected, $actual);
  2504. }
  2505. /**
  2506. * test that setRequestInfo can accept arrays and turn that into a Request object.
  2507. *
  2508. * @return void
  2509. */
  2510. public function testSetRequestInfoLegacy()
  2511. {
  2512. Router::setRequestInfo([
  2513. [
  2514. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  2515. 'url' => ['url' => 'protected/images/index']
  2516. ],
  2517. [
  2518. 'base' => '',
  2519. 'here' => '/protected/images/index',
  2520. 'webroot' => '/',
  2521. ]
  2522. ]);
  2523. $result = Router::getRequest();
  2524. $this->assertEquals('images', $result->controller);
  2525. $this->assertEquals('index', $result->action);
  2526. $this->assertEquals('', $result->base);
  2527. $this->assertEquals('/protected/images/index', $result->here);
  2528. $this->assertEquals('/', $result->webroot);
  2529. }
  2530. /**
  2531. * test get request.
  2532. *
  2533. * @return void
  2534. */
  2535. public function testGetRequest()
  2536. {
  2537. $requestA = new ServerRequest('/');
  2538. $requestB = new ServerRequest('/posts');
  2539. Router::pushRequest($requestA);
  2540. Router::pushRequest($requestB);
  2541. $this->assertSame($requestA, Router::getRequest(false));
  2542. $this->assertSame($requestB, Router::getRequest(true));
  2543. }
  2544. /**
  2545. * Test that Router::url() uses the first request
  2546. */
  2547. public function testUrlWithRequestAction()
  2548. {
  2549. Router::connect('/:controller', ['action' => 'index']);
  2550. Router::connect('/:controller/:action');
  2551. $firstRequest = new ServerRequest('/posts/index');
  2552. $firstRequest->addParams([
  2553. 'plugin' => null,
  2554. 'controller' => 'posts',
  2555. 'action' => 'index'
  2556. ])->addPaths(['base' => '']);
  2557. $secondRequest = new ServerRequest('/posts/index');
  2558. $secondRequest->addParams([
  2559. 'requested' => 1,
  2560. 'plugin' => null,
  2561. 'controller' => 'comments',
  2562. 'action' => 'listing'
  2563. ])->addPaths(['base' => '']);
  2564. Router::setRequestInfo($firstRequest);
  2565. Router::setRequestInfo($secondRequest);
  2566. $result = Router::url(['_base' => false]);
  2567. $this->assertEquals('/comments/listing', $result, 'with second requests, the last should win.');
  2568. Router::popRequest();
  2569. $result = Router::url(['_base' => false]);
  2570. $this->assertEquals('/posts', $result, 'with second requests, the last should win.');
  2571. // Make sure that popping an empty request doesn't fail.
  2572. Router::popRequest();
  2573. }
  2574. /**
  2575. * test that a route object returning a full URL is not modified.
  2576. *
  2577. * @return void
  2578. */
  2579. public function testUrlFullUrlReturnFromRoute()
  2580. {
  2581. $url = 'http://example.com/posts/view/1';
  2582. $route = $this->getMockBuilder('Cake\Routing\Route\Route')
  2583. ->setMethods(['match'])
  2584. ->setConstructorArgs(['/:controller/:action/*'])
  2585. ->getMock();
  2586. $route->expects($this->any())
  2587. ->method('match')
  2588. ->will($this->returnValue($url));
  2589. Router::connect($route);
  2590. $result = Router::url(['controller' => 'posts', 'action' => 'view', 1]);
  2591. $this->assertEquals($url, $result);
  2592. }
  2593. /**
  2594. * test protocol in url
  2595. *
  2596. * @return void
  2597. */
  2598. public function testUrlProtocol()
  2599. {
  2600. $url = 'http://example.com';
  2601. $this->assertEquals($url, Router::url($url));
  2602. $url = 'ed2k://example.com';
  2603. $this->assertEquals($url, Router::url($url));
  2604. $url = 'svn+ssh://example.com';
  2605. $this->assertEquals($url, Router::url($url));
  2606. $url = '://example.com';
  2607. $this->assertEquals($url, Router::url($url));
  2608. $url = '//example.com';
  2609. $this->assertEquals($url, Router::url($url));
  2610. $url = 'javascript:void(0)';
  2611. $this->assertEquals($url, Router::url($url));
  2612. $url = 'tel:012345-678';
  2613. $this->assertEquals($url, Router::url($url));
  2614. $url = 'sms:012345-678';
  2615. $this->assertEquals($url, Router::url($url));
  2616. $url = '#here';
  2617. $this->assertEquals($url, Router::url($url));
  2618. $url = '?param=0';
  2619. $this->assertEquals($url, Router::url($url));
  2620. $url = '/posts/index#here';
  2621. $expected = Configure::read('App.fullBaseUrl') . '/posts/index#here';
  2622. $this->assertEquals($expected, Router::url($url, true));
  2623. }
  2624. /**
  2625. * Testing that patterns on the :action param work properly.
  2626. *
  2627. * @return void
  2628. */
  2629. public function testPatternOnAction()
  2630. {
  2631. $route = new Route(
  2632. '/blog/:action/*',
  2633. ['controller' => 'blog_posts'],
  2634. ['action' => 'other|actions']
  2635. );
  2636. $result = $route->match(['controller' => 'blog_posts', 'action' => 'foo']);
  2637. $this->assertFalse($result);
  2638. $result = $route->match(['controller' => 'blog_posts', 'action' => 'actions']);
  2639. $this->assertEquals('/blog/actions/', $result);
  2640. $result = $route->parse('/blog/other', 'GET');
  2641. $expected = [
  2642. 'controller' => 'blog_posts',
  2643. 'action' => 'other',
  2644. 'pass' => [],
  2645. '_matchedRoute' => '/blog/:action/*',
  2646. ];
  2647. $this->assertEquals($expected, $result);
  2648. $result = $route->parse('/blog/foobar', 'GET');
  2649. $this->assertFalse($result);
  2650. }
  2651. /**
  2652. * Test that redirect() works.
  2653. *
  2654. * @return void
  2655. */
  2656. public function testRedirect()
  2657. {
  2658. Router::redirect('/mobile', '/', ['status' => 301]);
  2659. $routes = Router::routes();
  2660. $route = $routes[0];
  2661. $this->assertInstanceOf('Cake\Routing\Route\RedirectRoute', $route);
  2662. }
  2663. /**
  2664. * Test that redirect() works with another route class.
  2665. *
  2666. * @return void
  2667. */
  2668. public function testRedirectWithAnotherRouteClass()
  2669. {
  2670. $route1 = $this->getMockBuilder('Cake\Routing\Route\RedirectRoute')
  2671. ->setConstructorArgs(['/mobile\''])
  2672. ->setMethods(['parse'])
  2673. ->getMock();
  2674. $class = '\\' . get_class($route1);
  2675. Router::redirect('/mobile', '/', [
  2676. 'status' => 301,
  2677. 'routeClass' => $class
  2678. ]);
  2679. $routes = Router::routes();
  2680. $route = $routes[0];
  2681. $this->assertInstanceOf($class, $route);
  2682. }
  2683. /**
  2684. * Test that the compatibility method for incoming urls works.
  2685. *
  2686. * @return void
  2687. */
  2688. public function testParseNamedParameters()
  2689. {
  2690. $request = new ServerRequest();
  2691. $request->addParams([
  2692. 'controller' => 'posts',
  2693. 'action' => 'index',
  2694. ]);
  2695. $result = Router::parseNamedParams($request);
  2696. $this->assertSame([], $result->params['named']);
  2697. $request = new ServerRequest();
  2698. $request->addParams([
  2699. 'controller' => 'posts',
  2700. 'action' => 'index',
  2701. 'pass' => ['home', 'one:two', 'three:four', 'five[nested][0]:six', 'five[nested][1]:seven']
  2702. ]);
  2703. Router::parseNamedParams($request);
  2704. $expected = [
  2705. 'plugin' => null,
  2706. 'controller' => 'posts',
  2707. 'action' => 'index',
  2708. '_ext' => null,
  2709. 'pass' => ['home'],
  2710. 'named' => [
  2711. 'one' => 'two',
  2712. 'three' => 'four',
  2713. 'five' => [
  2714. 'nested' => ['six', 'seven']
  2715. ]
  2716. ]
  2717. ];
  2718. $this->assertEquals($expected, $request->params);
  2719. }
  2720. /**
  2721. * Test the scope() method
  2722. *
  2723. * @return void
  2724. */
  2725. public function testScope()
  2726. {
  2727. Router::scope('/path', ['param' => 'value'], function ($routes) {
  2728. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2729. $this->assertEquals('/path', $routes->path());
  2730. $this->assertEquals(['param' => 'value'], $routes->params());
  2731. $this->assertEquals('', $routes->namePrefix());
  2732. $routes->connect('/articles', ['controller' => 'Articles']);
  2733. });
  2734. }
  2735. /**
  2736. * Test the scope() method
  2737. *
  2738. * @return void
  2739. */
  2740. public function testScopeError()
  2741. {
  2742. $this->expectException(\InvalidArgumentException::class);
  2743. Router::scope('/path', 'derpy');
  2744. }
  2745. /**
  2746. * Test to ensure that extensions defined in scopes don't leak.
  2747. * And that global extensions are propagated.
  2748. *
  2749. * @return void
  2750. */
  2751. public function testScopeExtensionsContained()
  2752. {
  2753. Router::extensions(['json']);
  2754. Router::scope('/', function ($routes) {
  2755. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2756. $routes->setExtensions(['rss']);
  2757. $this->assertEquals(
  2758. ['rss'],
  2759. $routes->getExtensions(),
  2760. 'Should include new extensions.'
  2761. );
  2762. $routes->connect('/home', []);
  2763. });
  2764. $this->assertEquals(['json', 'rss'], array_values(Router::extensions()));
  2765. Router::scope('/api', function ($routes) {
  2766. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2767. $routes->setExtensions(['json', 'csv']);
  2768. $routes->connect('/export', []);
  2769. $routes->scope('/v1', function ($routes) {
  2770. $this->assertEquals(['json', 'csv'], $routes->getExtensions());
  2771. });
  2772. });
  2773. $this->assertEquals(['json', 'rss', 'csv'], array_values(Router::extensions()));
  2774. }
  2775. /**
  2776. * Test the scope() options
  2777. *
  2778. * @return void
  2779. */
  2780. public function testScopeOptions()
  2781. {
  2782. $options = ['param' => 'value', 'routeClass' => 'InflectedRoute', 'extensions' => ['json']];
  2783. Router::scope('/path', $options, function ($routes) {
  2784. $this->assertSame('InflectedRoute', $routes->getRouteClass());
  2785. $this->assertSame(['json'], $routes->getExtensions());
  2786. $this->assertEquals('/path', $routes->path());
  2787. $this->assertEquals(['param' => 'value'], $routes->params());
  2788. });
  2789. }
  2790. /**
  2791. * Test the scope() method
  2792. *
  2793. * @return void
  2794. */
  2795. public function testScopeNamePrefix()
  2796. {
  2797. Router::scope('/path', ['param' => 'value', '_namePrefix' => 'path:'], function ($routes) {
  2798. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2799. $this->assertEquals('/path', $routes->path());
  2800. $this->assertEquals(['param' => 'value'], $routes->params());
  2801. $this->assertEquals('path:', $routes->namePrefix());
  2802. $routes->connect('/articles', ['controller' => 'Articles']);
  2803. });
  2804. }
  2805. /**
  2806. * Test that prefix() creates a scope.
  2807. *
  2808. * @return void
  2809. */
  2810. public function testPrefix()
  2811. {
  2812. Router::prefix('admin', function ($routes) {
  2813. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2814. $this->assertEquals('/admin', $routes->path());
  2815. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2816. });
  2817. Router::prefix('admin', ['_namePrefix' => 'admin:'], function ($routes) {
  2818. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2819. $this->assertEquals('admin:', $routes->namePrefix());
  2820. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2821. });
  2822. }
  2823. /**
  2824. * Test that prefix() accepts options
  2825. *
  2826. * @return void
  2827. */
  2828. public function testPrefixOptions()
  2829. {
  2830. Router::prefix('admin', ['param' => 'value'], function ($routes) {
  2831. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2832. $this->assertEquals('/admin', $routes->path());
  2833. $this->assertEquals(['prefix' => 'admin', 'param' => 'value'], $routes->params());
  2834. });
  2835. Router::prefix('CustomPath', ['path' => '/custom-path'], function ($routes) {
  2836. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2837. $this->assertEquals('/custom-path', $routes->path());
  2838. $this->assertEquals(['prefix' => 'custom_path'], $routes->params());
  2839. });
  2840. }
  2841. /**
  2842. * Test that plugin() creates a scope.
  2843. *
  2844. * @return void
  2845. */
  2846. public function testPlugin()
  2847. {
  2848. Router::plugin('DebugKit', function ($routes) {
  2849. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2850. $this->assertEquals('/debug_kit', $routes->path());
  2851. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2852. });
  2853. }
  2854. /**
  2855. * Test that plugin() accepts options
  2856. *
  2857. * @return void
  2858. */
  2859. public function testPluginOptions()
  2860. {
  2861. Router::plugin('DebugKit', ['path' => '/debugger'], function ($routes) {
  2862. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2863. $this->assertEquals('/debugger', $routes->path());
  2864. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2865. });
  2866. Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function ($routes) {
  2867. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2868. $this->assertEquals('contacts:', $routes->namePrefix());
  2869. });
  2870. }
  2871. /**
  2872. * Test setting default route class.
  2873. *
  2874. * @return void
  2875. */
  2876. public function testDefaultRouteClass()
  2877. {
  2878. Router::connect('/:controller', ['action' => 'index']);
  2879. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2880. $this->assertEquals('/FooBar', $result);
  2881. // This is needed because tests/boostrap.php sets App.namespace to 'App'
  2882. static::setAppNamespace();
  2883. Router::defaultRouteClass('DashedRoute');
  2884. Router::connect('/cake/:controller', ['action' => 'cake']);
  2885. $result = Router::url(['controller' => 'FooBar', 'action' => 'cake']);
  2886. $this->assertEquals('/cake/foo-bar', $result);
  2887. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2888. $this->assertEquals('/FooBar', $result);
  2889. Router::reload();
  2890. Router::defaultRouteClass('DashedRoute');
  2891. Router::scope('/', function ($routes) {
  2892. $routes->fallbacks();
  2893. });
  2894. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2895. $this->assertEquals('/foo-bar', $result);
  2896. }
  2897. /**
  2898. * Test generation of routes with collisions between the query string
  2899. * and other url params
  2900. *
  2901. * @return void
  2902. */
  2903. public function testUrlWithCollidingQueryString()
  2904. {
  2905. Router::connect('/:controller/:action/:id');
  2906. $query = ['controller' => 'Foo', 'action' => 'bar', 'id' => 100];
  2907. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  2908. $this->assertEquals('/posts/view/1?controller=Foo&action=bar&id=100', $result);
  2909. $query = ['_host' => 'foo.bar', '_ssl' => 0, '_scheme' => 'ftp://', '_base' => 'baz', '_port' => '15'];
  2910. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  2911. $this->assertEquals('/posts/view/1?_host=foo.bar&_ssl=0&_scheme=ftp%3A%2F%2F&_base=baz&_port=15', $result);
  2912. }
  2913. /**
  2914. * Test setting the request context.
  2915. *
  2916. * @return void
  2917. */
  2918. public function testSetRequestContextCakePHP()
  2919. {
  2920. Router::connect('/:controller/:action/*');
  2921. $request = new ServerRequest([
  2922. 'base' => '/subdir',
  2923. 'url' => 'articles/view/1'
  2924. ]);
  2925. Router::setRequestContext($request);
  2926. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2927. $this->assertEquals('/subdir/things/add', $result);
  2928. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2929. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2930. $result = Router::url('/pages/home');
  2931. $this->assertEquals('/subdir/pages/home', $result);
  2932. }
  2933. /**
  2934. * Test setting the request context.
  2935. *
  2936. * @return void
  2937. */
  2938. public function testSetRequestContextPsr()
  2939. {
  2940. $server = [
  2941. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  2942. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  2943. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  2944. 'REQUEST_URI' => '/subdir/articles/view/1',
  2945. 'QUERY_STRING' => '',
  2946. 'SERVER_PORT' => 80,
  2947. ];
  2948. Router::connect('/:controller/:action/*');
  2949. $request = ServerRequestFactory::fromGlobals($server);
  2950. Router::setRequestContext($request);
  2951. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2952. $this->assertEquals('/subdir/things/add', $result);
  2953. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2954. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2955. $result = Router::url('/pages/home');
  2956. $this->assertEquals('/subdir/pages/home', $result);
  2957. }
  2958. /**
  2959. * Test getting the route collection
  2960. *
  2961. * @return void
  2962. */
  2963. public function testGetRouteCollection()
  2964. {
  2965. $collection = Router::getRouteCollection();
  2966. $this->assertInstanceOf(RouteCollection::class, $collection);
  2967. $this->assertCount(0, $collection->routes());
  2968. }
  2969. /**
  2970. * Test getting a route builder instance.
  2971. *
  2972. * @return void
  2973. */
  2974. public function testCreateRouteBuilder()
  2975. {
  2976. $builder = Router::createRouteBuilder('/api');
  2977. $this->assertInstanceOf(RouteBuilder::class, $builder);
  2978. $this->assertSame('/api', $builder->path());
  2979. $builder = Router::createRouteBuilder('/', [
  2980. 'routeClass' => 'InflectedRoute',
  2981. 'extensions' => ['json']
  2982. ]);
  2983. $this->assertInstanceOf(RouteBuilder::class, $builder);
  2984. $this->assertSame(['json'], $builder->getExtensions());
  2985. }
  2986. /**
  2987. * Connect some fallback routes for testing router behavior.
  2988. *
  2989. * @return void
  2990. */
  2991. protected function _connectDefaultRoutes()
  2992. {
  2993. Router::scope('/', function ($routes) {
  2994. $routes->fallbacks('InflectedRoute');
  2995. });
  2996. }
  2997. }