anatoliy700/yii2-robots

Implements a dynamic robots.txt file

v2.0.0 2019-07-24 12:03 UTC

Requires

• php: >=7.2.0
• yii2-developer/yii2-configure: ~1.2.0
• yiisoft/yii2: ^2.0.0
• yiisoft/yii2-redis: ~2.0.0

Requires (Dev)

• yiisoft/yii2-coding-standards: ~2.0

BSD-3-Clause

• Anatoliy

README

Генерирует контент robots.txt файла

Установка

Устанвливается через Composer

composer require anatoliy700/yii2-robots

или добавить

"anatoliy700/yii2-robots": "*"

в разделе require вашего composer.json файла.

Использование

Подключить в конфигурации приложения в разделе модули:

'modules' => [
    'robots' => [
         'class' => 'anatoliy700\robots\Module',
    ]
]

Для установки правил маршрутизации автоматически добавть в bootstrap

'bootstrap' => ['robots']

Описать зависимости в контейнере

    'container' => [
        'definitions' => [
             'anatoliy700\robots\IRobots' => [
                 'class' => 'anatoliy700\robots\Robots',
                 'directives' => [
                     'User-Agent' => '*',
                     'Disallow' => [
                         '/backend',
                     ],
                 ],
             ],
             'anatoliy700\robots\directives\IDirective' => 'anatoliy700\robots\directives\Directive',
        ],
    ]

В свойстве directives можно указать директивы, которые будут отдаваться роботу. Если User-Agent не будет указан, то будет установлен по умолчанию User-Agent: *.

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

Итеграция блокировки сраниц в модули контента

Для интеграции необходимо в модель, которая описывает контент страницы в админке, добавить поведение:

  'RobotsBehavior' => [
      'class' => 'anatoliy700\robots\behaviors\RobotsModelBehaviors',
      'route' => ['content/default/index', 'alias' => 'alias']
  ]

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

В правила модели добавить:

[['robotsBlockingFlag'], 'safe'],

Так же необходимо добавить в форму checkbox:

<?= $form->field($model, 'robotsBlockingFlag')->checkbox() ?>

Описать зависимость репозитория, который реализует хранилище для динамических директив :

  'container' => [
      'definitions' => [
           'anatoliy700\robots\repositories\IRepository' => [
               'class' => 'anatoliy700\robots\repositories\ActiveRecordRepository',
               'activeRecord' => 'anatoliy700\robots\repositories\adapters\RedisAdapter',
           ],
      ],
  ]

У данного репозитория есть свойство activeRecord, в котором указывается класс адаптера(в данном случае реализован адаптер для Redis). Если использовать адаптер для Redis, необходимо подключить компонент, который обеспечивает работу с Redis:

  'components' => [
      'redis' => [
         'class' => 'yii\redis\Connection',
         'hostname' => 'REDIS_HOST',
         'port' => 'REDIS_PORT',
         'database' => 2,
      ],
  ]

Для генерации URI из роута, необходима описать зависимость IRouteGenerator:

    'container' => [
        'definitions' => [
            'anatoliy700\robots\generators\IRouteGenerator' => [
                'class' => 'anatoliy700\robots\generators\RouteGenerator',
                'urlManager' => [
                    'class' => 'yii\web\UrlManager',
                    'enablePrettyUrl' => true,
                    'showScriptName' => false,
                    'rules' => [...],
                ],
            ],
        ],
    ]

В свойство urlManager необходимо передать конфигурацию urlManager с действующими правилами маршрутизации.