RoutingRouteTest.php 83 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366
  1. <?php
  2. namespace Illuminate\Tests\Routing;
  3. use Closure;
  4. use DateTime;
  5. use Exception;
  6. use Illuminate\Auth\Middleware\Authenticate;
  7. use Illuminate\Auth\Middleware\Authorize;
  8. use Illuminate\Container\Container;
  9. use Illuminate\Contracts\Routing\Registrar;
  10. use Illuminate\Contracts\Support\Responsable;
  11. use Illuminate\Database\Eloquent\Model;
  12. use Illuminate\Database\Eloquent\ModelNotFoundException;
  13. use Illuminate\Events\Dispatcher;
  14. use Illuminate\Http\Exceptions\HttpResponseException;
  15. use Illuminate\Http\JsonResponse;
  16. use Illuminate\Http\RedirectResponse;
  17. use Illuminate\Http\Request;
  18. use Illuminate\Http\Response;
  19. use Illuminate\Routing\Controller;
  20. use Illuminate\Routing\Exceptions\UrlGenerationException;
  21. use Illuminate\Routing\Middleware\SubstituteBindings;
  22. use Illuminate\Routing\ResourceRegistrar;
  23. use Illuminate\Routing\Route;
  24. use Illuminate\Routing\RouteCollection;
  25. use Illuminate\Routing\RouteGroup;
  26. use Illuminate\Routing\Router;
  27. use Illuminate\Routing\UrlGenerator;
  28. use Illuminate\Support\Str;
  29. use LogicException;
  30. use PHPUnit\Framework\TestCase;
  31. use stdClass;
  32. use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
  33. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  34. use UnexpectedValueException;
  35. class RoutingRouteTest extends TestCase
  36. {
  37. public function testBasicDispatchingOfRoutes()
  38. {
  39. $router = $this->getRouter();
  40. $router->get('foo/bar', function () {
  41. return 'hello';
  42. });
  43. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  44. $router = $this->getRouter();
  45. $router->get('foo/bar', function () {
  46. throw new HttpResponseException(new Response('hello'));
  47. });
  48. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  49. $router = $this->getRouter();
  50. $router->get('foo/bar', ['domain' => 'api.{name}.bar', function ($name) {
  51. return $name;
  52. }]);
  53. $router->get('foo/bar', ['domain' => 'api.{name}.baz', function ($name) {
  54. return $name;
  55. }]);
  56. $this->assertSame('taylor', $router->dispatch(Request::create('http://api.taylor.bar/foo/bar', 'GET'))->getContent());
  57. $this->assertSame('dayle', $router->dispatch(Request::create('http://api.dayle.baz/foo/bar', 'GET'))->getContent());
  58. $router = $this->getRouter();
  59. $router->get('foo/{age}', ['domain' => 'api.{name}.bar', function ($name, $age) {
  60. return $name.$age;
  61. }]);
  62. $this->assertSame('taylor25', $router->dispatch(Request::create('http://api.taylor.bar/foo/25', 'GET'))->getContent());
  63. $router = $this->getRouter();
  64. $router->get('foo/bar', function () {
  65. return 'hello';
  66. });
  67. $router->post('foo/bar', function () {
  68. return 'post hello';
  69. });
  70. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  71. $this->assertSame('post hello', $router->dispatch(Request::create('foo/bar', 'POST'))->getContent());
  72. $router = $this->getRouter();
  73. $router->get('foo/{bar}', function ($name) {
  74. return $name;
  75. });
  76. $this->assertSame('taylor', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  77. $router = $this->getRouter();
  78. $router->get('foo/{bar}/{baz?}', function ($name, $age = 25) {
  79. return $name.$age;
  80. });
  81. $this->assertSame('taylor25', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  82. $router = $this->getRouter();
  83. $router->get('foo/{name}/boom/{age?}/{location?}', function ($name, $age = 25, $location = 'AR') {
  84. return $name.$age.$location;
  85. });
  86. $this->assertSame('taylor30AR', $router->dispatch(Request::create('foo/taylor/boom/30', 'GET'))->getContent());
  87. $router = $this->getRouter();
  88. $router->get('{bar}/{baz?}', function ($name, $age = 25) {
  89. return $name.$age;
  90. });
  91. $this->assertSame('taylor25', $router->dispatch(Request::create('taylor', 'GET'))->getContent());
  92. $router = $this->getRouter();
  93. $router->get('{baz?}', function ($age = 25) {
  94. return $age;
  95. });
  96. $this->assertSame('25', $router->dispatch(Request::create('/', 'GET'))->getContent());
  97. $this->assertSame('30', $router->dispatch(Request::create('30', 'GET'))->getContent());
  98. $router = $this->getRouter();
  99. $router->get('{foo?}/{baz?}', ['as' => 'foo', function ($name = 'taylor', $age = 25) {
  100. return $name.$age;
  101. }]);
  102. $this->assertSame('taylor25', $router->dispatch(Request::create('/', 'GET'))->getContent());
  103. $this->assertSame('fred25', $router->dispatch(Request::create('fred', 'GET'))->getContent());
  104. $this->assertSame('fred30', $router->dispatch(Request::create('fred/30', 'GET'))->getContent());
  105. $this->assertTrue($router->currentRouteNamed('foo'));
  106. $this->assertTrue($router->currentRouteNamed('fo*'));
  107. $this->assertTrue($router->is('foo'));
  108. $this->assertTrue($router->is('foo', 'bar'));
  109. $this->assertFalse($router->is('bar'));
  110. $router = $this->getRouter();
  111. $router->get('foo/{file}', function ($file) {
  112. return $file;
  113. });
  114. $this->assertSame('oxygen%20', $router->dispatch(Request::create('http://test.com/foo/oxygen%2520', 'GET'))->getContent());
  115. $router = $this->getRouter();
  116. $router->patch('foo/bar', ['as' => 'foo', function () {
  117. return 'bar';
  118. }]);
  119. $this->assertSame('bar', $router->dispatch(Request::create('foo/bar', 'PATCH'))->getContent());
  120. $this->assertSame('foo', $router->currentRouteName());
  121. $router = $this->getRouter();
  122. $router->get('foo/bar', function () {
  123. return 'hello';
  124. });
  125. $this->assertEmpty($router->dispatch(Request::create('foo/bar', 'HEAD'))->getContent());
  126. $router = $this->getRouter();
  127. $router->any('foo/bar', function () {
  128. return 'hello';
  129. });
  130. $this->assertEmpty($router->dispatch(Request::create('foo/bar', 'HEAD'))->getContent());
  131. $router = $this->getRouter();
  132. $router->get('foo/bar', function () {
  133. return 'first';
  134. });
  135. $router->get('foo/bar', function () {
  136. return 'second';
  137. });
  138. $this->assertSame('second', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  139. $router = $this->getRouter();
  140. $router->get('foo/bar/åαф', function () {
  141. return 'hello';
  142. });
  143. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar/%C3%A5%CE%B1%D1%84', 'GET'))->getContent());
  144. $router = $this->getRouter();
  145. $router->get('foo/bar', ['boom' => 'auth', function () {
  146. return 'closure';
  147. }]);
  148. $this->assertSame('closure', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  149. }
  150. public function testNotModifiedResponseIsProperlyReturned()
  151. {
  152. $router = $this->getRouter();
  153. $router->get('test', function () {
  154. return (new SymfonyResponse('test', 304, ['foo' => 'bar']))->setLastModified(new DateTime);
  155. });
  156. $response = $router->dispatch(Request::create('test', 'GET'));
  157. $this->assertSame(304, $response->getStatusCode());
  158. $this->assertEmpty($response->getContent());
  159. $this->assertSame('bar', $response->headers->get('foo'));
  160. $this->assertNull($response->getLastModified());
  161. }
  162. public function testClosureMiddleware()
  163. {
  164. $router = $this->getRouter();
  165. $middleware = function ($request, $next) {
  166. return 'caught';
  167. };
  168. $router->get('foo/bar', ['middleware' => $middleware, function () {
  169. return 'hello';
  170. }]);
  171. $this->assertSame('caught', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  172. }
  173. public function testMiddlewareCanBeSkipped()
  174. {
  175. $router = $this->getRouter();
  176. $router->aliasMiddleware('web', RoutingTestMiddlewareGroupTwo::class);
  177. $router->get('foo/bar', ['middleware' => 'web', function () {
  178. return 'hello';
  179. }])->withoutMiddleware(RoutingTestMiddlewareGroupTwo::class);
  180. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  181. }
  182. public function testMiddlewareCanBeSkippedFromResources()
  183. {
  184. $router = $this->getRouter();
  185. $router->aliasMiddleware('web', RoutingTestMiddlewareGroupTwo::class);
  186. $router->resource('foo', RouteTestControllerMiddlewareGroupStub::class)
  187. ->middleware('web')
  188. ->withoutMiddleware(RoutingTestMiddlewareGroupTwo::class);
  189. $this->assertSame('Hello World', $router->dispatch(Request::create('foo', 'GET'))->getContent());
  190. }
  191. public function testMiddlewareWorksIfControllerThrowsHttpResponseException()
  192. {
  193. // Before calling controller
  194. $router = $this->getRouter();
  195. $middleware = function ($request, $next) {
  196. return 'caught';
  197. };
  198. $router->get('foo/bar', ['middleware' => $middleware, function () {
  199. throw new HttpResponseException(new Response('hello'));
  200. }]);
  201. $response = $router->dispatch(Request::create('foo/bar', 'GET'))->getContent();
  202. $this->assertSame('caught', $response);
  203. // After calling controller
  204. $router = $this->getRouter();
  205. $response = new Response('hello');
  206. $middleware = function ($request, $next) use ($response) {
  207. $this->assertSame($response, $next($request));
  208. return new Response($response->getContent().' caught');
  209. };
  210. $router->get('foo/bar', ['middleware' => $middleware, function () use ($response) {
  211. throw new HttpResponseException($response);
  212. }]);
  213. $response = $router->dispatch(Request::create('foo/bar', 'GET'))->getContent();
  214. $this->assertSame('hello caught', $response);
  215. }
  216. public function testReturnsResponseWhenMiddlewareReturnsResponsable()
  217. {
  218. $router = $this->getRouter();
  219. $router->get('foo/bar', [
  220. 'uses' => RouteTestClosureMiddlewareController::class.'@index',
  221. 'middleware' => ['foo', 'bar', 'baz'],
  222. ]);
  223. $router->aliasMiddleware('foo', function ($request, $next) {
  224. return $next($request);
  225. });
  226. $router->aliasMiddleware('bar', function ($request, $next) {
  227. return new ResponsableResponse;
  228. });
  229. $router->aliasMiddleware('baz', function ($request, $next) {
  230. return $next($request);
  231. });
  232. $this->assertSame(
  233. 'bar',
  234. $router->dispatch(Request::create('foo/bar', 'GET'))->getContent()
  235. );
  236. }
  237. public function testDefinedClosureMiddleware()
  238. {
  239. $router = $this->getRouter();
  240. $router->get('foo/bar', ['middleware' => 'foo', function () {
  241. return 'hello';
  242. }]);
  243. $router->aliasMiddleware('foo', function ($request, $next) {
  244. return 'caught';
  245. });
  246. $this->assertSame('caught', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  247. }
  248. public function testControllerClosureMiddleware()
  249. {
  250. $router = $this->getRouter();
  251. $router->get('foo/bar', [
  252. 'uses' => RouteTestClosureMiddlewareController::class.'@index',
  253. 'middleware' => 'foo',
  254. ]);
  255. $router->aliasMiddleware('foo', function ($request, $next) {
  256. $request['foo-middleware'] = 'foo-middleware';
  257. return $next($request);
  258. });
  259. $this->assertSame(
  260. 'index-foo-middleware-controller-closure',
  261. $router->dispatch(Request::create('foo/bar', 'GET'))->getContent()
  262. );
  263. }
  264. public function testFluentRouting()
  265. {
  266. $this->expectException(LogicException::class);
  267. $this->expectExceptionMessage('Route for [foo/bar] has no action.');
  268. $router = $this->getRouter();
  269. $router->get('foo/bar')->uses(function () {
  270. return 'hello';
  271. });
  272. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  273. $router->post('foo/bar')->uses(function () {
  274. return 'hello';
  275. });
  276. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'POST'))->getContent());
  277. $router->get('foo/bar')->uses(function () {
  278. return 'middleware';
  279. })->middleware(RouteTestControllerMiddleware::class);
  280. $this->assertSame('middleware', $router->dispatch(Request::create('foo/bar'))->getContent());
  281. $this->assertContains(RouteTestControllerMiddleware::class, $router->getCurrentRoute()->middleware());
  282. $router->get('foo/bar');
  283. $router->dispatch(Request::create('foo/bar', 'GET'));
  284. }
  285. public function testFluentRoutingWithControllerAction()
  286. {
  287. $router = $this->getRouter();
  288. $router->get('foo/bar')->uses(RouteTestControllerStub::class.'@index');
  289. $this->assertSame('Hello World', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  290. $router = $this->getRouter();
  291. $router->group(['namespace' => 'App'], function ($router) {
  292. $router->get('foo/bar')->uses(RouteTestControllerStub::class.'@index');
  293. });
  294. $action = $router->getRoutes()->getRoutes()[0]->getAction();
  295. $this->assertSame('App\\'.RouteTestControllerStub::class.'@index', $action['controller']);
  296. }
  297. public function testMiddlewareGroups()
  298. {
  299. unset($_SERVER['__middleware.group']);
  300. $router = $this->getRouter();
  301. $router->get('foo/bar', ['middleware' => 'web', function () {
  302. return 'hello';
  303. }]);
  304. $router->aliasMiddleware('two', RoutingTestMiddlewareGroupTwo::class);
  305. $router->middlewareGroup('web', [RoutingTestMiddlewareGroupOne::class, 'two:taylor']);
  306. $this->assertSame('caught taylor', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  307. $this->assertTrue($_SERVER['__middleware.group']);
  308. unset($_SERVER['__middleware.group']);
  309. }
  310. public function testMiddlewareGroupsCanReferenceOtherGroups()
  311. {
  312. unset($_SERVER['__middleware.group']);
  313. $router = $this->getRouter();
  314. $router->get('foo/bar', ['middleware' => 'web', function () {
  315. return 'hello';
  316. }]);
  317. $router->aliasMiddleware('two', RoutingTestMiddlewareGroupTwo::class);
  318. $router->middlewareGroup('first', ['two:abigail']);
  319. $router->middlewareGroup('web', [RoutingTestMiddlewareGroupOne::class, 'first']);
  320. $this->assertSame('caught abigail', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  321. $this->assertTrue($_SERVER['__middleware.group']);
  322. unset($_SERVER['__middleware.group']);
  323. }
  324. public function testFluentRouteNamingWithinAGroup()
  325. {
  326. $router = $this->getRouter();
  327. $router->group(['as' => 'foo.'], function () use ($router) {
  328. $router->get('bar', function () {
  329. return 'bar';
  330. })->name('bar');
  331. });
  332. $this->assertSame('bar', $router->dispatch(Request::create('bar', 'GET'))->getContent());
  333. $this->assertSame('foo.bar', $router->currentRouteName());
  334. }
  335. public function testRouteGetAction()
  336. {
  337. $router = $this->getRouter();
  338. $route = $router->get('foo', function () {
  339. return 'foo';
  340. })->name('foo');
  341. $this->assertIsArray($route->getAction());
  342. $this->assertArrayHasKey('as', $route->getAction());
  343. $this->assertSame('foo', $route->getAction('as'));
  344. $this->assertNull($route->getAction('unknown_property'));
  345. }
  346. public function testResolvingBindingParameters()
  347. {
  348. $router = $this->getRouter();
  349. $route = $router->get('foo/{bar:slug}', function () {
  350. return 'foo';
  351. })->name('foo');
  352. $this->assertSame('slug', $route->bindingFieldFor('bar'));
  353. $route = $router->get('foo/{bar:slug}/{baz}', function () {
  354. return 'foo';
  355. })->name('foo');
  356. $this->assertNull($route->bindingFieldFor('baz'));
  357. }
  358. public function testMacro()
  359. {
  360. $router = $this->getRouter();
  361. $router->macro('webhook', function () use ($router) {
  362. $router->match(['GET', 'POST'], 'webhook', function () {
  363. return 'OK';
  364. });
  365. });
  366. $router->webhook();
  367. $this->assertSame('OK', $router->dispatch(Request::create('webhook', 'GET'))->getContent());
  368. $this->assertSame('OK', $router->dispatch(Request::create('webhook', 'POST'))->getContent());
  369. }
  370. public function testRouteMacro()
  371. {
  372. $router = $this->getRouter();
  373. Route::macro('breadcrumb', function ($breadcrumb) {
  374. $this->action['breadcrumb'] = $breadcrumb;
  375. return $this;
  376. });
  377. $router->get('foo', function () {
  378. return 'bar';
  379. })->breadcrumb('fooBreadcrumb')->name('foo');
  380. $router->getRoutes()->refreshNameLookups();
  381. $this->assertSame('fooBreadcrumb', $router->getRoutes()->getByName('foo')->getAction()['breadcrumb']);
  382. }
  383. public function testClassesCanBeInjectedIntoRoutes()
  384. {
  385. unset($_SERVER['__test.route_inject']);
  386. $router = $this->getRouter();
  387. $router->get('foo/{var}', function (stdClass $foo, $var) {
  388. $_SERVER['__test.route_inject'] = func_get_args();
  389. return 'hello';
  390. });
  391. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  392. $this->assertInstanceOf(stdClass::class, $_SERVER['__test.route_inject'][0]);
  393. $this->assertSame('bar', $_SERVER['__test.route_inject'][1]);
  394. unset($_SERVER['__test.route_inject']);
  395. }
  396. public function testNullValuesCanBeInjectedIntoRoutes()
  397. {
  398. $container = new Container;
  399. $router = new Router(new Dispatcher, $container);
  400. $container->singleton(Registrar::class, function () use ($router) {
  401. return $router;
  402. });
  403. $container->bind(RoutingTestUserModel::class, function () {
  404. });
  405. $router->get('foo/{team}/{post}', [
  406. 'middleware' => SubstituteBindings::class,
  407. 'uses' => function (?RoutingTestUserModel $userFromContainer, RoutingTestTeamModel $team, $postId) {
  408. $this->assertNull($userFromContainer);
  409. $this->assertInstanceOf(RoutingTestTeamModel::class, $team);
  410. $this->assertSame('bar', $team->value);
  411. $this->assertSame('baz', $postId);
  412. },
  413. ]);
  414. $router->dispatch(Request::create('foo/bar/baz', 'GET'))->getContent();
  415. }
  416. public function testOptionsResponsesAreGeneratedByDefault()
  417. {
  418. $router = $this->getRouter();
  419. $router->get('foo/bar', function () {
  420. return 'hello';
  421. });
  422. $router->post('foo/bar', function () {
  423. return 'hello';
  424. });
  425. $response = $router->dispatch(Request::create('foo/bar', 'OPTIONS'));
  426. $this->assertEquals(200, $response->getStatusCode());
  427. $this->assertSame('GET,HEAD,POST', $response->headers->get('Allow'));
  428. }
  429. public function testHeadDispatcher()
  430. {
  431. $router = $this->getRouter();
  432. $router->match(['GET', 'POST'], 'foo', function () {
  433. return 'bar';
  434. });
  435. $response = $router->dispatch(Request::create('foo', 'OPTIONS'));
  436. $this->assertEquals(200, $response->getStatusCode());
  437. $this->assertSame('GET,HEAD,POST', $response->headers->get('Allow'));
  438. $response = $router->dispatch(Request::create('foo', 'HEAD'));
  439. $this->assertEquals(200, $response->getStatusCode());
  440. $this->assertEmpty($response->getContent());
  441. $router = $this->getRouter();
  442. $router->match(['GET'], 'foo', function () {
  443. return 'bar';
  444. });
  445. $response = $router->dispatch(Request::create('foo', 'OPTIONS'));
  446. $this->assertEquals(200, $response->getStatusCode());
  447. $this->assertSame('GET,HEAD', $response->headers->get('Allow'));
  448. $router = $this->getRouter();
  449. $router->match(['POST'], 'foo', function () {
  450. return 'bar';
  451. });
  452. $response = $router->dispatch(Request::create('foo', 'OPTIONS'));
  453. $this->assertEquals(200, $response->getStatusCode());
  454. $this->assertSame('POST', $response->headers->get('Allow'));
  455. }
  456. public function testNonGreedyMatches()
  457. {
  458. $route = new Route('GET', 'images/{id}.{ext}', function () {
  459. //
  460. });
  461. $request1 = Request::create('images/1.png', 'GET');
  462. $this->assertTrue($route->matches($request1));
  463. $route->bind($request1);
  464. $this->assertTrue($route->hasParameter('id'));
  465. $this->assertFalse($route->hasParameter('foo'));
  466. $this->assertSame('1', $route->parameter('id'));
  467. $this->assertSame('png', $route->parameter('ext'));
  468. $request2 = Request::create('images/12.png', 'GET');
  469. $this->assertTrue($route->matches($request2));
  470. $route->bind($request2);
  471. $this->assertSame('12', $route->parameter('id'));
  472. $this->assertSame('png', $route->parameter('ext'));
  473. // Test parameter() default value
  474. $route = new Route('GET', 'foo/{foo?}', function () {
  475. //
  476. });
  477. $request3 = Request::create('foo', 'GET');
  478. $this->assertTrue($route->matches($request3));
  479. $route->bind($request3);
  480. $this->assertSame('bar', $route->parameter('foo', 'bar'));
  481. }
  482. public function testRouteParametersDefaultValue()
  483. {
  484. $router = $this->getRouter();
  485. $router->get('foo/{bar?}', ['uses' => RouteTestControllerWithParameterStub::class.'@returnParameter'])->defaults('bar', 'foo');
  486. $this->assertSame('foo', $router->dispatch(Request::create('foo', 'GET'))->getContent());
  487. $router->get('foo/{bar?}', ['uses' => RouteTestControllerWithParameterStub::class.'@returnParameter'])->defaults('bar', 'foo');
  488. $this->assertSame('bar', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  489. $router->get('foo/{bar?}', function ($bar = '') {
  490. return $bar;
  491. })->defaults('bar', 'foo');
  492. $this->assertSame('foo', $router->dispatch(Request::create('foo', 'GET'))->getContent());
  493. }
  494. public function testControllerCallActionMethodParameters()
  495. {
  496. $router = $this->getRouter();
  497. // Has one argument but receives two
  498. unset($_SERVER['__test.controller_callAction_parameters']);
  499. $router->get(($str = Str::random()).'/{one}/{two}', RouteTestAnotherControllerWithParameterStub::class.'@oneArgument');
  500. $router->dispatch(Request::create($str.'/one/two', 'GET'));
  501. $this->assertEquals(['one' => 'one', 'two' => 'two'], $_SERVER['__test.controller_callAction_parameters']);
  502. // Has two arguments and receives two
  503. unset($_SERVER['__test.controller_callAction_parameters']);
  504. $router->get(($str = Str::random()).'/{one}/{two}', RouteTestAnotherControllerWithParameterStub::class.'@twoArguments');
  505. $router->dispatch(Request::create($str.'/one/two', 'GET'));
  506. $this->assertEquals(['one' => 'one', 'two' => 'two'], $_SERVER['__test.controller_callAction_parameters']);
  507. // Has two arguments but with different names from the ones passed from the route
  508. unset($_SERVER['__test.controller_callAction_parameters']);
  509. $router->get(($str = Str::random()).'/{one}/{two}', RouteTestAnotherControllerWithParameterStub::class.'@differentArgumentNames');
  510. $router->dispatch(Request::create($str.'/one/two', 'GET'));
  511. $this->assertEquals(['one' => 'one', 'two' => 'two'], $_SERVER['__test.controller_callAction_parameters']);
  512. // Has two arguments with same name but argument order is reversed
  513. unset($_SERVER['__test.controller_callAction_parameters']);
  514. $router->get(($str = Str::random()).'/{one}/{two}', RouteTestAnotherControllerWithParameterStub::class.'@reversedArguments');
  515. $router->dispatch(Request::create($str.'/one/two', 'GET'));
  516. $this->assertEquals(['one' => 'one', 'two' => 'two'], $_SERVER['__test.controller_callAction_parameters']);
  517. // No route parameters while method has parameters
  518. unset($_SERVER['__test.controller_callAction_parameters']);
  519. $router->get(($str = Str::random()).'', RouteTestAnotherControllerWithParameterStub::class.'@oneArgument');
  520. $router->dispatch(Request::create($str, 'GET'));
  521. $this->assertEquals([], $_SERVER['__test.controller_callAction_parameters']);
  522. // With model bindings
  523. unset($_SERVER['__test.controller_callAction_parameters']);
  524. $router->get(($str = Str::random()).'/{user}/{defaultNull?}/{team?}', [
  525. 'middleware' => SubstituteBindings::class,
  526. 'uses' => RouteTestAnotherControllerWithParameterStub::class.'@withModels',
  527. ]);
  528. $router->dispatch(Request::create($str.'/1', 'GET'));
  529. $values = array_values($_SERVER['__test.controller_callAction_parameters']);
  530. $this->assertInstanceOf(Request::class, $values[0]);
  531. $this->assertEquals(1, $values[1]->value);
  532. $this->assertNull($values[2]);
  533. $this->assertNull($values[3]);
  534. }
  535. public function testLeadingParamDoesntReceiveForwardSlashOnEmptyPath()
  536. {
  537. $router = $this->getRouter();
  538. $outer_one = 'abc1234'; // a string that is not one we're testing
  539. $router->get('{one?}', [
  540. 'uses' => function ($one = null) use (&$outer_one) {
  541. $outer_one = $one;
  542. return $one;
  543. },
  544. 'where' => ['one' => '(.+)'],
  545. ]);
  546. $this->assertSame('', $router->dispatch(Request::create(''))->getContent());
  547. $this->assertNull($outer_one);
  548. // Expects: '' ($one === null)
  549. // Actual: '/' ($one === '/')
  550. $this->assertSame('foo', $router->dispatch(Request::create('/foo', 'GET'))->getContent());
  551. $this->assertSame('foo/bar/baz', $router->dispatch(Request::create('/foo/bar/baz', 'GET'))->getContent());
  552. }
  553. public function testRoutesDontMatchNonMatchingPathsWithLeadingOptionals()
  554. {
  555. $this->expectException(NotFoundHttpException::class);
  556. $router = $this->getRouter();
  557. $router->get('{baz?}', function ($age = 25) {
  558. return $age;
  559. });
  560. $this->assertSame('25', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  561. }
  562. public function testRoutesDontMatchNonMatchingDomain()
  563. {
  564. $this->expectException(NotFoundHttpException::class);
  565. $router = $this->getRouter();
  566. $router->get('foo/bar', ['domain' => 'api.foo.bar', function () {
  567. return 'hello';
  568. }]);
  569. $this->assertSame('hello', $router->dispatch(Request::create('http://api.baz.boom/foo/bar', 'GET'))->getContent());
  570. }
  571. public function testRouteDomainRegistration()
  572. {
  573. $router = $this->getRouter();
  574. $router->get('/foo/bar')->domain('api.foo.bar')->uses(function () {
  575. return 'hello';
  576. });
  577. $this->assertSame('hello', $router->dispatch(Request::create('http://api.foo.bar/foo/bar', 'GET'))->getContent());
  578. }
  579. public function testMatchesMethodAgainstRequests()
  580. {
  581. /*
  582. * Basic
  583. */
  584. $request = Request::create('foo/bar', 'GET');
  585. $route = new Route('GET', 'foo/{bar}', function () {
  586. //
  587. });
  588. $this->assertTrue($route->matches($request));
  589. $request = Request::create('foo/bar', 'GET');
  590. $route = new Route('GET', 'foo', function () {
  591. //
  592. });
  593. $this->assertFalse($route->matches($request));
  594. /*
  595. * Method checks
  596. */
  597. $request = Request::create('foo/bar', 'GET');
  598. $route = new Route('GET', 'foo/{bar}', function () {
  599. //
  600. });
  601. $this->assertTrue($route->matches($request));
  602. $request = Request::create('foo/bar', 'POST');
  603. $route = new Route('GET', 'foo', function () {
  604. //
  605. });
  606. $this->assertFalse($route->matches($request));
  607. /*
  608. * Domain checks
  609. */
  610. $request = Request::create('http://something.foo.com/foo/bar', 'GET');
  611. $route = new Route('GET', 'foo/{bar}', ['domain' => '{foo}.foo.com', function () {
  612. //
  613. }]);
  614. $this->assertTrue($route->matches($request));
  615. $request = Request::create('http://something.bar.com/foo/bar', 'GET');
  616. $route = new Route('GET', 'foo/{bar}', ['domain' => '{foo}.foo.com', function () {
  617. //
  618. }]);
  619. $this->assertFalse($route->matches($request));
  620. /*
  621. * HTTPS checks
  622. */
  623. $request = Request::create('https://foo.com/foo/bar', 'GET');
  624. $route = new Route('GET', 'foo/{bar}', ['https', function () {
  625. //
  626. }]);
  627. $this->assertTrue($route->matches($request));
  628. $request = Request::create('https://foo.com/foo/bar', 'GET');
  629. $route = new Route('GET', 'foo/{bar}', ['https', 'baz' => true, function () {
  630. //
  631. }]);
  632. $this->assertTrue($route->matches($request));
  633. $request = Request::create('http://foo.com/foo/bar', 'GET');
  634. $route = new Route('GET', 'foo/{bar}', ['https', function () {
  635. //
  636. }]);
  637. $this->assertFalse($route->matches($request));
  638. /*
  639. * HTTP checks
  640. */
  641. $request = Request::create('https://foo.com/foo/bar', 'GET');
  642. $route = new Route('GET', 'foo/{bar}', ['http', function () {
  643. //
  644. }]);
  645. $this->assertFalse($route->matches($request));
  646. $request = Request::create('http://foo.com/foo/bar', 'GET');
  647. $route = new Route('GET', 'foo/{bar}', ['http', function () {
  648. //
  649. }]);
  650. $this->assertTrue($route->matches($request));
  651. $request = Request::create('http://foo.com/foo/bar', 'GET');
  652. $route = new Route('GET', 'foo/{bar}', ['baz' => true, function () {
  653. //
  654. }]);
  655. $this->assertTrue($route->matches($request));
  656. }
  657. public function testWherePatternsProperlyFilter()
  658. {
  659. $request = Request::create('foo/123', 'GET');
  660. $route = new Route('GET', 'foo/{bar}', function () {
  661. //
  662. });
  663. $route->where('bar', '[0-9]+');
  664. $this->assertTrue($route->matches($request));
  665. $request = Request::create('foo/123abc', 'GET');
  666. $route = new Route('GET', 'foo/{bar}', function () {
  667. //
  668. });
  669. $route->where('bar', '[0-9]+');
  670. $this->assertFalse($route->matches($request));
  671. $request = Request::create('foo/123abc', 'GET');
  672. $route = new Route('GET', 'foo/{bar}', ['where' => ['bar' => '[0-9]+'], function () {
  673. //
  674. }]);
  675. $route->where('bar', '[0-9]+');
  676. $this->assertFalse($route->matches($request));
  677. /*
  678. * Optional
  679. */
  680. $request = Request::create('foo/123', 'GET');
  681. $route = new Route('GET', 'foo/{bar?}', function () {
  682. //
  683. });
  684. $route->where('bar', '[0-9]+');
  685. $this->assertTrue($route->matches($request));
  686. $request = Request::create('foo/123', 'GET');
  687. $route = new Route('GET', 'foo/{bar?}', ['where' => ['bar' => '[0-9]+'], function () {
  688. //
  689. }]);
  690. $route->where('bar', '[0-9]+');
  691. $this->assertTrue($route->matches($request));
  692. $request = Request::create('foo/123', 'GET');
  693. $route = new Route('GET', 'foo/{bar?}/{baz?}', function () {
  694. //
  695. });
  696. $route->where('bar', '[0-9]+');
  697. $this->assertTrue($route->matches($request));
  698. $request = Request::create('foo/123/foo', 'GET');
  699. $route = new Route('GET', 'foo/{bar?}/{baz?}', function () {
  700. //
  701. });
  702. $route->where('bar', '[0-9]+');
  703. $this->assertTrue($route->matches($request));
  704. $request = Request::create('foo/123abc', 'GET');
  705. $route = new Route('GET', 'foo/{bar?}', function () {
  706. //
  707. });
  708. $route->where('bar', '[0-9]+');
  709. $this->assertFalse($route->matches($request));
  710. }
  711. public function testRoutePrefixParameterParsing()
  712. {
  713. $route = new Route('GET', '/foo', ['prefix' => 'profiles/{user:username}/portfolios', 'uses' => function () {
  714. //
  715. }]);
  716. $this->assertSame('profiles/{user}/portfolios/foo', $route->uri());
  717. }
  718. public function testDotDoesNotMatchEverything()
  719. {
  720. $route = new Route('GET', 'images/{id}.{ext}', function () {
  721. //
  722. });
  723. $request1 = Request::create('images/1.png', 'GET');
  724. $this->assertTrue($route->matches($request1));
  725. $route->bind($request1);
  726. $this->assertSame('1', $route->parameter('id'));
  727. $this->assertSame('png', $route->parameter('ext'));
  728. $request2 = Request::create('images/12.png', 'GET');
  729. $this->assertTrue($route->matches($request2));
  730. $route->bind($request2);
  731. $this->assertSame('12', $route->parameter('id'));
  732. $this->assertSame('png', $route->parameter('ext'));
  733. }
  734. public function testRouteBinding()
  735. {
  736. $router = $this->getRouter();
  737. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  738. return $name;
  739. }]);
  740. $router->bind('bar', function ($value) {
  741. return strtoupper($value);
  742. });
  743. $this->assertSame('TAYLOR', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  744. }
  745. public function testRouteClassBinding()
  746. {
  747. $router = $this->getRouter();
  748. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  749. return $name;
  750. }]);
  751. $router->bind('bar', RouteBindingStub::class);
  752. $this->assertSame('TAYLOR', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  753. }
  754. public function testRouteClassMethodBinding()
  755. {
  756. $router = $this->getRouter();
  757. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  758. return $name;
  759. }]);
  760. $router->bind('bar', RouteBindingStub::class.'@find');
  761. $this->assertSame('dragon', $router->dispatch(Request::create('foo/Dragon', 'GET'))->getContent());
  762. }
  763. public function testMiddlewarePrioritySorting()
  764. {
  765. $middleware = [
  766. Placeholder1::class,
  767. SubstituteBindings::class,
  768. Placeholder2::class,
  769. Authenticate::class,
  770. ExampleMiddleware::class,
  771. Placeholder3::class,
  772. ];
  773. $router = $this->getRouter();
  774. $router->middlewarePriority = [ExampleMiddlewareContract::class, Authenticate::class, SubstituteBindings::class, Authorize::class];
  775. $route = $router->get('foo', ['middleware' => $middleware, 'uses' => function ($name) {
  776. return $name;
  777. }]);
  778. $this->assertEquals([
  779. Placeholder1::class,
  780. ExampleMiddleware::class,
  781. Authenticate::class,
  782. SubstituteBindings::class,
  783. Placeholder2::class,
  784. Placeholder3::class,
  785. ], $router->gatherRouteMiddleware($route));
  786. }
  787. public function testModelBinding()
  788. {
  789. $router = $this->getRouter();
  790. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  791. return $name;
  792. }]);
  793. $router->model('bar', RouteModelBindingStub::class);
  794. $this->assertSame('TAYLOR', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  795. }
  796. public function testModelBindingWithNullReturn()
  797. {
  798. $this->expectException(ModelNotFoundException::class);
  799. $this->expectExceptionMessage('No query results for model [Illuminate\Tests\Routing\RouteModelBindingNullStub].');
  800. $router = $this->getRouter();
  801. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  802. return $name;
  803. }]);
  804. $router->model('bar', RouteModelBindingNullStub::class);
  805. $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent();
  806. }
  807. public function testModelBindingWithCustomNullReturn()
  808. {
  809. $router = $this->getRouter();
  810. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  811. return $name;
  812. }]);
  813. $router->model('bar', RouteModelBindingNullStub::class, function () {
  814. return 'missing';
  815. });
  816. $this->assertSame('missing', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  817. }
  818. public function testModelBindingWithBindingClosure()
  819. {
  820. $router = $this->getRouter();
  821. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  822. return $name;
  823. }]);
  824. $router->model('bar', RouteModelBindingNullStub::class, function ($value) {
  825. return (new RouteModelBindingClosureStub)->findAlternate($value);
  826. });
  827. $this->assertSame('tayloralt', $router->dispatch(Request::create('foo/TAYLOR', 'GET'))->getContent());
  828. }
  829. public function testModelBindingWithCompoundParameterName()
  830. {
  831. $router = $this->getRouter();
  832. $router->resource('foo-bar', RouteTestResourceControllerWithModelParameter::class, ['middleware' => SubstituteBindings::class]);
  833. $this->assertSame('12345', $router->dispatch(Request::create('foo-bar/12345', 'GET'))->getContent());
  834. }
  835. public function testModelBindingWithCompoundParameterNameAndRouteBinding()
  836. {
  837. $router = $this->getRouter();
  838. $router->model('foo_bar', RoutingTestUserModel::class);
  839. $router->resource('foo-bar', RouteTestResourceControllerWithModelParameter::class, ['middleware' => SubstituteBindings::class]);
  840. $this->assertSame('12345', $router->dispatch(Request::create('foo-bar/12345', 'GET'))->getContent());
  841. }
  842. public function testModelBindingThroughIOC()
  843. {
  844. $container = new Container;
  845. $router = new Router(new Dispatcher, $container);
  846. $container->singleton(Registrar::class, function () use ($router) {
  847. return $router;
  848. });
  849. $container->bind(RouteModelInterface::class, RouteModelBindingStub::class);
  850. $router->get('foo/{bar}', ['middleware' => SubstituteBindings::class, 'uses' => function ($name) {
  851. return $name;
  852. }]);
  853. $router->model('bar', RouteModelInterface::class);
  854. $this->assertSame('TAYLOR', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  855. }
  856. public function testGroupMerging()
  857. {
  858. $old = ['prefix' => 'foo/bar/'];
  859. $this->assertEquals(['prefix' => 'foo/bar/baz', 'namespace' => null, 'where' => []], RouteGroup::merge(['prefix' => 'baz'], $old));
  860. $old = ['domain' => 'foo'];
  861. $this->assertEquals(['domain' => 'baz', 'prefix' => null, 'namespace' => null, 'where' => []], RouteGroup::merge(['domain' => 'baz'], $old));
  862. $old = ['as' => 'foo.'];
  863. $this->assertEquals(['as' => 'foo.bar', 'prefix' => null, 'namespace' => null, 'where' => []], RouteGroup::merge(['as' => 'bar'], $old));
  864. $old = ['where' => ['var1' => 'foo', 'var2' => 'bar']];
  865. $this->assertEquals(['prefix' => null, 'namespace' => null, 'where' => [
  866. 'var1' => 'foo', 'var2' => 'baz', 'var3' => 'qux',
  867. ]], RouteGroup::merge(['where' => ['var2' => 'baz', 'var3' => 'qux']], $old));
  868. $old = [];
  869. $this->assertEquals(['prefix' => null, 'namespace' => null, 'where' => [
  870. 'var1' => 'foo', 'var2' => 'bar',
  871. ]], RouteGroup::merge(['where' => ['var1' => 'foo', 'var2' => 'bar']], $old));
  872. }
  873. public function testRouteGrouping()
  874. {
  875. /*
  876. * getPrefix() method
  877. */
  878. $router = $this->getRouter();
  879. $router->group(['prefix' => 'foo'], function () use ($router) {
  880. $router->get('bar', function () {
  881. return 'hello';
  882. });
  883. });
  884. $routes = $router->getRoutes();
  885. $routes = $routes->getRoutes();
  886. $this->assertSame('foo', $routes[0]->getPrefix());
  887. }
  888. public function testRouteGroupingOutsideOfInheritedNamespace()
  889. {
  890. $router = $this->getRouter();
  891. $router->group(['namespace' => 'App\Http\Controllers'], function ($router) {
  892. $router->group(['namespace' => '\Foo\Bar'], function ($router) {
  893. $router->get('users', 'UsersController@index');
  894. });
  895. });
  896. $routes = $router->getRoutes();
  897. $routes = $routes->getRoutes();
  898. $this->assertSame(
  899. 'Foo\Bar\UsersController@index',
  900. $routes[0]->getAction()['uses']
  901. );
  902. }
  903. public function testCurrentRouteUses()
  904. {
  905. $router = $this->getRouter();
  906. $router->get('foo/bar', ['as' => 'foo.bar', 'uses' => RouteTestControllerStub::class.'@index']);
  907. $this->assertNull($router->currentRouteAction());
  908. $this->assertSame('Hello World', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  909. $this->assertTrue($router->uses('*RouteTestControllerStub*'));
  910. $this->assertTrue($router->uses('*RouteTestControllerStub@index'));
  911. $this->assertTrue($router->uses(['*RouteTestControllerStub*', '*FooController*']));
  912. $this->assertTrue($router->uses(['*BarController*', '*FooController*', '*RouteTestControllerStub@index']));
  913. $this->assertTrue($router->uses(['*BarController*', '*FooController*'], '*RouteTestControllerStub*'));
  914. $this->assertFalse($router->uses(['*BarController*', '*FooController*']));
  915. $this->assertEquals($router->currentRouteAction(), RouteTestControllerStub::class.'@index');
  916. $this->assertTrue($router->currentRouteUses(RouteTestControllerStub::class.'@index'));
  917. }
  918. public function testRouteGroupingFromFile()
  919. {
  920. $router = $this->getRouter();
  921. $router->group(['prefix' => 'api'], __DIR__.'/fixtures/routes.php');
  922. $route = last($router->getRoutes()->get());
  923. $request = Request::create('api/users', 'GET');
  924. $this->assertTrue($route->matches($request));
  925. $this->assertSame('all-users', $route->bind($request)->run($request));
  926. }
  927. public function testRouteGroupingWithAs()
  928. {
  929. $router = $this->getRouter();
  930. $router->group(['prefix' => 'foo', 'as' => 'Foo::'], function () use ($router) {
  931. $router->get('bar', ['as' => 'bar', function () {
  932. return 'hello';
  933. }]);
  934. });
  935. $routes = $router->getRoutes();
  936. $route = $routes->getByName('Foo::bar');
  937. $this->assertSame('foo/bar', $route->uri());
  938. }
  939. public function testNestedRouteGroupingWithAs()
  940. {
  941. /*
  942. * nested with all layers present
  943. */
  944. $router = $this->getRouter();
  945. $router->group(['prefix' => 'foo', 'as' => 'Foo::'], function () use ($router) {
  946. $router->group(['prefix' => 'bar', 'as' => 'Bar::'], function () use ($router) {
  947. $router->get('baz', ['as' => 'baz', function () {
  948. return 'hello';
  949. }]);
  950. });
  951. });
  952. $routes = $router->getRoutes();
  953. $route = $routes->getByName('Foo::Bar::baz');
  954. $this->assertSame('foo/bar/baz', $route->uri());
  955. /*
  956. * nested with layer skipped
  957. */
  958. $router = $this->getRouter();
  959. $router->group(['prefix' => 'foo', 'as' => 'Foo::'], function () use ($router) {
  960. $router->group(['prefix' => 'bar'], function () use ($router) {
  961. $router->prefix('foz')->get('baz', ['as' => 'baz', function () {
  962. return 'hello';
  963. }]);
  964. });
  965. });
  966. $routes = $router->getRoutes();
  967. $route = $routes->getByName('Foo::baz');
  968. $this->assertSame('foz/foo/bar/baz', $route->uri());
  969. }
  970. public function testNestedRouteGroupingPrefixing()
  971. {
  972. /*
  973. * nested with layer skipped
  974. */
  975. $router = $this->getRouter();
  976. $router->group(['prefix' => 'foo', 'as' => 'Foo::'], function () use ($router) {
  977. $router->prefix('bar')->get('baz', ['as' => 'baz', function () {
  978. return 'hello';
  979. }]);
  980. });
  981. $routes = $router->getRoutes();
  982. $route = $routes->getByName('Foo::baz');
  983. $this->assertSame('bar/foo', $route->getAction('prefix'));
  984. }
  985. public function testRouteMiddlewareMergeWithMiddlewareAttributesAsStrings()
  986. {
  987. $router = $this->getRouter();
  988. $router->group(['prefix' => 'foo', 'middleware' => 'boo:foo'], function () use ($router) {
  989. $router->get('bar', function () {
  990. return 'hello';
  991. })->middleware('baz:gaz');
  992. });
  993. $routes = $router->getRoutes()->getRoutes();
  994. $route = $routes[0];
  995. $this->assertEquals(
  996. ['boo:foo', 'baz:gaz'],
  997. $route->middleware()
  998. );
  999. }
  1000. public function testRoutePrefixing()
  1001. {
  1002. /*
  1003. * Prefix route
  1004. */
  1005. $router = $this->getRouter();
  1006. $router->get('foo/bar', function () {
  1007. return 'hello';
  1008. });
  1009. $routes = $router->getRoutes();
  1010. $routes = $routes->getRoutes();
  1011. $routes[0]->prefix('prefix');
  1012. $this->assertSame('prefix/foo/bar', $routes[0]->uri());
  1013. /*
  1014. * Use empty prefix
  1015. */
  1016. $router = $this->getRouter();
  1017. $router->get('foo/bar', function () {
  1018. return 'hello';
  1019. });
  1020. $routes = $router->getRoutes();
  1021. $routes = $routes->getRoutes();
  1022. $routes[0]->prefix('/');
  1023. $this->assertSame('foo/bar', $routes[0]->uri());
  1024. /*
  1025. * Prefix homepage
  1026. */
  1027. $router = $this->getRouter();
  1028. $router->get('/', function () {
  1029. return 'hello';
  1030. });
  1031. $routes = $router->getRoutes();
  1032. $routes = $routes->getRoutes();
  1033. $routes[0]->prefix('prefix');
  1034. $this->assertSame('prefix', $routes[0]->uri());
  1035. /*
  1036. * Prefix homepage with empty prefix
  1037. */
  1038. $router = $this->getRouter();
  1039. $router->get('/', function () {
  1040. return 'hello';
  1041. });
  1042. $routes = $router->getRoutes();
  1043. $routes = $routes->getRoutes();
  1044. $routes[0]->prefix('/');
  1045. $this->assertSame('/', $routes[0]->uri());
  1046. }
  1047. public function testRoutePreservingOriginalParametersState()
  1048. {
  1049. $router = $this->getRouter();
  1050. $router->bind('bar', function ($value) {
  1051. return strlen($value);
  1052. });
  1053. $router->get('foo/{bar}', [
  1054. 'middleware' => SubstituteBindings::class,
  1055. 'uses' => function ($bar) use ($router) {
  1056. $route = $router->getCurrentRoute();
  1057. $this->assertSame('taylor', $route->originalParameter('bar'));
  1058. $this->assertSame('default', $route->originalParameter('unexisting', 'default'));
  1059. $this->assertEquals(['bar' => 'taylor'], $route->originalParameters());
  1060. return $bar;
  1061. },
  1062. ]);
  1063. $this->assertEquals(6, $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  1064. }
  1065. public function testMergingControllerUses()
  1066. {
  1067. $router = $this->getRouter();
  1068. $router->group(['namespace' => 'Namespace'], function () use ($router) {
  1069. $router->get('foo/bar', 'Controller@action');
  1070. });
  1071. $routes = $router->getRoutes()->getRoutes();
  1072. $action = $routes[0]->getAction();
  1073. $this->assertSame('Namespace\\Controller@action', $action['controller']);
  1074. $router = $this->getRouter();
  1075. $router->group(['namespace' => 'Namespace'], function () use ($router) {
  1076. $router->group(['namespace' => 'Nested'], function () use ($router) {
  1077. $router->get('foo/bar', 'Controller@action');
  1078. });
  1079. });
  1080. $routes = $router->getRoutes()->getRoutes();
  1081. $action = $routes[0]->getAction();
  1082. $this->assertSame('Namespace\\Nested\\Controller@action', $action['controller']);
  1083. $router = $this->getRouter();
  1084. $router->group(['prefix' => 'baz'], function () use ($router) {
  1085. $router->group(['namespace' => 'Namespace'], function () use ($router) {
  1086. $router->get('foo/bar', 'Controller@action');
  1087. });
  1088. });
  1089. $routes = $router->getRoutes()->getRoutes();
  1090. $action = $routes[0]->getAction();
  1091. $this->assertSame('Namespace\\Controller@action', $action['controller']);
  1092. }
  1093. public function testInvalidActionException()
  1094. {
  1095. $this->expectException(UnexpectedValueException::class);
  1096. $this->expectExceptionMessage('Invalid route action: [Illuminate\Tests\Routing\RouteTestControllerStub].');
  1097. $router = $this->getRouter();
  1098. $router->get('/', ['uses' => RouteTestControllerStub::class]);
  1099. $router->dispatch(Request::create('/'));
  1100. }
  1101. public function testShallowResourceRouting()
  1102. {
  1103. $router = $this->getRouter();
  1104. $router->resource('foo.bar', 'FooController', ['shallow' => true]);
  1105. $routes = $router->getRoutes();
  1106. $routes = $routes->getRoutes();
  1107. $this->assertSame('foo/{foo}/bar', $routes[0]->uri());
  1108. $this->assertSame('foo/{foo}/bar/create', $routes[1]->uri());
  1109. $this->assertSame('foo/{foo}/bar', $routes[2]->uri());
  1110. $this->assertSame('bar/{bar}', $routes[3]->uri());
  1111. $this->assertSame('bar/{bar}/edit', $routes[4]->uri());
  1112. $this->assertSame('bar/{bar}', $routes[5]->uri());
  1113. $this->assertSame('bar/{bar}', $routes[6]->uri());
  1114. $router = $this->getRouter();
  1115. $router->resource('foo', 'FooController');
  1116. $router->resource('foo.bar.baz', 'FooController', ['shallow' => true]);
  1117. $routes = $router->getRoutes();
  1118. $routes = $routes->getRoutes();
  1119. $this->assertSame('foo', $routes[0]->uri());
  1120. $this->assertSame('foo/create', $routes[1]->uri());
  1121. $this->assertSame('foo', $routes[2]->uri());
  1122. $this->assertSame('foo/{foo}', $routes[3]->uri());
  1123. $this->assertSame('foo/{foo}/edit', $routes[4]->uri());
  1124. $this->assertSame('foo/{foo}', $routes[5]->uri());
  1125. $this->assertSame('foo/{foo}', $routes[6]->uri());
  1126. $this->assertSame('foo/{foo}/bar/{bar}/baz', $routes[7]->uri());
  1127. $this->assertSame('foo/{foo}/bar/{bar}/baz/create', $routes[8]->uri());
  1128. $this->assertSame('foo/{foo}/bar/{bar}/baz', $routes[9]->uri());
  1129. }
  1130. public function testResourceRouting()
  1131. {
  1132. $router = $this->getRouter();
  1133. $router->resource('foo', 'FooController');
  1134. $routes = $router->getRoutes();
  1135. $this->assertCount(7, $routes);
  1136. $router = $this->getRouter();
  1137. $router->resource('foo', 'FooController', ['only' => ['update']]);
  1138. $routes = $router->getRoutes();
  1139. $this->assertCount(1, $routes);
  1140. $router = $this->getRouter();
  1141. $router->resource('foo', 'FooController', ['only' => ['show', 'destroy']]);
  1142. $routes = $router->getRoutes();
  1143. $this->assertCount(2, $routes);
  1144. $router = $this->getRouter();
  1145. $router->resource('foo', 'FooController', ['except' => ['show', 'destroy']]);
  1146. $routes = $router->getRoutes();
  1147. $this->assertCount(5, $routes);
  1148. $router = $this->getRouter();
  1149. $router->resource('foo-bars', 'FooController', ['only' => ['show']]);
  1150. $routes = $router->getRoutes();
  1151. $routes = $routes->getRoutes();
  1152. $this->assertSame('foo-bars/{foo_bar}', $routes[0]->uri());
  1153. $router = $this->getRouter();
  1154. $router->resource('foo-bar.foo-baz', 'FooController', ['only' => ['show']]);
  1155. $routes = $router->getRoutes();
  1156. $routes = $routes->getRoutes();
  1157. $this->assertSame('foo-bar/{foo_bar}/foo-baz/{foo_baz}', $routes[0]->uri());
  1158. $router = $this->getRouter();
  1159. $router->resource('foo-bars', 'FooController', ['only' => ['show'], 'as' => 'prefix']);
  1160. $routes = $router->getRoutes();
  1161. $routes = $routes->getRoutes();
  1162. $this->assertSame('foo-bars/{foo_bar}', $routes[0]->uri());
  1163. $this->assertSame('prefix.foo-bars.show', $routes[0]->getName());
  1164. ResourceRegistrar::verbs([
  1165. 'create' => 'ajouter',
  1166. 'edit' => 'modifier',
  1167. ]);
  1168. $router = $this->getRouter();
  1169. $router->resource('foo', 'FooController');
  1170. $routes = $router->getRoutes();
  1171. $this->assertSame('foo/ajouter', $routes->getByName('foo.create')->uri());
  1172. $this->assertSame('foo/{foo}/modifier', $routes->getByName('foo.edit')->uri());
  1173. }
  1174. public function testResourceRoutingParameters()
  1175. {
  1176. ResourceRegistrar::singularParameters();
  1177. $router = $this->getRouter();
  1178. $router->resource('foos', 'FooController');
  1179. $router->resource('foos.bars', 'FooController');
  1180. $routes = $router->getRoutes();
  1181. $routes = $routes->getRoutes();
  1182. $this->assertSame('foos/{foo}', $routes[3]->uri());
  1183. $this->assertSame('foos/{foo}/bars/{bar}', $routes[10]->uri());
  1184. ResourceRegistrar::setParameters(['foos' => 'oof', 'bazs' => 'b']);
  1185. $router = $this->getRouter();
  1186. $router->resource('bars.foos.bazs', 'FooController');
  1187. $routes = $router->getRoutes();
  1188. $routes = $routes->getRoutes();
  1189. $this->assertSame('bars/{bar}/foos/{oof}/bazs/{b}', $routes[3]->uri());
  1190. ResourceRegistrar::setParameters();
  1191. ResourceRegistrar::singularParameters(false);
  1192. $router = $this->getRouter();
  1193. $router->resource('foos', 'FooController', ['parameters' => 'singular']);
  1194. $router->resource('foos.bars', 'FooController')->parameters('singular');
  1195. $routes = $router->getRoutes();
  1196. $routes = $routes->getRoutes();
  1197. $this->assertSame('foos/{foo}', $routes[3]->uri());
  1198. $this->assertSame('foos/{foo}/bars/{bar}', $routes[10]->uri());
  1199. $router = $this->getRouter();
  1200. $router->resource('foos.bars', 'FooController', ['parameters' => ['foos' => 'foo', 'bars' => 'bar']]);
  1201. $routes = $router->getRoutes();
  1202. $routes = $routes->getRoutes();
  1203. $this->assertSame('foos/{foo}/bars/{bar}', $routes[3]->uri());
  1204. $router = $this->getRouter();
  1205. $router->resource('foos.bars', 'FooController')->parameter('foos', 'foo')->parameter('bars', 'bar');
  1206. $routes = $router->getRoutes();
  1207. $routes = $routes->getRoutes();
  1208. $this->assertSame('foos/{foo}/bars/{bar}', $routes[3]->uri());
  1209. }
  1210. public function testResourceRouteNaming()
  1211. {
  1212. $router = $this->getRouter();
  1213. $router->resource('foo', 'FooController');
  1214. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.index'));
  1215. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.show'));
  1216. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.create'));
  1217. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.store'));
  1218. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.edit'));
  1219. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.update'));
  1220. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.destroy'));
  1221. $router = $this->getRouter();
  1222. $router->resource('foo.bar', 'FooController');
  1223. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.index'));
  1224. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.show'));
  1225. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.create'));
  1226. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.store'));
  1227. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.edit'));
  1228. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.update'));
  1229. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.destroy'));
  1230. $router = $this->getRouter();
  1231. $router->resource('prefix/foo.bar', 'FooController');
  1232. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.index'));
  1233. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.show'));
  1234. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.create'));
  1235. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.store'));
  1236. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.edit'));
  1237. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.update'));
  1238. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.destroy'));
  1239. $router = $this->getRouter();
  1240. $router->resource('foo', 'FooController', ['names' => [
  1241. 'index' => 'foo',
  1242. 'show' => 'bar',
  1243. ]]);
  1244. $this->assertTrue($router->getRoutes()->hasNamedRoute('foo'));
  1245. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar'));
  1246. $router = $this->getRouter();
  1247. $router->resource('foo', 'FooController', ['names' => 'bar']);
  1248. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.index'));
  1249. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.show'));
  1250. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.create'));
  1251. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.store'));
  1252. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.edit'));
  1253. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.update'));
  1254. $this->assertTrue($router->getRoutes()->hasNamedRoute('bar.destroy'));
  1255. }
  1256. public function testRouterFiresRoutedEvent()
  1257. {
  1258. $container = new Container;
  1259. $router = new Router(new Dispatcher, $container);
  1260. $container->singleton(Registrar::class, function () use ($router) {
  1261. return $router;
  1262. });
  1263. $router->get('foo/bar', function () {
  1264. return '';
  1265. });
  1266. $request = Request::create('http://foo.com/foo/bar', 'GET');
  1267. $route = new Route('GET', 'foo/bar', ['http', function () {
  1268. //
  1269. }]);
  1270. $_SERVER['__router.request'] = null;
  1271. $_SERVER['__router.route'] = null;
  1272. $router->matched(function ($event) {
  1273. $_SERVER['__router.request'] = $event->request;
  1274. $_SERVER['__router.route'] = $event->route;
  1275. });
  1276. $router->dispatchToRoute($request);
  1277. $this->assertInstanceOf(Request::class, $_SERVER['__router.request']);
  1278. $this->assertEquals($_SERVER['__router.request'], $request);
  1279. unset($_SERVER['__router.request']);
  1280. $this->assertInstanceOf(Route::class, $_SERVER['__router.route']);
  1281. $this->assertEquals($_SERVER['__router.route']->uri(), $route->uri());
  1282. unset($_SERVER['__router.route']);
  1283. }
  1284. public function testRouterPatternSetting()
  1285. {
  1286. $router = $this->getRouter();
  1287. $router->pattern('test', 'pattern');
  1288. $this->assertEquals(['test' => 'pattern'], $router->getPatterns());
  1289. $router = $this->getRouter();
  1290. $router->patterns(['test' => 'pattern', 'test2' => 'pattern2']);
  1291. $this->assertEquals(['test' => 'pattern', 'test2' => 'pattern2'], $router->getPatterns());
  1292. }
  1293. public function testControllerRouting()
  1294. {
  1295. unset(
  1296. $_SERVER['route.test.controller.middleware'], $_SERVER['route.test.controller.except.middleware'],
  1297. $_SERVER['route.test.controller.middleware.class'],
  1298. $_SERVER['route.test.controller.middleware.parameters.one'], $_SERVER['route.test.controller.middleware.parameters.two']
  1299. );
  1300. $router = $this->getRouter();
  1301. $router->get('foo/bar', RouteTestControllerStub::class.'@index');
  1302. $this->assertSame('Hello World', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  1303. $this->assertTrue($_SERVER['route.test.controller.middleware']);
  1304. $this->assertEquals(Response::class, $_SERVER['route.test.controller.middleware.class']);
  1305. $this->assertEquals(0, $_SERVER['route.test.controller.middleware.parameters.one']);
  1306. $this->assertEquals(['foo', 'bar'], $_SERVER['route.test.controller.middleware.parameters.two']);
  1307. $this->assertFalse(isset($_SERVER['route.test.controller.except.middleware']));
  1308. }
  1309. public function testControllerRoutingArrayCallable()
  1310. {
  1311. unset(
  1312. $_SERVER['route.test.controller.middleware'], $_SERVER['route.test.controller.except.middleware'],
  1313. $_SERVER['route.test.controller.middleware.class'],
  1314. $_SERVER['route.test.controller.middleware.parameters.one'], $_SERVER['route.test.controller.middleware.parameters.two']
  1315. );
  1316. $router = $this->getRouter();
  1317. $router->get('foo/bar', [RouteTestControllerStub::class, 'index']);
  1318. $this->assertSame('Hello World', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  1319. $this->assertTrue($_SERVER['route.test.controller.middleware']);
  1320. $this->assertEquals(Response::class, $_SERVER['route.test.controller.middleware.class']);
  1321. $this->assertEquals(0, $_SERVER['route.test.controller.middleware.parameters.one']);
  1322. $this->assertEquals(['foo', 'bar'], $_SERVER['route.test.controller.middleware.parameters.two']);
  1323. $this->assertFalse(isset($_SERVER['route.test.controller.except.middleware']));
  1324. $action = $router->getRoutes()->getRoutes()[0]->getAction()['controller'];
  1325. $this->assertEquals(RouteTestControllerStub::class.'@index', $action);
  1326. }
  1327. public function testCallableControllerRouting()
  1328. {
  1329. $router = $this->getRouter();
  1330. $router->get('foo/bar', RouteTestControllerCallableStub::class.'@bar');
  1331. $router->get('foo/baz', RouteTestControllerCallableStub::class.'@baz');
  1332. $this->assertSame('bar', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  1333. $this->assertSame('baz', $router->dispatch(Request::create('foo/baz', 'GET'))->getContent());
  1334. }
  1335. public function testControllerMiddlewareGroups()
  1336. {
  1337. unset(
  1338. $_SERVER['route.test.controller.middleware'],
  1339. $_SERVER['route.test.controller.middleware.class']
  1340. );
  1341. $router = $this->getRouter();
  1342. $router->middlewareGroup('web', [
  1343. RouteTestControllerMiddleware::class,
  1344. RouteTestControllerMiddlewareTwo::class,
  1345. ]);
  1346. $router->get('foo/bar', RouteTestControllerMiddlewareGroupStub::class.'@index');
  1347. $this->assertSame('caught', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  1348. $this->assertTrue($_SERVER['route.test.controller.middleware']);
  1349. $this->assertEquals(Response::class, $_SERVER['route.test.controller.middleware.class']);
  1350. }
  1351. public function testImplicitBindings()
  1352. {
  1353. $router = $this->getRouter();
  1354. $router->get('foo/{bar}', [
  1355. 'middleware' => SubstituteBindings::class,
  1356. 'uses' => function (RoutingTestUserModel $bar) {
  1357. $this->assertInstanceOf(RoutingTestUserModel::class, $bar);
  1358. return $bar->value;
  1359. },
  1360. ]);
  1361. $this->assertSame('taylor', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  1362. }
  1363. public function testParentChildImplicitBindings()
  1364. {
  1365. $router = $this->getRouter();
  1366. $router->get('foo/{user}/{post:slug}', [
  1367. 'middleware' => SubstituteBindings::class,
  1368. 'uses' => function (RoutingTestUserModel $user, RoutingTestPostModel $post) {
  1369. $this->assertInstanceOf(RoutingTestUserModel::class, $user);
  1370. $this->assertInstanceOf(RoutingTestPostModel::class, $post);
  1371. return $user->value.'|'.$post->value;
  1372. },
  1373. ]);
  1374. $this->assertSame('1|test-slug', $router->dispatch(Request::create('foo/1/test-slug', 'GET'))->getContent());
  1375. }
  1376. public function testParentChildImplicitBindingsProperlyCamelCased()
  1377. {
  1378. $router = $this->getRouter();
  1379. $router->get('foo/{user}/{test_team:id}', [
  1380. 'middleware' => SubstituteBindings::class,
  1381. 'uses' => function (RoutingTestUserModel $user, RoutingTestTeamModel $testTeam) {
  1382. $this->assertInstanceOf(RoutingTestUserModel::class, $user);
  1383. $this->assertInstanceOf(RoutingTestTeamModel::class, $testTeam);
  1384. return $user->value.'|'.$testTeam->value;
  1385. },
  1386. ]);
  1387. $this->assertSame('1|4', $router->dispatch(Request::create('foo/1/4', 'GET'))->getContent());
  1388. }
  1389. public function testImplicitBindingsWithOptionalParameterWithExistingKeyInUri()
  1390. {
  1391. $router = $this->getRouter();
  1392. $router->get('foo/{bar?}', [
  1393. 'middleware' => SubstituteBindings::class,
  1394. 'uses' => function (RoutingTestUserModel $bar = null) {
  1395. $this->assertInstanceOf(RoutingTestUserModel::class, $bar);
  1396. return $bar->value;
  1397. },
  1398. ]);
  1399. $this->assertSame('taylor', $router->dispatch(Request::create('foo/taylor', 'GET'))->getContent());
  1400. }
  1401. public function testImplicitBindingsWithMissingModelHandledByMissing()
  1402. {
  1403. $router = $this->getRouter();
  1404. $router->get('foo/{bar}', [
  1405. 'middleware' => SubstituteBindings::class,
  1406. 'uses' => function (RouteModelBindingNullStub $bar = null) {
  1407. $this->assertInstanceOf(RouteModelBindingNullStub::class, $bar);
  1408. return $bar->first();
  1409. },
  1410. ])->missing(function () {
  1411. return new RedirectResponse('/', 302);
  1412. });
  1413. $request = Request::create('foo/taylor', 'GET');
  1414. $response = $router->dispatch($request);
  1415. $this->assertTrue($response->isRedirect('/'));
  1416. $this->assertEquals(302, $response->getStatusCode());
  1417. }
  1418. public function testImplicitBindingsWithOptionalParameterWithNoKeyInUri()
  1419. {
  1420. $router = $this->getRouter();
  1421. $router->get('foo/{bar?}', [
  1422. 'middleware' => SubstituteBindings::class,
  1423. 'uses' => function (RoutingTestUserModel $bar = null) {
  1424. $this->assertNull($bar);
  1425. },
  1426. ]);
  1427. $router->dispatch(Request::create('foo', 'GET'))->getContent();
  1428. }
  1429. public function testImplicitBindingsWithOptionalParameterWithNonExistingKeyInUri()
  1430. {
  1431. $this->expectException(ModelNotFoundException::class);
  1432. $router = $this->getRouter();
  1433. $router->get('foo/{bar?}', [
  1434. 'middleware' => SubstituteBindings::class,
  1435. 'uses' => function (RoutingTestNonExistingUserModel $bar = null) {
  1436. $this->fail('ModelNotFoundException was expected.');
  1437. },
  1438. ]);
  1439. $router->dispatch(Request::create('foo/nonexisting', 'GET'))->getContent();
  1440. }
  1441. public function testImplicitBindingThroughIOC()
  1442. {
  1443. $container = new Container;
  1444. $router = new Router(new Dispatcher, $container);
  1445. $container->singleton(Registrar::class, function () use ($router) {
  1446. return $router;
  1447. });
  1448. $container->bind(RoutingTestUserModel::class, RoutingTestExtendedUserModel::class);
  1449. $router->get('foo/{bar}', [
  1450. 'middleware' => SubstituteBindings::class,
  1451. 'uses' => function (RoutingTestUserModel $bar) {
  1452. $this->assertInstanceOf(RoutingTestExtendedUserModel::class, $bar);
  1453. },
  1454. ]);
  1455. $router->dispatch(Request::create('foo/baz', 'GET'))->getContent();
  1456. }
  1457. public function testDispatchingCallableActionClasses()
  1458. {
  1459. $router = $this->getRouter();
  1460. $router->get('foo/bar', ActionStub::class);
  1461. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar', 'GET'))->getContent());
  1462. $router->get('foo/bar2', [
  1463. 'uses' => ActionStub::class,
  1464. ]);
  1465. $this->assertSame('hello', $router->dispatch(Request::create('foo/bar2', 'GET'))->getContent());
  1466. }
  1467. public function testResponseIsReturned()
  1468. {
  1469. $router = $this->getRouter();
  1470. $router->get('foo/bar', function () {
  1471. return 'hello';
  1472. });
  1473. $response = $router->dispatch(Request::create('foo/bar', 'GET'));
  1474. $this->assertInstanceOf(Response::class, $response);
  1475. $this->assertNotInstanceOf(JsonResponse::class, $response);
  1476. }
  1477. public function testRouteFlushController()
  1478. {
  1479. $container = new Container;
  1480. $router = $this->getRouter();
  1481. $router->get('count', ActionCountStub::class);
  1482. $request = Request::create('count', 'GET');
  1483. $response = $router->dispatch($request);
  1484. $this->assertSame(1, $response->original['invokedCount']);
  1485. $this->assertSame(1, $response->original['middlewareInvokedCount']);
  1486. $response = $router->dispatch($request);
  1487. $this->assertSame(2, $response->original['invokedCount']);
  1488. $this->assertSame(2, $response->original['middlewareInvokedCount']);
  1489. $request->route()->flushController();
  1490. $response = $router->dispatch($request);
  1491. $this->assertSame(1, $response->original['invokedCount']);
  1492. $this->assertSame(1, $response->original['middlewareInvokedCount']);
  1493. }
  1494. public function testJsonResponseIsReturned()
  1495. {
  1496. $router = $this->getRouter();
  1497. $router->get('foo/bar', function () {
  1498. return ['foo', 'bar'];
  1499. });
  1500. $response = $router->dispatch(Request::create('foo/bar', 'GET'));
  1501. $this->assertNotInstanceOf(Response::class, $response);
  1502. $this->assertInstanceOf(JsonResponse::class, $response);
  1503. }
  1504. public function testRouteRedirect()
  1505. {
  1506. $container = new Container;
  1507. $router = new Router(new Dispatcher, $container);
  1508. $container->singleton(Registrar::class, function () use ($router) {
  1509. return $router;
  1510. });
  1511. $request = Request::create('contact_us', 'GET');
  1512. $container->singleton(Request::class, function () use ($request) {
  1513. return $request;
  1514. });
  1515. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1516. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1517. return $urlGenerator;
  1518. });
  1519. $router->get('contact_us', function () {
  1520. throw new Exception('Route should not be reachable.');
  1521. });
  1522. $router->redirect('contact_us', 'contact');
  1523. $response = $router->dispatch($request);
  1524. $this->assertTrue($response->isRedirect('contact'));
  1525. $this->assertEquals(302, $response->getStatusCode());
  1526. }
  1527. public function testRouteRedirectRetainsExistingStartingForwardSlash()
  1528. {
  1529. $container = new Container;
  1530. $router = new Router(new Dispatcher, $container);
  1531. $container->singleton(Registrar::class, function () use ($router) {
  1532. return $router;
  1533. });
  1534. $request = Request::create('contact_us', 'GET');
  1535. $container->singleton(Request::class, function () use ($request) {
  1536. return $request;
  1537. });
  1538. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1539. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1540. return $urlGenerator;
  1541. });
  1542. $router->get('contact_us', function () {
  1543. throw new Exception('Route should not be reachable.');
  1544. });
  1545. $router->redirect('contact_us', '/contact');
  1546. $response = $router->dispatch($request);
  1547. $this->assertTrue($response->isRedirect('/contact'));
  1548. $this->assertEquals(302, $response->getStatusCode());
  1549. }
  1550. public function testRouteRedirectStripsMissingStartingForwardSlash()
  1551. {
  1552. $container = new Container;
  1553. $router = new Router(new Dispatcher, $container);
  1554. $container->singleton(Registrar::class, function () use ($router) {
  1555. return $router;
  1556. });
  1557. $request = Request::create('contact_us', 'GET');
  1558. $container->singleton(Request::class, function () use ($request) {
  1559. return $request;
  1560. });
  1561. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1562. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1563. return $urlGenerator;
  1564. });
  1565. $router->get('contact_us', function () {
  1566. throw new Exception('Route should not be reachable.');
  1567. });
  1568. $router->redirect('contact_us', 'contact');
  1569. $response = $router->dispatch($request);
  1570. $this->assertTrue($response->isRedirect('contact'));
  1571. $this->assertEquals(302, $response->getStatusCode());
  1572. }
  1573. public function testRouteRedirectExceptionWhenMissingExpectedParameters()
  1574. {
  1575. $this->expectException(UrlGenerationException::class);
  1576. $this->expectExceptionMessage('Missing required parameter for [Route: laravel_route_redirect_destination] [URI: users/{user}] [Missing parameter: user].');
  1577. $container = new Container;
  1578. $router = new Router(new Dispatcher, $container);
  1579. $container->singleton(Registrar::class, function () use ($router) {
  1580. return $router;
  1581. });
  1582. $request = Request::create('users', 'GET');
  1583. $container->singleton(Request::class, function () use ($request) {
  1584. return $request;
  1585. });
  1586. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1587. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1588. return $urlGenerator;
  1589. });
  1590. $router->get('users', function () {
  1591. throw new Exception('Route should not be reachable.');
  1592. });
  1593. $router->redirect('users', 'users/{user}');
  1594. $router->dispatch($request);
  1595. }
  1596. public function testRouteRedirectWithCustomStatus()
  1597. {
  1598. $container = new Container;
  1599. $router = new Router(new Dispatcher, $container);
  1600. $container->singleton(Registrar::class, function () use ($router) {
  1601. return $router;
  1602. });
  1603. $request = Request::create('contact_us', 'GET');
  1604. $container->singleton(Request::class, function () use ($request) {
  1605. return $request;
  1606. });
  1607. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1608. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1609. return $urlGenerator;
  1610. });
  1611. $router->get('contact_us', function () {
  1612. throw new Exception('Route should not be reachable.');
  1613. });
  1614. $router->redirect('contact_us', 'contact', 301);
  1615. $response = $router->dispatch($request);
  1616. $this->assertTrue($response->isRedirect('contact'));
  1617. $this->assertEquals(301, $response->getStatusCode());
  1618. }
  1619. public function testRoutePermanentRedirect()
  1620. {
  1621. $container = new Container;
  1622. $router = new Router(new Dispatcher, $container);
  1623. $container->singleton(Registrar::class, function () use ($router) {
  1624. return $router;
  1625. });
  1626. $request = Request::create('contact_us', 'GET');
  1627. $container->singleton(Request::class, function () use ($request) {
  1628. return $request;
  1629. });
  1630. $urlGenerator = new UrlGenerator(new RouteCollection, $request);
  1631. $container->singleton(UrlGenerator::class, function () use ($urlGenerator) {
  1632. return $urlGenerator;
  1633. });
  1634. $router->get('contact_us', function () {
  1635. throw new Exception('Route should not be reachable.');
  1636. });
  1637. $router->permanentRedirect('contact_us', 'contact');
  1638. $response = $router->dispatch($request);
  1639. $this->assertTrue($response->isRedirect('contact'));
  1640. $this->assertEquals(301, $response->getStatusCode());
  1641. }
  1642. public function testRouteCanMiddlewareCanBeAssigned()
  1643. {
  1644. $route = new Route(['GET'], '/', []);
  1645. $route->middleware(['foo'])->can('create', Route::class);
  1646. $this->assertEquals([
  1647. 'foo',
  1648. 'can:create,Illuminate\Routing\Route',
  1649. ], $route->middleware());
  1650. $route = new Route(['GET'], '/', []);
  1651. $route->can('create');
  1652. $this->assertEquals([
  1653. 'can:create',
  1654. ], $route->middleware());
  1655. }
  1656. protected function getRouter()
  1657. {
  1658. $container = new Container;
  1659. $router = new Router(new Dispatcher, $container);
  1660. $container->singleton(Registrar::class, function () use ($router) {
  1661. return $router;
  1662. });
  1663. return $router;
  1664. }
  1665. }
  1666. class RouteTestControllerStub extends Controller
  1667. {
  1668. public function __construct()
  1669. {
  1670. $this->middleware(RouteTestControllerMiddleware::class);
  1671. $this->middleware(RouteTestControllerParameterizedMiddlewareOne::class.':0');
  1672. $this->middleware(RouteTestControllerParameterizedMiddlewareTwo::class.':foo,bar');
  1673. $this->middleware(RouteTestControllerExceptMiddleware::class, ['except' => 'index']);
  1674. }
  1675. public function index()
  1676. {
  1677. return 'Hello World';
  1678. }
  1679. }
  1680. class RouteTestControllerCallableStub extends Controller
  1681. {
  1682. public function __call($method, $arguments = [])
  1683. {
  1684. return $method;
  1685. }
  1686. }
  1687. class RouteTestControllerMiddlewareGroupStub extends Controller
  1688. {
  1689. public function __construct()
  1690. {
  1691. $this->middleware('web');
  1692. }
  1693. public function index()
  1694. {
  1695. return 'Hello World';
  1696. }
  1697. }
  1698. class RouteTestControllerWithParameterStub extends Controller
  1699. {
  1700. public function returnParameter($bar = '')
  1701. {
  1702. return $bar;
  1703. }
  1704. }
  1705. class RouteTestAnotherControllerWithParameterStub extends Controller
  1706. {
  1707. public function callAction($method, $parameters)
  1708. {
  1709. $_SERVER['__test.controller_callAction_parameters'] = $parameters;
  1710. }
  1711. public function oneArgument($one)
  1712. {
  1713. //
  1714. }
  1715. public function twoArguments($one, $two)
  1716. {
  1717. //
  1718. }
  1719. public function differentArgumentNames($bar, $baz)
  1720. {
  1721. //
  1722. }
  1723. public function reversedArguments($two, $one)
  1724. {
  1725. //
  1726. }
  1727. public function withModels(Request $request, RoutingTestUserModel $user, $defaultNull = null, RoutingTestTeamModel $team = null)
  1728. {
  1729. //
  1730. }
  1731. }
  1732. class RouteTestResourceControllerWithModelParameter extends Controller
  1733. {
  1734. public function show(RoutingTestUserModel $fooBar)
  1735. {
  1736. return $fooBar->value;
  1737. }
  1738. }
  1739. class RouteTestClosureMiddlewareController extends Controller
  1740. {
  1741. public function __construct()
  1742. {
  1743. $this->middleware(function ($request, $next) {
  1744. $response = $next($request);
  1745. return $response->setContent(
  1746. $response->content().'-'.$request['foo-middleware'].'-controller-closure'
  1747. );
  1748. });
  1749. }
  1750. public function index()
  1751. {
  1752. return 'index';
  1753. }
  1754. }
  1755. class RouteTestControllerMiddleware
  1756. {
  1757. public function handle($request, $next)
  1758. {
  1759. $_SERVER['route.test.controller.middleware'] = true;
  1760. $response = $next($request);
  1761. $_SERVER['route.test.controller.middleware.class'] = get_class($response);
  1762. return $response;
  1763. }
  1764. }
  1765. class RouteTestControllerMiddlewareTwo
  1766. {
  1767. public function handle($request, $next)
  1768. {
  1769. return new Response('caught');
  1770. }
  1771. }
  1772. class RouteTestControllerParameterizedMiddlewareOne
  1773. {
  1774. public function handle($request, $next, $parameter)
  1775. {
  1776. $_SERVER['route.test.controller.middleware.parameters.one'] = $parameter;
  1777. return $next($request);
  1778. }
  1779. }
  1780. class RouteTestControllerParameterizedMiddlewareTwo
  1781. {
  1782. public function handle($request, $next, $parameter1, $parameter2)
  1783. {
  1784. $_SERVER['route.test.controller.middleware.parameters.two'] = [$parameter1, $parameter2];
  1785. return $next($request);
  1786. }
  1787. }
  1788. class RouteTestControllerExceptMiddleware
  1789. {
  1790. public function handle($request, $next)
  1791. {
  1792. $_SERVER['route.test.controller.except.middleware'] = true;
  1793. return $next($request);
  1794. }
  1795. }
  1796. class ResponsableResponse implements Responsable
  1797. {
  1798. public function toResponse($request)
  1799. {
  1800. return new Response('bar');
  1801. }
  1802. }
  1803. class RouteBindingStub
  1804. {
  1805. public function bind($value, $route)
  1806. {
  1807. return strtoupper($value);
  1808. }
  1809. public function find($value, $route)
  1810. {
  1811. return strtolower($value);
  1812. }
  1813. }
  1814. class RouteModelBindingStub extends Model
  1815. {
  1816. public function getRouteKeyName()
  1817. {
  1818. return 'id';
  1819. }
  1820. public function where($key, $value)
  1821. {
  1822. $this->value = $value;
  1823. return $this;
  1824. }
  1825. public function first()
  1826. {
  1827. return strtoupper($this->value);
  1828. }
  1829. }
  1830. class RouteModelBindingNullStub extends Model
  1831. {
  1832. public function getRouteKeyName()
  1833. {
  1834. return 'id';
  1835. }
  1836. public function where($key, $value)
  1837. {
  1838. return $this;
  1839. }
  1840. public function first()
  1841. {
  1842. //
  1843. }
  1844. }
  1845. class RouteModelBindingClosureStub
  1846. {
  1847. public function findAlternate($value)
  1848. {
  1849. return strtolower($value).'alt';
  1850. }
  1851. }
  1852. class RoutingTestMiddlewareGroupOne
  1853. {
  1854. public function handle($request, $next)
  1855. {
  1856. $_SERVER['__middleware.group'] = true;
  1857. return $next($request);
  1858. }
  1859. }
  1860. class RoutingTestMiddlewareGroupTwo
  1861. {
  1862. public function handle($request, $next, $parameter = null)
  1863. {
  1864. return new Response('caught '.$parameter);
  1865. }
  1866. }
  1867. class RoutingTestUserModel extends Model
  1868. {
  1869. public function posts()
  1870. {
  1871. return new RoutingTestPostModel;
  1872. }
  1873. public function testTeams()
  1874. {
  1875. return new RoutingTestTeamModel;
  1876. }
  1877. public function getRouteKeyName()
  1878. {
  1879. return 'id';
  1880. }
  1881. public function where($key, $value)
  1882. {
  1883. $this->value = $value;
  1884. return $this;
  1885. }
  1886. public function first()
  1887. {
  1888. return $this;
  1889. }
  1890. public function firstOrFail()
  1891. {
  1892. return $this;
  1893. }
  1894. }
  1895. class RoutingTestPostModel extends Model
  1896. {
  1897. public function getRouteKeyName()
  1898. {
  1899. return 'id';
  1900. }
  1901. public function where($key, $value)
  1902. {
  1903. $this->value = $value;
  1904. return $this;
  1905. }
  1906. public function first()
  1907. {
  1908. return $this;
  1909. }
  1910. }
  1911. class RoutingTestTeamModel extends Model
  1912. {
  1913. public function getRouteKeyName()
  1914. {
  1915. return 'id';
  1916. }
  1917. public function where($key, $value)
  1918. {
  1919. $this->value = $value;
  1920. return $this;
  1921. }
  1922. public function first()
  1923. {
  1924. return $this;
  1925. }
  1926. public function firstOrFail()
  1927. {
  1928. return $this;
  1929. }
  1930. }
  1931. class RoutingTestExtendedUserModel extends RoutingTestUserModel
  1932. {
  1933. //
  1934. }
  1935. class RoutingTestNonExistingUserModel extends RoutingTestUserModel
  1936. {
  1937. public function first()
  1938. {
  1939. //
  1940. }
  1941. public function firstOrFail()
  1942. {
  1943. throw new ModelNotFoundException;
  1944. }
  1945. }
  1946. class ActionStub
  1947. {
  1948. public function __invoke()
  1949. {
  1950. return 'hello';
  1951. }
  1952. }
  1953. class ActionCountStub extends Controller
  1954. {
  1955. protected $middlewareInvokedCount = 0;
  1956. protected $invokedCount = 0;
  1957. public function __construct()
  1958. {
  1959. $this->middleware(function ($request, $next) {
  1960. $this->middlewareInvokedCount++;
  1961. return $next($request);
  1962. });
  1963. }
  1964. public function __invoke()
  1965. {
  1966. $this->invokedCount++;
  1967. return [
  1968. 'invokedCount' => $this->invokedCount,
  1969. 'middlewareInvokedCount' => $this->middlewareInvokedCount,
  1970. ];
  1971. }
  1972. }
  1973. interface ExampleMiddlewareContract
  1974. {
  1975. //
  1976. }
  1977. class ExampleMiddleware implements ExampleMiddlewareContract
  1978. {
  1979. public function handle($request, Closure $next)
  1980. {
  1981. return $next($request);
  1982. }
  1983. }