RouterTest.php 111 KB

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