Класс yii\behaviors\SluggableBehavior

SluggableBehavior автоматически заполняет указанное свойство значением, которое может быть использовано в качестве слэга в URL.

Чтобы использовать SluggableBehavior, добавьте следующий код в ваш класс ActiveRecord:

use yii\behaviors\SluggableBehavior;

public function behaviors()
{
    return [
        [
            'class' => SluggableBehavior::className(),
            'attribute' => 'title',
            // 'slugAttribute' => 'slug',
        ],
    ];
}

По умолчанию, SluggableBehavior заполнит свойство slug значением, которое может быть использовано в качестве слэга в URL при валидации связанного объекта AR.

Поскольку значения свойств будут устанавливаться автоматически этим поведением, они обычно не являются пользовательским вводом и, следовательно, не должны проверяться, т.е. свойство slug не должно появляться в методе rules() модели.

Если имя вашего свойства отличается, вы можете настроить свойство $slugAttribute следующим образом:

public function behaviors()
{
    return [
        [
            'class' => SluggableBehavior::className(),
            'slugAttribute' => 'alias',
        ],
    ];
}

Открытые свойства

Открытые методы

Защищенные методы

Подробное описание свойств

$attribute общедоступное свойство

Атрибут или список атрибутов, значение которого будет преобразовано в слэг, или null означает, что будет использовано свойство $value для генерации слэга.

public string|array|null $attribute = null

$ensureUnique общедоступное свойство

Необходимо ли гарантировать, что сгенерированное значение слэга уникально среди записей класса владельца. При включенном свойстве поведение автоматически проверит уникальность слэга. В случае ошибки проверки будет выполнена попытка сгенерировать уникальное значение слэга на основе исходного, пока не будет достигнута удача.

public boolean $ensureUnique = false

$immutable общедоступное свойство (доступно начиная с версии 2.0.2)

Необходимо ли генерировать новый слэг, если он уже был сгенерирован ранее. Если true, поведение не сгенерирует новый слэг, даже если $attribute изменен.

public boolean $immutable = false

$slugAttribute общедоступное свойство

Атрибут, который получит значение слэга.

public string $slugAttribute = 'slug'

$uniqueSlugGenerator общедоступное свойство

Генератор уникальных значений слэга. Он используется в случае, когда $ensureUnique включен, и сгенерированный слэг не уникален. Это должен быть вызываемый объект PHP со следующей сигнатурой:

function ($baseSlug, $iteration, $model)
{
    // return uniqueSlug
}

Если не задан, уникальный слэг будет сгенерирован путем добавления инкрементирующего суффикса к базовому слэгу.

public callable $uniqueSlugGenerator = null

$uniqueValidator общедоступное свойство

Настройка для валидатора уникальности слэга. Параметр 'class' можно опустить — по умолчанию будет использоваться yii\validators\UniqueValidator.

См. также yii\validators\UniqueValidator.

public array $uniqueValidator = []

$value общедоступное свойство

Значение, которое будет использовано в качестве слэга. Это может быть анонимная функция, произвольное значение или null. Если это анонимная функция, то возвращаемое значение функции будет использовано в качестве слэга. Если null , то свойство $attribute будет использовано для генерации слэга. Подпись функции должна быть следующей:

function ($event)
{
    // return slug
}

public callable|string|null $value = null

Подробное описание методов