PHPackages                             voskobovich/yii2-seo-toolkit - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. voskobovich/yii2-seo-toolkit

ActiveYii2-toolkit

voskobovich/yii2-seo-toolkit
============================

SEO tools for Yii2

v1.0.0(10y ago)121374MITPHPPHP >=5.4.0

Since Jan 28Pushed 9y ago4 watchersCompare

[ Source](https://github.com/voskobovich/yii2-seo-toolkit)[ Packagist](https://packagist.org/packages/voskobovich/yii2-seo-toolkit)[ Docs](https://github.com/voskobovich/yii2-seo-toolkit)[ RSS](/packages/voskobovich-yii2-seo-toolkit/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

Yii2 SEO Toolkit
================

[](#yii2-seo-toolkit)

Помогает реализовать управление урлами страниц системы как в CMS WordPress, с управлением из админпанели таблицей маршрутизации и редиректами.

[![License](https://camo.githubusercontent.com/4f6ef86d206e357afbca8319eaf297aa2f3de6cb01db583be9e42aff28cbee24/68747470733a2f2f706f7365722e707567782e6f72672f766f736b6f626f766963682f796969322d73656f2d746f6f6c6b69742f6c6963656e73652e737667)](https://packagist.org/packages/voskobovich/yii2-seo-toolkit)[![Latest Stable Version](https://camo.githubusercontent.com/1ae8be8fba32beed270eef3c634437dd42aa125958d5bb4956d1e3ff1b24d276/68747470733a2f2f706f7365722e707567782e6f72672f766f736b6f626f766963682f796969322d73656f2d746f6f6c6b69742f762f737461626c652e737667)](https://packagist.org/packages/voskobovich/yii2-seo-toolkit)[![Latest Unstable Version](https://camo.githubusercontent.com/3d2fe4caa907dec2cbeb0ffc838abc67abc005415167ffdbce146cfb93202f46/68747470733a2f2f706f7365722e707567782e6f72672f766f736b6f626f766963682f796969322d73656f2d746f6f6c6b69742f762f756e737461626c652e737667)](https://packagist.org/packages/voskobovich/yii2-seo-toolkit)[![Total Downloads](https://camo.githubusercontent.com/af3bef3fb14b70addadd665c25f54d63f413782a52d93df3131e4b0671b94cea/68747470733a2f2f706f7365722e707567782e6f72672f766f736b6f626f766963682f796969322d73656f2d746f6f6c6b69742f646f776e6c6f6164732e737667)](https://packagist.org/packages/voskobovich/yii2-seo-toolkit)

Support
-------

[](#support)

[GutHub issues](https://github.com/voskobovich/yii2-seo-toolkit/issues).

Usage
-----

[](#usage)

1. Создать таблицу для хранения роутинга (применить миграцию)
2. Создать свой экземпляр модели UrlRoute
3. Настроить UrlManager
4. Подключить класс UrlManager из пакета
5. Подключить классы правил роутинга
    3\. ClearUrlRule для очистки урлов от мусора (двойные слэши, слэш в окончании ...)
    3\. UrlRule отвечает непосредственно за роутинг
6. В нужной AR модели
7. Реализовать интерфейс SeoModelInterface
8. Подключить поведение CreateUrlBehavior
9. Подключить ActualityUrlBehavior
10. Создаем CRUD для управления роутами
11. Создаем таблицу (применяем миграцию)

---

```
php yii migrate/create create_table__url_route
```

Унаследуйте созданный класс миграции от **\\voskobovich\\seo\\migrations\\create\_table\_\_url\_route**.
Например:

```
class  extends \voskobovich\seo\migrations\create_table__url_route
{

}
```

Применяем миграцию

```
php yii migrate
```

2. Создаем свой экземпляр модели UrlRoute

---

Yii2 SEO toolkit не знает с какими моделями и роутами ему придется работать.
Чтобы это исправить, нужно унаследоваться от модели UrlRoute из пакета и реализовать 2 метода из UrlRouteInterface.
Вот пример из моего проекта.

```
class UrlRoute extends \voskobovich\seo\models\UrlRoute
{
    const OBJECT_CATEGORY = 'category';
    const OBJECT_POST = 'post';
    const OBJECT_TAG = 'tag';
    const OBJECT_USER = 'user';

    /**
     * List objects
     * @return array;
     */
    public static function objectItems()
    {
        return [
            static::OBJECT_CATEGORY => 'Category',
            static::OBJECT_POST => 'Post',
            static::OBJECT_TAG => 'Tag',
            static::OBJECT_USER => 'User',
        ];
    }

    /**
     * Route map for objects
     * @return array;
     */
    public static function routeMap()
    {
        return [
            static::OBJECT_CATEGORY => [
                static::ACTION_INDEX => 'category/index',
                static::ACTION_VIEW => 'category/view',
            ],
            static::OBJECT_POST => [
                static::ACTION_INDEX => 'post/index',
                static::ACTION_VIEW => 'post/view',
            ],
            static::OBJECT_TAG => [
                static::ACTION_INDEX => 'tag/index',
                static::ACTION_VIEW => 'tag/view',
            ],
            static::OBJECT_USER => [
                static::ACTION_INDEX => 'user/index',
                static::ACTION_VIEW => 'user/view',
            ],
        ];
    }
}
```

Из примера видно, что роутинг будет работать с 4-я объектами.
Для каждого объекта сконфигурирован список стандартных действий "показать все" (index) и "показать один" (view).
Действия нужны для того, чтобы различать логику обработки роута. Например, мы можем сделать вот так:

1. Роут */foo* это действие *index* для объекта *post*. В итоге, перейдя по */foo* мы получим список всех постов (в yii роутинге это равняется переходу на *post/index*).
2. Роут */bar* это действие *view* для объекта *post* c *id=3*. В итоге, перейдя по */bar* мы увидим запись с *id=5* (в yii роутинге это равняется переходу на *post/view*).
    Список действий можно расширить, дополнив список в методе *getActionItems*.
3. Настраиваем UrlManager

---

В стандартном классе UrlManager реализовано кеширование роутов которое помогает ускорить процесс генерации ссылок в стандартном роутинге Yii2. Суть кеширования в том, чтобы запоминать для каких роутов нет правил в конфиге и больше не пытаться построить ссылку для этого роута. То есть, если для роута *post/view* нет правила, то больше для этого роута правил искаться не будет, что и логично. Но для нас это беда, и вот почему. Для роута *post/view id=4* может быть правило в таблице маршрутизации, а для *post/view id=5* может не быть. Если не отключить кеширование, то при генерации ссылок на посты если первой будет сгенерирована ссылка для *post/view id=5* то UrlManager запомнит, что правила для этого роута нет и больше не будет его обрабатывать. В итоге мы не получим наших красивых ссылок для остальных постов. Итак, подключаем класс UrlManager из пакета.

```
'urlManager' => [
    'class' => 'voskobovich\seo\web\UrlManager',
    'cacheable' => false,
    'rules' => [
        '' => 'post/index',

        ['class' => '\voskobovich\seo\web\ClearUrlRule'],
        ['class' => '\voskobovich\seo\web\UrlRule', 'modelClass' => 'app\models\UrlRoute'],

        // Default
        '/' => '/view',
        '//' => '/',
        '/' => '/',
    ]
],
```

Правило *ClearUrlRule* умеет:

1. Заменить множество слэшей на один
2. Удалить слэш в конце ссылки
3. Буквы верхнего регистра перевести в нижний

**Внимание!** В целях оптимизации рекомендую настроить эти правила на уровне вашего веб-сервера.

Правило *UrlRule* отвечает за наш волшебный роутинг.
В атрибут *modelClass* передается модель *UrlRoute* которая была создана на прошлом шаге.

4. Настраиваем AR модель

---

Чтобы для новых моделей ссылки автоматом попадили в таблицу роутинга, нужно подключить *CreateUrlBehavior* и реализовать интерфейс *SeoModelInterface*.
Привожу пример модели *Post* из моего проекта.

```
class Post extends BaseActiveRecord implements SeoModelInterface
{
    // ...

    /**
     * @return array
     */
    public function behaviors()
    {
        return [
            'createUrlBehavior' => [
                'class' => CreateUrlBehavior::className(),
                'modelClass' => UrlRoute::className(),
                'objectKey' => UrlRoute::OBJECT_POST
            ],
            'actualityUrlBehavior' => [
                'class' => ActualityUrlBehavior::className(),
                'modelClass' => UrlRoute::className(),
                'objectKey' => UrlRoute::OBJECT_POST
            ]
        ];
    }

    /**
     * Build Seo Path
     * @return null|string
     */
    public function getSeoPath()
    {
        /** @var Category|TreeInterface $mainCategory */
        $mainCategory = $this->mainCategory;
        if ($mainCategory) {
            return $mainCategory->path . '/' . $this->slug;
        }

        return null;
    }

    // ...
}
```

Метод *getSeoPath()* должен возвращать путь, по которому будет доступна запись поста.
У меня этот роут состоит из пути к главной категории поста и короткого имени самого поста (/cat/subcat/post-slug).

Поведению нужно передать нашу модель UrlRoute и сообщить каким объектом является наша AR модель используя ранее созданные константы в модели UrlRoute.

5. Подключаем ActualityUrlBehavior

---

После настройки всего пользователь все еще может перейти по старой ссылке и увидеть страницу. Например, мы для */post/view?id=6* создали красивый урл */best-post*. Но пользователь все еще может перейти по старой ссылке и получить страницу, хотя в идеале его нужно отправить на новый урл с 301-м редиректом.
Вот пример обработчика запроса из моего проекта.

```
class PostController extends Controller
{
    // ...

    public function actionView($id)
    {
        /** @var Post $model */
        $model = Post::find()
            ->andWhere(['id' => $id])
            ->one();

        $model->trigger(ActualityUrlBehavior::EVENT_CHECK_URL);

        return $this->render('view', [
            'model' => $model
        ]);
    }

    // ...
}
```

Говорю сразу, подключать поведение на весь контролер не нужно. Это поведение нужно только для view экшена.
Этому поведению так же нужно передать класс нашей созданной модели UrlRoute и название объекта из константы.

6. Создаем CRUD для управления роутами

---

Во вьюхах есть небольшая логика, так что привожу примеры основных кусков кода из своего проекта.

Файл **create.php**

```