Компоненты

Компоненты являются основными строительными блоками приложений Yii. Компоненты - это экземпляры yii\base\Component или расширенный класс. Три основные функции, которые компоненты предоставляют для других классов, это

  • Свойства (Properties)
  • События (Events)
  • Поведения (Behaviors)

Отдельно и в сочетании, эти функции делают классы Yii намного более настраиваемыми и удобными в использовании. Например, включенный виджет выбора даты, компонент пользовательского интерфейса, может использоваться в представлении для создания интерактивного средства выбора даты:

use yii\jui\DatePicker;

echo DatePicker::widget([
    'language' => 'ru',
    'name'  => 'country',
    'clientOptions' => [
        'dateFormat' => 'yy-mm-dd',
    ],
]);

Свойства виджета легко записываются, потому что класс расширяет yii\base\Component.

Хотя компоненты являются очень мощными, они немного тяжелее обычных объектов, в связи с тем, что для поддержки функций событий и поведения в частности требуется дополнительная память и процессорное время. Если ваши компоненты не нуждаются в этих двух функциях, вы можете рассмотреть расширение класса компонента из yii\base\Object вместо yii\base\Component. Это сделает ваши компоненты столь же эффективными, как обычные объекты PHP, но с дополнительной поддержкой свойств.

При расширении класса из yii\base\Component или yii\base\Object рекомендуется следовать этим соглашениям:

  • Если вы переопределите конструктор, укажите в качестве последнего параметра конструктора параметр $config, а затем передайте этот параметр родительскому конструктору.
  • Всегда вызывать конструктор-родитель в конце вашего переопределяющего конструктора.
  • Если вы переопределите метод yii\base\Object::init(), убедитесь, что вы вызываете родительскую реализацию init() в начале вашего метода init().

Например:

<?php

namespace yii\components\MyClass;

use yii\base\Object;

class MyClass extends Object
{
    public $prop1;
    public $prop2;

    public function __construct($param1, $param2, $config = [])
    {
        // ... initialization before configuration is applied

        parent::__construct($config);
    }

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

        // ... initialization after configuration is applied
    }
}

Следуя этим рекомендациям, ваши компоненты будут конфигурироваться, когда они будут созданы. Например:

$component = new MyClass(1, 2, ['prop1' => 3, 'prop2' => 4]);
// alternatively
$component = \Yii::createObject([
    'class' => MyClass::className(),
    'prop1' => 3,
    'prop2' => 4,
], [1, 2]);

Класс yii\base\Object обеспечивает следующий жизненный цикл объекта:

  • Предварительная инициализация внутри конструктора. Здесь вы можете установить значения свойств по умолчанию.
  • Конфигурация объекта через $config. Конфигурация может перезаписывать значения по умолчанию, установленные в конструкторе.
  • Пост-инициализация в init(). Вы можете переопределить этот метод для выполнения проверок и нормализации свойств.
  • Вызов метода объекта.

Первые три шага происходят внутри конструктора объекта. Это означает, что после получения экземпляра класса (то есть объекта) этот объект уже был инициализирован в правильное, надежное состояние.