Контроллеры

Статистика: Символов — 11 073/9 422 без пробелов (5 553/4 786 без кода):, слов — 768
Разметка: Wiki
{{TOC}}

{{DOCVER 4.0=0da300f6445bec5a70d007f503834fce957b065b 16.10.2014 04:19:00, 4.1=efd541a0b218b1c6aafb73f0051c18ed150e3c24 25.05.2014 05:21:00, 4.2=d7b13440c003218ed79e9d508706eca01990122f 4.12.2014 5:01:15}}

== Простейшие контроллеры ==
Вместо того, чтобы определять всю ((docs/v4/routing маршрутизацию)) (//routing//) вашего проекта в файле %%(t)routes.php%% вы можете организовать её, используя класс %%Controller%%. Контроллеры могут группировать связанную логику в отдельные классы, а кроме того использовать дополнительные возможности Laravel, такие как автоматическое ((docs/v4/ioc внедрение зависимостей)).

Контроллеры обычно хранятся в папке %%(t)app/controllers%%, а этот путь по умолчанию зарегистрирован в ((docs/v4/configuration настройке)) **classmap** вашего файла %%(t)composer.json%%. Тем не менее контроллеры технически могут жить в любом каталоге или подкаталоге. Объявления маршрутов не зависят от расположения на диске файла класса контроллера. Поэтому, пока Composer знает, как автоматически загружать класс контроллера, этот файл может быть размещён где угодно.

Вот пример простейшего класса контроллера:
%%
  class UserController extends BaseController {

      /**
       * Отобразить профиль соответствующего пользователя.
       */
      public function showProfile($id)
      {
          $user = User::find($id);

          return View::make('user.profile', array('user' => $user));
      }

  }
%%

Все контроллеры должны наследовать класс %%BaseController%%. Этот класс также может хранится в папке %%(t)app/controllers%% и в него можно поместить общую логику для других контроллеров. %%BaseController%% расширяет стандартный класс Laravel, %%Controller%%.

Теперь, определив контроллер, мы можем зарегистрировать маршрут для его действия (//action//):
%%
  Route::get('user/{id}', 'UserController@showProfile');
%%

Если вы решили организовать ваши контроллеры в пространства имён, просто используйте полное имя класса при определении маршрута:
%%
  Route::get('foo', 'Namespace\FooController@method');
%%

.(alert)
Поскольку мы используем ((http://getcomposer.org Composer)) для автозагрузки наших PHP-классов, то контроллеры могут жить где угодно в файловой системе, пока Composer знает, как их загружать. Для каталога контроллера не требуется какая-либо особая структура папок в вашем приложении. Маршрутизация контроллеров полностью отделена от файловой системы.

.(tl_note)
Помните, что имена класса в строках следуют обычным правилам PHP и если ваш класс начинается с **n**, **t** и других букв в нижнем регистре, то обратный слэш перед ними нужно экранировать - иначе они преобразуются в разрыв строки, табуляцию или иной спецсимвол: %%"namespace\new_controller"%% - //прим. пер.//

Вы также можете присвоить имя этому маршруту:
%%
  Route::get('foo', array('uses' => 'FooController@method',
                          'as' => 'name'));
%%

Вы можете получить URL к //действию// методом %%URL::action()%% или вспомогательный метод %%action()%%:
%%
  $url = URL::action('FooController@method');

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

Получить имя //действия//, которое выполняется в данном запросе, можно методом %%currentRouteAction()%%:
%%
  $action = Route::currentRouteAction();
%%

== Фильтры для контроллеров ==
((docs/v4/routing#фильтры Фильтры)) могут указываться для контроллеров аналогично "обычным" маршрутам:
%%
  Route::get('profile', array('before' => 'auth',
             'uses' => 'UserController@showProfile'));
%%

Однако вы можете указывать их и изнутри самого контроллера:
%%
  class UserController extends BaseController {

      /**
       * Создать экземпляр класса UserController.
       */
      public function __construct()
      {
          $this->beforeFilter('auth', array('except' => 'getLogin'));

          $this->beforeFilter('csrf', array('on' => 'post'));

          $this->afterFilter('log', array('only' =>
                              array('fooAction', 'barAction')));
      }

  }
%%

Можно устанавливать фильтры в виде функции-замыкания:
%%
  class UserController extends BaseController {

      /**
       * Создать экземпляр класса UserController.
       */
      public function __construct()
      {
          $this->beforeFilter(function () {
              //
          });
      }

  }
%%

%%(DOCNEW 4.1=efd541a0b218b1c6aafb73f0051c18ed150e3c24 25.05.2014 05:21:00)
Если вы хотите использовать другой метод в качестве фильтра для контроллера, то можете использовать **@**-синтаксис для определения фильтра:
~%%
	class UserController extends BaseController {

		/**
		 * Создание нового экземпляра UserController.
		 */
		public function __construct()
		{
			$this->beforeFilter('@filterRequests');
		}

		/**
		 * Фильтрация входящих запросов.
		 */
		public function filterRequests($route, $request)
		{
			//
		}

	}
~%%
%%

== ((#restful)) Неявные контроллеры ==
Laravel позволяет вам легко создавать единый маршрут для обработки всех //действий// контроллера. Для начала зарегистрируйте маршрут методом %%Route::controller()%%.
%%
  Route::controller('users', 'UserController');
%%

.(tl_note)
До версии 4.2 "неявные" контроллеры назывались "((ВП:REST RESTful))" - //прим. пер.//

Метод %%controller()%% принимает два аргумента. Первый - корневой ((ВП:URI)) (путь), который обрабатывает данный контроллер, а второй - имя класса самого контроллера. После регистрации просто добавьте методы в этот класс с префиксом в виде типа HTTP-запроса (//HTTP verb//), который они обрабатывают.

%%
  class UserController extends BaseController {

      public function getIndex()
      {
          // GET-запрос.
      }

      public function postProfile()
      {
          // POST-запрос.
      }

      public function anyLogin()
      {
          //
      }

  }
%%

Методы **index** обрабатывают корневой URI контроллера - в нашем случае это %%(t)users%%.

Если имя //действия// вашего контроллера состоит из нескольких слов вы можете обратиться к нему по URI, используя синтаксис с дефисами (%%(t)-%%). Например, следующее действие в нашем классе %%UserController%% будет доступно по адресу %%(t)users/admin-profile%%:
%%
  public function getAdminProfile() {}
%%

== ((#ресурс)) RESTful-контроллеры ресурсов ==
Контроллеры ресурсов упрощают построение RESTful-контроллеров, работающих с ресурсами. Например, вы можете создать контроллер, обрабатывающий фотографии, хранимые вашим приложением. Вы можете быстро создать такой контроллер с помощью команды **controller:make** интерфейса ((docs/v4/artisan Artisan)) и метода %%Route::resource()%%.

.(tl_note)
До версии 4.2 эти контроллеры назывались просто ресурсными, а RESTful были те, что с этой версии стали называться "неявными" - //прим. пер.//

Для создания контроллера выполните следующую консольную команду:
%%(sh)
  php artisan controller:make PhotoController
%%

Теперь мы можем зарегистрировать его как контроллер ресурса:
%%
  Route::resource('photo', 'PhotoController');
%%

Этот единственный вызов создаёт множество маршрутов для обработки различных RESTful-действий на ресурсе %%(t)photo%%. Сам сгенерированный контроллер уже имеет методы-заглушки для каждого из этих маршрутов с комментариями, которые напоминают вам о том, какие типы запросов они обрабатывают.

**Запросы, обрабатываемые контроллером ресурсов**
%%(hvlraw)
  <table>
    <thead>
      <tr>
        <th>Тип</th>
        <th>Путь</th>
        <th>Действие</th>
        <th>Имя маршрута</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>GET</td>
        <td>/resource</td>
        <td>index</td>
        <td>resource.index</td>
      </tr>
      <tr>
        <td>GET</td>
        <td>/resource/create</td>
        <td>create</td>
        <td>resource.create</td>
      </tr>
      <tr>
        <td>POST</td>
        <td>/resource</td>
        <td>store</td>
        <td>resource.store</td>
      </tr>
      <tr>
        <td>GET</td>
        <td>/resource/{resource}</td>
        <td>show</td>
        <td>resource.show</td>
      </tr>
      <tr>
        <td>GET</td>
        <td>/resource/{resource}/edit</td>
        <td>edit</td>
        <td>resource.edit</td>
      </tr>
      <tr>
        <td>PUT/PATCH</td>
        <td>/resource/{resource}</td>
        <td>update</td>
        <td>resource.update</td>
      </tr>
      <tr>
        <td>DELETE</td>
        <td>/resource/{resource}</td>
        <td>destroy</td>
        <td>resource.destroy</td>
      </tr>
    </tbody>
  </table>
%%

Иногда вам может быть нужно обрабатывать только часть всех возможных действий:
%%(sh)
  php artisan controller:make PhotoController --only=index,show

  php artisan controller:make PhotoController --except=index
%%

Вы можете указать этот набор и при регистрации ((docs/v4/routing маршрута)):
%%
  Route::resource('photo', 'PhotoController',
                  array('only' => array('index', 'show')));
  // либо:
  Route::resource('photo', 'PhotoController',
                  array('except' => array('create', 'store', 'update', 'destroy')));
%%

%%(DOCNEW 4.1=efd541a0b218b1c6aafb73f0051c18ed150e3c24 25.05.2014 05:21:00)
По умолчанию все действия контроллера ресурсов имеют имена маршрутов, но вы можете переопределить эти имена, передав массив %%names%% с нужными значениями:
~%%
Route::resource('photo', 'PhotoController',
				array('names' => array('create' => 'photo.build')));
~%%
%%

%%(DOCNEW 4.2=d7b13440c003218ed79e9d508706eca01990122f 4.12.2014 5:01:15)
**Обработка контроллеров вложенных ресурсов**
Используйте "точечную" нотацию в объявлении маршрута для контроллеров "вложенных" ресурсов:
~%%
  Route::resource('photos.comments', 'PhotoCommentController');
~%%

Этот маршрут зарегистрирует "вложенный" ресурс, к которому можно обратиться по такому URL: %%(t)photos/{photoResource}/comments/{commentResource}%%.
~%%
  class PhotoCommentController extends BaseController {

    public function show($photoId, $commentId)
    {
      //
    }

  }
~%%

**Добавление дополнительных маршрутов в контроллеры ресурсов**
Когда вам необходимо добавить дополнительные маршруты в контроллер ресурсов, не входящие в маршруты ресурсов по умолчанию, их надо определить до вызова %%Route::resource%%:
~%%
  Route::get('photos/popular');
  Route::resource('photos', 'PhotoController');
~%%
%%

== Обработка неопределённых методов ==
При использовании %%Route::controller%% можно определить "catch-all" метод, который будет вызываться для обработки запроса, когда в контроллере нет соответствующего метода. Он должен называться **missingMethod** и принимать массив методов и параметров запроса в виде единственного своего аргумента.

%%
  public function missingMethod($parameters = array())
  {
      //
  }
%%

При использовании контроллеров ресурсов необходимо определить для них волшебный метод %%__call%% , чтобы обрабатывать любые отсутствующие методы.