Laravel document sorting 6. Response

Preface ：Laravel Document sorting , Only for record , Nothing else .

1、laravel The basic response of the framework
Route::get('/', function () {
    return 'Hello World';
});

Ps：
A、laravel The basic response of the framework , Simply return a string through a route or controller
B、 The specified string will be automatically converted to by the framework HTTP Respond to

2、 The usual return , You need to return a complete Illuminate\Http\Response example , Such as ：
use Illuminate\Http\Response;

Route::get('home', function () {
    return (new Response($content, $status))
                  ->header('Content-Type', $value);
});
Ps： The reason for returning a complete instance , To facilitate the definition of headers and status codes
Response Class inherited by instance ：Symfony\Component\HttpFoundation\Response

3、 About response , For convenience , You can use auxiliary functions response, Such as ：
Route::get('home', function () {
    return response($content, $status)
                  ->header('Content-Type', $value);
});

4、 Most response methods can be called in a chain , Such as attaching headers to responses ：
return response($content)
            ->header('Content-Type', $type)
            ->header('X-Header-One', 'Header Value')
            ->header('X-Header-Two', 'Header Value');

5、 additional cookie To response
return response($content)->header('Content-Type', $type)
                 ->withCookie('name', 'value');

WithCookie Method has some additional parameters ：
->withCookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly)

Ps： By default ,laravel The framework will be right cookie To encrypt , Users cannot read and modify , however , If some , You don't want to encrypt , available App\Http\Middleware\EncryptCookies Middleware $except attribute , Such as ：
/**
 * No need to be encrypted cookies name .
 *
 * @var array
 */
protected $except = [
    'cookie_name',
];

6、 Auxiliary function response() Without any parameters , The return implementation is ？
Illuminate\Contracts\Routing\ResponseFactory Of contract Realization

7、 The response of the view
return response()->view('hello', $data)->header('Content-Type', $type);

8、json Respond to
return response()->json(['name' => 'Abigail', 'state' => 'CA']);

Ps：json() Method will automatically set the Content-Type Set to application/json, And through PHP Of json_encode() Method to convert the array to json

9、jsonP Respond to
return response()->json(['name' => 'Abigail', 'state' => 'CA'])
                 ->setCallback($request->input('callback'));

Ps：jsonp The response is relative to json Respond to , Just add one more setCallback Method

10、 File download response
return response()->download($pathToFile);

Ps：download Method to force the user browser to generate a response for downloading a file with a specified path .

Download There is another method 2、3 Parameters , They are file names 、http header , as follows ：
return response()->download($pathToFile, $name, $headers);

11、 Redirect response
Route::get('dashboard', function () {
    return redirect('home/dashboard');
});

Ps： Use redirect() Auxiliary function , Is the simplest redirect response

Common useful examples ： For example, the user submits an empty form , Just let him go back , Continue to that page , This is the time , be used back function , Such as
Route::post('user/profile', function () {
    // Verify the request ...

    return back()->withInput();
});

12、 Redirect to named route
return redirect()->route('login');

Ps： If the route has parameters , In the route The second argument to the method
// Redirect to the following URI: profile/{id}

return redirect()->route('profile', [1]);

If the route parameter is Eloquent Model id, Then the model is directly transferred to ,id Will be extracted
return redirect()->route('profile', [$user]);

13、 Redirect to controller behavior
return redirect()->action('[email protected]');

Ps： If the controller route requires parameters , It's in action Method , Pass in the second parameter
return redirect()->action('[email protected]', [1]);

14、 Redirect and add session Flash Data
Usually redirect to a new url, The data will be written to session. therefore , This is the time , Flash data is very convenient , Such as ：
Route::post('user/profile', function () {
    // Update the user's personal data ...

    return redirect('dashboard')->with('status', 'Profile updated!');
});
sync

After redirecting to a new page , If you still want to get the data on this page , Use blade The grammar of ：
@if (session('status'))
    <div class="alert alert-success">
        { { session('status') }}
    </div>
@endif

15、 Response macro
If you want to define a response that is reused in many routers and controllers , have access to
Illuminate\Contracts\Routing\ResponseFactory Method of implementation macro, give an example ：

From the service provider boot Method
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Contracts\Routing\ResponseFactory;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Provide services that run after registration .
     *
     * @param  ResponseFactory  $factory
     * @return void
     */
    public function boot(ResponseFactory $factory)
    {
        $factory->macro('caps', function ($value) use ($factory) {
            return $factory->make(strtoupper($value));
        });
    }
}
Ps：macro() The first argument to the method is the macro name , The second parameter is the closure function .
The closure function of the macro will be in responseFactory Implementation or auxiliary function of response The macro name is called when it is run .

Such as ：
return response()->caps('foo');