# Controllers * Introduction * Writing Controllers * Basic Controllers * Single Action Controllers * Controller Middleware * Resource Controllers * Partial Resource Routes * Nested Resources * Naming Resource Routes * Naming Resource Route Parameters * Scoping Resource Routes * Localizing Resource URIs * Supplementing Resource Controllers * Singleton Resource Controllers * Middleware and Resource Controllers * Dependency Injection and Controllers ## Introduction Instead of defining all of your request handling logic as closures in your route files, you may wish to organize this behavior using "controller" classes. Controllers can group related request handling logic into a single class. For example, a `UserController` class might handle all incoming requests related to users, including showing, creating, updating, and deleting users. By default, controllers are stored in the `app/Http/Controllers` directory. ## Writing Controllers ### Basic Controllers To quickly generate a new controller, you may run the `make:controller` Artisan command. By default, all of the controllers for your application are stored in the `app/Http/Controllers` directory: 1php artisan make:controller UserController php artisan make:controller UserController Let's take a look at an example of a basic controller. A controller may have any number of public methods which will respond to incoming HTTP requests: 1 User::findOrFail($id) 17 ]); 18 } 19} User::findOrFail($id) ]); } } Once you have written a controller class and method, you may define a route to the controller method like so: 1use App\Http\Controllers\UserController; 2  3Route::get('/user/{id}', [UserController::class, 'show']); use App\Http\Controllers\UserController; Route::get('/user/{id}', [UserController::class, 'show']); When an incoming request matches the specified route URI, the `show` method on the `App\Http\Controllers\UserController` class will be invoked and the route parameters will be passed to the method. Controllers are not **required** to extend a base class. However, it is sometimes convenient to extend a base controller class that contains methods that should be shared across all of your controllers. ### Single Action Controllers If a controller action is particularly complex, you might find it convenient to dedicate an entire controller class to that single action. To accomplish this, you may define a single `__invoke` method within the controller: 1middleware('auth'); Route::get('/profile', [UserController::class, 'show'])->middleware('auth'); Or, you may find it convenient to specify middleware within your controller class. To do so, your controller should implement the `HasMiddleware` interface, which dictates that the controller should have a static `middleware` method. From this method, you may return an array of middleware that should be applied to the controller's actions: 1 PhotoController::class, 3 'posts' => PostController::class, 4]); Route::resources([ 'photos' => PhotoController::class, 'posts' => PostController::class, ]); The `softDeletableResources` method registers many resources controllers that all use the `withTrashed` method: 1Route::softDeletableResources([ 2 'photos' => PhotoController::class, 3 'posts' => PostController::class, 4]); Route::softDeletableResources([ 'photos' => PhotoController::class, 'posts' => PostController::class, ]); #### Actions Handled by Resource Controllers Verb | URI | Action | Route Name ---|---|---|--- GET | `/photos` | index | photos.index GET | `/photos/create` | create | photos.create POST | `/photos` | store | photos.store GET | `/photos/{photo}` | show | photos.show GET | `/photos/{photo}/edit` | edit | photos.edit PUT/PATCH | `/photos/{photo}` | update | photos.update DELETE | `/photos/{photo}` | destroy | photos.destroy #### Customizing Missing Model Behavior Typically, a 404 HTTP response will be generated if an implicitly bound resource model is not found. However, you may customize this behavior by calling the `missing` method when defining your resource route. The `missing` method accepts a closure that will be invoked if an implicitly bound model cannot be found for any of the resource's routes: 1use App\Http\Controllers\PhotoController; 2use Illuminate\Http\Request; 3use Illuminate\Support\Facades\Redirect; 4  5Route::resource('photos', PhotoController::class) 6 ->missing(function (Request $request) { 7 return Redirect::route('photos.index'); 8 }); use App\Http\Controllers\PhotoController; use Illuminate\Http\Request; use Illuminate\Support\Facades\Redirect; Route::resource('photos', PhotoController::class) ->missing(function (Request $request) { return Redirect::route('photos.index'); }); #### Soft Deleted Models Typically, implicit model binding will not retrieve models that have been [soft deleted](/docs/12.x/eloquent#soft-deleting), and will instead return a 404 HTTP response. However, you can instruct the framework to allow soft deleted models by invoking the `withTrashed` method when defining your resource route: 1use App\Http\Controllers\PhotoController; 2  3Route::resource('photos', PhotoController::class)->withTrashed(); use App\Http\Controllers\PhotoController; Route::resource('photos', PhotoController::class)->withTrashed(); Calling `withTrashed` with no arguments will allow soft deleted models for the `show`, `edit`, and `update` resource routes. You may specify a subset of these routes by passing an array to the `withTrashed` method: 1Route::resource('photos', PhotoController::class)->withTrashed(['show']); Route::resource('photos', PhotoController::class)->withTrashed(['show']); #### Specifying the Resource Model If you are using [route model binding](/docs/12.x/routing#route-model-binding) and would like the resource controller's methods to type-hint a model instance, you may use the `--model` option when generating the controller: 1php artisan make:controller PhotoController --model=Photo --resource php artisan make:controller PhotoController --model=Photo --resource #### Generating Form Requests You may provide the `--requests` option when generating a resource controller to instruct Artisan to generate [form request classes](/docs/12.x/validation#form-request-validation) for the controller's storage and update methods: 1php artisan make:controller PhotoController --model=Photo --resource --requests php artisan make:controller PhotoController --model=Photo --resource --requests ### Partial Resource Routes When declaring a resource route, you may specify a subset of actions the controller should handle instead of the full set of default actions: 1use App\Http\Controllers\PhotoController; 2  3Route::resource('photos', PhotoController::class)->only([ 4 'index', 'show' 5]); 6  7Route::resource('photos', PhotoController::class)->except([ 8 'create', 'store', 'update', 'destroy' 9]); use App\Http\Controllers\PhotoController; Route::resource('photos', PhotoController::class)->only([ 'index', 'show' ]); Route::resource('photos', PhotoController::class)->except([ 'create', 'store', 'update', 'destroy' ]); #### API Resource Routes When declaring resource routes that will be consumed by APIs, you will commonly want to exclude routes that present HTML templates such as `create` and `edit`. For convenience, you may use the `apiResource` method to automatically exclude these two routes: 1use App\Http\Controllers\PhotoController; 2  3Route::apiResource('photos', PhotoController::class); use App\Http\Controllers\PhotoController; Route::apiResource('photos', PhotoController::class); You may register many API resource controllers at once by passing an array to the `apiResources` method: 1use App\Http\Controllers\PhotoController; 2use App\Http\Controllers\PostController; 3  4Route::apiResources([ 5 'photos' => PhotoController::class, 6 'posts' => PostController::class, 7]); use App\Http\Controllers\PhotoController; use App\Http\Controllers\PostController; Route::apiResources([ 'photos' => PhotoController::class, 'posts' => PostController::class, ]); To quickly generate an API resource controller that does not include the `create` or `edit` methods, use the `--api` switch when executing the `make:controller` command: 1php artisan make:controller PhotoController --api php artisan make:controller PhotoController --api ### Nested Resources Sometimes you may need to define routes to a nested resource. For example, a photo resource may have multiple comments that may be attached to the photo. To nest the resource controllers, you may use "dot" notation in your route declaration: 1use App\Http\Controllers\PhotoCommentController; 2  3Route::resource('photos.comments', PhotoCommentController::class); use App\Http\Controllers\PhotoCommentController; Route::resource('photos.comments', PhotoCommentController::class); This route will register a nested resource that may be accessed with URIs like the following: 1/photos/{photo}/comments/{comment} /photos/{photo}/comments/{comment} #### Scoping Nested Resources Laravel's [implicit model binding](/docs/12.x/routing#implicit-model-binding- scoping) feature can automatically scope nested bindings such that the resolved child model is confirmed to belong to the parent model. By using the `scoped` method when defining your nested resource, you may enable automatic scoping as well as instruct Laravel which field the child resource should be retrieved by. For more information on how to accomplish this, please see the documentation on scoping resource routes. #### Shallow Nesting Often, it is not entirely necessary to have both the parent and the child IDs within a URI since the child ID is already a unique identifier. When using unique identifiers such as auto-incrementing primary keys to identify your models in URI segments, you may choose to use "shallow nesting": 1use App\Http\Controllers\CommentController; 2  3Route::resource('photos.comments', CommentController::class)->shallow(); use App\Http\Controllers\CommentController; Route::resource('photos.comments', CommentController::class)->shallow(); This route definition will define the following routes: Verb | URI | Action | Route Name ---|---|---|--- GET | `/photos/{photo}/comments` | index | photos.comments.index GET | `/photos/{photo}/comments/create` | create | photos.comments.create POST | `/photos/{photo}/comments` | store | photos.comments.store GET | `/comments/{comment}` | show | comments.show GET | `/comments/{comment}/edit` | edit | comments.edit PUT/PATCH | `/comments/{comment}` | update | comments.update DELETE | `/comments/{comment}` | destroy | comments.destroy ### Naming Resource Routes By default, all resource controller actions have a route name; however, you can override these names by passing a `names` array with your desired route names: 1use App\Http\Controllers\PhotoController; 2  3Route::resource('photos', PhotoController::class)->names([ 4 'create' => 'photos.build' 5]); use App\Http\Controllers\PhotoController; Route::resource('photos', PhotoController::class)->names([ 'create' => 'photos.build' ]); ### Naming Resource Route Parameters By default, `Route::resource` will create the route parameters for your resource routes based on the "singularized" version of the resource name. You can easily override this on a per resource basis using the `parameters` method. The array passed into the `parameters` method should be an associative array of resource names and parameter names: 1use App\Http\Controllers\AdminUserController; 2  3Route::resource('users', AdminUserController::class)->parameters([ 4 'users' => 'admin_user' 5]); use App\Http\Controllers\AdminUserController; Route::resource('users', AdminUserController::class)->parameters([ 'users' => 'admin_user' ]); The example above generates the following URI for the resource's `show` route: 1/users/{admin_user} /users/{admin_user} ### Scoping Resource Routes Laravel's [scoped implicit model binding](/docs/12.x/routing#implicit-model- binding-scoping) feature can automatically scope nested bindings such that the resolved child model is confirmed to belong to the parent model. By using the `scoped` method when defining your nested resource, you may enable automatic scoping as well as instruct Laravel which field the child resource should be retrieved by: 1use App\Http\Controllers\PhotoCommentController; 2  3Route::resource('photos.comments', PhotoCommentController::class)->scoped([ 4 'comment' => 'slug', 5]); use App\Http\Controllers\PhotoCommentController; Route::resource('photos.comments', PhotoCommentController::class)->scoped([ 'comment' => 'slug', ]); This route will register a scoped nested resource that may be accessed with URIs like the following: 1/photos/{photo}/comments/{comment:slug} /photos/{photo}/comments/{comment:slug} When using a custom keyed implicit binding as a nested route parameter, Laravel will automatically scope the query to retrieve the nested model by its parent using conventions to guess the relationship name on the parent. In this case, it will be assumed that the `Photo` model has a relationship named `comments` (the plural of the route parameter name) which can be used to retrieve the `Comment` model. ### Localizing Resource URIs By default, `Route::resource` will create resource URIs using English verbs and plural rules. If you need to localize the `create` and `edit` action verbs, you may use the `Route::resourceVerbs` method. This may be done at the beginning of the `boot` method within your application's `App\Providers\AppServiceProvider`: 1/** 2 * Bootstrap any application services. 3 */ 4public function boot(): void 5{ 6 Route::resourceVerbs([ 7 'create' => 'crear', 8 'edit' => 'editar', 9 ]); 10} /** * Bootstrap any application services. */ public function boot(): void { Route::resourceVerbs([ 'create' => 'crear', 'edit' => 'editar', ]); } Laravel's pluralizer supports [several different languages which you may configure based on your needs](/docs/12.x/localization#pluralization- language). Once the verbs and pluralization language have been customized, a resource route registration such as `Route::resource('publicacion', PublicacionController::class)` will produce the following URIs: 1/publicacion/crear 2 3/publicacion/{publicaciones}/editar /publicacion/crear /publicacion/{publicaciones}/editar ### Supplementing Resource Controllers If you need to add additional routes to a resource controller beyond the default set of resource routes, you should define those routes before your call to the `Route::resource` method; otherwise, the routes defined by the `resource` method may unintentionally take precedence over your supplemental routes: 1use App\Http\Controller\PhotoController; 2  3Route::get('/photos/popular', [PhotoController::class, 'popular']); 4Route::resource('photos', PhotoController::class); use App\Http\Controller\PhotoController; Route::get('/photos/popular', [PhotoController::class, 'popular']); Route::resource('photos', PhotoController::class); Remember to keep your controllers focused. If you find yourself routinely needing methods outside of the typical set of resource actions, consider splitting your controller into two, smaller controllers. ### Singleton Resource Controllers Sometimes, your application will have resources that may only have a single instance. For example, a user's "profile" can be edited or updated, but a user may not have more than one "profile". Likewise, an image may have a single "thumbnail". These resources are called "singleton resources", meaning one and only one instance of the resource may exist. In these scenarios, you may register a "singleton" resource controller: 1use App\Http\Controllers\ProfileController; 2use Illuminate\Support\Facades\Route; 3  4Route::singleton('profile', ProfileController::class); use App\Http\Controllers\ProfileController; use Illuminate\Support\Facades\Route; Route::singleton('profile', ProfileController::class); The singleton resource definition above will register the following routes. As you can see, "creation" routes are not registered for singleton resources, and the registered routes do not accept an identifier since only one instance of the resource may exist: Verb | URI | Action | Route Name ---|---|---|--- GET | `/profile` | show | profile.show GET | `/profile/edit` | edit | profile.edit PUT/PATCH | `/profile` | update | profile.update Singleton resources may also be nested within a standard resource: 1Route::singleton('photos.thumbnail', ThumbnailController::class); Route::singleton('photos.thumbnail', ThumbnailController::class); In this example, the `photos` resource would receive all of the standard resource routes; however, the `thumbnail` resource would be a singleton resource with the following routes: Verb | URI | Action | Route Name ---|---|---|--- GET | `/photos/{photo}/thumbnail` | show | photos.thumbnail.show GET | `/photos/{photo}/thumbnail/edit` | edit | photos.thumbnail.edit PUT/PATCH | `/photos/{photo}/thumbnail` | update | photos.thumbnail.update #### Creatable Singleton Resources Occasionally, you may want to define creation and storage routes for a singleton resource. To accomplish this, you may invoke the `creatable` method when registering the singleton resource route: 1Route::singleton('photos.thumbnail', ThumbnailController::class)->creatable(); Route::singleton('photos.thumbnail', ThumbnailController::class)->creatable(); In this example, the following routes will be registered. As you can see, a `DELETE` route will also be registered for creatable singleton resources: Verb | URI | Action | Route Name ---|---|---|--- GET | `/photos/{photo}/thumbnail/create` | create | photos.thumbnail.create POST | `/photos/{photo}/thumbnail` | store | photos.thumbnail.store GET | `/photos/{photo}/thumbnail` | show | photos.thumbnail.show GET | `/photos/{photo}/thumbnail/edit` | edit | photos.thumbnail.edit PUT/PATCH | `/photos/{photo}/thumbnail` | update | photos.thumbnail.update DELETE | `/photos/{photo}/thumbnail` | destroy | photos.thumbnail.destroy If you would like Laravel to register the `DELETE` route for a singleton resource but not register the creation or storage routes, you may utilize the `destroyable` method: 1Route::singleton(...)->destroyable(); Route::singleton(...)->destroyable(); #### API Singleton Resources The `apiSingleton` method may be used to register a singleton resource that will be manipulated via an API, thus rendering the `create` and `edit` routes unnecessary: 1Route::apiSingleton('profile', ProfileController::class); Route::apiSingleton('profile', ProfileController::class); Of course, API singleton resources may also be `creatable`, which will register `store` and `destroy` routes for the resource: 1Route::apiSingleton('photos.thumbnail', ProfileController::class)->creatable(); Route::apiSingleton('photos.thumbnail', ProfileController::class)->creatable(); ### Middleware and Resource Controllers Laravel allows you to assign middleware to all, or only specific, methods of resource routes using the `middleware`, `middlewareFor`, and `withoutMiddlewareFor` methods. These methods provide fine-grained control over which middleware is applied to each resource action. #### Applying Middleware to all Methods You may use the `middleware` method to assign middleware to all routes generated by a resource or singleton resource route: 1Route::resource('users', UserController::class) 2 ->middleware(['auth', 'verified']); 3  4Route::singleton('profile', ProfileController::class) 5 ->middleware('auth'); Route::resource('users', UserController::class) ->middleware(['auth', 'verified']); Route::singleton('profile', ProfileController::class) ->middleware('auth'); #### Applying Middleware to Specific Methods You may use the `middlewareFor` method to assign middleware to one or more specific methods of a given resource controller: 1Route::resource('users', UserController::class) 2 ->middlewareFor('show', 'auth'); 3  4Route::apiResource('users', UserController::class) 5 ->middlewareFor(['show', 'update'], 'auth'); 6  7Route::resource('users', UserController::class) 8 ->middlewareFor('show', 'auth') 9 ->middlewareFor('update', 'auth'); 10  11Route::apiResource('users', UserController::class) 12 ->middlewareFor(['show', 'update'], ['auth', 'verified']); Route::resource('users', UserController::class) ->middlewareFor('show', 'auth'); Route::apiResource('users', UserController::class) ->middlewareFor(['show', 'update'], 'auth'); Route::resource('users', UserController::class) ->middlewareFor('show', 'auth') ->middlewareFor('update', 'auth'); Route::apiResource('users', UserController::class) ->middlewareFor(['show', 'update'], ['auth', 'verified']); The `middlewareFor` method may also be used in conjunction with singleton and API singleton resource controllers: 1Route::singleton('profile', ProfileController::class) 2 ->middlewareFor('show', 'auth'); 3  4Route::apiSingleton('profile', ProfileController::class) 5 ->middlewareFor(['show', 'update'], 'auth'); Route::singleton('profile', ProfileController::class) ->middlewareFor('show', 'auth'); Route::apiSingleton('profile', ProfileController::class) ->middlewareFor(['show', 'update'], 'auth'); #### Excluding Middleware from Specific Methods You may use the `withoutMiddlewareFor` method to exclude middleware from specific methods of a resource controller: 1Route::middleware(['auth', 'verified', 'subscribed'])->group(function () { 2 Route::resource('users', UserController::class) 3 ->withoutMiddlewareFor('index', ['auth', 'verified']) 4 ->withoutMiddlewareFor(['create', 'store'], 'verified') 5 ->withoutMiddlewareFor('destroy', 'subscribed'); 6}); Route::middleware(['auth', 'verified', 'subscribed'])->group(function () { Route::resource('users', UserController::class) ->withoutMiddlewareFor('index', ['auth', 'verified']) ->withoutMiddlewareFor(['create', 'store'], 'verified') ->withoutMiddlewareFor('destroy', 'subscribed'); }); ## Dependency Injection and Controllers #### Constructor Injection The Laravel [service container](/docs/12.x/container) is used to resolve all Laravel controllers. As a result, you are able to type-hint any dependencies your controller may need in its constructor. The declared dependencies will automatically be resolved and injected into the controller instance: 1name; 16  17 // Store the user... 18  19 return redirect('/users'); 20 } 21} name; // Store the user... return redirect('/users'); } } If your controller method is also expecting input from a route parameter, list your route arguments after your other dependencies. For example, if your route is defined like so: 1use App\Http\Controllers\UserController; 2  3Route::put('/user/{id}', [UserController::class, 'update']); use App\Http\Controllers\UserController; Route::put('/user/{id}', [UserController::class, 'update']); You may still type-hint the `Illuminate\Http\Request` and access your `id` parameter by defining your controller method as follows: 1