Контроллеры

Введение

Вместо того, чтобы определять всю логику обработки запросов в виде замыканий в файлах маршуртов, вы можете организовать её с помощью классов контроллеров. Контроллеры могут группировать связанную с обработкой HTTP-запросов логику в отдельный класс. Контроллеры хранятся в папке app/Http/Controllers.

Простейшие контроллеры

Определение контроллеров

Ниже приведён пример простейшего класса контроллера. Обратите внимание, контроллер наследует базовый класс контроллера, встроенный в Laravel. Базовый класс предоставляет несколько удобных методов, таких как метод PHPmiddleware(), используемый для назначения посредников на действия контроллера:

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
  /**
   * Показать профиль данного пользователя.
   *
   * @param  int  $id
   * @return Response
   */
  public function show($id)
  {
    return view('user.profile', ['user' => User::findOrFail($id)]);
  }
}

Мы можем определить маршрут для действия (action) этого контроллера вот так:

Route::get('user/{id}', 'UserController@show');

Теперь при соответствии запроса указанному URI маршрута будет выполняться метод PHPshow() класса UserController. Само собой параметры маршрута также будут переданы в метод.

Контроллерам не обязательно наследовать базовый класс. Но тогда у вас не будет таких удобных возможностей, как методы PHPmiddleware(), PHPvalidate() и PHPdispatch().

Контроллеры и пространства имён

Важно помнить, что при определении маршрута контроллера нам не надо указывать полное пространство имён контроллера, а только ту часть имени класса, которая следует за «корнем» пространства имён — App\Http\Controllers. Потому что RouteServiceProvider загружает ваши файлы маршрутов вместе с группой маршрутизации, содержащей корневое пространство имён контроллера.

Если вы решите разместить свои контроллеры в поддиректориях App\Http\Controllers, то просто используйте конкретное имя класса относительно корня пространства имён App\Http\Controllers. Тогда, если полный путь к вашему классу будет App\Http\Controllers\Photos\AdminController, то вам надо зарегистрировать маршруты к контроллеру вот так:

Route::get('foo', 'Photos\AdminController@method');

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class ShowProfile extends Controller
{
  /**
   * Показать профиль данного пользователя.
   *
   * @param  int  $id
   * @return Response
   */
  public function __invoke($id)
  {
    return view('user.profile', ['user' => User::findOrFail($id)]);
  }
}

Route::get('user/{id}', 'ShowProfile');

Route::get('foo', ['uses' => 'FooController@method', 'as' => 'name']);

$url = route('name');

$url = action('FooController@method');

$action = Route::currentRouteAction();

$url = action('App\Http\Controllers\FooController@method');

URL::setRootControllerNamespace('App\Http\Controllers');

$url = action('FooController@method');

Посредник контроллера

Посредник можно указать для маршрутов контроллера в файлах маршрутов:

Route::get('profile', 'UserController@show')->middleware('auth');

Route::get('profile', [
  'middleware' => 'auth',
  'uses' => 'UserController@showProfile'
]);

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

class UserController extends Controller
{
  /**
   * Создание нового экземпляра контроллера.
   *
   * @return void
   */
  public function __construct()
  {
    $this->middleware('auth');

    $this->middleware('log')->only('index');

    $this->middleware('subscribed')->except('store');
  }
}

class UserController extends Controller
{
  /**
   * Создание нового экземпляра UserController.
   */
  public function __construct()
  {
    $this->middleware('auth');

    $this->middleware('log', ['only' => [
      'fooAction',
      'barAction',
    ]]);

    $this->middleware('subscribed', ['except' => [
      'fooAction',
      'barAction',
    ]]);
  }
}

$this->middleware(function ($request, $next) {
  // ...

  return $next($request);
});

Контроллеры ресурсов

Маршрутизация ресурсов Laravel назначает обычные CRUD-маршруты на контроллеры одной строчкой кода. Например, вы можете создать контроллер, обрабатывающий все HTTP-запросы к фотографиям, хранимым вашим приложением. Вы можете быстро создать такой контроллер с помощью Artisan-команды shmake:controller:

shphp artisan make:controller PhotoController --resource

shphp artisan make:controller PhotoController

Эта команда сгенерирует контроллер app/Http/Controllers/PhotoController.php. Контроллер будет содержать метод для каждой доступной операции с ресурсами.

Теперь мы можем зарегистрировать маршрут контроллера ресурса:

Route::resource('photos', 'PhotoController');

Один этот вызов создаёт множество маршрутов для обработки различных действий для ресурса. Сгенерированный контроллер уже имеет методы-заглушки для каждого из этих действий с комментариями о том, какие URI и типы запросов они обрабатывают.

Действия, обрабатываемые контроллером ресурсов

<input type="hidden" name="_method" value="PUT">

{{ method_field('PUT') }}

Частичные маршруты ресурсов

При объявлении маршрута вы можете указать подмножество всех возможных действий, которые должен обрабатывать контроллер вместо полного набора стандартных действий:

Route::resource('photo', 'PhotoController', ['only' => [
    'index', 'show'
]]);

Route::resource('photo', 'PhotoController', ['except' => [
    'create', 'store', 'update', 'destroy'
]]);

Именование маршрутов ресурсов

По умолчанию все действия контроллера ресурсов имеют имена маршрутов, но вы можете переопределить эти имена, передав массив names вместе с остальными параметрами:

Route::resource('photo', 'PhotoController', ['names' => [
    'create' => 'photo.build'
]]);

Route::resource('photos.comments', 'PhotoCommentController');

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;

class PhotoCommentController extends Controller
{
  /**
   * Показать определённый комментарий к фото.
   *
   * @param  int  $photoId
   * @param  int  $commentId
   * @return Response
   */
  public function show($photoId, $commentId)
  {
    //
  }
}

Route::resource('user', 'AdminUserController', ['parameters' => [
    'user' => 'admin_user'
]]);

/user/{admin_user}

Route::resource('users.photos', 'PhotoController', [
    'parameters' => 'singular'
]);

// /users/{user}/photos/{photo}

Route::singularResourceParameters();

Route::resourceParameters([
    'user' => 'person', 'photo' => 'image'
]);

Добавление дополнительных маршрутов в контроллеры ресурсов

Если вам надо добавить дополнительные маршруты в контроллер ресурсов, не входящие в набор маршрутов ресурсов по умолчанию, их надо определить до вызова PHPRoute::resource, иначе определенные методом PHPresource() маршруты могут нечаянно «победить» ваши дополнительные маршруты:

Route::get('photos/popular', 'PhotoController@method');

Route::resource('photos', 'PhotoController');

Старайтесь, чтобы контроллеры были узкоспециализированными. Если вам постоянно требуются методы вне стандартного набора действий с ресурсами, попробуйте разделить контроллер на два небольших контроллера.

Route::controller('users', 'UserController');

<?php

namespace App\Http\Controllers;

class UserController extends Controller
{
  /**
   * Отклик на запрос GET /users
   */
  public function getIndex()
  {
    //
  }

  /**
   * Отклик на запрос GET /users/show/1
   */
  public function getShow($id)
  {
    //
  }

  /**
   * Отклик на запрос GET /users/admin-profile
   */
  public function getAdminProfile()
  {
    //
  }

  /**
   * Отклик на запрос POST /users/profile
   */
  public function postProfile()
  {
    //
  }
}

public function getAdminProfile() {}

Назначение имён маршрутов

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

Route::controller('users', 'UserController', [
  'getShow' => 'user.show',
]);

Внедрение зависимостей и контроллеры

Внедрение в конструктор

Сервис-контейнер в Laravel используется для работы всех контроллеров Laravel. В результате вы можете указывать типы любых зависимостей, которые могут потребоваться вашему контроллеру в его конструкторе. Заявленные зависимости будут автоматически получены и внедрены в экземпляр контроллера:

<?php

namespace App\Http\Controllers;

//для версии 5.1 и ранее:
//use Illuminate\Routing\Controller;

use App\Repositories\UserRepository;

class UserController extends Controller
{
  /**
   * Экземпляр репозитория пользователя.
   */
  protected $users;

  /**
   * Создание нового экземпляра контроллера.
   *
   * @param  UserRepository  $users
   * @return void
   */
  public function __construct(UserRepository $users)
  {
    $this->users = $users;
  }
}

Разумеется, вы можете также указать тип любого контракта Laravel. Если контейнер может с ним работать, значит вы можете указывать его тип. В некоторых случаях внедрение зависимостей в контроллер обеспечивает лучшую тестируемость приложения.

Внедрение в метод

Кроме внедрения в конструктор, вы также можете указывать типы зависимостей в методах вашего контроллера. Распространённый пример внедрения в метод — внедрение экземпляра Illuminate\Http\Request в один из методов контроллера:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
//для версии 5.1 и ранее:
//use Illuminate\Routing\Controller;

class UserController extends Controller
{
  /**
   * Сохранить нового пользователя.
   *
   * @param  Request  $request
   * @return Response
   */
  public function store(Request $request)
  {
    $name = $request->name;

    //
  }
}

Если метод вашего контроллера также ожидает данных из параметра маршрута, просто перечислите аргументы маршрута после остальных зависимостей. Например, если ваш маршрут определён так:

Route::put('user/{id}', 'UserController@update');

Вы по-прежнему можете указать тип Illuminate\Http\Request и обращаться к параметру id, определив метод контроллера вот так:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
//для версии 5.1 и ранее:
//use Illuminate\Routing\Controller;

class UserController extends Controller
{
  /**
   * Обновить данного пользователя.
   *
   * @param  Request  $request
   * @param  string $id
   *
   * //для версии 5.1 и ранее
   * @param  int $id
   *
   * @return Response
   */
  public function update(Request $request, $id)
  {
    //
  }
}

Кэширование маршрутов

Маршруты на основе замыканий нельзя кэшировать. Чтобы использовать кэширование маршрутов, необходимо перевести все маршруты замыканий на классы контроллера.

Если ваше приложение единолично использует маршруты контроллера, то вы можете воспользоваться преимуществом кэширования маршрутов в Laravel. Использование кэша маршрутов радикально уменьшит время, требуемое для регистрации всех маршрутов вашего приложения. В некоторых случаях регистрация ваших маршрутов может стать быстрее в 100 раз. Для создания кэша маршрутов просто выполните Artisan-команду shroute:cache:

shphp artisan route:cache

После выполнения этой команды ваши кэшированные маршруты будут загружаться при каждом запросе. Помните, после добавления новых маршрутов, вам необходимо заново сгенерировать свежий кэш маршрутов. Поэтому нужно выполнить команду shroute:cache уже при развёртывании вашего проекта.

Для очистки кэша маршрутов используйте команду shroute:clear:

shphp artisan route:clear