Как правильно сделать seo модуль для Yii2?

Question

[Orbb]

Приветствую!

Сейчас у меня есть небольшой сайт, на котором за разные зоны урлов отвечают разные контроллеры.
Проблема вот в чем: до этого я писал информационник, там все подкатегории и категории были реализованы в одном месте - один контроллер, один метод - внедрить возможность изменения title и description на уровне базы страниц было не сложно.

Тут же ситуация посложней - контроллеров штук 6, 3 раздела уникальны, в каждом контроллере по 7-15 экшенов. Соответвественно, придется вставлять везде одинаковые проверки и дублировать код - ну нафиг. Всех возможностей Yii2 не знаю, в голове крутится вариант выноса этого в главный layout, т.к. он один на весь фронт, но этот вариант рассматриваю только как крайне запасной.

Подскажите, куда двигаться и как реализовать подобное.

Answer 1

[Максим Тимофеев]

Надо конечно смотреть на структуру, но:
Можно написать хелпер и дергать его метод, что бы не дублировать код.
Можно написать поведение и подключать в контроллере.
Можно написать компонент и прицепить в конфиге. Там же зацепиться за событие, например beforeAction и выполнить его метод.

Comments

[Orbb]

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

[Максим Тимофеев]

Orbb, Тут надо понимать что Вы генерить будете и на основе чего. Если Все данные из модели, то возможно стоит реализовать трейт или поведение для моделей.

Answer 2

[Виталий Хоменко]

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

Почему? Разве это проблема подключить компонент в единой нужной точке?


Дополняю:

/**
 * Зарегистрировать все тэги метаданных для страницы с правила
 */
public function applySeoRule ()
{
    # Не применяем правила если отключен
    if ( ! $this->isEnabled() ) {
        return;
    }
    # Только если есть правило для SEO
    if ( $this->hasSeoRule() ) {
        $view = Yii::$app->controller ?
            Yii::$app->controller->getView() :
            Yii::$app->getView();
        $seoRule = $this->getSeoRule();
        # Параметры индексации
        if ( $seoRule->is_no_index ) {
            $view->registerMetaTag( [
                'name' => 'robots',
                'content' => 'noindex',
            ], 'robots' );
        }
        # Основные метаданные
        if ( $seoRule->title !== '' ) {
            $view->title = $seoRule->title;
        }
        if ( $seoRule->description !== '' ) {
            $view->registerMetaTag( [
                'name' => 'description',
                'content' => $seoRule->description,
            ], 'description' );
        }
        if ( $seoRule->keywords !== '' ) {
            $view->registerMetaTag( [
                'name' => 'keywords',
                'content' => $seoRule->keywords,
            ], 'keywords' );
        }
        # Метаданные OpenGraph
        $opengraphTags = [
            'opengraph_title' => 'og:title',
            'opengraph_site_name' => 'og:site_name',
            'opengraph_url' => 'og:url',
            'opengraph_description' => 'og:description',
        ];
        $registerOpengraph = false;
        foreach ( $opengraphTags as $attribute => $tagName ) {
            if ( isset( $seoRule->$attribute ) && $seoRule->$attribute !== '' ) {
                $view->registerMetaTag( [
                    'name' => $tagName,
                    'content' => $seoRule->$attribute,
                ], $tagName );
                $registerOpengraph = true;
            }
        }
        if ( $seoRule->opengraphImage ) {
            $view->registerMetaTag( [
                'name' => 'og:image',
                'content' => $seoRule->opengraphImage->getFileUrlWithDomain(),
            ], 'og:image' );
            $registerOpengraph = true;
        }
        if ( $registerOpengraph ) {
            $view->registerMetaTag( [
                'name' => 'og:locale',
                'content' => str_replace( '-', '_', Yii::$app->language ),
            ], 'og:locale' );
            $view->registerMetaTag( [
                'name' => 'og:type',
                'content' => 'website',
            ], 'og:type' );
        }
        # Twitter OpenGraph
        $twitterTags = [
            'twitter_url' => 'twitter:url',
            'twitter_title' => 'twitter:title',
            'twitter_description' => 'twitter:description',
            'twitter_site' => 'twitter:site',
            'twitter_creator' => 'twitter:creator',
        ];
        $registerTwitter = false;
        foreach ( $twitterTags as $attribute => $tagName ) {
            if ( isset( $seoRule->$attribute ) && $seoRule->$attribute !== '' ) {
                $view->registerMetaTag( [
                    'name' => $tagName,
                    'content' => $seoRule->$attribute,
                ], $tagName );
                $registerTwitter = true;
            }
        }
        if ( $seoRule->twitterImage ) {
            $view->registerMetaTag( [
                'name' => 'twitter:image',
                'content' => $seoRule->twitterImage->getFileUrlWithDomain(),
            ], 'twitter:image' );
            $registerTwitter = true;
        }
        if ( $registerTwitter ) {
            $view->registerMetaTag( [
                'name' => 'twitter:card',
                'content' => 'summary',
            ], 'twitter:card' );
        }
    }
}

Comments

[Максим Тимофеев]

Там будет чехорда с передачей в него данных.

[Виталий Хоменко]

Максим Тимофеев, у нас этот компонент настраивается с панели управления. То есть администратор в панели может настроить любые данные, включая разметку opengraph, twitter и остальное. В контроллерах и экшн-методах seo-данные не формируются и не передаются.

[Orbb]

Виталий Хоменко, хм, мне казалось это костыль) как раз компонентное решение

[Виталий Хоменко]

Orbb, когда вы берете задачу в работу вы определяете все ее нюансы: как должно работать, когда, при каких условиях, с какими данными, как управлять этим. Потом, на основе всех вводных определяете методы и способы реализации, а их может быть очень много. Так вот, если вы реализовали не оптимально, то это и есть костыль.

[Максим Тимофеев]

Orbb, лично мне не очень нравится вариант с хелпером в layout, но Виталий Хоменко прав. Определить оптимальный метод не зная нюансов нереально. Решать Вам. Я бы в layout передавал уже готовые данные в массиве, на основе которого генерил meta теги, возможно с помощью виджета или хелпера, что бы не тулить там циклы. Но в него надо передавать именно данные готовые. А вот подготовка этих данных, на мой взгляд, должна быть в модели.
Получится логика разбитая на две части. Виджет + behavior. Возможно это вообще модуль со своим CRUD, бд и т.д. Что бы иметь возможность задавать вручную, а если не задано генерить на основе чего-то.

[Orbb]

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

[Orbb]

Виталий Хоменко, Виталий, а подскажите еще - компонент я написал, модуль подключил, все ок. Но в вашем модуле как-то лаконично написано $this->title, что ссылается на View, а каким образом из Seo компонента возможно повлиять на переменные другой модели?
Не, ну понятно что возвращать значения, делать проверку на существование и прочее, но у вас то просто $this->title, и нигде выше он не приравнивается ни к чему)

[Виталий Хоменко]

Orbb, а что есть $this в лайауте? Это объект View. Вы можете сразу внутри компонента обращаться к нему, через сервис-локатор Yii::$app. Добавил в ответ фрагмент кода

[Orbb]

Виталий Хоменко, ох, как круто-то, спасибо) возьму на заметку