HTTP-отклики

Создание откликов

Строки и массивы

Все маршруты и контроллеры должны возвращать отклик для отправки обратно в браузер. Laravel предоставляет несколько разных способов для возврата откликов. Самый основной отклик — простой возврат строки из маршрута или контроллера. Фреймворк автоматически конвертирует строку в полный HTTP-отклик:

Route::get('/', function () {
  return 'Hello World';
});

Route::get('/', function () {
  return [1, 2, 3];
});

Route::get('home', function () {
  return response('Hello World', 200)
                ->header('Content-Type', 'text/plain');
});

use Illuminate\Http\Response;

Route::get('home', function () {
  return (new Response($content, $status))
                ->header('Content-Type', $value);
});

Route::get('home', function () {
  return response($content, $status)
                ->header('Content-Type', $value);
});

Добавление заголовков в отклики

Имейте ввиду, что большинство методов Response сцепляемы, что делает создание откликов более гибким. Например, вы можете использовать метод PHPheader() для добавления нескольких заголовков в отклик перед его отправкой пользователю:

return response($content)
          ->header('Content-Type', $type)
          ->header('X-Header-One', 'Header Value')
          ->header('X-Header-Two', 'Header Value');

return response($content)
          ->withHeaders([
            'Content-Type' => $type,
            'X-Header-One' => 'Header Value',
            'X-Header-Two' => 'Header Value',
          ]);

return response()->view('hello')->header('Content-Type', $type);

Добавление cookie в отклики

return response($content)
                ->header('Content-Type', $type)
                ->cookie('name', 'value', $minutes);

->cookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly)

<?php

namespace App\Http\Controllers;

use Cookie;
use App\Http\Controllers\Controller;
class DashboardController extends Controller
{
  /**
   * Показать панель управления приложения.
   *
   * @return Response
   */
  public function index()
  {
    Cookie::queue('saw_dashboard', true, 15);

    return view('dashboard');
  }
}

return response($content)->header('Content-Type', $type)
               ->withCookie('name', 'value');

->withCookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly)

Cookies и шифрование

По умолчанию все генерируемые cookie в Laravel шифруются и подписываются, поэтому они не могут быть прочитаны или изменены клиентом. Если вы хотите отключить шифрование для определённого набора cookie в вашем приложении, вы можете использовать свойство PHP$except посредника App\Http\Middleware\EncryptCookies, который находится в каталоге app/Http/Middleware:

/**
 * Названия тех cookie, которые не надо шифровать.
 *
 * @var array
 */
protected $except = [
  'cookie_name',
];

Переадресация

Отклики для переадресации — это объекты класса Illuminate\Http\RedirectResponse, и они содержат надлежащие заголовки, необходимые для переадресации пользователя на другой URL. Есть несколько способов создания объекта RedirectResponse. Простейший из них — использовать глобальный вспомогательный метод PHPredirect():

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

Если вы захотите переадресовать пользователя на предыдущую страницу (например, после отправки формы с некорректными данными), используйте глобальный метод PHPback(). Поскольку для этого используются сессии, маршрут, вызывающий метод PHPback(), должен использовать группу посредников web или должен применять всех посредников сессий:

Route::post('user/profile', function () {
  // Проверка запроса...

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

Переадресация на именованный маршрут

Когда вы вызываете функцию PHPredirect() без параметров, возвращается экземпляр Illuminate\Routing\Redirector, позволяя вам вызывать любой метод объекта Redirector. Например, для создания RedirectResponse на именованный маршрут вы можете использовать метод PHProute():

return redirect()->route('login');

Если у вашего маршрута есть параметры, вы можете передать их в качестве второго аргумента в метод PHProute():

// Для маршрута с таким URI: profile/{id}

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

Заполнение параметров через модели Eloquent

Если вы переадресовываете на маршрут с параметром «ID», который был взят из модели Eloquent, то вы можете просто передать саму модель. ID будет извлечён автоматически:

// Для маршрута с таким URI: profile/{id}

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

/**
 * Получить значение ключа маршрута модели.
 *
 * @return mixed
 */
public function getRouteKey()
{
  return $this->slug;
}

// Для маршрута с таким URI: profile/{user}

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

Переадресация на действие контроллера

Также вы можете создать отклик-переадресацию на действие контроллера. Для этого передайте контроллер и название действия в метод PHPaction().

return redirect()->action('HomeController@index');

return redirect()->action('App\Http\Controllers\HomeController@index');

Если маршрут вашего контроллера требует параметров, вы можете передать их вторым аргументом метода PHPaction():

return redirect()->action(
  'UserController@profile', ['id' => 1]
);

return redirect()->action('App\Http\Controllers\UserController@profile', ['user' => 1]);

Переадресация с одноразовыми переменными сессии

Переадресация на новый URL и передача данных в сессию обычно происходят в одно время. Обычно это делается после успешного выполнения действия, когда вы передаёте сообщение об этом в сессию. Для удобства вы можете создать экземпляр RedirectResponse и передать данные в сессию в одной гибкой связке методов:

Route::post('user/profile', function () {
  // Обновление профиля пользователя...

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

Когда пользователь переадресован, вы можете вывести одноразовое сообщение из сессии. Например, с помощью синтаксиса Blade:

@if (session('status'))
  <div class="alert alert-success">
    {{ session('status') }}
  </div>
@endif

Другие типы откликов

Метод PHPresponse() можно использовать для создания экземпляров откликов других типов. Когда PHPresponse() вызывается без аргументов, возвращается реализация контракта Illuminate\Contracts\Routing\ResponseFactory. Этот контракт предоставляет несколько полезных методов для создания откликов.

Отклики представления

Если вам необходим контроль над статусом и заголовком отклика, но при этом необходимо возвращать представление в качестве содержимого отклика, используйте метод PHPview():

return response()
            ->view('hello', $data, 200)
            ->header('Content-Type', $type);

Конечно, если вам не надо передавать свой код HTTP-статуса и свои заголовки, вы можете просто использовать глобальную функцию PHPview().

JSON-отклики

Метод PHPjson() автоматически задаст заголовок Content-Type для application/json, а также конвертирует данный массив в JSON при помощи PHP-функции PHPjson_encode():

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

Если вы хотите создать JSONP-отклик, используйте метод PHPjson() совместно с методом PHPsetCallback():

return response()
            ->json(['name' => 'Abigail', 'state' => 'CA'])
            ->withCallback($request->input('callback'));

Отклик загрузки файла

Метод PHPdownload() используется для создания отклика, получив который, браузер пользователя скачивает файл по указанному пути. Метод PHPdownload() принимает вторым аргументом имя файла, именно это имя увидит пользователь при скачивании файла. И наконец, вы можете передать массив HTTP-заголовков третьим аргументом метода:

return response()->download($pathToFile);

return response()->download($pathToFile, $name, $headers);

Класс Symfony HttpFoundation, который управляет загрузкой файлов, требует, чтобы загружаемый файл имел ASCII-имя.

return response()->file($pathToFile);

return response()->file($pathToFile, $headers);

Макрос отклика

Если вы хотите определить собственный отклик, который вы смогли бы использовать повторно в различных маршрутах и контроллерах, то можете использовать метод PHPmacro() на фасаде Response. Например, из метода PHPboot() сервис-провайдера:

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Response;
//для версии 5.2 и ранее:
//use Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
  /**
   * Регистрация макроса отклика приложения.
   *
   * @return void
   */
  public function boot()
  {
    Response::macro('caps', function ($value) {
      return Response::make(strtoupper($value));
    });
  }
}

<?php

namespace App\Providers;

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

class ResponseMacroServiceProvider extends ServiceProvider
{
  /**
   * Выполнение загрузки сервисов после регистрации.
   *
   * @param  ResponseFactory  $factory
   * @return void
   */
  public function boot(ResponseFactory $factory)
  {
    $factory->macro('caps', function ($value) use ($factory) {
      return $factory->make(strtoupper($value));
    });
  }
}

Функция PHPmacro() принимает имя в качестве первого аргумента и замыкание в качестве второго. Замыкание макроса будет выполнено при вызове имени макроса из реализации ResponseFactory: или из метода PHPresponse():

return response()->caps('foo');