README

安装

composer require ichinya/laravel-sitemap

使用

生成器

在调度器中添加执行代码 \Ichinya\LaravelSitemap\Sitemap::generate()->writeToFile();，在方法中可以指定其他文件名

执行代码后将在网站根目录创建名为 sitemap.xml 的文件，该文件可通过以下链接访问 http://site.ru/sitemap.xml

要实现魔法，只需为所需的模型实现接口 Ichinya\LaravelSitemap\Sitemapable;

即模型应具有以下形式

<?php

namespace App\Models;

use Ichinya\LaravelSitemap\Sitemapable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Post extends Model implements Sitemapable
{
    use HasFactory;
}

在此情况下将使用路由 posts.index 和 posts.show，如果要替换标准路由，则需要指定

// маршрут для списка, в примере posts.index
public ?string $sitemap_model_route_list = null;
// маршрут для каждой позиции в примере это posts.show
public ?string $sitemap_model_route_item = null;

或者添加方法

    public function getSitemapModelRouteItem(): string
    {
        return $this->sitemap_model_route_item;
    }
    
    public function getSitemapModelRouteList(): string
    {
        return $this->sitemap_model_route_list;
    }

时间戳将取自字段 updated_at，因此它会相应地变化

    // можно указанть другое поле с отметкой времени, например published_at. Если поле данное поле у позиции будет null, то она не попадет в карту. Данное поведение можно поменять, смотрите ниже 
    public string $sitemap_datetime = 'updated_at';
    
    // можно использовать метод для использования любой логики
    public function getSitemapDatetime(): string
    {
        return $this->sitemap_datetime;
    }

获取位置列表

    // тут можно написать просто запрос, какие позиции попадут в карту
    public function getSitemapItems()
    {
        return self::whereNotNull($this->getSitemapDatetime())->get();
    }

标准使用方法

添加路由

Route::get('/sitemaps.xml', [SitemapController::class, 'index']);

在控制器中编写

 public function index()
    {
        $article = \App\Models\Article::all();

        $sitemapUrsl = new \Ichinya\LaravelSitemap\SitemapUrls();
        // можно указать значения по умолчанию $changefreq = 'weekly', $priority = 0.5
        $sitemapUrsl = new \Ichinya\LaravelSitemap\SitemapUrls('weekly', 0.5);
     
        $sitemapUrsl->addModel($article, 'article.show'); // второй параметр имя роута, с помощью которого генерируютя ссылки
        $sitemapUrsl->addModelClass(\App\Models\Page::class) // имя роута будет page.show
        
        // при добавлении модели можно указать поле с датой следующим параметром.
        $sitemapUrsl->addModelClass(\App\Models\StaticPage::class, 'created_at')
        
        $sitemapUrsl
            ->addUrl(route('main'), time())
            ->addUrl(route('categories.edit', time()) // добавляем ссылки на различные страницы
            ->addUrl('/rules', time(), 'weekly', 0.5); // добавляем ссылки на различные страницы
        // время можно указать в timestamp, через Carbon, объектом DateTime или строкой 


        $sitemap = Sitemap::create($sitemapUrsl); // ядро ссылок собрали, теперь отправляем на создание

        return $sitemap->render();
    }

待办事项

• 创建多个文件
• 使用配置
• 自动生成在特定时间或按命令