04Приложение и его компоненты

Что есть в приложении кроме MVC#

Входной скрипт#

Он делает пять вещей: объявляет константы, подключает автозагрузчик Composer и класс Yii, читает конфигурацию, создаёт приложение и вызывает run().

<?php
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'dev');

require __DIR__ . '/../vendor/autoload.php';          // автозагрузчик Composer
require __DIR__ . '/../vendor/yiisoft/yii2/Yii.php';  // класс Yii + автозагрузчик Yii + DI-контейнер

$config = require __DIR__ . '/../config/web.php';

(new yii\web\Application($config))->run();

#!/usr/bin/env php
<?php
defined('YII_DEBUG') or define('YII_DEBUG', true);

require __DIR__ . '/vendor/autoload.php';
require __DIR__ . '/vendor/yiisoft/yii2/Yii.php';

$config = require __DIR__ . '/config/console.php';

$exitCode = (new yii\console\Application($config))->run();
exit($exitCode);

Константы объявляют в самом начале, до подключения других файлов:

defined('X') or define('X', v) — идиома «определить, если ещё не определено»: так константу можно переопределить снаружи, например в тестовом входном скрипте.

Объект приложения#

Два вида: yii\web\Application для HTTP и yii\console\Application для команд. Оба наследуют yii\base\Application, которая в свою очередь — модуль и Service Locator.

Обязательные свойства#

return [
    'id' => 'basic',                    // уникальный идентификатор приложения
    'basePath' => dirname(__DIR__),     // корень с кодом; задаёт псевдоним @app
    // ...
];

Свойства, которые настраивают чаще всего#

Свойства с разумными умолчаниями#

События приложения#

Обработчики вешают прямо в конфигурации через синтаксис 'on имяСобытия' или кодом после создания приложения:

return [
    'on beforeRequest' => function ($event) {
        // приложение создано, запрос ещё не обрабатывался — удобно выбрать язык по домену
    },
    'on beforeAction' => function (\yii\base\ActionEvent $event) {
        if ($somethingWrong) {
            $event->isValid = false;   // отменить выполнение действия
        }
    },
    'on afterAction' => function (\yii\base\ActionEvent $event) {
        $event->result = strtoupper($event->result);   // изменить результат действия
    },
];

Жизненный цикл приложения#

Подробнее о каждом шаге — в разделе Жизненный цикл запроса.

Компоненты приложения#

Приложение — это Service Locator: набор именованных объектов, к которым обращаются как Yii::$app->id. Компонент создаётся при первом обращении и дальше переиспользуется в рамках запроса.

'components' => [
    'cache' => 'yii\caching\ApcCache',                 // просто имя класса
    'db' => [                                          // массив конфигурации
        'class' => 'yii\db\Connection',
        'dsn' => 'mysql:host=localhost;dbname=demo',
        'username' => 'root',
        'password' => '',
        'charset' => 'utf8',
    ],
    'search' => function () {                           // фабрика-замыкание
        return new app\components\SolrService('127.0.0.1');
    },
],

Если компонент нужен в каждом запросе, даже когда к нему явно не обращаются (например, log должен ловить сообщения с самого начала), добавьте его ID в bootstrap:

'bootstrap' => ['log'],

Встроенные компоненты#

У них фиксированные ID и классы по умолчанию — достаточно указать только нужные свойства.