README

laravel框架快速生成sitemap

要求

1. php >= 7.2
2. Composer

安装

composer require zyan/laravel-sitemap -vvv

使用

use Zyan\Sitemap\Sitemap;

//path输出目录 不传默认为 public目录
$path = public_path();

$sitemap = Factory::sitemap($path);
$sitemap->table('表名')->where(['where条件 可不传'])->field(['字段'])->url('url规则')->make();

//可生成多个表
$sitemap->table('表名')->url('url规则')->make();

table

//不需要填写前缀
$sitemap->table('article')->make(); 

where[可选]

//请参考laravel手册中where传数组的方法 https://learnku.com/docs/laravel/8.5/queries/10404#ead379
$sitemap->table('article')->where([['id','>',1000],['state','=',1]])->make(); 

field

//请参考laravel手册select传数组的方法 https://learnku.com/docs/laravel/8.5/queries/10404#bb14ff
$sitemap->table('article')->field(['id','...'])->make();

url

//配合field字段为变量替换url 请用{}括起来
$sitemap->table('article')->field(['id'])->url('/article/{uid}.html')->make();
//可以有多个
$sitemap->table('article')->field(['id','type'])->url('/article/{type}/{uid}.html')->make();
//也可以指定域名 不指定默认以 读取 config('app.url') 
$sitemap->table('article')->field(['id','type'])->url('https://php.ac.cn/article/{id}.html')->make();

make

//开始生成
$sitemap->table('article')->field(['id'])->url('/user/{id}.html')->make();

生成结果

暂时仅支持txt格式 /sitemap/map.txt 为索引文件对应下面的url 请将这里的网址添加到百度站长即可

https://php.ac.cn/sitemap/article_1.txt
https://php.ac.cn/sitemap/article_2.txt
https://php.ac.cn/sitemap/article_3.txt
...

/sitemap/表名_分页.txt
/sitemap/article_1.txt
/sitemap/article_2.txt
/sitemap/article_3.txt

以上是默认目录的生成结果,如果您指定了目录,请自行修改上传后对应该路径

参与贡献

1. 将当前库fork到你的名下
2. 在你的本地修改完成后，审阅过后提交到你的仓库
3. 提交PR并描述你的修改，等待合并

许可证

MIT许可证