Главная/🏗Структура приложения

05Контроллеры и действия

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

⏱ ~7 мин 📚 1 глава руководства Изучено

Контроллер принимает запрос, дёргает модели и отдаёт результат в представление. Он состоит из действий — публичных методов actionXxx() или отдельных классов. Маршрут post/view — это PostController::actionView().

Минимальный контроллер#

controllers/PostController.phpPHP

namespace app\controllers;

use Yii;
use app\models\Post;
use yii\web\Controller;
use yii\web\NotFoundHttpException;

class PostController extends Controller
{
    public function actionView($id)
    {
        $model = Post::findOne($id);
        if ($model === null) {
            throw new NotFoundHttpException();          // → страница 404
        }
        return $this->render('view', ['model' => $model]);
    }

    public function actionCreate()
    {
        $model = new Post();
        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        }
        return $this->render('create', ['model' => $model]);
    }
}

Веб-контроллеры наследуют yii\web\Controller, консольные — yii\console\Controller.

Маршруты и имена#

Маршрут: контроллер/действие или модуль/контроллер/действие. Идентификаторы — в нижнем регистре, слова через дефис.

ID контроллера	Класс
`article`	`app\controllers\ArticleController`
`post-comment`	`app\controllers\PostCommentController`
`admin/post-comment`	`app\controllers\admin\PostCommentController` (подпапка без модуля)

Пространство имён задаёт controllerNamespace приложения (по умолчанию app\controllers). Если соглашение не подходит — например, контроллер из чужой библиотеки — используйте карту:

PHP

'controllerMap' => [
    'account' => 'app\controllers\UserController',
    'article' => [
        'class' => 'app\controllers\PostController',
        'enableCsrfValidation' => false,
    ],
],

Маршрут без действия → defaultAction контроллера (index); запрос без маршрута → defaultRoute приложения (site). Оба можно переопределить:

PHP

class SiteController extends Controller
{
    public $defaultAction = 'home';
}

Действия#

Встроенные (inline)#

Публичный метод с префиксом action. Имя метода — из ID действия: hello-world → actionHelloWorld.

Отдельные (standalone)#

Класс, унаследованный от yii\base\Action, с методом run(). Регистрируется в карте действий контроллера. Так удобно переиспользовать действия между контроллерами и в расширениях:

PHP

public function actions()
{
    return [
        'error' => 'yii\web\ErrorAction',                      // страница ошибки
        'captcha' => ['class' => 'yii\captcha\CaptchaAction'],
        'page' => ['class' => 'yii\web\ViewAction', 'viewPrefix' => 'pages'],   // статические страницы
    ];
}

components/HelloWorldAction.phpPHP

namespace app\components;

use yii\base\Action;

class HelloWorldAction extends Action
{
    public $greeting = 'Hello';

    public function run($name = 'World')
    {
        return "{$this->greeting}, {$name}";
    }
}

ID отдельных действий могут быть любыми — они заданы явно в actions().

Результат действия#

Что вернули	Что произойдёт
строка	станет телом ответа (обычно результат `$this->render()`)
объект `Response`	отправится как есть — так работает `$this->redirect()`
массив / любые данные	попадёт в `Response::data` и отформатируется по `Response::format` (JSON, XML…)
число в консоли	код выхода команды

PHP

public function actionForward()
{
    return $this->redirect('https://example.com');   // redirect() возвращает Response
}

public function actionInfo()
{
    Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
    return ['message' => 'hello', 'code' => 100];
}

Параметры действий#

Параметры метода заполняются из $_GET по имени (в консоли — из аргументов командной строки):

PHP

public function actionView($id, $version = null) { /* ... */ }

?r=post/view&id=123 → $id = '123', $version = null;
?r=post/view → BadRequestHttpException — обязательный параметр не передан;
?r=post/view&id[]=123 → BadRequestHttpException — ожидался скаляр, пришёл массив.

Чтобы принять массив, укажите тип: public function actionView(array $id) — тогда скаляр автоматически обернётся в массив.

Жизненный цикл контроллера#

init() — контроллер создан и сконфигурирован.
Создание действия по ID: сначала карта actions(), затем метод actionXxx(), иначе InvalidRouteException.
beforeAction() последовательно у приложения, модуля и контроллера. Вернул false — остальные пропускаются, действие не выполняется. Здесь работают фильтры.
Выполнение действия с параметрами из запроса.
afterAction() в обратном порядке: контроллер → модуль → приложение.
Результат уходит в компонент response.

Что ещё умеет контроллер#

render($view, $params)

представление + шаблон (layout)

renderPartial($view, $params)

без шаблона

renderAjax($view, $params)

без шаблона, но с зарегистрированными JS/CSS — для ответов на AJAX

renderContent($html)

обернуть готовую строку в шаблон

redirect($url, $statusCode = 302)

перенаправление; $url может быть маршрутом-массивом

goHome(), goBack(), refresh()

на главную, на предыдущий URL (см. Url::remember()), перезагрузка текущей страницы

asJson($data), asXml($data)

сами выставляют response->format и возвращают объект ответа: его нужно вернуть из действия

behaviors()

фильтры контроллера: доступ, HTTP-методы, кеш

$layout

свой шаблон для этого контроллера; false — без шаблона

$enableCsrfValidation

проверка CSRF-токена для POST (по умолчанию включена)

Типичный CRUD#

Так выглядит контроллер, который генерирует Gii, — хороший образец «тонкого» контроллера:

PHP

use yii\filters\VerbFilter;
use yii\web\NotFoundHttpException;

class PostController extends Controller
{
    public function behaviors()
    {
        return [
            'verbs' => [
                'class' => VerbFilter::class,
                'actions' => ['delete' => ['POST']],
            ],
        ];
    }

    public function actionIndex()
    {
        $searchModel = new PostSearch();
        $dataProvider = $searchModel->search(Yii::$app->request->queryParams);
        return $this->render('index', compact('searchModel', 'dataProvider'));
    }

    public function actionUpdate($id)
    {
        $model = $this->findModel($id);
        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            Yii::$app->session->setFlash('success', 'Сохранено');
            return $this->redirect(['view', 'id' => $model->id]);
        }
        return $this->render('update', ['model' => $model]);
    }

    public function actionDelete($id)
    {
        $this->findModel($id)->delete();
        return $this->redirect(['index']);
    }

    protected function findModel($id)
    {
        if (($model = Post::findOne($id)) !== null) {
            return $model;
        }
        throw new NotFoundHttpException('Запись не найдена.');
    }
}

Проверь себя5

app\controllers\admin\PostCommentController::actionCreateReply() — префикс до слеша трактуется как подпапка пространства имён.

Это самостоятельный класс: его можно переиспользовать в разных контроллерах, настраивать через конфигурацию и распространять в расширениях (ErrorAction, CaptchaAction, ViewAction).

Будет выброшено BadRequestHttpException (HTTP 400) ещё до выполнения действия.

Установить Yii::$app->response->format = Response::FORMAT_JSON и вернуть массив, либо вызвать return $this->asJson($data).

Приложение → модуль → контроллер; любой false останавливает цепочку.