RouterTest.php 108 KB

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