Basics Flashcards
The most basic Laravel routes accept a _ and a _
URI and a Closure
Write a simple Closure-based get route.
Route::get(‘foo’, function () {
return ‘Hello World’;
});
What directory are the route files stored in?
The ‘routes’ directory
Where is RouteServiceProvider.php stored?
In the ‘app/Providers’ directory
What does the RouteServiceProvider do for routes/web.php?
Applies the ‘web’ middleware group.
What does the RouteServiceProvider do for routes/api.php?
Applies the ‘web’ middleware group, and applies the ‘/api’ URI prefix.
How would you modify the default ‘/api’ routes prefix?
Modify it in the RouteServiceProvider.
What HTTP verbs can you register routes for?
get post put patch delete options
How would you register a route that responds to multiple HTTP verbs?
Route::match([‘get’, ‘post’], ‘/’, $callback);
or
Route::any(‘/’, $callback);
What does Route::match do?
Registers a route that responds to multiple HTTP verbs.
What does Route::any do?
Registers a route that responds to any HTTP verb.
Which incoming HTTP verbs are checked for the existence of a CSRF token?
post put patch delete (only applies to web middleware's routes)
How to define a route that redirects to another URI?
Route::redirect(‘/here’, ‘/there’);
What is the default status code returned with Route::redirect?
302
How to return a Route::redirect with a customise status code?
Route::redirect(‘/here’, ‘/there’, 301);
How to return a permanent redirect on a URI?
Route::permanentRedirect(‘/here’, ‘/there’)
What Route method to use if your route only needs to return a view without going through a controller?
Route::view(‘/welcome’, ‘welcome’)
How to pass data to a simple Route::view?
Route::view(‘/welcome’, ‘welcome’, [‘name’ => ‘Nicolas’]);
What is a route parameter?
It’s a captured segment of the URI.
Write a simple get route that captures and returns a parameter.
Route::get(‘user/{id}’, function ($id) {
return ‘User ‘.$id;
});
What is the syntax of a route parameter within registering a URI?
Enclosed in braces.
What characters may route parameter identifiers contain?
Only alphabetic and underscore.
How are route parameters injected into route callbacks and controllers?
Based only on their order.
How to make the presence of a route parameter in the URI optional?
Use ? after the identifier and supply a default value:
Route::get(‘user/{name?}’, function ($name = null) {
return $name;
});
Write two get routes that use a regular expression constraint to ensure: (1) an alphabetic parameter and (2) a numeric parameter.
Route::get(‘user/{name}, $callback)->where(‘name’, ‘[A-Za-z]+’);
Route::get(‘user/{id}, $callback)->where(‘id’, ‘[1-9]+’);
Write one route that has both id and name parameters each constrained to numerical and name constrained to alphabetical.
Route::get(‘user/{id}/{name}’, $callback)->where([‘id’ => ‘[0-9]+’, ‘name’ => ‘[A-Za-z]+’);
How do you set global parameter constraints? Set one for ‘id’ to be numerical.
In RouteServiceProvider’s boot() method, add:
Route::pattern(‘id’, ‘[0-9]+’);
Automatically applied to all routes using that parameter name.
What characters may form part of a parameter’s value?
All characters except forward-slash. You may include forward-slash as well (in ONLY the last segment of the URI/route) using:
Route::get(‘search/{search}’, $callback)->where(‘search’, ‘.*’);
What are the benefits of named routes?
Easily generate URIs and redirects.
Change URIs in your route files without having to update them in Blade files.
How to set a name for a route?
Chain the name method onto the route definition.
Route::get(‘users’, $callback)->name(‘profiles’);
How to generate a URL to a named route? Write code to set $url of the route named ‘profile’.
$url = route(‘profile’);
Write code to return a redirect to a route named ‘profile’.
return redirect()->route(‘profile’);
Write code to set $url of the route below:
Route::get(‘user/{id}/profile’, $callback)->name(‘profile’);
$url = route(‘profile’, [‘id’ => $id]);
How to determine whether the current request is a given named route?
$request->route()->named(‘users’);
Returns boolean
How to assign middleware to all routes in a given group?
Route::middleware(['first', 'second'])->group(function () {
// routes go here
});
The middleware method must go before the group method, and the middlewares are executed in the order they are listed in the array.
Write code to prefix a group of routes with the URI segment ‘admin’.
Route::prefix('admin')->group(function(){
Route::get('users', $callback);
// matches '/admin/callback'
});Write code to prefix the names of a group of routes with the name ‘admin’.
Route::name('admin.')->group(function(){
Route::get($url, $callback)->name('users');
// is assigned the name 'admin.users'
});
Note: you must provide the trailing ‘.’ character within the prefix string.
What is the benefit of route model binding?
A controller action will often query to retrieve the model of the ID it was passed. RMB relieves that by automatically passing/injecting the entire model matching the ID given in the route.
What happens if during route model binding, the model’s ID cannot be found?
A 404 response will automatically be generated.
How is implicit route model binding set up?
The model injected into the controller must be type-hinted and its identifier/name must match that of the route segment parameter.
How to once-off customise the key used during route model binding?
Specify the column to search in the route parameter definition:
Route::get(‘/posts/{post:slug}’, $callback);
How to ‘globally’ customise the key used during route model binding for a specific model?
Override the getRouteKeyName() method on the Eloquent model:
public function getRouteKeyName() {
return ‘slug’;
}
Discuss the route that will be executed when no other route matches the incoming request.
Unhandled requests will automatically render a 404. However, you may define a fallback route (as the last route in web.php) with:
Route::fallback($callback);
All web middleware will still apply.
Explain form method spoofing.
Because HTML forms do not support the PUT, PATCH or DELETE verbs, a hidden field is added to the form who’s value determines the request method.
In Blade, use the @method() directive.
In Blade, what does @method(‘PUT’) expand to?
< input type=”hidden” name=”_method” value=”PUT” >
In Blade, what does @csrf expand to?
< input type=”hidden” name=”_token” value=”{{ csrf_token() }}” >
What is the practice of including the @method directive called?
Form method spoofing
What does middleware do, in a nutshell?
Middleware filters incoming HTTP requests.
Where are all provided middleware located?
In the ‘app/Http/Middleware’ directory.
How to make a new middleware?
php artisan make:middleware MyMiddleware
Will place a new class in ‘app/Http/Middleware’ directory.
When you are writing custom middleware, what code will pass the request deeper into the application assuming your tests pass?
return $next($request);
Will call the supplied $next callback with the $request object.
What allows you to type-hint any dependencies you need within a middleware’s constructor?
All middleware are resolved via the service container.
What code determines whether middleware runs before or after the application handles the request?
In your handle method, this code runs before:
public function handle($request, Closure $next) {
// code here
return $next($request);
}
This code runs after:
public function handle($request, Closure $next) {
$response = $next($request);
// code here
return $response;
}
What are global middleware?
These middleware are run during every request to your application. They are listed in the $middleware property of the app/Http/Kernel.php class.
How to register a middleware you’ve created as global?
Add it to the list of middleware on the $middleware property of the app/Http/Kernel.php class.
Outline the method of applying non-global (route-specific) middleware.
First assign the middleware a key within the $routeMiddleware property of the app/Http/Kernel.php class, then use that key when specifying middleware at the route level.
Write code to assign the ‘auth’ middleware to one route.
Route::get($uri, $callback)->middleware(‘auth’);
You may also pass the fully qualified class name, rather than the key.
Write code to assign two middleware to one route.
Route::get($uri, $callback)->middleware(‘one’, ‘two’);
You may also pass the fully qualified class name, rather than the key.
Write code to apply ‘auth’ middleware to a group of routes.
Route::middleware('auth')->group(function(){
// routes go here
});When assigning middleware to a group of routes, how to prevent the middleware from being applied to an individual route within the group?
Chain ->withoutMiddleware(‘name’); onto that route.
This can only apply to routeMiddleware and does not apply to global middleware.
What does the VerifyCsrfToken middleware do?
Checks that the token in the request input matches the token stored in the session.
How would you exclude a set of URIs from CSRF protection?
Place them outside of the web middleware group, or, add the URIs to the $except property of the VerifyCsrfToken middleware class. (You may use wildcards in the URLs, eg: ‘stripe/*’.)
When is CSRF protection automatically disabled?
When running tests.
What directory are controllers stored in?
app/Http/Controllers
What is the main benefit to using Controllers?
Controllers group related request handling logic into a single class.
All Controller classes extend which class?
They all extend the app/Http/Controller.php class, which itself extends the BaseController class.
Does a Controller have to extend the BaseController class?
No, but then you will not have access to convenience features such as the middleware, validate and dispatch methods.
How to define a route to a controller action?
Route::get(‘user’/{id}’, ‘UserController@show’);
Here, the show method on the UserController class will be executed. The route parameter will be passed to the method.
Is it necessary to specify the full controller namespace when defining a controller route?
No, the RouteServiceProvider loads your routes within the App\Http\Controller namespace.
If you nest your controllers deeper into the App\Http\Controllers directory, how to specify their namespace when registering a route?
Route:get(‘foo’, ‘Photos\SomeController@method’);
Assuming your full controller class namespace is: App\Http\Controllers\Photos\SomeController
How to structure a controller that only handles a single action?
Place a single __invoke method on the controller.
How to register a route for a single action controller?
You do not need to specify the __invoke method:
Route::get(‘user/{id}’, ‘ShowProfile’);
How to generate a single-action controller using artisan?
php artisan make:controller SomeController –invokable
A single-action controller is also known as?
An invokable controller.
Briefly, what are two ways to assign middleware?
Either to routes:
Route::get(‘users’, ‘UsersController@index’)->middleware(‘auth’);
or in the __construct method of a controller:
$this->middleware(‘auth’);
Give examples of assigning middleware to a controller and how to restrict the middleware to only certain methods.
public function __construct()
{
$this->middleware(‘auth’);
$this->middleware(‘log’)->only(‘index’);
$this->middleware(‘subscribed’)->except(‘store’);
}
Write the artisan command to create a controller to handle all “CRUD” HTTP requests for your app’s photos.
php artisan make:controller PhotoController –resource
How to register a resourceful route to a resource controller?
Route::resource(‘photos’, ‘PhotosController’);
How to register routes to many resource controllers at once?
Pass an array to the Route::resources (plural) method:
Route::resources([
‘photos’ => ‘PhotoController’,
‘posts’ => ‘PostController’
]);
When would you use the flag –model in artisan like this:
php artisan make:controller PhotoController –resource –model=Photo
When you want to use route model binding and would like the resource controller’s methods to type-hint a model instance.
When declaring resource routes, how would you specify only a subset of actions the controller should handle?
Define partial resource routes be chaining on either the only or except methods to Route::resource:
Route::resource(‘photos’, ‘PhotoController’)->only([
‘index’, ‘show’
]);
What if you need to add additional routes to a resource controller beyond the default set of resource routes?
Always define those routes BEFORE your call to Route::resource to avoid unintentional clashes.
How does Laravel resolve controller calls?
Using the service container. Declared dependencies are automatically resolved and injected into the controller instance.
If your controller method is expecting route parameters, but you also want other parameters injected, how to list them in the method header?
Always list your route parameters AFTER other dependencies like $request eg:
public function update(Request $request, $id)
{
…
}
How to generate a route cache?
Run the artisan command:
php artisan route:cache
(You must exclusively use controller-based routes, no closures.)
