PHPTime

Трейты в PHP и behaviors в Yii 2: что выбрать для модели

Трейт добавляет методы и свойства в класс, а behavior Yii 2 подключает к объекту отдельный компонент, который умеет реагировать на его события. Разберём, какой механизм подходит для общего метода, какой — для действий при сохранении и куда вынести бизнес-логику, если модель разрослась.

Traits vs Behaviors: где проходит граница

Трейт — механизм языка PHP. Когда класс включает трейт через use, его методы и свойства становятся членами класса. Метод трейта работает с $this как с экземпляром этого класса и может обращаться к его закрытым членам. Набор подключённых трейтов задаётся в объявлении класса.

Поведение Yii 2 — отдельный объект, обычно наследник yii\base\Behavior. Оно хранит ссылку на владельца в $owner, может подписываться на его события и предоставлять ему публичные методы и свойства. Владелец должен наследоваться от yii\base\Component. Поведение можно объявить в behaviors() для всего класса или подключить к отдельному экземпляру через attachBehavior().

ВопросТрейт PHPПоведение Yii 2
Где живёт реализация?В составе классаВ отдельном объекте
Как вызывается метод?Как обычный метод классаЧерез делегирование Yii, если метод отсутствует у владельца
Можно заменить на одном экземпляре?Состав класса фиксированМожно отсоединить старое и подключить новое
Как работать с событиями?Класс сам регистрирует обработчикиПоведение объявляет подписки в events()

Абстрактные методы трейта: требования к классу

Если общему методу нужны данные модели, объявите точку доступа явно. Абстрактный метод в трейте показывает, что класс обязан предоставить реализацию с совместимой сигнатурой. Конкретный класс может получить эту реализацию и по наследству. Пример одинаково работает в PHP 8.3, 8.4 и 8.5.

PHP
<?php

declare(strict_types=1);

trait HasDisplayName
{
    // Каждый класс сам определяет, откуда брать имя.
    abstract protected function rawName(): string;

    public function displayName(): string
    {
        $name = trim($this->rawName());

        return $name === '' ? 'Без имени' : $name;
    }
}

final class Author
{
    use HasDisplayName;

    public function __construct(private readonly string $name)
    {
    }

    protected function rawName(): string
    {
        return $this->name;
    }
}

echo (new Author('  Анна  '))->displayName(); // Анна

Такой контракт переживёт переименование поля или смену способа хранения. Если вызывающему коду нужен общий тип для нескольких классов, объявите интерфейс с методом displayName(): string и добавьте implements в классы. Трейт даст реализацию, а интерфейс позволит использовать её в сигнатурах.

Свойства в трейтах: состояние и требования

Трейт может объявить обычное типизированное свойство, например private ?string $cachedLabel = null;. Оно станет свойством каждого экземпляра класса. Задайте начальное значение или присвойте его до первого чтения: обращение к неинициализированному типизированному свойству вызывает Error, даже если его тип допускает null.

Если класс или другой подключённый трейт объявляет свойство с тем же именем, PHP проверяет совместимость объявлений. У обычных свойств должны совпадать видимость, тип, модификатор readonly и начальное значение. Несовместимость приводит к фатальной ошибке при объявлении класса. Для состояния, которое уже хранится в модели, используйте абстрактный метод доступа, как в примере выше.

В PHP 8.4 абстрактные свойства появились у абстрактных классов. В трейте для требования к классу используйте абстрактный метод: он подходит и для PHP 8.3. В Yii ActiveRecord учитывайте ещё одну деталь: публичное PHP-свойство с именем атрибута перехватывает обычное обращение через $model->field. Присваивание тогда может менять PHP-свойство мимо механизма атрибутов ActiveRecord. Храните вспомогательное состояние под отдельным именем, а значения колонок передавайте через API модели.

Конфликты методов: insteadof и as

Приоритет методов такой: собственный метод класса, затем метод трейта, затем унаследованный метод. Если два трейта предоставляют один и тот же метод и классу нужна реализация из трейта, выберите её через insteadof. Через as можно создать псевдоним метода или изменить его видимость. Псевдоним сохраняет исходное имя там, где метод под ним доступен.

PHP
<?php

declare(strict_types=1);

trait ShortLabel
{
    public function label(): string
    {
        return 'Отчёт';
    }
}

trait DetailedLabel
{
    public function label(): string
    {
        return 'Отчёт по заказам';
    }
}

final class OrderReport
{
    use ShortLabel, DetailedLabel {
        // Выбираем основной метод и сохраняем второй под отдельным именем.
        ShortLabel::label insteadof DetailedLabel;
        DetailedLabel::label as detailedLabel;
    }
}

$report = new OrderReport();
echo $report->label(), PHP_EOL;
echo $report->detailedLabel(), PHP_EOL;

У behaviors действуют правила Yii. При обычном вызове публичный метод владельца имеет приоритет. Если Yii делегирует вызов и подходящий публичный метод есть у нескольких поведений, срабатывает первое подходящее в порядке подключения. Когда важна конкретная реализация, получите поведение по имени через getBehavior() и вызывайте метод у него. Для подписок действует другой принцип: несколько обработчиков могут получать одно и то же событие.

Behavior Yii 2: отметка времени при сохранении

В проекте на Yii 2 подключите готовый TimestampBehavior к ActiveRecord, если метки времени нужно заполнять при вставке и обновлении. В примере таблица post содержит целочисленные колонки created_at и updated_at для Unix-времени.

PHP
<?php

declare(strict_types=1);

use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;

final class Post extends ActiveRecord
{
    public static function tableName(): string
    {
        return 'post';
    }

    public function behaviors(): array
    {
        return [
            'timestamps' => [
                'class' => TimestampBehavior::class,
                // При вставке заполняются обе колонки, при обновлении — updated_at.
                'value' => static fn (): int => time(),
            ],
        ];
    }
}

При обычном сохранении поведение срабатывает на EVENT_BEFORE_INSERT и EVENT_BEFORE_UPDATE. Если метки должны выставляться и при массовом updateAll(), укажите их в самом обновлении или обеспечьте это на уровне базы: такой вызов обходится без событий отдельных экземпляров. По той же причине прямой SQL не запускает обработчики Yii.

Собственное поведение строится по той же схеме: events() возвращает соответствие между событиями владельца и обработчиками. Для проверки протестируйте путь через владельца: вставку, обновление и, если используется, отсоединение поведения. Так тест покрывает и сам обработчик, и его привязку к событию.

Что вынести из разросшейся модели

Начните с того, что меняется вместе. Если несколько классов форматируют подпись по одному правилу, а данные берут из собственных полей, небольшой трейт с явным контрактом сокращает дублирование. Если нескольким ActiveRecord нужна одна реакция на сохранение с разными настройками, вынесите её в behavior и передавайте настройки через behaviors().

Когда метод оформляет заказ, управляет транзакцией и обращается к платёжному шлюзу, выделите сервис с явными зависимостями. Такой сценарий удобнее вызывать явно и тестировать отдельно от жизненного цикла модели. Для правил, которые должны выполняться при любом способе записи, проверьте все пути изменения данных и закрепите подходящие инварианты на уровне базы, где это возможно.

Чек-лист перед выбором

  1. Для общего метода нескольких PHP-классов выберите трейт и объявите его требования через типизированные методы.
  2. Для настраиваемой реакции на событие компонента Yii 2 выберите behavior и проверьте, какие операции действительно вызывают это событие.
  3. Для бизнес-сценария с транзакциями или внешними зависимостями выделите сервис с явной точкой вызова.
  4. Проверьте совпадения имён методов и свойств, особенно имён атрибутов ActiveRecord. Если вызывающему коду важно конкретное поведение, обращайтесь к нему по имени.

Частые вопросы

Можно ли использовать трейт и behavior в одной модели Yii 2?

Да. Трейт может предоставлять метод для отображаемого имени, а behavior — выставлять метки времени при сохранении. Если оба предоставляют одноимённый публичный метод, обычный вызов попадёт в метод модели, добавленный трейтом.

Может ли трейт требовать от класса типизированное свойство?

Трейт может сам объявить типизированное свойство. Если значение должен предоставлять класс, объявите абстрактный метод с типом возврата. Такой контракт работает во всех трёх версиях PHP — 8.3, 8.4 и 8.5.

Почему TimestampBehavior не срабатывает при updateAll()?

UpdateAll() отправляет массовое обновление в базу без сохранения отдельных экземпляров ActiveRecord. События этих экземпляров не возникают, поэтому updated_at нужно передать в данные обновления или заполнять на уровне базы.

Справка по теме

Ещё в разделе «Возможности PHP»

Шпаргалка по SOLID с примерами на PHP 8

Шпаргалка по SOLID для PHP 8.3–8.5. Пять принципов на рабочих примерах со строгой типизацией, типичной ошибкой для каждого и чек-листом для ревью.

8 мин

Getter’ы и setter’ы в PHP: магия, которая должна знать своё место

Когда использовать геттеры и сеттеры в PHP 8.5, а когда — публичные свойства и readonly. Практичные примеры, ловушки __get и __set, чек-лист.

7 мин

Возможности PHP 5.5 и их развитие в PHP 8.x

Как функции PHP 5.5 — генераторы, finally, OPcache и password_hash — выросли в PHP 8.x. Практичные примеры, которых не хватает в доках.

7 мин

Как пользоваться filter_var в PHP

Как пользоваться filter_var в PHP 8.3–8.5: проверять числа, булевы значения, email, URL и IP, задавать диапазоны и отличать ошибку от нуля и false.

7 мин