sdelfi/yii2-sitemap-module

Yii2 module for automatically generation XML Sitemap

1.4.3 2021-07-03 13:13 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: >=2.0.6

Requires (Dev)

• ext-sqlite3: *
• codeception/codeception: 2.0.*
• yiisoft/yii2-codeception: ~2.0.0
• yiisoft/yii2-faker: *

MIT

• Assayer Pro
• Stanislav

• xml
• module
• Sitemap
• yii2

README

Yii2 module for automatically generating XML Sitemap.

Installation

The preferred way to install this extension is through composer.

• Either run

php composer.phar require --prefer-dist "sdelfi/yii2-sitemap-module" "*"

or add

"sdelfi/yii2-sitemap-module" : "*"

to the require section of your application's composer.json file.

• Configure the cache component of your application's configuration file, for example:

'components' => [
    'cache' => [
        'class' => 'yii\caching\FileCache',
    ],
]

• Add a new module in modules section of your application's configuration file, for example:

'modules' => [
    'sitemap' => [
        'class' => 'sdelfi\sitemap\Module',
    ],
...
],

• Add confuguration for sitemap into components section:

'components' => [
    'robotsTxt' => [
        'class' => 'sdelfi\sitemap\RobotsTxt',
        'userAgent' => [
            // Disallow url for all bots
            '*' => [
                'Disallow' => [
                    ['/api/default/index'],
                ],
                'Allow' => [
                    ['/api/doc/index'],
                ],
            ],
            // Block a specific image from Google Images
            'Googlebot-Image' => [
                'Disallow' => [
                    // All images on your site from Google Images
                    '/',
                    // Files of a specific file type (for example, .gif)
                    '/*.gif$',
                ],
            ],
        ],
    ],
    'sitemap' => [
        'class' => 'sdelfi\sitemap\Sitemap',
        'models' => [
            // your models
            'app\modules\news\models\News',
            // or configuration for creating a behavior
            [
                'class' => 'app\modules\news\models\News',
                'behaviors' => [
                    'sitemap' => [
                        'class' => '\sdelfi\sitemap\behaviors\SitemapBehavior',
                        'scope' => function ($model) {
                            /** @var \yii\db\ActiveQuery $model */
                            $model->select(['url', 'lastmod']);
                            $model->andWhere(['is_deleted' => 0]);
                        },
                        'dataClosure' => function ($model) {
                            /** @var self $model */
                            return [
                                'loc' => Url::to($model->url, true),
                                'lastmod' => strtotime($model->lastmod),
                                'changefreq' => \sdelfi\sitemap\Sitemap::DAILY,
                                'priority' => 0.8
                            ];
                        }
                    ],
                ],
            ],
        ],
        'urls'=> [
            // your additional urls
            [
                'loc' => ['/news/default/index'],
                'changefreq' => \sdelfi\sitemap\Sitemap::DAILY,
                'priority' => 0.8,
                'news' => [
                    'publication'   => [
                        'name'          => 'Example Blog',
                        'language'      => 'en',
                    ],
                    'access'            => 'Subscription',
                    'genres'            => 'Blog, UserGenerated',
                    'publication_date'  => 'YYYY-MM-DDThh:mm:ssTZD',
                    'title'             => 'Example Title',
                    'keywords'          => 'example, keywords, comma-separated',
                    'stock_tickers'     => 'NASDAQ:A, NASDAQ:B',
                ],
                'images' => [
                    [
                        'loc'           => 'http://example.com/image.jpg',
                        'caption'       => 'This is an example of a caption of an image',
                        'geo_location'  => 'City, State',
                        'title'         => 'Example image',
                        'license'       => 'http://example.com/license',
                    ],
                ],
            ],
        ],
        'enableCache' => false, // default is true
        'enableGzip' => true, // default is false
        'cacheExpire' => 1, // 1 second. Default is 24 hours,
        'sortByPriority' => true, // default is false
    ],
],

• Add behavior in the AR models, for example:

use sdelfi\sitemap\behaviors\SitemapBehavior;

public function behaviors()
{
    return [
        'sitemap' => [
            'class' => SitemapBehavior::className(),
            /**'batchSize' => 100,*/
            'scope' => function ($model) {
                /** @var \yii\db\ActiveQuery $model */
                $model->select(['url', 'lastmod']);
                $model->andWhere(['is_deleted' => 0]);
            },
            'dataClosure' => function ($model) {
                /** @var self $model */
                return [
                    'loc' => Url::to($model->url, true),
                    'lastmod' => strtotime($model->lastmod),
                    'changefreq' => Sitemap::DAILY,
                    'priority' => 0.8
                ];
            }
        ],
    ];
}

• Add a new rule for urlManager of your application's configuration file, for example:

'urlManager' => [
    'rules' => [
        ['pattern' => 'sitemap-<id:\d+>', 'route' => '/sitemap/default/index', 'suffix' => '.xml'],
        ['pattern' => 'sitemap', 'route' => 'sitemap/default/index', 'suffix' => '.xml'],
    ],
],

Console generate sitemap

Remove sitemap section from modules configuration.

Add console command configuration:

    'controllerMap' => [
        'sitemap' => [
            'class' => 'sdelfi\sitemap\console\CreateController',
        ],
    ],

Add baseUrl for urlManager:

     'urlManager' => [
         'baseUrl' => '',
         'hostInfo' => 'http://example.com/',
     ],

Run command from console:

$ ./yii sitemap/create

Resources

• XML Sitemap

• News Sitemap

• Image sitemaps