elbgoods/laravel-sitemap

基于laravel模型生成站点地图

v1.0.0 2021-03-10 12:39 UTC

This package is not auto-updated.

Last update: 2024-09-20 04:30:38 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

请在这里添加您的描述。尽量限制在一段或两段文字内,并提及您支持的PSRs,以避免用户和贡献者之间的混淆。

安装

您可以通过composer安装此包

composer require elbgoods/laravel-sitemap

配置和用法

首先创建一个配置文件 config/sitemap.php,或者使用以下命令获取模板文件

php artisan vendor:publish --provider="Elbgoods\LaravelSitemap\LaravelSitemapServiceProvider" --tag=config

添加单个页面到站点地图

站点地图URL条目由以下格式的数组表示

[
    'loc' => 'https://example.com/terms', // (required) url of the page,
    'lastmod' => Carbon::yesterday(), // (optional) last page modification
    'priority' => 0.9, // (optional) site priority
    'changefreq' => SitepageUrl::daily // (optional) page change frequency
]

为模型添加页面

您可以通过将模型类名添加到sitepage配置数组中,为每个模型项(例如,如果您是一家商店的所有产品)创建一个sitepage条目。

您的模型必须实现Elbgoods\LaravelSitemap\Contracts\Sitemap接口。该接口包含一个方法getSitemapUrl(),该方法必须返回该模型的具体URL。

默认情况下,所有模型项都将被添加到站点地图中。
您可以使用此函数过滤模型项

public static function getSitemapQuery(): Builder

生成站点地图

您可以使用以下Artisan命令手动生成站点地图

php artisan sitemap:generate > sitemap.xml

或使用调度器

$schedule->command('sitemap:generate')
    ->daily()
    ->sendOutputTo($filePath);

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全

如果您发现任何安全问题,请通过电子邮件发送至nschirrmeister@elbgoods.de,而不是使用问题跟踪器。

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件

开源

您可以使用此包,但如果它进入了您的生产环境,我们非常希望您购买或为世界种一棵树。

众所周知,解决气候危机并防止气温上升超过1.5摄氏度的最佳工具之一是种植树木。如果您为我的森林做出贡献,您将为当地家庭创造就业机会并恢复野生动物栖息地。

您可以在offset.earth/treeware购买树木

有关Treeware的更多信息,请参阅https://treeware.earth

Laravel Package Boilerplate

此包是使用Laravel Package Boilerplate生成的。