README

此库是 mima/sitemap-generator 在 yii2 框架中的实现。它提供了一组基于 yii2 特性的自定义组件和编写器。有关 sitemap 生成器库的文档，您可以在这里找到：here。

• 安装
• 使用

安装

通过命令行使用 composer 安装

composer require mima/yii2-sitemap-generator

或在您的 composer.json 文件的要求部分添加依赖项

{
    "require": {
        "mima/yii2-sitemap-generator": "~1.0"
    }
}

使用

在运行时配置组件

use SitemapGenerator\Component\SitemapGeneratorComponent;
use SitemapGenerator\Factory\SimpleGeneratorFactory;
use MyNamespace\Extractor\MyDataExtractor;

\Yii::$app->set('sitemapGenerator', [
    'class' => SitemapGeneratorComponent::class,
    'directoryToSaveSitemap' => '@webroot',
    'fileName' => 'sitemap.xml',
    'extractor' => MyDataExtractor::class,
    'generatorFactory' => SimpleGeneratorFactory::class
]);

在应用程序配置中配置

return [
    // ...
    'components' => [
        'sitemapGenerator' => [
            'class' => SitemapGenerator\Component\SitemapGeneratorComponent::class,
            'directoryToSaveSitemap' => '@webroot',
            'fileName' => 'sitemap.xml',
            'extractor' => MyNamespace\Extractor\MyDataExtractor::class,
            'generatorFactory' => SitemapGenerator\Factory\SimpleGeneratorFactory::class
        ]
    ]
    //...
];

以下是一些有效设置

• directoryToSaveSitemap - 保存 sitemap 的目录的实路径或 yii 别名
• fileName - sitemap 文件名
• extractor - 实现 SitemapGenerator\Extractor\DataExtractorInterface 类的类的名称
• generatorFactory - 实现 SitemapGenerator\Factory\GeneratorFactoryInterface 类的类的名称

要生成 sitemap，请调用 generate 方法

// This code generate sitemap and return path to file, containig sitemap
$filePath = \Yii::$app->get('sitemapGenerator')->generate();