Оновлення із версії 1.1

Між версіями 1.1 і 2.0 існує багато відмінностей, оскільки Yii був повністю переписаний для версії 2.0. Таким чином, оновлення з версії 1.1 не є таким же тривіальним, як оновлення між мінорними версіями. У цьому посібнику з оновлення наведено основні відмінності між двома версіями.

Якщо раніше ви не використовували Yii 1.1, ви можете пропустити цей розділ і перейти до розділу "Встановлення Yii".

Також врахуйте, що Yii 2.0 надає більше нового функціоналу, ніж той, що буде описано тут. Наполегливо рекомендується прочитати посібник повністю, щоб дізнатися весь доступний функціонал. Можливо, що необхідний функціонал, який ви до цього розробляли самі, тепер є частиною фреймворку.

Встановлення

Yii 2.0 використовує Composer, який де-факто є менеджером пакунків для PHP. Встановлення фреймворку, також як і розширень, здійснюється через Composer. Більш детальні відомості по встановленню Yii 2.0 приведені в розділі Встановлення Yii. Відомості про те, як створювати розширення для Yii 2.0 або адаптувати вже наявні розширення для версії 1.1 під версію 2.0, наведені в розділі Створення розширень.

Вимоги PHP

Yii 2.0 використовує PHP 5.4 або вище, який включає велику кількість поліпшень в порівнянні з версією 5.2, яка використовувалася Yii 1.1. Таким чином, існує багато відмінностей у мові, які ви повинні приймати до уваги. Нижче наведені основні зміни в PHP:

Простори імен

Однією з основних змін в Yii 2.0 є використання просторів імен. Майже кожен клас фреймворку знаходиться у просторі імен, наприклад, yii\web\Request. Префікс "С" більше не використовується в іменах класів. Схема іменування зараз відповідає структурі директорій. Наприклад, yii\web\Request означає, що відповідний клас знаходиться у файлі web/Request.php в директорії фреймворку. (Завдяки завантажувачу класів Yii, ви можете використовувати будь-який клас фреймворку без необхідності безпосередньо підключати його).

Компонент та Обʼєкт

В Yii 2.0 клас CComponent із версії 1.1 був розділений на два класи: yii\base\BaseObject і yii\base\Component. Клас BaseObject є простим базовим класом, який дозволяє керувати властивостями обʼєкта за допомогою геттерів та сеттерів. Клас Component наслідується від класа BaseObject та підтримує події та поведінки.

Якщо вашому класу не потрібно використовувати функціонал подій та поведінок, ви можете використати BaseObject у якості базового класу. В основному, це випадки, коли класи представляють собою базові структури даних.

Конфігурація обʼєкта

Клас BaseObject надає єдиний спосіб конфігурування обʼєктів. Будь-який дочірній клас BaseObject може визначити конструктор (якщо потрібно) для своєї конфігурації наступним чином:

class MyClass extends \yii\base\BaseObject
{
    public function __construct($param1, $param2, $config = [])
    {
        // ... ініціализація до того, як буде застосована конфігурація

        parent::__construct($config);
    }

    public function init()
    {
        parent::init();

        // ... ініціализація після того, як була застосована конфігурація
    }
}

У прикладі вище, останній параметр конструктора повинен бути масивом конфігурації, який містить пари у форматі ключ-значення для ініціалізації властивостей обʼєкта. Ви можете перевизначити метод init() для ініціалізації обʼєкту після того, як до нього була застосована конфігурація.

Дотримуючись цієї угоди, ви зможете створювати і конфігурувати нові обʼєкти за допомогою масиву конфігурації:

$object = Yii::createObject([
    'class' => 'MyClass',
    'property1' => 'abc',
    'property2' => 'cde',
], [$param1, $param2]);

Більш детальна інформація про конфігурацію представлена у розділі Конфігурації.

Події

В Yii 1, події створювалися за допомогою оголошення методу on (наприклад, onBeforeSave). В Yii 2 ви можете тепер використовувати будь-яке імʼя події. Ви ініціюєте подію за допомогою виклику методу trigger().

$event = new \yii\base\Event;
$component->trigger($eventName, $event);

Для приєднання обробника події використовуйте метод on().

$component->on($eventName, $handler);
// прибрати обробник:
// $component->off($eventName, $handler);

Є також інші покращення у функціоналі подій. Більш детальна інформація представлена у розділі Події.

Псевдоніми шляху

Yii 2.0 розширює спосіб використання псевдонімів шляху як для файлів та директорій, так і для URL. У Yii 2.0 тепер також потрібно, щоб імʼя псевдоніма починалося із символу @, для розмежування псевдонімів від звичайних шляхів файлів/директорій і URL. Наприклад, псевдонім @yii відповідає директорії встановлення Yii. Псевдоніми шляху підтримуються в багатьох місцях коду Yii. Наприклад, yii\caching\FileCache::$cachePath може мати значення як псевдоніму шляху, так і звичайного шляху до директорії.

Псевдоніми шляху тісно повʼязані з простором імен класів. Рекомендується призначити псевдонім шляху для кожного базового простору імен, таким чином завантажувач класів Yii може використовуватися без будь-якої додаткової конфігурації. Наприклад, оскільки @yii посилається на директорію де встановленно Yii, клас yii\web\Request може бути завантажений автоматично. Якщо ви використовуєте сторонні бібліотеки, такі як Zend Framework, ви можете також визначити псевдонім шляху @Zend, який відповідає директорії встановлення цього фреймворку. Після чого Yii буде здатний автоматично завантажувати будь-який клас Zend Framework.

Більш детальна інформація про псевдоніми шляху представлена у розділі Псевдоніми.

Представлення

Однією із основних змін в Yii 2 є те, що спеціальна змінна $this у представленні більше не відповідає поточному контролеру або віджету. Замість цього, $this тепер відповідає обʼєкту представлення, новій можливості, яка була введена у версії 2.0. Обʼєкт представлення має тип yii\web\View, який являє собою частину представлення у шаблоні проектування Модель-Представления-Контролер (MVC). Якщо ви хочете отримати доступ до контролера або віджету, то використовуйте вираз $this->context.

Для формування часткових представлень тепер використовується метод $this->render(), а не $this->renderPartial(). Результат виклику методу render тепер повинен бути виведений безпосередньо, тому що render повертає результат, а не відображає його одразу. Наприклад,

echo $this->render('_item', ['item' => $item]);

Крім використання PHP у якості основного шаблонізатору, Yii 2.0 також включає офіційні розширення для основних популярних шаблонізаторів: Smarty і Twig. Шаблонізатор Prado більше не підтримується. Для використання вказаних шаблонізаторів вам необхідно сконфігурувати компонент додатка view за допомогою налаштування властивості View::$renderers.

Більш детальна інформація представлена у розділі Шаблонізатори.

Моделі

Yii 2.0 використовує основний клас yii\base\Model для моделей, аналогічний класу CModel у версії 1.1. Клас CFormModel більше не підтримується. Замість цього, для створення моделі форми у Yii 2.0 ви повинні безпосередньо успадковуватися від класу yii\base\Model.

У Yii 2.0 зʼявився новий метод scenarios() для оголошення сценаріїв, які підтримуються, і для позначення в якому сценарії атрибути повинні перевірятися, вважатися безпечними і т. п. Наприклад,

public function scenarios()
{
    return [
        'backend' => ['email', 'role'],
        'frontend' => ['email', '!role'],
    ];
}

У прикладі вище, оголошено два сценарії: backend і frontend. Для сценарію backend обидва атрибута email і role є безпечними та можуть бути масово призначені. Для сценарію frontend атрибут email може бути масово призначений, але атрибут role - ні. Обидва атрибути email та role повинні бути перевірені за допомогою правил валідації.

Метод rules() як і раніше використовується для оголошення правил валідації. Зверніть увагу, що у звʼязку з появою нового методу scenarios(), більше не підтримується валідатор unsafe.

У більшості випадків вам не потрібно перевизначати метод scenarios(), якщо метод rules() повністю вказує всі сценарії, що існують, та якщо немає потреби в оголошенні атрибутів небезпечними.

Більш детальна інформація представлена у розділі Моделі.

Контролери

В якості базового класу для контролерів в Yii 2.0 використовується yii\web\Controller, який є аналогічним CController у Yii 1.1. Базовим класом для всіх дій є yii\base\Action.

Однією із основних змін є те, що дія контролера тепер має повернути результат замість того, щоб безпосередньо виводити його:

public function actionView($id)
{
    $model = \app\models\Post::findOne($id);
    if ($model) {
        return $this->render('view', ['model' => $model]);
    } else {
        throw new \yii\web\NotFoundHttpException;
    }
}

Більш детальна інформація представлена у розділі Контролери.

Віджети

У Yii 2.0 клас yii\base\Widget використовується як базовий клас для віджетів, аналогічно CWidget у Yii 1.1.

Для кращої підтримки фреймворку в IDE, Yii 2.0 використовує новий синтаксис для віджетів. Нові статичні методи begin(), end(), та widget() використовуються таким чином:

use yii\widgets\Menu;
use yii\widgets\ActiveForm;

// Зверніть увагу, що ви повинні виводити результат
echo Menu::widget(['items' => $items]);

// Вказуємо масив для конфігурації властивостей обʼєкта
$form = ActiveForm::begin([
    'options' => ['class' => 'form-horizontal'],
    'fieldConfig' => ['inputOptions' => ['class' => 'input-xlarge']],
]);
... поля форми ...
ActiveForm::end();

Більш детальна інформація представлена у розділі Віджети.

Теми

У Yii 2.0 теми працюють абсолютно по-іншому. Тепер вони засновані на механізмі співставлення шляхів вихідного файлу представлення із темізованим файлом. Наприклад, якщо використовується співставлення шляхів ['/web/views' => '/web/themes/basic'], то темізована версія файлу представлення /web/views/site/index.php буде знаходитися у /web/themes/basic/site/index.php. З цієї причини теми можуть бути застосовані до будь-якого файлу представлення, навіть до представлення, яке сформоване за межами контексту контролера або віджету.

Також, більше не існує компонента CThemeManager. Замість цього є властивість theme компонента додатка view, яку можна сконфігурувати.

Більш детальна інформація представлена у розділі Темізація.

Консольні додатки

Консольні додатки тепер організовані як контролери, аналогічно веб-додаткам. Консольні контролери повинні бути успадковані від класу yii\console\Controller, аналогічного CConsoleCommand у версії 1.1.

Для виконання консольної команди, використовуйте yii <маршрут>, де <маршрут> це маршрут контролера (наприклад, sitemap/index). Додаткові анонімні аргументи будуть передані у якості параметрів відповідній дії контролера, у той час, як іменовані аргументи будуть передані у відповідності із оголошеннями у yii\console\Controller::options().

Yii 2.0 підтримує автоматичне генерування довідкової інформації із блоків коментарів.

Більш детальна інформація представлена у розділі Консольні команди.

I18N

У Yii 2.0 були прибрані вбудовані форматтери часу та чисел на користь PECL розширення PHP intl.

Переклад повідомлень тепер здійснюється через компонент додатка i18n. Даний компонент управляє наборами джерел повідомлень, що дозволяє вам використовувати різні джерела повідомлень, залежно від категорії повідомлення.

Більш детальна інформація представлена у розділі Інтернаціоналізація.

Фільтри дій

Фільтри дій тепер зроблені за допомогою поведінок. Новостворюваний фільтр необхідно успадкувати від yii\base\ActionFilter. Для використання фільтра - приєднайте його до контролера у якості поведінки. Наприклад, для використання фільтра yii\filters\AccessControl слід зробити наступне:

public function behaviors()
{
    return [
        'access' => [
            'class' => 'yii\filters\AccessControl',
            'rules' => [
                ['allow' => true, 'actions' => ['admin'], 'roles' => ['@']],
            ],
        ],
    ];
}

Більш детальна інформація представлена у розділі Фільтри.

Ресурси

У Yii 2.0 представлена нова можливість колекції ресурсів, яка замінює концепт пакунків скриптів у Yii 1.1.

Колекція ресурсів - це колекція файлів ресурсів (наприклад: Javascript файли, CSS файли, файли зображень, і т. п.) у певній директорії. Кожна колекція ресурсів представлена​ класом, успадкованим від yii\web\AssetBundle. Колекція ресурсів стає доступною через веб, за допомогою реєстрації її методом yii\web\AssetBundle::register(). На відміну від Yii 1.1, сторінка, яка реєструє колекцію ресурсів, автоматично буде містити посилання на Javascript і CSS файли, які зазначені у колекції.

Більш детальна інформація представлена у розділі Ресурси.

Хелпери

У Yii 2.0 включено багато широко використовуваних статичних класів.

Більш детальна інформація представлена у розділі Огляд хелперів.

Форми

Yii 2.0 вводить нове поняття поле для побудови форм за допомогою yii\widgets\ActiveForm. Поле - це контейнер, що містить лейбл, поле введення, повідомлення про помилку і/або допоміжний текст. Поле представлено обʼєктом ActiveField. Використовуючи поля, ви можете будувати форми набагато простіше, ніж це було раніше:

<?php $form = yii\widgets\ActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <div class="form-group">
        <?= Html::submitButton('Login') ?>
    </div>
<?php yii\widgets\ActiveForm::end(); ?>

Більш детальна інформація представлена у розділі Створення форм.

Конструктор запитів

У версії 1.1, побудова запиту була розкидана серед декількох класів, включаючи CDbCommand, CDbCriteria та CDbCommandBuilder. У Yii 2.0 запит до БД представлений в рамках обʼєкта Query, який може бути перетворений у SQL-вираз за допомогою QueryBuilder. Наприклад,

$query = new \yii\db\Query();
$query->select('id, name')
      ->from('user')
      ->limit(10);

$command = $query->createCommand();
$sql = $command->sql;
$rows = $command->queryAll();

Найкращим способом використання даних методів є робота з Active Record.

Більш детальна інформація представлена у розділі Конструктор запитів.

Active Record

У Yii 2.0 внесено безліч змін в роботу Active Record. Основними двома є побудова запитів і робота із звʼязками.

Клас CDbCriteria у версії 1.1 був замінений на yii\db\ActiveQuery у Yii 2.0. Цей клас успадковується від yii\db\Query і таким чином отримує всі методи, які необхідні для побудови запиту. Для побудови запиту вам слід викликати метод yii\db\ActiveRecord::find():

// Отримуємо всіх *активних* клієнтів і сортуємо їх по ID
$customers = Customer::find()
    ->where(['status' => $active])
    ->orderBy('id')
    ->all();

Для оголошення звʼязку слід просто призначити геттер, який повертає обʼєкт ActiveQuery. Імʼя властивості, яке визначене геттером, представляє собою назву звʼязку. Наприклад, наступний код оголошує звʼязок orders (у версії 1.1 вам потрібно було б оголосити звʼязки в одному центральному місці - relations()):

class Customer extends \yii\db\ActiveRecord
{
    public function getOrders()
    {
        return $this->hasMany('Order', ['customer_id' => 'id']);
    }
}

Тепер ви можете використовувати вираз $customer->orders для отримання всіх замовлень клієнта із звʼязаної таблиці. Ви також можете використовувати наступний код, щоб застосувати потрібні умови "на льоту":

$orders = $customer->getOrders()->andWhere('status=1')->all();

Yii 2.0 здійснює жадібне завантаження (eager loading) звʼязку по-іншому, на відміну від версії 1.1. Зокрема, у версії 1.1 для вибору даних із основної і звʼязаної таблиць буде використаний запит JOIN. У Yii 2.0 будуть виконані два запити без використання JOIN: перший запит повертає дані для основної таблиці, а другий - для звʼязаної, за допомогою фільтрації по первинних ключах основної таблиці.

Замість того, щоб повертати обʼєкти ActiveRecord, ви можете використовувати метод asArray() при побудові запиту, для вибірки великої кількості записів. Це змусить повернути результат запиту у якості масиву, що може суттєво знизити витрати процесорного часу і памʼяті при великій кількості записів. Наприклад:

$customers = Customer::find()->asArray()->all();

Ще одна зміна повʼязана з тим, що ви більше не можете визначати значення атрибутів за замовчуванням з допомогою public властивостей. Ви можете встановити їх у методі init вашого класу запису, якщо це потрібно.

public function init()
{
    parent::init();
    $this->status = self::STATUS_NEW;
}

Також у версії 1.1 були деякі проблеми із перевизначенням конструктора ActiveRecord. Дані проблеми відсутні у версії 2.0. Зверніть увагу, що при додаванні параметрів у конструктор, вам, можливо, знадобиться перевизначити метод yii\db\ActiveRecord::instantiate(). Перевизначення може не знадобитися, якщо параметри, передані в конструктор матимуть значення за умовчанням, наприклад null.

Є також безліч інших змін та покращень у ActiveRecord. Більш детальна інформація про них представлена у розділі Active Record.

Поведінки Active Record

У версії 2.0 розробники позбулися класу базової поведінки CActiveRecordBehavior. Новостворюваний клас поведінки Active Record має бути успадкованим безпосередньо від класу yii\base\Behavior. Якщо класу поведінки необхідно реагувати на деякі події власника, потрібно перевизначити метод events(), як показано нижче,

namespace app\components;

use yii\db\ActiveRecord;
use yii\base\Behavior;

class MyBehavior extends Behavior
{
    // ...

    public function events()
    {
        return [
            ActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate',
        ];
    }

    public function beforeValidate($event)
    {
        // ...
    }
}

User та IdentityInterface

Клас CWebUser у версії 1.1 тепер замінений класом yii\web\User, а також більше не існує класу CUserIdentity. Замість цього, необхідно реалізувати інтерфейс yii\web\IdentityInterface, що набагато простіше у використанні.

Більш детальна інформація представлена у розділах Аутентифікація, Авторизація та Розширений шаблон додатка.

Керування URL

Робота з URL в Yii 2.0 аналогічна тій, що була у версії 1.1. Основне покращення полягає в тому, що тепер підтримуються додаткові параметри. Наприклад, якщо у вас є правило, оголошене нижче, то воно співпаде з post/popular та post/1/popular. У версії 1.1 вам довелося б використовувати два правила для отримання того ж результату.

[
    'pattern' => 'post/<page:\d+>/<tag>',
    'route' => 'post/index',
    'defaults' => ['page' => 1],
]

Більш детальна інформація представлена у розділі Маршрутизація та створення URL.

Використання Yii 1.1 разом із 2.x

Інформація про використання коду для Yii 1.1 разом із Yii 2.0 представлена у розділі Робота із стороннім кодом.