dreamjobs/sitemap-generator

Yii2 component for generate sitemap.xml files.

yii2-sitemap-generator

Yii2 component for generate sitemap.xml files, _(*1)

Installation

Run, _(*2)

php composer.phar require "dreamjobs/sitemap-generator" "~1.0"

or, _(*3)

Add to composer.json in your project, _(*4)

{
    "require": {
        "dreamjobs/sitemap-generator": "~1.0"
    }
}

then run command, _(*5)

php composer.phar update

Configuration

Edit "./console/config/main.php", _(*6)

return [
    'controllerMap' => [
        'sitemap' => [
            'class' => 'dreamjobs\sitemap\SitemapController',
            'baseUrl' => 'https://dreamjobs.com.co',
            'modelsPath' => '@console/models/sitemap', // Sitemap-data models directory
            'modelsNamespace' => 'console\models\sitemap', // Namespace in [[modelsPath]] files
            'savePathAlias' => '@frontend/web', // Where would be placed the generated sitemap-files
            'sitemapFileName' => 'sitemap.xml', // Name of main sitemap-file in [[savePathAlias]] directory
        ],
    ],
];

"./environments/prod/console/config/main-local.php", _(*7)

'components' => [
    // fix console create url
    'urlManager' => [
        'baseUrl' => 'http://example.com',
    ],
],

"./environments/dev/console/config/main-local.php", _(*8)

'components' => [
    // fix console create url
    'urlManager' => [
        'baseUrl' => 'http://example.local',
    ],
],

run command, _(*9)

php ./init

OR just apply same config to your "/console/config/main-local.php", _(*10)

ALSO you can merge urlManager rules from frontend(or common) to console config. Just change "/console/config/main.php" file:, _(*11)

// get config of urlManager from frontend for correctly create urls in console app
$frontend = require(__DIR__ . '/../../frontend/config/main.php');
$frontendUrlManager = [
    'components' => [
        'urlManager' => $frontend['components']['urlManager'],
    ],
];

// ...

// Merge frontend urlManager config with console application main config
return yii\helpers\ArrayHelper::merge($frontendUrlManager, [
    'id' => 'app-console',
    // ...
];

Also useful append .gitignore for ignore all generated sitemaps files:, _(*12)

# sitemaps
/frontend/web/sitemap*.xml

TBD: creating sitemap-data models, _(*13)

Usage

Run Yii console command in project root:, _(*14)

php ./yii sitemap

then check "http://site/sitemap.xml" file, _(*15)